Jump to

• Request
• Response
• Examples

Get an interaction context enrichment

get

/admin/interactionContextEnrichments/{id}

Request

Path Parameters

• id(required): string
  The id of the InteractionContextEnrichment

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : InteractionContextEnrichment

Type: object

Show Source

• id: string
• interaction-context-enrichment-specification-item: object interaction-context-enrichment-specification-item
• interaction-context-enrichment-specification-link-key: string

{
    "type":"object",
    "properties":{
        "interaction-context-enrichment-specification-link-key":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "interaction-context-enrichment-specification-item":{
            "type":"object",
            "properties":{
                "interaction-context-change-mode":{
                    "description":"Change mode of the interaction context\n",
                    "type":"object",
                    "properties":{
                        "new-context-expiry":{
                            "description":"declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to\nten minutes\n",
                            "type":"object",
                            "properties":{
                                "expiry-uom":{
                                    "type":"string",
                                    "enum":[
                                        "sec",
                                        "min"
                                    ],
                                    "default":"min"
                                },
                                "expiry-units":{
                                    "type":"integer",
                                    "minimum":1,
                                    "maximum":59,
                                    "default":10
                                }
                            }
                        },
                        "operation-mode":{
                            "description":"if set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change\nthe context. This validation has to happen before each backend call\n",
                            "type":"string",
                            "enum":[
                                "SAFE",
                                "UNSAFE"
                            ],
                            "default":"SAFE"
                        },
                        "requires-existing-context":{
                            "type":"boolean",
                            "default":false
                        },
                        "existing-context-handling":{
                            "type":"string",
                            "enum":[
                                "replace",
                                "enrich",
                                "update",
                                "terminate"
                            ]
                        }
                    }
                },
                "context-items":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object",
                        "properties":{
                            "interaction-context-key-name":{
                                "description":"the map key on the interaction context\n",
                                "type":"string",
                                "nullable":false
                            },
                            "interaction-context-fixed-value":{
                                "description":"the fixed value for the key on the interaction context\n",
                                "type":"string",
                                "nullable":false
                            },
                            "interaction-context-source":{
                                "type":"object",
                                "properties":{
                                    "message-direction":{
                                        "description":"the message direction. request from the caller or from the response\n",
                                        "type":"string",
                                        "enum":[
                                            "REQUEST",
                                            "RESPONSE"
                                        ]
                                    },
                                    "selector":{
                                        "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                                        "type":"string"
                                    },
                                    "interaction-context-source-kind":{
                                        "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                                        "type":"string",
                                        "enum":[
                                            "ContentJSONPathSelector",
                                            "ContentJSONPointerSelector",
                                            "HeaderSelector",
                                            "QueryParameterSelector",
                                            "PathParameterSelector"
                                        ]
                                    }
                                },
                                "oneOf":[
                                    {
                                        "required":[
                                            "message-direction",
                                            "interaction-context-source-kind",
                                            "selector"
                                        ]
                                    }
                                ]
                            }
                        },
                        "oneOf":[
                            {
                                "required":[
                                    "interaction-context-key-name",
                                    "interaction-context-source"
                                ]
                            },
                            {
                                "required":[
                                    "interaction-context-key-name",
                                    "interaction-context-fixed-value"
                                ]
                            }
                        ]
                    }
                }
            },
            "oneOf":[
                {
                    "required":[
                        "interaction-context-change-mode",
                        "context-items"
                    ]
                }
            ]
        }
    }
}

