Replace an interaction context enrichment.
put
/admin/interactionContextEnrichments/{id}
Request
Path Parameters
-
id(required): string
The ID of the InteractionContextEnrichment to be updated.
Supported Media Types
- application/json
Nested Schema : interaction-context-enrichment-specification-item
Type:
Show Source
object-
context-items: array
context-items
Minimum Number of Items:
1 -
interaction-context-change-mode: object
interaction-context-change-mode
Change mode of the interaction context .
Match One Schema
Show Source
Nested Schema : interaction-context-change-mode
Type:
objectChange mode of the interaction context
.
Show Source
-
existing-context-handling: string
Allowed Values:
[ "replace", "enrich", "update", "terminate" ] -
new-context-expiry: object
new-context-expiry
Declares the maximum lifetime of an initiated interaction context. A maximum 59 minutes. Defaults to ten minutes .
-
operation-mode: string
Default Value:
SAFEAllowed Values:[ "SAFE", "UNSAFE" ]If set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change the context. This validation has to happen before each backend call . -
requires-existing-context: boolean
Default Value:
false
Nested Schema : items
Type:
Show Source
object-
interaction-context-fixed-value: string
The fixed value for the key on the interaction context .
-
interaction-context-key-name: string
The map key on the interaction context .
-
interaction-context-source: object
interaction-context-source
Match One Schema
Show Source
Nested Schema : interaction-context-source
Type:
Show Source
object-
interaction-context-source-kind: string
Allowed Values:
[ "ContentJSONPathSelector", "ContentJSONPointerSelector", "HeaderSelector", "QueryParameterSelector", "PathParameterSelector" ]The kind of selector. ContentJSONPathSelector: payload selection based on JSONPath ContentJSONPointerSelector: payload selection based on JSONPointer HeaderSelector: the name of a header QueryParameterSelector: the name of a query parameter PathParameterSelector: the name of a path parameter . -
message-direction: string
Allowed Values:
[ "REQUEST", "RESPONSE" ]The message direction. request from the caller or from the response . -
selector: string
The specific selection string. In case there is no match, then the specific context element is not modified or created .
Match One Schema
Show Source
Nested Schema : new-context-expiry
Type:
objectDeclares the maximum lifetime of an initiated interaction context. A maximum 59 minutes. Defaults to
ten minutes
.
Show Source
-
expiry-units: integer
Minimum Value:
1Maximum Value:59Default Value:10 -
expiry-uom: string
Default Value:
minAllowed Values:[ "sec", "min" ]
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : interaction-context-enrichment-specification-item
Type:
Show Source
object-
context-items: array
context-items
Minimum Number of Items:
1 -
interaction-context-change-mode: object
interaction-context-change-mode
Change mode of the interaction context .
Match One Schema
Show Source
Nested Schema : interaction-context-change-mode
Type:
objectChange mode of the interaction context
.
Show Source
-
existing-context-handling: string
Allowed Values:
[ "replace", "enrich", "update", "terminate" ] -
new-context-expiry: object
new-context-expiry
Declares the maximum lifetime of an initiated interaction context. A maximum 59 minutes. Defaults to ten minutes .
-
operation-mode: string
Default Value:
SAFEAllowed Values:[ "SAFE", "UNSAFE" ]If set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change the context. This validation has to happen before each backend call . -
requires-existing-context: boolean
Default Value:
false
Nested Schema : items
Type:
Show Source
object-
interaction-context-fixed-value: string
The fixed value for the key on the interaction context .
-
interaction-context-key-name: string
The map key on the interaction context .
-
interaction-context-source: object
interaction-context-source
Match One Schema
Show Source
Nested Schema : interaction-context-source
Type:
Show Source
object-
interaction-context-source-kind: string
Allowed Values:
[ "ContentJSONPathSelector", "ContentJSONPointerSelector", "HeaderSelector", "QueryParameterSelector", "PathParameterSelector" ]The kind of selector. ContentJSONPathSelector: payload selection based on JSONPath ContentJSONPointerSelector: payload selection based on JSONPointer HeaderSelector: the name of a header QueryParameterSelector: the name of a query parameter PathParameterSelector: the name of a path parameter . -
message-direction: string
Allowed Values:
[ "REQUEST", "RESPONSE" ]The message direction. request from the caller or from the response . -
selector: string
The specific selection string. In case there is no match, then the specific context element is not modified or created .
Match One Schema
Show Source
Nested Schema : new-context-expiry
Type:
objectDeclares the maximum lifetime of an initiated interaction context. A maximum 59 minutes. Defaults to
ten minutes
.
Show Source
-
expiry-units: integer
Minimum Value:
1Maximum Value:59Default Value:10 -
expiry-uom: string
Default Value:
minAllowed Values:[ "sec", "min" ]
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
409 Response
Conflict
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
Examples
The following example shows how to replace an integration context enrichment by submitting a PUT request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X PUT
https://{FABRIC_HOST}/admin/interactionContextEnrichments/{id}
-H "Content-Type: application/json" -D @replace_ICE.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
{
"interaction-context-enrichment-specification-link-key": "CM-B2C-New",
"interaction-context-enrichment-specification-item": {
"interaction-context-change-mode": {
"new-context-expiry": {
"expiry-uom": "sec",
"expiry-units": 59
},
"operation-mode": "UNSAFE",
"requires-existing-context": false,
"existing-context-handling": "enrich"
},
"context-items": [
{
"interaction-context-key-name": "source-system",
"interaction-context-fixed-value": "CM-B2C"
}
]
}
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"id": "ICSE1650526055",
"interaction-context-enrichment-specification-link-key": "CM-B2C-New",
"interaction-context-enrichment-specification-item": {
"interaction-context-change-mode": {
"new-context-expiry": {
"expiry-uom": "sec",
"expiry-units": 59
},
"operation-mode": "UNSAFE",
"requires-existing-context": false,
"existing-context-handling": "enrich"
},
"context-items": [
{
"interaction-context-key-name": "source-system",
"interaction-context-fixed-value": "CM-B2C"
}
]
}
}