overview

Last Updated : Jul 18, 2022 |
Prolog information
Metadata
Keywords:

elements overview

provides a flexible and easy integration among different applications, providing a centralized solution to store context information. Many applications can use the abstract context concepts thatprovides.
A context entry inconsists of the following elements:
  • contextId: A text field that contains a unique identification for the context. You can specify the contextId while adding the context entry in. If you do not specify a contextId while creating a context, the system generates a unique id.
  • data: The data field in a context entry is an abstract map with multiple key/value pairs. Keys in the data field must be unique. Multiple identical keys in the same request results in the values being overwritten with the last key. To provide a better structure and organization of context data,also supports inner maps in context data fields.
  • groupId: An optional text field that creates a logical group of related context entries. You can specify the groupId while adding the context entry inor while updating an existing context entry.
  • aliasId: An optional field that contains unique identifications for the aliases associated with a Context object. You can specify aliasId/aliasIds while adding the context entry inor you can update an existing context entry to have aliasIds.
  • routingId (rid): A parameter used in a Geo-redundant deployment to route requests by the load balancer. If you specify a value for the rid parameter,assigns the value to the routingId. The default value is 0. The rid query parameter for a request, if provided, cannot be left blank.
  • topic: An optional text field that can be used to specify the topic of the context object, which can be used later for filtering when querying context data in External Data Mart (EDM). You can specify the topic while adding the context entry inor while updating an existing context entry.
    For more information on External Data Mart (EDM), see the External Data Mart overview section in this document.
  • userId : The userId represents externally provided User ID value. It is just another identifier that is used to represent an externally provided User ID of an interaction. The userId can be changed using a PUT command.
  • externalId : The externalId represents externally provided External ID value. It is just another identifier that is used to represent an externally provided External ID of an interaction. The externalId can be changed using a PUT command.
  • tenantid : The tenant identification to which the context belongs. This parameter provides additional filtering forNotifications. A client can subscribe for notifications only for contexts which are created with a specific tenantId. This allows for application developers to create a one to one relationship between a producer application feeding into theand a consumer application feeding off the.
  • accountId : The accountId represents an externally provided Account ID value. It is another identifier that is used to represent an externally provided Account ID of an interaction. The accountId can be changed using a PUT command.