Nested Schema : interaction-context-enrichment-specification-item

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "interaction-context-change-mode":{
            "description":"Change mode of the interaction context\n",
            "type":"object",
            "properties":{
                "new-context-expiry":{
                    "description":"declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to\nten minutes\n",
                    "type":"object",
                    "properties":{
                        "expiry-uom":{
                            "type":"string",
                            "enum":[
                                "sec",
                                "min"
                            ],
                            "default":"min"
                        },
                        "expiry-units":{
                            "type":"integer",
                            "minimum":1,
                            "maximum":59,
                            "default":10
                        }
                    }
                },
                "operation-mode":{
                    "description":"if set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change\nthe context. This validation has to happen before each backend call\n",
                    "type":"string",
                    "enum":[
                        "SAFE",
                        "UNSAFE"
                    ],
                    "default":"SAFE"
                },
                "requires-existing-context":{
                    "type":"boolean",
                    "default":false
                },
                "existing-context-handling":{
                    "type":"string",
                    "enum":[
                        "replace",
                        "enrich",
                        "update",
                        "terminate"
                    ]
                }
            }
        },
        "context-items":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "interaction-context-key-name":{
                        "description":"the map key on the interaction context\n",
                        "type":"string",
                        "nullable":false
                    },
                    "interaction-context-fixed-value":{
                        "description":"the fixed value for the key on the interaction context\n",
                        "type":"string",
                        "nullable":false
                    },
                    "interaction-context-source":{
                        "type":"object",
                        "properties":{
                            "message-direction":{
                                "description":"the message direction. request from the caller or from the response\n",
                                "type":"string",
                                "enum":[
                                    "REQUEST",
                                    "RESPONSE"
                                ]
                            },
                            "selector":{
                                "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                                "type":"string"
                            },
                            "interaction-context-source-kind":{
                                "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                                "type":"string",
                                "enum":[
                                    "ContentJSONPathSelector",
                                    "ContentJSONPointerSelector",
                                    "HeaderSelector",
                                    "QueryParameterSelector",
                                    "PathParameterSelector"
                                ]
                            }
                        },
                        "oneOf":[
                            {
                                "required":[
                                    "message-direction",
                                    "interaction-context-source-kind",
                                    "selector"
                                ]
                            }
                        ]
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "interaction-context-key-name",
                            "interaction-context-source"
                        ]
                    },
                    {
                        "required":[
                            "interaction-context-key-name",
                            "interaction-context-fixed-value"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "interaction-context-change-mode",
                "context-items"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "interaction-context-change-mode":{
            "description":"Change mode of the interaction context\n",
            "type":"object",
            "properties":{
                "new-context-expiry":{
                    "description":"declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to\nten minutes\n",
                    "type":"object",
                    "properties":{
                        "expiry-uom":{
                            "type":"string",
                            "enum":[
                                "sec",
                                "min"
                            ],
                            "default":"min"
                        },
                        "expiry-units":{
                            "type":"integer",
                            "minimum":1,
                            "maximum":59,
                            "default":10
                        }
                    }
                },
                "operation-mode":{
                    "description":"if set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change\nthe context. This validation has to happen before each backend call\n",
                    "type":"string",
                    "enum":[
                        "SAFE",
                        "UNSAFE"
                    ],
                    "default":"SAFE"
                },
                "requires-existing-context":{
                    "type":"boolean",
                    "default":false
                },
                "existing-context-handling":{
                    "type":"string",
                    "enum":[
                        "replace",
                        "enrich",
                        "update",
                        "terminate"
                    ]
                }
            }
        },
        "context-items":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "interaction-context-key-name":{
                        "description":"the map key on the interaction context\n",
                        "type":"string",
                        "nullable":false
                    },
                    "interaction-context-fixed-value":{
                        "description":"the fixed value for the key on the interaction context\n",
                        "type":"string",
                        "nullable":false
                    },
                    "interaction-context-source":{
                        "type":"object",
                        "properties":{
                            "message-direction":{
                                "description":"the message direction. request from the caller or from the response\n",
                                "type":"string",
                                "enum":[
                                    "REQUEST",
                                    "RESPONSE"
                                ]
                            },
                            "selector":{
                                "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                                "type":"string"
                            },
                            "interaction-context-source-kind":{
                                "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                                "type":"string",
                                "enum":[
                                    "ContentJSONPathSelector",
                                    "ContentJSONPointerSelector",
                                    "HeaderSelector",
                                    "QueryParameterSelector",
                                    "PathParameterSelector"
                                ]
                            }
                        },
                        "oneOf":[
                            {
                                "required":[
                                    "message-direction",
                                    "interaction-context-source-kind",
                                    "selector"
                                ]
                            }
                        ]
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "interaction-context-key-name",
                            "interaction-context-source"
                        ]
                    },
                    {
                        "required":[
                            "interaction-context-key-name",
                            "interaction-context-fixed-value"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "interaction-context-change-mode",
                "context-items"
            ]
        }
    ]
}

