Overview
You can document each interaction that takes place between a customer and an agent in the Engagement Center by creating an interaction log item. An interaction log item contains information such as:
- the customer and the agent that interacted with each other
- the date and time the interaction took place
- notes the agent took about the interaction
- links to related objects such as service tickets and sales orders
The interaction log is a collected history of these interaction items.
By keeping this history and making it available to your agents, you can improve the efficiency of your customer interactions because every agent will have an overview of the interactions that previously occurred with a particular customer.
API Reference
/{tenant}/interactionLog
Interaction log
/{tenant}/interactionLog
get
Retrieve the interaction log.
If no query is specified, the complete interaction log consisting of all interaction log items is returned. To filter the interaction log items, use the query parameter q. The interaction log service uses the same query syntax as the Document service.
You can sort the interaction log using the query parameter sort.
Only persisted fields can be used for querying and sorting. The following fields are transient and cannot be used for formulating queries or sorting the interaction log:
- Interaction reason description (
interactionReasons.description) - Communication direction description (
communicationDirectionDescription) - Communication origin description (
communicationOriginDescription) - Communication medium description (
communicationMediumDescription)
If you would like to query or sort by those attributes, use the following persisted attributes instead:
- Interaction reason (
interactionReasons.interactionReason) - Communication direction (
communicationDirection) - Communication origin (
communicationOrigin) - Communication medium (
communicationMedium)
The GET method is paged. Use the query parameters pageNumber to control which page is retrieved. Use the query parameter pageSize to control the number of interaction log items per page. The maximum pageSize supported is 64.
Required scope: hybris.interactionlog_view
post
Create a new interaction log item.
The id of the interaction log item is automatically generated by the system. It is returned in the field id in the response body. It is also part of the response header Location.
Required scope: hybris.interactionlog_manage
get /{tenant}/interactionLog
Retrieve the interaction log.
If no query is specified, the complete interaction log consisting of all interaction log items is returned. To filter the interaction log items, use the query parameter q. The interaction log service uses the same query syntax as the Document service.
You can sort the interaction log using the query parameter sort.
Only persisted fields can be used for querying and sorting. The following fields are transient and cannot be used for formulating queries or sorting the interaction log:
- Interaction reason description (
interactionReasons.description) - Communication direction description (
communicationDirectionDescription) - Communication origin description (
communicationOriginDescription) - Communication medium description (
communicationMediumDescription)
If you would like to query or sort by those attributes, use the following persisted attributes instead:
- Interaction reason (
interactionReasons.interactionReason) - Communication direction (
communicationDirection) - Communication origin (
communicationOrigin) - Communication medium (
communicationMedium)
The GET method is paged. Use the query parameters pageNumber to control which page is retrieved. Use the query parameter pageSize to control the number of interaction log items per page. The maximum pageSize supported is 64.
Required scope: hybris.interactionlog_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
Query Parameters
- sort: (string)
The list of comma-separated properties used to sort the results. By default, the column values are sorted in ascending order. Can either be in the form of fieldName or fieldName:asc,fieldName:desc. If you want to sort by localized attributes, you must use the following form: fieldName.language or fieldName.language:asc,fieldName.language:desc.
Example:
metadata.createdAt:desc
- q: (string)
The simple query criteria based on available fields to limit returned results or a set of modified documents.
Example:
customerId:"C0750876755"
- pageNumber: (integer - default: 1 - minimum: 1)
The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
Example:
1 - pageSize: (integer - default: 16 - minimum: 1 - maximum: 64)
The number of documents being retrieved on the page.
Example:
16
HTTP status code 200
Interaction log retrieved successfully.
Headers
- Link: required (string - repeat: true)
Link to the current page, the next page and the previous page. Marked accordingly with rel self, rel next and rel prev. The syntax must be conform to RFC-5988. The link to the current page (self) is required and must be provided always. The link to the next page (next) is optional. If not present, the next page is not available, as the current page is the last page of the result. The link to the previous page (prev) is optional. If not present, the previous page is not available, as the current page is the first page of the result.
Example:
<http://sample.com?pageNumber=2&pageSize=10>; rel="self", <http://sample.com?pageNumber=3&pageSize=10>; rel="next"
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction log schema",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction log item schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the interaction log item"
},
"customerId": {
"type": "string",
"description": "Unique identifier of the customer"
},
"agentId": {
"type": "string",
"description": "Unique identifier of the CECenter agent"
},
"agentTitle": {
"type": "string",
"description": "Title of the agent"
},
"agentFirstName": {
"type": "string",
"description": "First name of the agent"
},
"agentLastName": {
"type": "string",
"description": "Last name of the agent"
},
"interactionStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the interaction started (in UTC)"
},
"interactionEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date an time the interaction ended (in UTC)"
},
"interactionReasons": {
"description": "Reasons for the interaction",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
},
"interactionDescription": {
"type": "string",
"description": "Free-text description of the interaction"
},
"communicationStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) started (in UTC)"
},
"communicationEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) ended (in UTC)"
},
"communicationDirection": {
"description": "Direction of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication directions",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"communicationDirectionDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication direction"
},
"communicationOrigin": {
"description": "Origin of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication origins",
"enum": [
"CECENTER",
"STOREFRONT"
]
},
"communicationOriginDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication origin"
},
"communicationMedium": {
"description": "Communication medium",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication mediums",
"enum": [
"TEXT_CHAT",
"WEBRTC_VIDEO",
"SAP_COMMUNITY",
"PHONE"
]
},
"communicationMediumDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication medium"
},
"communicationExcerpt": {
"type": "string",
"description": "An excerpt of the communication (e.g. part of a text chat"
},
"communicationSystemInteractionId": {
"type": "string",
"description": "Unique identifier of the interaction in the communication system"
},
"relatedObjects": {
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Related object schema",
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "Type of the lined object"
},
"objectId": {
"type": "string",
"description": "Unique identifier of the linked object"
},
"objectName": {
"type": "string",
"description": "Human-readable name of the linked object"
},
"rootObjectId": {
"type": "string",
"description": "Unique identifer of the linked root object; used only if the linked object is part of a hierarchy"
}
},
"required": [
"objectType",
"objectId"
]
}
},
"metadata": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Document repository meta data schema",
"type": "object",
"properties": {
"version": {
"description": "Document repository version number",
"type": "integer"
},
"createdAt": {
"description": "Time the document was created at",
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"description": "Time the document was last modified at",
"type": "string",
"format": "date-time"
},
"mixins": {
"description": "Mixins object. Keys in mixins can only be constructed from numbers, letters, hyphens and underscores.",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"description": "URI for mixin.",
"type": "string"
},
{
"description": "Inline mixin.",
"type": "object"
}
]
}
}
}
},
"required": [
"version"
]
},
"mixins": {
"type": "object",
"description": "The collection of mixins stored in the service ticket. Each attribute is a separate mixin.",
"additionalProperties": true
}
},
"required": [
"id"
]
}
}
Example:
[
{
"id": "5551c0ffa86e7c1f624d0001",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000001",
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:10:00.000+0000",
"modifiedAt": "2016-07-19T14:15:00.000+0000"
}
},
{
"id": "5551c0ffa86e7c1f624d0002",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:30:00.000+0000",
"interactionEndedAt": "2016-07-19T14:35:00.000+0000",
"communicationStartedAt": "2016-07-19T14:31:20.000+0000",
"communicationEndedAt": "2016-07-19T14:34:30.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
},
{
"interactionReason": "SERVICE_INQUIRY",
"description": "Service-Related Inquiry"
}
],
"interactionDescription": "Customer called again to ask about shipping details for the bike. Explained that we ship using UPS.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000002",
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:30:00.000+0000",
"modifiedAt": "2016-07-19T14:35:00.000+0000"
}
},
{
"id": "5551c0ffa86e7c1f624d0003",
"customerId": "C0750876755",
"agentId": "john@hybristest.com",
"agentTitle": "Mr.",
"agentFirstName": "John",
"agentLastName": "Doe",
"interactionStartedAt": "2016-07-19T14:40:00.000+0000",
"interactionEndedAt": "2016-07-19T14:45:00.000+0000",
"communicationStartedAt": "2016-07-19T14:41:20.000+0000",
"communicationEndedAt": "2016-07-19T14:44:30.000+0000",
"interactionReasons": [
{
"interactionReason": "SERVICE_INQUIRY",
"description": "Service-Related Inquiry"
}
],
"interactionDescription": "Customer asked for a repair of her bike; created a service ticket",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "TEXT_CHAT",
"communicationMediumDescription": "Text Chat",
"communicationExcerpt": "Hello, I received my new bike but it appears the light is broken. Could you send someone to fix it...",
"communicationSystemInteractionId": "12345000003",
"mixins": {
"collectors_info": {
"CollectorsValue": {
"usd": 30.99,
"eur": 23.99
}
}
},
"relatedObjects": [
{
"objectType": "SalesOrder",
"objectId": "5551c0ffa86e7c1f624d03fb",
"objectName": "Sales order 0815"
},
{
"objectType": "SalesOrder",
"objectId": "5551c0ffa86e7c1f624d03fc",
"objectName": "Sales order 0816"
}
],
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:40:00.000+0000",
"modifiedAt": "2016-07-19T14:45:00.000+0000",
"mixins": {
"collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
}
}
}
]
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
post /{tenant}/interactionLog
Create a new interaction log item.
The id of the interaction log item is automatically generated by the system. It is returned in the field id in the response body. It is also part of the response header Location.
Required scope: hybris.interactionlog_manage
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction log item schema for use with POST",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"description": "Unique identifier of the customer"
},
"agentId": {
"type": "string",
"description": "Unique identifier of the CECenter agent"
},
"agentTitle": {
"type": "string",
"description": "Title of the agent"
},
"agentFirstName": {
"type": "string",
"description": "First name of the agent"
},
"agentLastName": {
"type": "string",
"description": "Last name of the agent"
},
"interactionStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the interaction started (in UTC)"
},
"interactionEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date an time the interaction ended (in UTC)"
},
"interactionReasons": {
"description": "Reasons for the interaction",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
},
"interactionDescription": {
"type": "string",
"description": "Free-text description of the interaction"
},
"communicationStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) started (in UTC)"
},
"communicationEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) ended (in UTC)"
},
"communicationDirection": {
"description": "Direction of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication directions",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"communicationOrigin": {
"description": "Origin of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication origins",
"enum": [
"CECENTER",
"STOREFRONT"
]
},
"communicationMedium": {
"description": "Communication medium",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication mediums",
"enum": [
"TEXT_CHAT",
"WEBRTC_VIDEO",
"SAP_COMMUNITY",
"PHONE"
]
},
"communicationExcerpt": {
"type": "string",
"description": "An excerpt of the communication (e.g. part of a text chat)"
},
"communicationSystemInteractionId": {
"type": "string",
"description": "Unique identifier of the interaction in the communication system"
},
"metadata": {
"type": "object",
"properties": {
"mixins": {
"description": "Mixins object. Keys in mixins can only be constructed from numbers, letters, hyphens and underscores.",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"description": "URI for mixin.",
"type": "string"
},
{
"description": "Inline mixin.",
"type": "object"
}
]
}
}
}
}
},
"mixins": {
"type": "object",
"description": "The collection of mixins stored in the service ticket. Each attribute is a separate mixin.",
"additionalProperties": true
},
"relatedObjects": {
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Related object schema",
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "Type of the lined object"
},
"objectId": {
"type": "string",
"description": "Unique identifier of the linked object"
},
"objectName": {
"type": "string",
"description": "Human-readable name of the linked object"
},
"rootObjectId": {
"type": "string",
"description": "Unique identifer of the linked root object; used only if the linked object is part of a hierarchy"
}
},
"required": [
"objectType",
"objectId"
]
}
}
}
}
Example:
{
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationOrigin": "STOREFRONT",
"communicationMedium": "WEBRTC_VIDEO",
"communicationSystemInteractionId": "12345000001",
"mixins": {
"collectors_info": {
"CollectorsValue": {
"usd": 30.99,
"eur": 23.99
}
}
},
"metadata": {
"mixins": {
"collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
}
}
}
HTTP status code 201
Interaction log item created successfully.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Resource Location",
"description": "Schema for showing location of the new resource.",
"properties": {
"id": {
"description": "The identifier of the created resource",
"type": "string"
},
"link": {
"description": "The link to the created resource",
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"link"
]
}
Example:
{
"id": "5551c0ffa86e7c1f624d0001",
"link": "https://api.beta.yaas.io/hybris/interactionlog/v1/myexampleshop/interactionLog/5551c0ffa86e7c1f624d0001"
}
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
/{tenant}/interactionLog/{item}
Interaction log item
get
Retrieve an interaction log item.
The interaction log item to be retrieved is identified by its id.
Required scope: hybris.interactionlog_view
put
Update an existing interaction log item.
The interaction log item to be updated is identified by its id.
Note that creating an interaction log item with a caller-specified id is not allowed. Use the POST method at the endpoint /{tenant}/interactionLog to create interaction log items and have their ids generated by the system.
Required scope: hybris.interactionlog_manage
delete
Delete an interaction log item.
The interaction log item to be deleted is identified by its id.
Required scope: hybris.interactionlog_delete
get /{tenant}/interactionLog/{item}
Retrieve an interaction log item.
The interaction log item to be retrieved is identified by its id.
Required scope: hybris.interactionlog_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
- Interaction log item: required (string)
Example:
5551c0ffa86e7c1f624d0001
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 200
Interaction log item retrieved successfully.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction log item schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the interaction log item"
},
"customerId": {
"type": "string",
"description": "Unique identifier of the customer"
},
"agentId": {
"type": "string",
"description": "Unique identifier of the CECenter agent"
},
"agentTitle": {
"type": "string",
"description": "Title of the agent"
},
"agentFirstName": {
"type": "string",
"description": "First name of the agent"
},
"agentLastName": {
"type": "string",
"description": "Last name of the agent"
},
"interactionStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the interaction started (in UTC)"
},
"interactionEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date an time the interaction ended (in UTC)"
},
"interactionReasons": {
"description": "Reasons for the interaction",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
},
"interactionDescription": {
"type": "string",
"description": "Free-text description of the interaction"
},
"communicationStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) started (in UTC)"
},
"communicationEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) ended (in UTC)"
},
"communicationDirection": {
"description": "Direction of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication directions",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"communicationDirectionDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication direction"
},
"communicationOrigin": {
"description": "Origin of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication origins",
"enum": [
"CECENTER",
"STOREFRONT"
]
},
"communicationOriginDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication origin"
},
"communicationMedium": {
"description": "Communication medium",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication mediums",
"enum": [
"TEXT_CHAT",
"WEBRTC_VIDEO",
"SAP_COMMUNITY",
"PHONE"
]
},
"communicationMediumDescription": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication medium"
},
"communicationExcerpt": {
"type": "string",
"description": "An excerpt of the communication (e.g. part of a text chat"
},
"communicationSystemInteractionId": {
"type": "string",
"description": "Unique identifier of the interaction in the communication system"
},
"relatedObjects": {
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Related object schema",
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "Type of the lined object"
},
"objectId": {
"type": "string",
"description": "Unique identifier of the linked object"
},
"objectName": {
"type": "string",
"description": "Human-readable name of the linked object"
},
"rootObjectId": {
"type": "string",
"description": "Unique identifer of the linked root object; used only if the linked object is part of a hierarchy"
}
},
"required": [
"objectType",
"objectId"
]
}
},
"metadata": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Document repository meta data schema",
"type": "object",
"properties": {
"version": {
"description": "Document repository version number",
"type": "integer"
},
"createdAt": {
"description": "Time the document was created at",
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"description": "Time the document was last modified at",
"type": "string",
"format": "date-time"
},
"mixins": {
"description": "Mixins object. Keys in mixins can only be constructed from numbers, letters, hyphens and underscores.",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"description": "URI for mixin.",
"type": "string"
},
{
"description": "Inline mixin.",
"type": "object"
}
]
}
}
}
},
"required": [
"version"
]
},
"mixins": {
"type": "object",
"description": "The collection of mixins stored in the service ticket. Each attribute is a separate mixin.",
"additionalProperties": true
}
},
"required": [
"id"
]
}
Example:
{
"id": "5551c0ffa86e7c1f624d0001",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000001",
"mixins": {
"collectors_info": {
"CollectorsValue": {
"usd": 30.99,
"eur": 23.99
}
}
},
"metadata": {
"createdAt": "2016-07-19T14:10:00.000+0000",
"modifiedAt": "2016-07-19T14:15:00.000+0000",
"version": 1,
"mixins": {
"collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
}
}
}
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 404
Interaction log item not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 404,
"type": "element_resource_non_existing",
"message": "The requested interaction log item does not exist."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
put /{tenant}/interactionLog/{item}
Update an existing interaction log item.
The interaction log item to be updated is identified by its id.
Note that creating an interaction log item with a caller-specified id is not allowed. Use the POST method at the endpoint /{tenant}/interactionLog to create interaction log items and have their ids generated by the system.
Required scope: hybris.interactionlog_manage
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
- Interaction log item: required (string)
Example:
5551c0ffa86e7c1f624d0001
Headers
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction log item schema for use with PUT",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the interaction log item"
},
"customerId": {
"type": "string",
"description": "Unique identifier of the customer"
},
"agentId": {
"type": "string",
"description": "Unique identifier of the CECenter agent"
},
"agentTitle": {
"type": "string",
"description": "Title of the agent"
},
"agentFirstName": {
"type": "string",
"description": "First name of the agent"
},
"agentLastName": {
"type": "string",
"description": "Last name of the agent"
},
"interactionStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the interaction started (in UTC)"
},
"interactionEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date an time the interaction ended (in UTC)"
},
"interactionReasons": {
"description": "Reasons for the interaction",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
},
"interactionDescription": {
"type": "string",
"description": "Free-text description of the interaction"
},
"communicationStartedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) started (in UTC)"
},
"communicationEndedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time the communication(such as text chat or phone call) ended (in UTC)"
},
"communicationDirection": {
"description": "Direction of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication directions",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"communicationOrigin": {
"description": "Origin of the communication",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication origins",
"enum": [
"CECENTER",
"STOREFRONT"
]
},
"communicationMedium": {
"description": "Communication medium",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication mediums",
"enum": [
"TEXT_CHAT",
"WEBRTC_VIDEO",
"SAP_COMMUNITY",
"PHONE"
]
},
"communicationExcerpt": {
"type": "string",
"description": "An excerpt of the communication (e.g. part of a text chat)"
},
"communicationSystemInteractionId": {
"type": "string",
"description": "Unique identifier of the interaction in the communication system"
},
"relatedObjects": {
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Related object schema",
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "Type of the lined object"
},
"objectId": {
"type": "string",
"description": "Unique identifier of the linked object"
},
"objectName": {
"type": "string",
"description": "Human-readable name of the linked object"
},
"rootObjectId": {
"type": "string",
"description": "Unique identifer of the linked root object; used only if the linked object is part of a hierarchy"
}
},
"required": [
"objectType",
"objectId"
]
}
},
"metadata": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Document repository meta data schema for use with PUT",
"type": "object",
"properties": {
"version": {
"description": "Document repository version number",
"type": "integer"
},
"mixins": {
"description": "Mixins object. Keys in mixins can only be constructed from numbers, letters, hyphens and underscores.",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]*$": {
"anyOf": [
{
"description": "URI for mixin.",
"type": "string"
},
{
"description": "Inline mixin.",
"type": "object"
}
]
}
}
}
},
"required": [
"version"
]
},
"mixins": {
"type": "object",
"description": "The collection of mixins stored in the service ticket. Each attribute is a separate mixin.",
"additionalProperties": true
}
},
"required": [
"id"
]
}
Example:
{
"id": "5551c0ffa86e7c1f624d0001",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationOrigin": "STOREFRONT",
"communicationMedium": "WEBRTC_VIDEO",
"communicationSystemInteractionId": "12345000001",
"mixins": {
"collectors_info": {
"CollectorsValue": {
"usd": 30.99,
"eur": 23.99
}
}
},
"metadata": {
"mixins": {
"collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
},
"version": 1
}
}
HTTP status code 204
Interaction log item updated successfully.
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 404
Interaction log item not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 404,
"type": "element_resource_non_existing",
"message": "The requested interaction log item does not exist."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 409
Optimistic locking failure.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 409,
"type": "conflict_resource",
"message": "Optimistic locking error: cannot find interaction log item with version 1."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
delete /{tenant}/interactionLog/{item}
Delete an interaction log item.
The interaction log item to be deleted is identified by its id.
Required scope: hybris.interactionlog_delete
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
- Interaction log item: required (string)
Example:
5551c0ffa86e7c1f624d0001
Headers
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 204
Interaction log item deleted successfully.
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 404
Interaction log item not found.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 404,
"type": "element_resource_non_existing",
"message": "The requested interaction log item does not exist."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
/{tenant}/communicationDirections
Communication directions
/{tenant}/communicationDirections
get
Retrieve the allowed values for the communication direction.
Required scope: hybris.interactionlog_configuration_view
get /{tenant}/communicationDirections
Retrieve the allowed values for the communication direction.
Required scope: hybris.interactionlog_configuration_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of communication directions with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Communication direction with technical key and descriptions",
"type": "object",
"properties": {
"communicationDirection": {
"description": "Technical key of the communication direction",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication directions",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication direction"
}
},
"required": [
"communicationDirection"
]
}
}
Example:
[
{
"communicationDirection": "INBOUND",
"description": {
"de": "Eingehend",
"en": "Inbound"
}
},
{
"communicationDirection": "OUTBOUND",
"description": {
"de": "Ausgehend",
"en": "Outbound"
}
}
]
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
/{tenant}/communicationMediums
Communication mediums
/{tenant}/communicationMediums
get
Retrieve the allowed values for the communication mediums.
Required scope: hybris.interactionlog_configuration_view
get /{tenant}/communicationMediums
Retrieve the allowed values for the communication mediums.
Required scope: hybris.interactionlog_configuration_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of communication mediums with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Communication medium with technical key and descriptions",
"type": "object",
"properties": {
"communicationMedium": {
"description": "Technical key of the communication medium",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication mediums",
"enum": [
"TEXT_CHAT",
"WEBRTC_VIDEO",
"SAP_COMMUNITY",
"PHONE"
]
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication medium"
}
},
"required": [
"communicationMedium"
]
}
}
Example:
[
{
"communicationMedium": "TEXT_CHAT",
"description": {
"de": "Text-Chat",
"en": "Text Chat"
}
},
{
"communicationMedium": "WEBRTC_VIDEO",
"description": {
"de": "WebRTC-Videogespräch",
"en": "WebRTC Video Call"
}
},
{
"communicationMedium": "SAP_COMMUNITY",
"description": {
"de": "SAP Jam Communities",
"en": "SAP Jam Communities"
}
},
{
"communicationMedium": "PHONE",
"description": {
"de": "Phone Call",
"en": "Phone Call"
}
}
]
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
/{tenant}/communicationOrigins
Communication origins
/{tenant}/communicationOrigins
get
Retrieve the allowed values for the communication origins.
Required scope: hybris.interactionlog_configuration_view
get /{tenant}/communicationOrigins
Retrieve the allowed values for the communication origins.
Required scope: hybris.interactionlog_configuration_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of communication origins with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Communication origin with technical key and descriptions",
"type": "object",
"properties": {
"communicationOrigin": {
"description": "Technical key of the communication origin",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Enumeration of supported communication origins",
"enum": [
"CECENTER",
"STOREFRONT"
]
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the communication origin"
}
},
"required": [
"communicationOrigin"
]
}
}
Example:
[
{
"communicationOrigin": "CECENTER",
"description": {
"de": "Customer Engagement Center",
"en": "Customer Engagement Center"
}
},
{
"communicationOrigin": "STOREFRONT",
"description": {
"de": "Storefront",
"en": "Storefront"
}
}
]
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
/{tenant}/interactionReasons
Interaction reason configuration
/{tenant}/interactionReasons
get
Retrieve the configured interaction reasons.
Required scope: hybris.interactionlog_configuration_view
put
Update the interaction reason configuration.
Note that the interaction reason configuration you provide in the request body will overwrite the complete existing interaction reason configuration. If you would like to update only a subset of the configured interaction reasons, use the GET method at the endpoint /{tenant}/interactionReasons to retrieve the current configuration, make the desired adjustments to the result set, and then use the PUT method at the endpoint /{tenant}/interactionReasons to update the configuration.
Required scope: hybris.interactionlog_configuration_manage
delete
Delete the interaction reason configuration.
Note that the complete interaction reason configuration will be deleted. If you would like to delete only a subset of the configured interaction reasons, use the GET method at the endpoint /{tenant}/interactionReasons to retrieve the current configuration, remove the interaction reasons you wish to delete from the result set, and then use the PUT method at the endpoint /{tenant}/interactionReasons to update the configuration.
Required scope: hybris.interactionlog_configuration_delete
get /{tenant}/interactionReasons
Retrieve the configured interaction reasons.
Required scope: hybris.interactionlog_configuration_view
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
pl
- hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
en,pl,it
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 200
Interaction reasons retrieved successfully.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
}
Example:
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description": {
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "SERVICE_INQUIRY",
"description": {
"en": "Service-Related Inquiry",
"de": "Service-bezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description": {
"it": "Allgemeine Anfrage"
}
},
{
"active": true,
"interactionReason": "QUALITY_ISSUE",
"description": {
"en": "Quality Issue",
"de": "Qualitätsproblem"
}
},
{
"active": false,
"interactionReason": "COMPLAINT",
"description": {
"en": "Complaint",
"de": "Reklamation"
}
},
{
"active": true,
"interactionReason": "PRAISE",
"description": {
"de": "test",
"pl": "Lob"
}
}
]
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
put /{tenant}/interactionReasons
Update the interaction reason configuration.
Note that the interaction reason configuration you provide in the request body will overwrite the complete existing interaction reason configuration. If you would like to update only a subset of the configured interaction reasons, use the GET method at the endpoint /{tenant}/interactionReasons to retrieve the current configuration, make the desired adjustments to the result set, and then use the PUT method at the endpoint /{tenant}/interactionReasons to update the configuration.
Required scope: hybris.interactionlog_configuration_manage
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Array of interaction reasons with technical keys and descriptions",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Interaction reason with technical key and descriptions",
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activation/deactivation flag for the interaction reason"
},
"interactionReason": {
"type": "string",
"description": "Technical key of the interaction reason",
"pattern": "^[0-9a-zA-Z_]+$"
},
"description": {
"$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
"description": "Human-readable and translatable description of the interaction reason"
}
}
}
}
Example:
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description": {
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "SERVICE_INQUIRY",
"description": {
"en": "Service-Related Inquiry",
"de": "Service-bezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description": {
"it": "Allgemeine Anfrage"
}
},
{
"active": true,
"interactionReason": "QUALITY_ISSUE",
"description": {
"en": "Quality Issue",
"de": "Qualitätsproblem"
}
},
{
"active": false,
"interactionReason": "COMPLAINT",
"description": {
"en": "Complaint",
"de": "Reklamation"
}
},
{
"active": true,
"interactionReason": "PRAISE",
"description": {
"de": "test",
"pl": "Lob"
}
}
]
HTTP status code 204
Interaction reason configuration successfully created or updated.
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}
delete /{tenant}/interactionReasons
Delete the interaction reason configuration.
Note that the complete interaction reason configuration will be deleted. If you would like to delete only a subset of the configured interaction reasons, use the GET method at the endpoint /{tenant}/interactionReasons to retrieve the current configuration, remove the interaction reasons you wish to delete from the result set, and then use the PUT method at the endpoint /{tenant}/interactionReasons to update the configuration.
Required scope: hybris.interactionlog_configuration_delete
URI Parameters
- tenant: required (string - minLength: 3 - maxLength: 16 - pattern: [a-z][a-z0-9]+)
Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.
Headers
- Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
Bearer access_token
HTTP status code 204
Interaction reason configuration deleted successfully.
HTTP status code 400
Request syntactically incorrect. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 400,
"type": "tenant_mismatch",
"message": "Tenants in request header and resource path do not match"
}
HTTP status code 401
Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 401,
"message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
"type": "insufficient_credentials",
"moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}
HTTP status code 403
Evaluated request scopes in access token are not sufficient and do not match required scopes.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 403,
"type": "insufficient_permissions",
"message": "The credentials indicate a system-known user, but the user is not allowed to perform the requested operation."
}
HTTP status code 408
Request timed out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 408,
"type": "request_timeout",
"message": "The request timed out."
}
HTTP status code 500
An internal server error occurred.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "error",
"description": "Schema for API specified errors.",
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "original HTTP error code, should be consistent with the response HTTP code",
"minimum": 100,
"maximum": 599
},
"type": {
"type": "string",
"description": "classification of the error type, lower case with underscore eg validation_failure",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support"
},
"details": {
"type": "array",
"description": "list of problems causing this error",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "errorDetail",
"description": "schema for specific error cause",
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
},
"type": {
"type": "string",
"description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
"pattern": "[a-z]+[a-z_]*[a-z]+"
},
"message": {
"type": "string",
"description": "descriptive error detail message for debugging"
},
"moreInfo": {
"type": "string",
"format": "uri",
"description": "link to documentation to investigate further and finding support for error detail"
}
},
"required": [
"type"
]
}
}
},
"required": [
"status",
"type"
]
}
Example:
{
"status": 500,
"type": "internal_server_error",
"message": "Internal server error"
}Scopes
The table shows the scopes that the Interaction Log service supports.
| SCOPE | DESCRIPTION |
|---|---|
| hybris.interactionlog_view | Read-only access to the interaction log |
| hybris.interactionlog_manage | Create and update interaction log items |
| hybris.interactionlog_delete | Delete interaction log items |
| hybris.interactionlog_configuration_view | Read-only access to interaction log configuration |
| hybris.interactionlog_configuration_manage | Create and update interaction log configuration |
| hybris.interactionlog_configuration_delete | Delete interaction log configuration |
For more information about scopes, authorization, and authentication procedures for YaaS services, see Scopes and Authorization.
Manage Interaction Log
In the Interaction Log service, an interaction log is a collection of interaction log items. Use the service to create an interaction log item that documents each interaction with a customer. Each interaction log item contains information such as the customer and the agent who interacted with each other, the date and time the interaction took place, notes the agent took about the interaction, and links to other related objects, such as service tickets and sales orders.
Create Interaction Log Item
In the Interaction Log service, an interaction reason is an optional attribute when you create an interaction log item. To create an interaction log item with an interaction reason, include the interaction reason value in the interaction reason list you create. The interaction log item is available in the interaction log collection after you create the log item. In addition, the enumerated types communication direction, communication medium, and communication origin are optional. These three types have default values. To create an interaction log item with communication direction, communication medium, and communication origin, the values for these three fields must be within the default value lists.
Update Interaction Log Item
Update an interaction log item by identifying its ID.
Retrieve Interaction Log Items
Retrieve interaction log items by query parameters such as customerId. The Interaction Log service uses the same query syntax as the Document service. If you do not specify the query, the service returns the complete interaction log, consisting of all interaction log items.
Communication Direction
The Interaction Log service uses communication direction to distinguish the originator of a communication.
Default communication directions
You can pass only one of the default values:
INBOUND: An inbound call center deals primarily with incoming calls. In such cases, it’s the customers, or potential customers, who call into the call center.OUTBOUND: Agents in an outbound call center call out to customers or potential customers.
Communication Medium
In the Interaction Log service, the communication medium is the channel by which the participants in an interaction communicate. Use the communication medium to deliver information.
Default communication mediums
You can pass only one of these default values:
TEXT_CHAT: Plain text messagesWEBRTC_VIDEO: Live video chatSAP_COMMUNITY: Messages from the SAP Jam CommunitiesPHONE: PSTN voice call
Communication Origin
Use the communication origin to indicate where messages come from.
Default communication origins
You can pass only one of these default values:
CECENTER: Messages from the Engagement CenterSTOREFRONT: Messages from the storefront
Interaction Reason
The interaction reason explains why you save the interaction log. You can customize and store the interaction reason for the interaction log items using the Configuration service.
Custom interaction reasons
Customizing the interaction reason configuration completely overwrites the existing one. To update only a subset of the configured interaction reasons, call the GET method to retrieve the current configuration, make the desired adjustments to the result set, and call the PUT method to update the configuration.
Error Messages
The service returns the error code 400 and a corresponding message in these scenarios:
- The request body is missing any of these mandatory attributes: the relatedObjects objectType, the relatedObjects objectId, and the interaction log item ID.
- The values for the communication direction, communication medium, and communication origin are not within their default value lists.
- The interaction reason is not contained in the interaction reason list.
Create an Interaction Log Item
Create a new interaction log item. The system automatically generates the ID of the interaction log item and returns it in the field id in the response body. The ID is also part of the response header Location.
Request
- Method: POST
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionLog - Headers
- Authorization: This requires a valid OAuth2 access Partial socialmediapost_token doesn't exist. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_manage.
Body:
{ "customerId": "C0750876755", "agentId": "mandy@hybristest.com", "agentTitle": "Ms.", "agentFirstName": "Mandy", "agentLastName": "Smith", "interactionStartedAt": "2016-07-19T14:10:00.000+0000", "interactionEndedAt": "2016-07-19T14:15:00.000+0000", "communicationStartedAt": "2016-07-19T14:10:20.000+0000", "communicationEndedAt": "2016-07-19T14:14:20.000+0000", "interactionReasons": [ { "interactionReason": "PRODUCT_INQUIRY" } ], "interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.", "communicationDirection": "INBOUND", "communicationOrigin": "STOREFRONT", "communicationMedium": "WEBRTC_VIDEO", "communicationSystemInteractionId": "12345000001" }
Response
A successful response returns a 201 status code. The JSON response content looks similar to the example shown.
Example
{
"id": "5551c0ffa86e7c1f624d0001",
"link": "https://api.beta.yaas.io/hybris/interactionlog/v1/myexampleshop/interactionLog/5551c0ffa86e7c1f624d0001"
}
Retrieve an Interaction Log Item by ID
Retrieve an interaction log item by item ID. If you do not specify the query, the service returns a complete interaction log consisting of all interaction log items.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionLog/{item} - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_view.
Response
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
{
"id": "5551c0ffa86e7c1f624d0001",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000001",
"metadata": {
"createdAt": "2016-07-19T14:10:00.000+0000",
"modifiedAt": "2016-07-19T14:15:00.000+0000",
"version": 1
}
}
Search for Interaction Log Items
This tutorial describes how to retrieve an interaction log. If you do not specify a query, the service returns the complete interaction log consisting of all interaction log items. To filter the interaction log items, use the query parameter q. The Interaction Log service uses the same query syntax as the Document service.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionLog Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_view.
URI Parameter
- {tenant}: The name of the current tenant
- Query Parameter
- q: You can use the query to make search results more specific using these query methods:
- If a string value does not have any special characters or spaces, you can omit the quotation marks. For example:
?q=customerId: “C0750876755”. - To search for more than one value at a time, put the string values in parentheses () and separate them with commas. For example:
?q=customerId: (“C0750876755”, “C0750876756”).
- If a string value does not have any special characters or spaces, you can omit the quotation marks. For example:
- q: You can use the query to make search results more specific using these query methods:
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
[
{
"id": "5551c0ffa86e7c1f624d0001",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:10:00.000+0000",
"interactionEndedAt": "2016-07-19T14:15:00.000+0000",
"communicationStartedAt": "2016-07-19T14:10:20.000+0000",
"communicationEndedAt": "2016-07-19T14:14:20.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
}
],
"interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000001",
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:10:00.000+0000",
"modifiedAt": "2016-07-19T14:15:00.000+0000"
}
},
{
"id": "5551c0ffa86e7c1f624d0002",
"customerId": "C0750876755",
"agentId": "mandy@hybristest.com",
"agentTitle": "Ms.",
"agentFirstName": "Mandy",
"agentLastName": "Smith",
"interactionStartedAt": "2016-07-19T14:30:00.000+0000",
"interactionEndedAt": "2016-07-19T14:35:00.000+0000",
"communicationStartedAt": "2016-07-19T14:31:20.000+0000",
"communicationEndedAt": "2016-07-19T14:34:30.000+0000",
"interactionReasons": [
{
"interactionReason": "PRODUCT_INQUIRY",
"description": "Product-Related Inquiry"
},
{
"interactionReason": "SERVICE_INQUIRY",
"description": "Service-Related Inquiry"
}
],
"interactionDescription": "Customer called again to ask about shipping details for the bike. Explained that we ship using UPS.",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "WEBRTC_VIDEO",
"communicationMediumDescription": "WebRTC Video Call",
"communicationSystemInteractionId": "12345000002",
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:30:00.000+0000",
"modifiedAt": "2016-07-19T14:35:00.000+0000"
}
},
{
"id": "5551c0ffa86e7c1f624d0003",
"customerId": "C0750876755",
"agentId": "john@hybristest.com",
"agentTitle": "Mr.",
"agentFirstName": "John",
"agentLastName": "Doe",
"interactionStartedAt": "2016-07-19T14:40:00.000+0000",
"interactionEndedAt": "2016-07-19T14:45:00.000+0000",
"communicationStartedAt": "2016-07-19T14:41:20.000+0000",
"communicationEndedAt": "2016-07-19T14:44:30.000+0000",
"interactionReasons": [
{
"interactionReason": "SERVICE_INQUIRY",
"description": "Service-Related Inquiry"
}
],
"interactionDescription": "Customer asked for a repair of her bike; created a service ticket",
"communicationDirection": "INBOUND",
"communicationDirectionDescription": "Inbound",
"communicationOrigin": "STOREFRONT",
"communicationOriginDescription": "Storefront",
"communicationMedium": "TEXT_CHAT",
"communicationMediumDescription": "Text Chat",
"communicationExcerpt": "Hello, I received my new bike but it appears the light is broken. Could you send someone to fix it...",
"communicationSystemInteractionId": "12345000003",
"relatedObjects": [
{
"objectType": "SalesOrder",
"objectId": "5551c0ffa86e7c1f624d03fb",
"objectName": "Sales order 0815"
},
{
"objectType": "SalesOrder",
"objectId": "5551c0ffa86e7c1f624d03fc",
"objectName": "Sales order 0816"
}
],
"metadata": {
"version": 1,
"createdAt": "2016-07-19T14:40:00.000+0000",
"modifiedAt": "2016-07-19T14:45:00.000+0000"
}
}
]
Update an Interaction Log Item
This tutorial describes how to update an interaction log item by log ID.
Request
- Method: PUT
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionLog/{item} - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_manage.
- Body:
{ "id": "5551c0ffa86e7c1f624d0001", "customerId": "C0750876755", "agentId": "mandy@hybristest.com", "agentTitle": "Ms.", "agentFirstName": "Mandy", "agentLastName": "Smith", "interactionStartedAt": "2016-07-19T14:10:00.000+0000", "interactionEndedAt": "2016-07-19T14:15:00.000+0000", "communicationStartedAt": "2016-07-19T14:10:20.000+0000", "communicationEndedAt": "2016-07-19T14:14:20.000+0000", "interactionReasons": [ { "interactionReason": "PRODUCT_INQUIRY" } ], "interactionDescription": "Customer called to ask about the configuration of a bike in the web shop. Assisted the customer with the configuration.", "communicationDirection": "INBOUND", "communicationOrigin": "STOREFRONT", "communicationMedium": "WEBRTC_VIDEO", "communicationSystemInteractionId": "12345000001", "metadata": { "version": 1 } }
Response
A successful response returns a 204 status code.
Delete an Interaction Log Item
This tutorial describes how to delete an interaction log item by ID.
Request
- Method: DELETE
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionLog/{item} - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_delete.
Response
A successful response returns a 204 status code.
Retrieve Default Communication Directions
This tutorial describes how to retrieve the allowable values for the communication directions.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/communicationDirections - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_view.
Response
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
[
{
"communicationDirection": "INBOUND",
"description":
{
"de": "Eingehend",
"en": "Inbound"
}
},
{
"communicationDirection": "OUTBOUND",
"description":
{
"de": "Ausgehend",
"en": "Outbound"
}
}
]
Retrieve Default Communication Mediums
This tutorial describes how to retrieve the allowable values for the communication mediums.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/communicationMediums - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_view.
Response
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
[
{
"communicationMedium": "TEXT_CHAT",
"description":
{
"de": "Text-Chat",
"en": "Text Chat"
}
},
{
"communicationMedium": "WEBRTC_VIDEO",
"description":
{
"de": "WebRTC-Videogespräch",
"en": "WebRTC Video Call"
}
},
{
"communicationMedium": "SAP_COMMUNITY",
"description":
{
"de": "SAP Jam Communities",
"en": "SAP Jam Communities"
}
},
{
"communicationMedium": "PHONE",
"description":
{
"de": "Phone Call",
"en": "Phone Call"
}
}
]
Retrieve Default Communication Origins
This tutorial describes how to retrieve the allowable values for the communication origins.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/communicationOrigins - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_view.
Response
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
[
{
"communicationOrigin": "CECENTER",
"description":
{
"de": "Customer Engagement Center",
"en": "Customer Engagement Center"
}
},
{
"communicationOrigin": "STOREFRONT",
"description":
{
"de": "Storefront",
"en": "Storefront"
}
}
]
Update Custom Interaction Reasons
This tutorial describes how to add, update, and delete interaction reasons using PUT requests. Because the interaction reason configuration in the request body completely overwrites the existing interaction reason configuration, you can create an entirely new list of reasons.
Request
- Method: PUT
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionReasons Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_manage.
Body: The examples in this tutorial show how to format the response body for different PUT requests to add, delete, and update interaction reasons.
Add an interaction reason
Add one interaction reason with the name PRODUCT_INQUIRY.
Request
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
}
]
Response
A successful response returns a 204 status code. The JSON response content looks similar to the example shown:
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
}
]
Add a second interaction reason
Add a new interaction reason with the name SERVICE_INQUIRY. After you complete this request, your service will have interaction reasons: PRODUCT_INQUIRY and SERVICE_INQUIRY.
Request
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "SERVICE_INQUIRY",
"description":
{
"en": "Service-Related Inquiry",
"de": "Service-bezogene Anfrage"
}
}
]
Response
A successful response returns a 204 status code. The JSON response content looks similar to the example shown:
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "SERVICE_INQUIRY",
"description":
{
"en": "Service-Related Inquiry",
"de": "Service-bezogene Anfrage"
}
}
]
Update an interaction reason
Update the interaction reason name from SERVICE_INQUIRY to GENERAL_INQUIRY. After you complete this request, your service will have the interaction reasons PRODUCT_INQUIRY and GENERAL_INQUIRY.
Request
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description":
{
"it": "Allgemeine Anfrage"
}
}
]
Response
A successful response returns a 204 status code. An example JSON content looks similar to the example shown:
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description":
{
"it": "Allgemeine Anfrage"
}
}
]
Delete an interaction reason and add a new one
Delete the interaction reason PRODUCT_INQUIRY, and add a new interaction reason with the name COMPLAINT. After you complete this request, your service will have the interaction reasons GENERAL_INQUIRY and COMPLAINT.
Request
[
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description":
{
"it": "Allgemeine Anfrage"
}
},
{
"active": false,
"interactionReason": "COMPLAINT",
"description":
{
"en": "Complaint",
"de": "Reklamation"
}
}
]
Response
A successful response returns a 204 status code. The JSON response content looks similar to the example shown:
[
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description":
{
"it": "Allgemeine Anfrage"
}
},
{
"active": false,
"interactionReason": "COMPLAINT",
"description":
{
"en": "Complaint",
"de": "Reklamation"
}
}
]
Retrieve all Interaction Reasons
This tutorial shows how to retrieve the configured interaction reasons using the GET method.
Request
- Method: GET
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionReasons - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_view.
Response
A successful response returns a 200 status code. The JSON response content looks similar to the example shown.
Example
[
{
"active": true,
"interactionReason": "PRODUCT_INQUIRY",
"description":
{
"en": "Product-Related Inquiry",
"de": "Produktbezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "SERVICE_INQUIRY",
"description":
{
"en": "Service-Related Inquiry",
"de": "Service-bezogene Anfrage"
}
},
{
"active": true,
"interactionReason": "GENERAL_INQUIRY",
"description":
{
"it": "Allgemeine Anfrage"
}
},
{
"active": true,
"interactionReason": "QUALITY_ISSUE",
"description":
{
"en": "Quality Issue",
"de": "Qualitätsproblem"
}
},
{
"active": false,
"interactionReason": "COMPLAINT",
"description":
{
"en": "Complaint",
"de": "Reklamation"
}
},
{
"active": true,
"interactionReason": "PRAISE",
"description":
{
"de": "test",
"pl": "Lob"
}
}
]
Clean Up all Interaction Reasons
This tutorial shows how to delete the interaction reason configuration using the DELETE method. The service completely deletes the interaction reason.
Request
- Method: DELETE
- Request URL:
https://api.beta.yaas.io/hybris/interactionlog/v1/{tenant}/interactionReasons - Headers
- Authorization: This requires a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.interactionlog_configuration_delete.
Response
A successful response returns a 204 status code.
Error Types
For more information about error codes, see the API Reference.
Glossary
| Term | Description |
|---|---|
| communication channel | A channel that customers and agents can use to communicate with one another. |
| customer interaction | The complete exchange of information between the customer and agent from the beginning to the end of the contact. This includes all activities, such as communicating with the business partner, creating business transactions, and any follow-up activities. |
| interaction history | The collection of interactions with a specific customer. For example, the interaction history contains the interaction logs. Agents can navigate from the interaction logs to the relevant business transactions. |
| interaction log | The record of a customer interaction containing information, such as notes, tags, and business transactions. |
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Use our private help channel. Receive updates over email and contact our specialists directly.
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.