Session context modification

Deleting an attribute from a session context

delete

Removes a particular attribute from a specified session context. Recommended for performing calls on the management side.

Note: Optimistic locking is not taken into account here.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Pattern: ^[a-z][a-z0-9]+$
sessionIdstringRequired

Customer session ID.

attributeNamestringRequired

Name of the attribute that should be deleted from the session context.

Responses
delete
/session-context/{tenant}/context/{sessionId}/attributes/{attributeName}
DELETE /session-context/{tenant}/context/{sessionId}/attributes/{attributeName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Adding a new attribute to a session context

post

Adds an attribute to a session context file for a session with a given sessionId. Recommended for performing calls on the management side.

Note: Optimistic locking is not taken into account here.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Pattern: ^[a-z][a-z0-9]+$
sessionIdstringRequired

Customer session ID.

Body

Context attribute

keystringRequired

Additional context information key

valueone ofRequired

Additional context information value

objectOptional
or
stringOptional
Responses
post
/session-context/{tenant}/context/{sessionId}/attributes
POST /session-context/{tenant}/context/{sessionId}/attributes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "key": "text",
  "value": {}
}

No content

Last updated

Was this helpful?