Nested Schema : context-items

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"object",
        "properties":{
            "interaction-context-key-name":{
                "description":"the map key on the interaction context\n",
                "type":"string",
                "nullable":false
            },
            "interaction-context-fixed-value":{
                "description":"the fixed value for the key on the interaction context\n",
                "type":"string",
                "nullable":false
            },
            "interaction-context-source":{
                "type":"object",
                "properties":{
                    "message-direction":{
                        "description":"the message direction. request from the caller or from the response\n",
                        "type":"string",
                        "enum":[
                            "REQUEST",
                            "RESPONSE"
                        ]
                    },
                    "selector":{
                        "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                        "type":"string"
                    },
                    "interaction-context-source-kind":{
                        "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                        "type":"string",
                        "enum":[
                            "ContentJSONPathSelector",
                            "ContentJSONPointerSelector",
                            "HeaderSelector",
                            "QueryParameterSelector",
                            "PathParameterSelector"
                        ]
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "message-direction",
                            "interaction-context-source-kind",
                            "selector"
                        ]
                    }
                ]
            }
        },
        "oneOf":[
            {
                "required":[
                    "interaction-context-key-name",
                    "interaction-context-source"
                ]
            },
            {
                "required":[
                    "interaction-context-key-name",
                    "interaction-context-fixed-value"
                ]
            }
        ]
    }
}

Nested Schema : interaction-context-change-mode

Type: object

Change 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. At maximum 59 minutes. Defaults to ten minutes
• operation-mode: string
  Default Value: SAFE

  Allowed 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

