Context Store REST

Last Updated : Apr 08, 2021 |

Context Store implements a RESTful web services interface, the ContextStoreRest service, to provide the required services to the clients.

The ContextStoreRest service identifies the resources using HTTP or HTTPS URLs and returns the output to the clients using JavaScript Object Notation (JSON).

Using the contextId, or optionally an aliasId, through the ContextStoreRest snap-in service, you can create, read, update and delete context entries and values. You can also group related context entries together by assigning a groupId when the context entry is created or by updating an existing context entry with a groupId.

The required fields for Context Store object are as follows:

  • contextId: A unique identifier for the context. If you do not specify a contextId while creating a context, the system generates a unique id. A contextId can be of maximum 255 characters.

  • data: Represented as key/value pairs.

Basic request example

Note:

On multiple node deployments, ContextStoreRest requests must be submitted through the clusterIP, which ensures that the requests are load balanced across all the servers in a cluster. For single node deployments, enter the Avaya Breeze® platform node security IP instead of the cluster IP.

Request name

URL

HTTP request type

Content

Create a new context object

https://clusterIP/services/ContextStoreRest/cs/contexts/

POST

{"contextId":"sampleContext", data":{"key1":"value1","key2":"value2","key3":"value3"}}

Retrieve an existing context object

https://clusterIP/services/ContextStoreRest/cs/contexts/sampleContext

GET

For more information about ContextStoreRest, and the complete API documentation, see Avaya Context Store Snap-in Developer Guide.