Constructor
-
new ContextStore(csConfig)
-
ContextStore API
Parameters:
Name Type Description csConfigAvayaDataStoreClient.Config.CsConfiguration
Methods
-
createContext(requestBody, sid, rid, touchpoint, lease, rules, shortId) → {Object}
-
request to create Context
Parameters:
Name Type Description requestBodyString Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
rulesBoolean set flag to enable rules
shortIdBoolean set flag to request short auto generated contextId (less than 12 characters)
Returns:
{ Object }response with empty string "" or JSON Object containing contextId (if it was not specified in request)
-
deleteAliasByAliasId(aliasId, sid, rid, touchpoint) → {String}
-
Deletes Alias from Context via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ String }empty string
-
deleteContext(contextId, sid, rid) → {String}
-
Deletes Context from Context Store via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
Returns:
{ String }empty string
-
deleteContextByAliasId(aliasId, sid, rid) → {String}
-
Deletes Context from Context Store via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
Returns:
{ String }empty string
-
deleteValueByAliasId(aliasId, key, sid, rid, touchpoint) → {String}
-
Deletes Context Value from Context via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
keyString key name to retrieve
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ String }empty string
-
deleteValueByContextId(contextId, key, sid, rid, touchpoint) → {String}
-
Deletes Context Value from Context via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
keyString key name to retrieve
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ String }empty string
-
generateToken() → {String}
-
request to generate Token
Returns:
{ String }token value
-
getAliasesByContextId(contextId, sid, rid, touchpoint) → {Object}
-
Get Alias(es) from Context Store via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getAuditByAliasId(aliasId, sid, rid, touchpoint) → {Object}
-
Get Audit Trail from Context via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getAuditByContextId(contextId, sid, rid, touchpoint) → {Object}
-
Get Audit Trail from Context via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getContext(contextId, sid, rid, touchpoint) → {Object}
-
Get Context from Context Store via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getContextByAliasId(aliasId, sid, rid, touchpoint) → {Object}
-
Get Context from Context Store via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getContextByAliasIdWithMetaData(aliasId, sid, rid, touchpoint) → {Object}
-
Get Context from Context Store via Alias Id With Meta Data
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getContextIdByAliasId(aliasId, sid, rid, touchpoint) → {Object}
-
Get ContextId from Context Store via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getContextStoreStatus(csConfig) → {String}
-
Get Context Store Status
Parameters:
Name Type Description csConfigAvayaDataStoreClient.Config.CsConfiguration Returns:
{ String }response with String
-
getContextWithMetaData(contextId, sid, rid, touchpoint) → {Object}
-
Get Context from Context Store via Context Id with Meta Data
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ Object }response with JSON Object
-
getEDMEntryAudit(contextId, diff, data, metadata, schema) → {Object}
-
Get EDM Context Entry Audit Trail
Parameters:
Name Type Description contextIdString contextId of Context data object
diffBoolean enable to show differences for context entries
dataBoolean enable to show context data
metadataBoolean enable to show context metadata
schemaBoolean enable to show schema related to the context
Returns:
{ Object }response with JSON Object
-
getEDMGroupAudit(groupId, diff, data, metadata, schema) → {Object}
-
Get EDM Context Group Audit Trail
Parameters:
Name Type Description groupIdString Group Id
diffBoolean enable to show differences for context entries
dataBoolean enable to show context data
metadataBoolean enable to show context metadata
schemaBoolean enable to show schema related to the context
Returns:
{ Object }response with JSON Object
-
getGroup(groupId, sid, rid) → {Object}
-
Get Context from Context Store via Group Id
Parameters:
Name Type Description groupIdString Group Id
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
Returns:
{ Object }response with JSON Object
-
getGroupByAliasId(aliasId, sid, rid) → {String}
-
Get Group from Context Store via Alias Id
Parameters:
Name Type Description aliasIdString Alias Id
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
Returns:
{ String }value
-
getValueByAliasId(aliasId, key, sid, rid, touchpoint) → {String}
-
Get Context Value from Context Store via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
keyString key name to retrieve
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ String }value
-
getValueByContextId(contextId, sid, rid, touchpoint) → {String}
-
Get Context Value from Context Store via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
Returns:
{ String }value
-
updateAliasesByAliasId(aliasId, requestBody, sid, rid, touchpoint, lease) → {String}
-
Updates Alias(es) in Context via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
Returns:
{ String }empty string
-
updateAliasesByContextId(contextId, requestBody, sid, rid, touchpoint, lease) → {Object}
-
Updates Alias(es) in Context via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
Returns:
{ Object }response
-
updateContext(contextId, requestBody, sid, rid, touchpoint, lease, rules, groupId) → {String}
-
request to update Context
Parameters:
Name Type Description contextIdString contextId of Context data object
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
rulesBoolean set flag to enable rules
groupIdString Group Id
Returns:
{ String }empty string
-
updateContextByAliasId(aliasId, requestBody, sid, rid, touchpoint, lease, rules, groupId) → {String}
-
request to update Context By Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
rulesBoolean set flag to enable rules
groupIdString Group Id
Returns:
{ String }empty string
-
updateValueByAliasId(aliasId, key, value, sid, rid, touchpoint, lease) → {String}
-
Updates Context Value in Context via Alias Id
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
keyString key name to retrieve
valueString updated Value
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
Returns:
{ String }empty string
-
updateValueByContextId(contextId, key, value, sid, rid, touchpoint, lease) → {String}
-
Updates Context Value in Context via Context Id
Parameters:
Name Type Description contextIdString contextId of Context data object
keyString key name to retrieve
valueString updated Value
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
Returns:
{ String }empty string
-
upsertContext(contextId, requestBody, sid, rid, touchpoint, lease, rules) → {Object}
-
request to update Context or create it if it does not exist
Parameters:
Name Type Description contextIdString contextId of Context data object
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
rulesBoolean set flag to enable rules
Returns:
{ Object }response with JSON Object
-
upsertContextByAliasId(aliasId, requestBody, sid, rid, touchpoint, lease, rules) → {Object}
-
request to update Context or create it if it does not exist
Parameters:
Name Type Description aliasIdString additional, indexable identifier(s) for the Context (for requests "by AliasId" only)
requestBodyJSON Context data object containing required key/value pairs (required) The same optional fields are available as in ContextStoreRest (contextId, groupId, tenantId etc.)
sidString session id associated with a Context entry
ridString routing identifier which is used to distinguish between Contexts in geo-redundant deployment
touchpointString User/application identifier for Audit Trail
leaseInteger Context will be stored for period specified in lease
rulesBoolean set flag to enable rules
Returns:
{ Object }response with empty string "" or JSON Object containing contextId (if it was not specified in request)