{
    "description":"Change mode of the interaction context\n",
    "type":"object",
    "properties":{
        "new-context-expiry":{
            "description":"declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to\nten minutes\n",
            "type":"object",
            "properties":{
                "expiry-uom":{
                    "type":"string",
                    "enum":[
                        "sec",
                        "min"
                    ],
                    "default":"min"
                },
                "expiry-units":{
                    "type":"integer",
                    "minimum":1,
                    "maximum":59,
                    "default":10
                }
            }
        },
        "operation-mode":{
            "description":"if set to SAFE, then only context deletion is allowed as context operation on HTTP methods that change\nthe context. This validation has to happen before each backend call\n",
            "type":"string",
            "enum":[
                "SAFE",
                "UNSAFE"
            ],
            "default":"SAFE"
        },
        "requires-existing-context":{
            "type":"boolean",
            "default":false
        },
        "existing-context-handling":{
            "type":"string",
            "enum":[
                "replace",
                "enrich",
                "update",
                "terminate"
            ]
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "interaction-context-key-name":{
            "description":"the map key on the interaction context\n",
            "type":"string",
            "nullable":false
        },
        "interaction-context-fixed-value":{
            "description":"the fixed value for the key on the interaction context\n",
            "type":"string",
            "nullable":false
        },
        "interaction-context-source":{
            "type":"object",
            "properties":{
                "message-direction":{
                    "description":"the message direction. request from the caller or from the response\n",
                    "type":"string",
                    "enum":[
                        "REQUEST",
                        "RESPONSE"
                    ]
                },
                "selector":{
                    "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                    "type":"string"
                },
                "interaction-context-source-kind":{
                    "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                    "type":"string",
                    "enum":[
                        "ContentJSONPathSelector",
                        "ContentJSONPointerSelector",
                        "HeaderSelector",
                        "QueryParameterSelector",
                        "PathParameterSelector"
                    ]
                }
            },
            "oneOf":[
                {
                    "required":[
                        "message-direction",
                        "interaction-context-source-kind",
                        "selector"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "interaction-context-key-name",
                "interaction-context-source"
            ]
        },
        {
            "required":[
                "interaction-context-key-name",
                "interaction-context-fixed-value"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "interaction-context-key-name":{
            "description":"the map key on the interaction context\n",
            "type":"string",
            "nullable":false
        },
        "interaction-context-fixed-value":{
            "description":"the fixed value for the key on the interaction context\n",
            "type":"string",
            "nullable":false
        },
        "interaction-context-source":{
            "type":"object",
            "properties":{
                "message-direction":{
                    "description":"the message direction. request from the caller or from the response\n",
                    "type":"string",
                    "enum":[
                        "REQUEST",
                        "RESPONSE"
                    ]
                },
                "selector":{
                    "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
                    "type":"string"
                },
                "interaction-context-source-kind":{
                    "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
                    "type":"string",
                    "enum":[
                        "ContentJSONPathSelector",
                        "ContentJSONPointerSelector",
                        "HeaderSelector",
                        "QueryParameterSelector",
                        "PathParameterSelector"
                    ]
                }
            },
            "oneOf":[
                {
                    "required":[
                        "message-direction",
                        "interaction-context-source-kind",
                        "selector"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "interaction-context-key-name",
                "interaction-context-source"
            ]
        },
        {
            "required":[
                "interaction-context-key-name",
                "interaction-context-fixed-value"
            ]
        }
    ]
}

Nested Schema : interaction-context-source

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "message-direction":{
            "description":"the message direction. request from the caller or from the response\n",
            "type":"string",
            "enum":[
                "REQUEST",
                "RESPONSE"
            ]
        },
        "selector":{
            "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
            "type":"string"
        },
        "interaction-context-source-kind":{
            "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
            "type":"string",
            "enum":[
                "ContentJSONPathSelector",
                "ContentJSONPointerSelector",
                "HeaderSelector",
                "QueryParameterSelector",
                "PathParameterSelector"
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "message-direction",
                "interaction-context-source-kind",
                "selector"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "message-direction":{
            "description":"the message direction. request from the caller or from the response\n",
            "type":"string",
            "enum":[
                "REQUEST",
                "RESPONSE"
            ]
        },
        "selector":{
            "description":"the specific selection string. In case there is no match, then the specific context element is not\nmodified or created\n",
            "type":"string"
        },
        "interaction-context-source-kind":{
            "description":"the kind of selector.\nContentJSONPathSelector:    payload selection based on JSONPath\nContentJSONPointerSelector: payload selection based on JSONPointer\nHeaderSelector:             the name of a header\nQueryParameterSelector:     the name of a query parameter\nPathParameterSelector:      the name of a path parameter\n",
            "type":"string",
            "enum":[
                "ContentJSONPathSelector",
                "ContentJSONPointerSelector",
                "HeaderSelector",
                "QueryParameterSelector",
                "PathParameterSelector"
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "message-direction",
                "interaction-context-source-kind",
                "selector"
            ]
        }
    ]
}

Nested Schema : new-context-expiry

Type: object

declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to ten minutes

Show Source

• expiry-units: integer
  Minimum Value: 1

  Maximum Value: 59

  Default Value: 10
• expiry-uom: string
  Default Value: min

  Allowed Values: [ "sec", "min" ]

{
    "description":"declares the maximum lifetime of an initiated interaction context. At maximum 59 minutes. Defaults to\nten minutes\n",
    "type":"object",
    "properties":{
        "expiry-uom":{
            "type":"string",
            "enum":[
                "sec",
                "min"
            ],
            "default":"min"
        },
        "expiry-units":{
            "type":"integer",
            "minimum":1,
            "maximum":59,
            "default":10
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to get an interaction context enrichment object by submitting a GET request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X GET https://{FABRIC_HOST}/admin/interactionContextEnrichments/{id} -H "Content-Type: application/json" | json_pp

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": "min",
                "expiry-units": 10
            },
            "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"
            }
        ]
    }
}

Back to Top