Service Ticket

Overview

Service tickets enable you to track customer issues and work on those issues through to resolution.

You can configure service ticket types for different types of service you provide, such as requests for repairs, request for servicing, and general inquiries.

When you create a service ticket, you can specify the relevant information, for example:

A short description of the customer's issue or request
The customer the service ticket was opened for
The product, the reported request or issue is related to
A configurable classification that allows you to further differentiate different classes of service tickets
A priority and desired due date

When working on the resolution of a service ticket you can use features such as:

Built-in status management
A transcript concept that allows processors of the tickets to enter additional information about the processing status
Automatic calculation of processing times

Note that it is recommended to use the Service Ticket Mashup service for developing applications on top of service tickets. The Service Ticket Mashup service provides additional capabilities such as consistency checks for customer and product master data when creating or updating service tickets and reading additional customer and product attributes when retrieving service tickets.

API Reference

/{tenant}/serviceTickets

Service tickets

/{tenant}/serviceTickets

get

Retrieve a collection of service tickets.

If no query is specified, all service tickets are returned in the result collection. To filter the result collection, use the query parameter q. The service ticket service uses the same query syntax as the Document service.

You can sort the result collection 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 result collection:

Type description (typeDescription)
Classification description (classification.description)
Priority description (priorityDescription)
Status description (statusDescription)

If you would like to query or sort by those attributes, use the following persisted attributes instead:

Type (type)
Classification (classification)
Priority (priority)
Status (status)

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 service tickets per page. The maximum pageSize supported is 64.

Required scope: hybris.serviceticket_view

post

Create a new service ticket.

The id of the service ticket 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.

Upon successful creation of the service ticket, the PubSub event serviceticket-created is raised.

Required scope: hybris.serviceticket_manage

Retrieve a collection of service tickets.

You can sort the result collection 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 result collection:

Type description (typeDescription)
Classification description (classification.description)
Priority description (priorityDescription)
Status description (statusDescription)

If you would like to query or sort by those attributes, use the following persisted attributes instead:

Type (type)
Classification (classification)
Priority (priority)
Status (status)

Required scope: hybris.serviceticket_view

Request
Response

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.
Example:
```
myexampleshop
```

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

Service tickets 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": "Service tickets schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket schema",
        "type": "object",
        "properties": {
            "id": {
                "type": "string",
                "description": "Unique identifier of the service ticket"
            },
            "ticketNumber": {
                "type": "string",
                "description": "Human-readable service ticket number"
            },
            "type": {
                "type": "string",
                "description": "Service ticket type"
            },
            "typeDescription": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the ticket type"
            },
            "classification": {
                "description": "Classification",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket classifications schema",
                "type": "array",
                "items": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Service ticket classification schema",
                    "type": "object",
                    "properties": {
                        "active": {
                            "type": "boolean",
                            "description": "Activation/deactivation flag for the ticket classfication"
                        },
                        "classification": {
                            "type": "string",
                            "description": "Technical key of the service ticket classification"
                        },
                        "description": {
                            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                            "description": "Human-readable and translatable description of the service ticket classification"
                        }
                    },
                    "required": [
                        "classification"
                    ]
                }
            },
            "priority": {
                "description": "Service ticket priority",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Enumeration of supported service ticket priorities",
                "enum": [
                    "VERY_HIGH",
                    "HIGH",
                    "MEDIUM",
                    "LOW"
                ]
            },
            "priorityDescription": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the priority"
            },
            "status": {
                "description": "Service ticket status",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Enumeration of supported service ticket statuses",
                "enum": [
                    "OPEN",
                    "IN_PROCESS",
                    "COMPLETED",
                    "CONFIRMED"
                ]
            },
            "statusDescription": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the status"
            },
            "cctrTaskStatus": {
                "description": "Service ticket cctr task send status",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Enumeration of supported service ticket send cctr task statuses",
                "enum": [
                    "TO_BE_SENT",
                    "SENT_SUCCEED",
                    "SENT_FAILED"
                ]
            },
            "dueAt": {
                "type": "string",
                "format": "date-time",
                "description": "Date and the time the ticket is due (in UTC)"
            },
            "closedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Date and the time the ticket was closed (in UTC)"
            },
            "processingTime": {
                "type": "integer",
                "description": "Calculated processing time of the ticket in seconds"
            },
            "customerId": {
                "type": "string",
                "description": "Id of the customer the service ticket was opened for"
            },
            "productId": {
                "type": "string",
                "description": "Id of the product the ticket was opened for"
            },
            "shortDescription": {
                "type": "string",
                "description": "Short description of the ticket"
            },
            "assignedTo": {
                "type": "string",
                "description": "Id of the user working on the service ticket"
            },
            "transcript": {
                "type": "array",
                "items": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "title": "Service ticket transcript item schema",
                    "type": "object",
                    "properties": {
                        "createdBy": {
                            "type": "string",
                            "description": "User who created this transcript entry"
                        },
                        "createdAt": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Date and time the transscript item was created (in UTC)"
                        },
                        "description": {
                            "type": "string",
                            "description": "Description"
                        }
                    }
                },
                "description": "Transcript"
            },
            "createdBy": {
                "type": "User who created the ticket"
            },
            "modifiedBy": {
                "type": "User who last modified the ticket"
            },
            "metadata": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Document repository meta data schema",
                "type": "object",
                "additionalProperties": {
                    "anyOf": [
                        {
                            "description": "Properties of service ticket you want to store."
                        }
                    ]
                },
                "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",
            "type",
            "priority",
            "status",
            "customerId",
            "metadata"
        ]
    }
}

Example:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "typeDescription": "Service Request",
    "classification": [
        {
            "classification": "BASIC_TECHNICAL_SKILLS",
            "description": "Basic technical skills required"
        }
    ],
    "mixins": {
        "collectors_info": {
            "CollectorsValue": {
                "usd": 30.99,
                "eur": 23.99
            }
        }
    },
    "priority": "HIGH",
    "priorityDescription": "High",
    "status": "IN_PROCESS",
    "statusDescription": "In Process",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "processingTime": 432000,
    "customerId": "C0750876755",
    "productId": "54e60e07d26ec374ee8e769f",
    "shortDescription": "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript": [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata": {
        "createdAt": "2015-06-19T12:28:07.000+0000",
        "modifiedAt": "2015-06-19T12:28:07.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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Create a new service ticket.

The id of the service ticket 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.

Upon successful creation of the service ticket, the PubSub event serviceticket-created is raised.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```

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": "Service ticket schema for use with POST",
    "type": "object",
    "additionalProperties": {
        "anyOf": [
            {
                "description": "Properties of service ticket you want to store."
            }
        ]
    },
    "properties": {
        "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
        },
        "ticketNumber": {
            "type": "string",
            "description": "Human-readable service ticket number"
        },
        "type": {
            "type": "string",
            "description": "Service ticket type"
        },
        "id": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-id.json"
        },
        "priority": {
            "description": "Service ticket priority",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket priorities",
            "enum": [
                "VERY_HIGH",
                "HIGH",
                "MEDIUM",
                "LOW"
            ]
        },
        "classification": {
            "description": "Classification",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Service ticket classifications schema",
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket classification schema",
                "type": "object",
                "properties": {
                    "active": {
                        "type": "boolean",
                        "description": "Activation/deactivation flag for the ticket classfication"
                    },
                    "classification": {
                        "type": "string",
                        "description": "Technical key of the service ticket classification"
                    },
                    "description": {
                        "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                        "description": "Human-readable and translatable description of the service ticket classification"
                    }
                },
                "required": [
                    "classification"
                ]
            }
        },
        "status": {
            "description": "Service ticket status",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket statuses",
            "enum": [
                "OPEN",
                "IN_PROCESS",
                "COMPLETED",
                "CONFIRMED"
            ]
        },
        "dueAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and the time the ticket is due (in UTC)"
        },
        "customerId": {
            "type": "string",
            "description": "Id of the customer the service ticket was opened for"
        },
        "productId": {
            "type": "string",
            "description": "Id of the product the ticket was opened for"
        },
        "shortDescription": {
            "type": "string",
            "description": "Short description of the ticket"
        },
        "assignedTo": {
            "type": "string",
            "description": "Id of the user working on the service ticket"
        },
        "transcript": {
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket transcript item schema",
                "type": "object",
                "properties": {
                    "createdBy": {
                        "type": "string",
                        "description": "User who created this transcript entry"
                    },
                    "createdAt": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Date and time the transscript item was created (in UTC)"
                    },
                    "description": {
                        "type": "string",
                        "description": "Description"
                    }
                }
            },
            "description": "Transcript"
        },
        "createdBy": {
            "type": "User who created the ticket"
        },
        "modifiedBy": {
            "type": "User who last modified the ticket"
        }
    },
    "required": [
        "type",
        "priority",
        "status",
        "customerId"
    ]
}

Example:

{
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "priority": "HIGH",
    "classification": [
        {
            "classification": "BASIC_TECHNICAL_SKILLS"
        }
    ],
    "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"
        }
    },
    "status": "IN_PROCESS",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "customerId": "C0750876755",
    "productId": "54e60e07d26ec374ee8e769f",
    "shortDescription": "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript": [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com"
}

HTTP status code 201

Service ticket 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": "55473b487deefe21340ae74f",
    "link": "https://api.beta.yaas.io/hybris/serviceticket/v1/myexampleshop/serviceTickets/55473b487deefe21340ae74f"
}

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTickets/{id}

Service ticket

get

Retrieve a service ticket.

The service ticket to be retrieved is identified by its id.

Required scope: hybris.serviceticket_view

put

Update a service ticket.

The service ticket to be updated is identified by its id.

Note that creating a service ticket with a caller-specified id is not allowed. Use the POST method at the endpoint /{tenant}/serviceTickets to create service tickets and have their ids generated by the system.

Upon successful update of the service ticket, the PubSub event serviceticket-updated is raised.

Required scope: hybris.serviceticket_manage

delete

Delete a service ticket.

The service ticket to be deleted is identified by its id.

Upon successful deletion of the service ticket, the PubSub event serviceticket-deleted is raised.

Required scope: hybris.serviceticket_delete

Retrieve a service ticket.

The service ticket to be retrieved is identified by its id.

Required scope: hybris.serviceticket_view

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

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

Service ticket retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Service ticket schema",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the service ticket"
        },
        "ticketNumber": {
            "type": "string",
            "description": "Human-readable service ticket number"
        },
        "type": {
            "type": "string",
            "description": "Service ticket type"
        },
        "typeDescription": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
            "description": "Human-readable and translatable description of the ticket type"
        },
        "classification": {
            "description": "Classification",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Service ticket classifications schema",
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket classification schema",
                "type": "object",
                "properties": {
                    "active": {
                        "type": "boolean",
                        "description": "Activation/deactivation flag for the ticket classfication"
                    },
                    "classification": {
                        "type": "string",
                        "description": "Technical key of the service ticket classification"
                    },
                    "description": {
                        "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                        "description": "Human-readable and translatable description of the service ticket classification"
                    }
                },
                "required": [
                    "classification"
                ]
            }
        },
        "priority": {
            "description": "Service ticket priority",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket priorities",
            "enum": [
                "VERY_HIGH",
                "HIGH",
                "MEDIUM",
                "LOW"
            ]
        },
        "priorityDescription": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
            "description": "Human-readable and translatable description of the priority"
        },
        "status": {
            "description": "Service ticket status",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket statuses",
            "enum": [
                "OPEN",
                "IN_PROCESS",
                "COMPLETED",
                "CONFIRMED"
            ]
        },
        "statusDescription": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
            "description": "Human-readable and translatable description of the status"
        },
        "cctrTaskStatus": {
            "description": "Service ticket cctr task send status",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket send cctr task statuses",
            "enum": [
                "TO_BE_SENT",
                "SENT_SUCCEED",
                "SENT_FAILED"
            ]
        },
        "dueAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and the time the ticket is due (in UTC)"
        },
        "closedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and the time the ticket was closed (in UTC)"
        },
        "processingTime": {
            "type": "integer",
            "description": "Calculated processing time of the ticket in seconds"
        },
        "customerId": {
            "type": "string",
            "description": "Id of the customer the service ticket was opened for"
        },
        "productId": {
            "type": "string",
            "description": "Id of the product the ticket was opened for"
        },
        "shortDescription": {
            "type": "string",
            "description": "Short description of the ticket"
        },
        "assignedTo": {
            "type": "string",
            "description": "Id of the user working on the service ticket"
        },
        "transcript": {
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket transcript item schema",
                "type": "object",
                "properties": {
                    "createdBy": {
                        "type": "string",
                        "description": "User who created this transcript entry"
                    },
                    "createdAt": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Date and time the transscript item was created (in UTC)"
                    },
                    "description": {
                        "type": "string",
                        "description": "Description"
                    }
                }
            },
            "description": "Transcript"
        },
        "createdBy": {
            "type": "User who created the ticket"
        },
        "modifiedBy": {
            "type": "User who last modified the ticket"
        },
        "metadata": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Document repository meta data schema",
            "type": "object",
            "additionalProperties": {
                "anyOf": [
                    {
                        "description": "Properties of service ticket you want to store."
                    }
                ]
            },
            "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",
        "type",
        "priority",
        "status",
        "customerId",
        "metadata"
    ]
}

Example:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "typeDescription": "Service Request",
    "classification": [
        {
            "classification": "BASIC_TECHNICAL_SKILLS",
            "description": "Basic technical skills required"
        }
    ],
    "mixins": {
        "collectors_info": {
            "CollectorsValue": {
                "usd": 30.99,
                "eur": 23.99
            }
        }
    },
    "priority": "HIGH",
    "priorityDescription": "High",
    "status": "IN_PROCESS",
    "statusDescription": "In Process",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "processingTime": 432000,
    "customerId": "C0750876755",
    "productId": "54e60e07d26ec374ee8e769f",
    "shortDescription": "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript": [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata": {
        "createdAt": "2015-06-19T12:28:07.000+0000",
        "modifiedAt": "2015-06-19T12:28:07.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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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

Service ticket 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 service ticket 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_service_error",
    "message": "An internal server error occurred."
}

Update a service ticket.

The service ticket to be updated is identified by its id.

Upon successful update of the service ticket, the PubSub event serviceticket-updated is raised.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

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": "Service ticket schema for use with PUT",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of the service ticket"
        },
        "ticketNumber": {
            "type": "string",
            "description": "Human-readable service ticket number"
        },
        "type": {
            "type": "string",
            "description": "Service ticket type"
        },
        "classification": {
            "description": "Classification",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Service ticket classifications schema",
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket classification schema",
                "type": "object",
                "properties": {
                    "active": {
                        "type": "boolean",
                        "description": "Activation/deactivation flag for the ticket classfication"
                    },
                    "classification": {
                        "type": "string",
                        "description": "Technical key of the service ticket classification"
                    },
                    "description": {
                        "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                        "description": "Human-readable and translatable description of the service ticket classification"
                    }
                },
                "required": [
                    "classification"
                ]
            }
        },
        "priority": {
            "description": "Service ticket priority",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket priorities",
            "enum": [
                "VERY_HIGH",
                "HIGH",
                "MEDIUM",
                "LOW"
            ]
        },
        "status": {
            "description": "Service ticket status",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket statuses",
            "enum": [
                "OPEN",
                "IN_PROCESS",
                "COMPLETED",
                "CONFIRMED"
            ]
        },
        "cctrTaskStatus": {
            "description": "Service ticket cctr task send status",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Enumeration of supported service ticket send cctr task statuses",
            "enum": [
                "TO_BE_SENT",
                "SENT_SUCCEED",
                "SENT_FAILED"
            ]
        },
        "dueAt": {
            "type": "string",
            "format": "date-time",
            "description": "Date and the time the ticket is due (in UTC)"
        },
        "customerId": {
            "type": "string",
            "description": "Id of the customer the service ticket was opened for"
        },
        "productId": {
            "type": "string",
            "description": "Id of the product the ticket was opened for"
        },
        "shortDescription": {
            "type": "string",
            "description": "Short description of the ticket"
        },
        "assignedTo": {
            "type": "string",
            "description": "Id of the user working on the service ticket"
        },
        "transcript": {
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Service ticket transcript item schema",
                "type": "object",
                "properties": {
                    "createdBy": {
                        "type": "string",
                        "description": "User who created this transcript entry"
                    },
                    "createdAt": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Date and time the transscript item was created (in UTC)"
                    },
                    "description": {
                        "type": "string",
                        "description": "Description"
                    }
                }
            },
            "description": "Transcript"
        },
        "createdBy": {
            "type": "User who created the ticket"
        },
        "modifiedBy": {
            "type": "User who last modified the ticket"
        },
        "metadata": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Document repository meta data schema for use with PUT",
            "type": "object",
            "additionalProperties": {
                "anyOf": [
                    {
                        "description": "Properties of service ticket you want to store."
                    }
                ]
            },
            "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",
        "type",
        "priority",
        "status",
        "customerId",
        "metadata"
    ]
}

Example:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "classification": [
        {
            "classification": "BASIC_TECHNICAL_SKILLS"
        }
    ],
    "mixins": {
        "collectors_info": {
            "CollectorsValue": {
                "usd": 51.22,
                "eur": 23.44
            }
        }
    },
    "priority": "HIGH",
    "status": "IN_PROCESS",
    "customerId": "C0750876755",
    "productId": "54e60e07d26ec374ee8e769f",
    "shortDescription": "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript": [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata": {
        "version": 1,
        "mixins": {
            "collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
        }
    }
}

HTTP status code 204

Service ticket 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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

Service ticket 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 service ticket 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 service ticket 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_service_error",
    "message": "An internal server error occurred."
}

Delete a service ticket.

The service ticket to be deleted is identified by its id.

Upon successful deletion of the service ticket, the PubSub event serviceticket-deleted is raised.

Required scope: hybris.serviceticket_delete

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

Service ticket 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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

Service ticket 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 service ticket 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTickets/{id}/attachments

Service ticket attachments

get

Retrieve attachments information for a given service ticket.

You can use the following fields for defining query criteria via query parameter q.

name
size
createdBy
createdAt
modifiedBy
modifiedAt

Required scope: hybris.serviceticket_view

post

Upload an attachment for a given service ticket.

Required scope: hybris.serviceticket_manage

delete

Delete all attachments for a given service ticket.

Required scope: hybris.serviceticket_manage

Retrieve attachments information for a given service ticket.

You can use the following fields for defining query criteria via query parameter q.

name
size
createdBy
createdAt
modifiedBy
modifiedAt

Required scope: hybris.serviceticket_view

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Query Parameters

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

Attachments information 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#",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "id": {
                "type": "string"
            },
            "metadata": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "The name of attachment"
                    },
                    "size": {
                        "type": "string",
                        "description": "The total bytes of attachment"
                    },
                    "createdBy": {
                        "type": "string"
                    },
                    "createdAt": {
                        "description": "Time the attachment was uploaded at",
                        "type": "string"
                    },
                    "modifiedBy": {
                        "type": "string"
                    },
                    "modifiedAt": {
                        "description": "Time the attachment metadata was update at",
                        "type": "string"
                    }
                },
                "required": [
                    "name"
                ]
            }
        },
        "required": [
            "id",
            "metadata"
        ]
    }
}

Example:

[
    {
        "id": "5367728b18aef6ef24a04e38",
        "metadata": {
            "name": "attachment1.jpg",
            "size": "1024000",
            "createdBy": "mandy@hybristest.com",
            "createdAt": "1459335611324",
            "modifiedBy": "mandy@hybristest.com",
            "modifiedAt": "1459335611324"
        }
    },
    {
        "id": "5367728b18aef6ef24a04e39",
        "metadata": {
            "name": "attachment1.zip",
            "size": "1024000",
            "createdBy": "mandy@hybristest.com",
            "createdAt": "1459335611324",
            "modifiedBy": "mandy@hybristest.com",
            "modifiedAt": "1459335611324"
        }
    }
]

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Upload an attachment for a given service ticket.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: multipart/form-data

Form Parameters

uploadCollection: required (file)
The attachment file

HTTP status code 201

Attachment uploaded 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": "57173ab02e9465001db61956",
    "link": "https://api.beta.yaas.io/hybris/serviceticket/v1/myexampleshop/serviceTickets/565cb63d9aae8a28f217a8b7/attachments/57173ab02e9465001db61956"
}

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Delete all attachments for a given service ticket.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

All attachments for the specified service ticket 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTickets/{id}/attachments/{fileId}

Manage service ticket attachments

get

Retrieve the download link for a given attachment.

Required scope: hybris.serviceticket_view

put

Update the metadata for a given attachment.

Required scope: hybris.serviceticket_manage

delete

Delete an attachment.

Required scope: hybris.serviceticket_manage

Retrieve the download link for a given attachment.

Required scope: hybris.serviceticket_view

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```
fileId: required (string)
The attachment file id.
Example:
```
5367728b18aef6ef24a04e38
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 200

Download link retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "link": {
            "type": "string",
            "description": "Real download link of attachment"
        }
    },
    "required": [
        "link"
    ]
}

Example:

{
    "link": "https://s3.amazonaws.com/bucket/7367728b18aef6ef24a04e39?x-amz-security-token=AQoDYXdz..."
}

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Update the metadata for a given attachment.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```
fileId: required (string)
The attachment file id.
Example:
```
5367728b18aef6ef24a04e38
```

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#",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The name of attachment"
        }
    },
    "required": [
        "name"
    ]
}

Example:

{
    "name": "attachment.jpg"
}

HTTP status code 204

Attachment metadata 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Delete an attachment.

Required scope: hybris.serviceticket_manage

Request
Response

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.
Example:
```
myexampleshop
```
id: required (string)
Service ticket id.
Example:
```
55473b487deefe21340ae74f
```
fileId: required (string)
The attachment file id.
Example:
```
5367728b18aef6ef24a04e38
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

Attachment 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTicketPriorities

Service ticket priorities

/{tenant}/serviceTicketPriorities

get

Retrieve the allowed values for the service ticket priority.

Required scope: hybris.serviceticket_configuration_view

Retrieve the allowed values for the service ticket priority.

Required scope: hybris.serviceticket_configuration_view

Request
Response

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.
Example:
```
myexampleshop
```

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

Service ticket priorities retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Service ticket priorities schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket priority schema",
        "type": "object",
        "properties": {
            "priority": {
                "description": "Technical key of the priority",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Enumeration of supported service ticket priorities",
                "enum": [
                    "VERY_HIGH",
                    "HIGH",
                    "MEDIUM",
                    "LOW"
                ]
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the priority"
            }
        },
        "required": [
            "priority"
        ]
    }
}

Example:

[
    {
        "priority": "VERY_HIGH",
        "description": {
            "en": "Very high",
            "de": "Sehr hoch"
        }
    },
    {
        "priority": "HIGH",
        "description": {
            "en": "High",
            "de": "Hoch"
        }
    },
    {
        "priority": "MEDIUM",
        "description": {
            "en": "Medium",
            "de": "Mittel"
        }
    },
    {
        "priority": "LOW",
        "description": {
            "en": "Low",
            "de": "Niedrig"
        }
    }
]

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTicketStatuses

Service ticket statuses

/{tenant}/serviceTicketStatuses

get

Retrieve the allowed values for the service ticket status.

Required scope: hybris.serviceticket_configuration_view

Retrieve the allowed values for the service ticket status.

Required scope: hybris.serviceticket_configuration_view

Request
Response

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.
Example:
```
myexampleshop
```

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

Service ticket statuses retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Service ticket statuses schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket status schema",
        "type": "object",
        "properties": {
            "status": {
                "description": "Technical key of the status",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Enumeration of supported service ticket statuses",
                "enum": [
                    "OPEN",
                    "IN_PROCESS",
                    "COMPLETED",
                    "CONFIRMED"
                ]
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the status"
            }
        },
        "required": [
            "status"
        ]
    }
}

Example:

[
    {
        "status": "OPEN",
        "description": {
            "en": "Open",
            "de": "Offen"
        }
    },
    {
        "status": "IN_PROCESS",
        "description": {
            "en": "In Process",
            "de": "In Bearbeitung"
        }
    },
    {
        "status": "COMPLETED",
        "description": {
            "en": "Completed",
            "de": "Abgeschlossen"
        }
    },
    {
        "status": "CONFIRMED",
        "description": {
            "en": "Confirmed",
            "de": "Bestätigt"
        }
    }
]

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTicketTypes

Service ticket type configuration

/{tenant}/serviceTicketTypes

get

Retrieve the configured service ticket types.

Required scope: hybris.serviceticket_configuration_view

put

Update the service ticket type configuration.

Note that the service ticket type configuration you provide in the request body will overwrite the complete existing service ticket type configuration. If you would like to update only a subset of the configured service ticket types, use the GET method at the endpoint /{tenant}/serviceTicketTypes to retrieve the current configuration, make the desired adjustments to the result set, and use the PUT method at the endpoint /{tenant}/serviceTicketTypes to update the configuration.

Required scope: hybris.serviceticket_configuration_manage

delete

Delete the service ticket type configuration.

Note that the complete service ticket type configuration will be deleted. If you would like to delete only a subset of the configured service ticket types, use the GET method at the endpoint /{tenant}/serviceTicketTypes to retrieve the current configuration, remove the service ticket types you wish to delete from the result set, and then use the PUT method at the endpoint /{tenant}/serviceTicketTypes to update the configuration.

Required scope: hybris.serviceticket_configuration_delete

Retrieve the configured service ticket types.

Required scope: hybris.serviceticket_configuration_view

Request
Response

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.
Example:
```
myexampleshop
```

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

Service ticket types retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Service ticket types schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket type schema",
        "type": "object",
        "properties": {
            "active": {
                "type": "boolean",
                "description": "Activation/deactivation flag for the ticket type"
            },
            "type": {
                "type": "string",
                "description": "Technical key of the service ticket type"
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the service ticket type"
            }
        },
        "required": [
            "type"
        ]
    }
}

Example:

[
    {
        "active": true,
        "type": "GENERAL_INQUIRY",
        "description": {
            "en": "General Inquiry",
            "de": "Allgemeine Anfrage"
        }
    },
    {
        "active": false,
        "type": "REPAIR",
        "description": {
            "en": "Repair",
            "de": "Reparatur"
        }
    },
    {
        "active": true,
        "type": "SERVICE_REQUEST",
        "description": {
            "en": "Service Request",
            "de": "Serviceanfrage"
        }
    }
]

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Update the service ticket type configuration.

Required scope: hybris.serviceticket_configuration_manage

Request
Response

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.
Example:
```
myexampleshop
```

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": "Service ticket types schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket type schema",
        "type": "object",
        "properties": {
            "active": {
                "type": "boolean",
                "description": "Activation/deactivation flag for the ticket type"
            },
            "type": {
                "type": "string",
                "description": "Technical key of the service ticket type"
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the service ticket type"
            }
        },
        "required": [
            "type"
        ]
    }
}

Example:

[
    {
        "active": true,
        "type": "GENERAL_INQUIRY",
        "description": {
            "en": "General Inquiry",
            "de": "Allgemeine Anfrage"
        }
    },
    {
        "active": false,
        "type": "REPAIR",
        "description": {
            "en": "Repair",
            "de": "Reparatur"
        }
    },
    {
        "active": true,
        "type": "SERVICE_REQUEST",
        "description": {
            "en": "Service Request",
            "de": "Serviceanfrage"
        }
    }
]

HTTP status code 204

Service ticket type 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Delete the service ticket type configuration.

Required scope: hybris.serviceticket_configuration_delete

Request
Response

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.
Example:
```
myexampleshop
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

Service ticket type 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTicketClassifications

Service ticket classification configuration

/{tenant}/serviceTicketClassifications

get

Retrieve the configured service ticket classifications.

Required scope: hybris.serviceticket_configuration_view

put

Update the service ticket classification configuration.

Note that the service ticket classification configuration you provide in the request body will overwrite the complete existing service ticket classification configuration. If you would like to update only a subset of the configured service ticket classifications, use the GET method at the endpoint /{tenant}/serviceTicketClassifications to retrieve the current configuration, make the desired adjustments to the result set, and then use the PUT method at the endpoint /{tenant}/serviceTicketClassifications to update the configuration.

Required scope: hybris.serviceticket_configuration_manage

delete

Delete the service ticket classification configuration.

Note that the complete service ticket classification configuration will be deleted. If you would like to delete only a subset of the configured service ticket classifications, use the GET method at the endpoint /{tenant}/serviceTicketClassifications to retrieve the current configuration, remove the service ticket classifications you wish to delete from the result set, and then use the PUT method on the endpoint /{tenant}/serviceTicketClassifications to update the configuration.

Required scope: hybris.serviceticket_configuration_delete

Retrieve the configured service ticket classifications.

Required scope: hybris.serviceticket_configuration_view

Request
Response

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.
Example:
```
myexampleshop
```

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

Service ticket classifications retrieved successfully.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Service ticket classifications schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket classification schema",
        "type": "object",
        "properties": {
            "active": {
                "type": "boolean",
                "description": "Activation/deactivation flag for the ticket classfication"
            },
            "classification": {
                "type": "string",
                "description": "Technical key of the service ticket classification"
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the service ticket classification"
            }
        },
        "required": [
            "classification"
        ]
    }
}

Example:

[
    {
        "active": false,
        "classification": "BASIC_CONSULTING_SKILLS",
        "description": {
            "en": "Basic consulting skills required",
            "de": "Consulting-Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "BASIC_TECHNICAL_SKILLS",
        "description": {
            "en": "Basic technical skills required",
            "de": "Technische Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "ADVANCED_TECHNICAL_SKILLS",
        "description": {
            "en": "Advanced technical skills required",
            "de": "Fortgeschrittene technische Kenntnisse erforderlich"
        }
    }
]

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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Update the service ticket classification configuration.

Required scope: hybris.serviceticket_configuration_manage

Request
Response

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.
Example:
```
myexampleshop
```

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": "Service ticket classifications schema",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Service ticket classification schema",
        "type": "object",
        "properties": {
            "active": {
                "type": "boolean",
                "description": "Activation/deactivation flag for the ticket classfication"
            },
            "classification": {
                "type": "string",
                "description": "Technical key of the service ticket classification"
            },
            "description": {
                "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json",
                "description": "Human-readable and translatable description of the service ticket classification"
            }
        },
        "required": [
            "classification"
        ]
    }
}

Example:

[
    {
        "active": false,
        "classification": "BASIC_CONSULTING_SKILLS",
        "description": {
            "en": "Basic consulting skills required",
            "de": "Consulting-Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "BASIC_TECHNICAL_SKILLS",
        "description": {
            "en": "Basic technical skills required",
            "de": "Technische Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "ADVANCED_TECHNICAL_SKILLS",
        "description": {
            "en": "Advanced technical skills required",
            "de": "Fortgeschrittene technische Kenntnisse erforderlich"
        }
    }
]

HTTP status code 204

Service ticket classification 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

Delete the service ticket classification configuration.

Required scope: hybris.serviceticket_configuration_delete

Request
Response

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.
Example:
```
myexampleshop
```

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

Service ticket classification 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": "validation_violation",
    "message": "The tenants passed in the request header hybris-tenant and in the resource path do not match.",
    "details": [
        {
            "type": "tenant_mismatch",
            "message": "The tenants passed in the request header hybris-tenant and in the 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_service_error",
    "message": "An internal server error occurred."
}

/{tenant}/serviceTickets
/{tenant}/serviceTicketPriorities
/{tenant}/serviceTicketStatuses
/{tenant}/serviceTicketTypes
/{tenant}/serviceTicketClassifications

Events

For more information about events, see the PubSub service documentation.

The topic owner client is: hybris.serviceticket

Event Type	Description	Payload	Example
hybris.serviceticket.serviceticket-created	Service Ticket created	schema	json { "payload" : { "assignedTo" : "mandy@hybristest.com", "classification" : [ { "classification" : "BASIC_TECHNICAL_SKILLS", "description" : { "de" : "Technische Grundkenntnisse erforderlich", "en" : "Basic technical skills required" } } ], "createdBy" : "mandy@hybristest.com", "customerId" : "C0750876755", "dueAt" : "2015-06-30T23:59:59.999+0000", "id" : "580750d939fa36001d6e44c6", "metadata" : { "createdAt" : "2016-10-19T10:54:17.602+0000", "modifiedAt" : "2016-10-19T10:54:17.602+0000", "version" : 1 }, "modifiedBy" : "mandy@hybristest.com", "priority" : "HIGH", "priorityDescription" : { "de" : "Hoch", "en" : "High" }, "processingTime" : 2, "productId" : "54e60e07d26ec374ee8e769f", "shortDescription" : "Request for regular maintenance", "status" : "IN_PROCESS", "statusDescription" : { "de" : "In Bearbeitung", "en" : "In Process" }, "ticketNumber" : "J6BAQC", "type" : "SERVICE_REQUEST", "typeDescription" : { "de" : "Serviceanfrage", "en" : "Service Request" }}}
hybris.serviceticket.serviceticket-updated	Service Ticket updated	schema	json{ "payload" : { "assignedTo" : "mandy@hybristest.com", "classification" : [ { "classification" : "BASIC_TECHNICAL_SKILLS", "description" : { "de" : "Technische Grundkenntnisse erforderlich", "en" : "Basic technical skills required" } } ], "createdBy" : "mandy@hybristest.com", "customerId" : "C0750876755", "dueAt" : "2015-06-30T23:59:59.999+0000", "id" : "580750d939fa36001d6e44c6", "metadata" : { "createdAt" : "2016-10-19T10:54:17.602+0000", "modifiedAt" : "2016-10-19T11:00:21.099+0000", "version" : 2 }, "modifiedBy" : "mandy@hybristest.com", "priority" : "HIGH", "priorityDescription" : { "de" : "Hoch", "en" : "High" }, "processingTime" : 365, "productId" : "54e60e07d26ec374ee8e769f", "shortDescription" : "Request for regular maintenance", "status" : "IN_PROCESS", "statusDescription" : { "de" : "In Bearbeitung", "en" : "In Process" }, "ticketNumber" : "J6BAQC", "type" : "SERVICE_REQUEST", "typeDescription" : { "de" : "Serviceanfrage", "en" : "Service Request" }}}
hybris.serviceticket.serviceticket-deleted	Service Ticket deleted	schema	`json{ "payload" : { "id" : "580750d939fa36001d6e44c6"}}`

Scopes

The table shows the scopes that the Service Ticket service supports.

SCOPE	DESCRIPTION
hybris.serviceticket_view	Read-only access to service tickets.
hybris.serviceticket_manage	Create and update service tickets.
hybris.serviceticket_delete	Delete service tickets.
hybris.serviceticket_configuration_view	Read-only access to service ticket configuration.
hybris.serviceticket_configuration_manage	Create and update service ticket configuration.
hybris.serviceticket_configuration_delete	Delete service ticket configuration.

For more information about scopes, authorization, and authentication procedures for YaaS services, see Scopes and Authorization

Service Ticket Creation Details

When creating a service ticket, provide all the required data as defined in the appropriate schema. You can also add optional information to the request body. This section outlines the details of the structure of the service ticket body and the information that you need to know when you create a new service ticket.

This example shows a newly-created service ticket body:

{
  "assignedTo" : "mandy@hybristest.com",
  "classification" : [{
    "classification" : "BASIC_TECHNICAL_SKILLS",
    "description" : {
     "de" : "Technische Grundkenntnisse erforderlich",
     "en" : "Basic technical skills required"
    }
   }
  ],
  "transcript": [{
    "createdBy": "mandy@hybristest.com",
    "createdAt": "2015-06-19T12:28:07.000+0000",
    "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
   }
  ],
  "createdBy" : "mandy@hybristest.com",
  "customerId" : "C0750876755",
  "dueAt" : "2015-06-30T23:59:59.999+0000",
  "id" : "580750d939fa36001d6e44c6",
  "metadata" : {
    "createdAt" : "2016-10-19T10:54:17.602+0000",
    "modifiedAt" : "2016-10-19T10:54:17.602+0000",
    "mixins": {
      "collectors_info": "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
    },
    "version" : 1
  },
  "mixins" : {
    "collectors_info" : {
       "CollectorsValue": {
          "usd": 30.99,
          "eur": 23.99
       }  
    },
  },
  "modifiedBy" : "mandy@hybristest.com",
  "priority" : "HIGH",
  "priorityDescription" : {
   "de" : "Hoch",
   "en" : "High"
  },
  "processingTime" : 2,
  "productId" : "54e60e07d26ec374ee8e769f",
  "shortDescription" : "Request for regular maintenance",
  "status" : "IN_PROCESS",
  "statusDescription" : {
   "de" : "In Bearbeitung",
   "en" : "In Process"
  },
  "ticketNumber" : "J6BAQC",
  "type" : "SERVICE_REQUEST",
  "typeDescription" : {
   "de" : "Serviceanfrage",
   "en" : "Service Request"
  }
}

Basic information

customerId: Identifier of the customer the service ticket is opened for.
productId: Identifier of the product the ticket is opened for.
assignedTo: The processor of the service ticket.
status: Service ticket status, such as OPEN, IN_PROCESS, COMPLETED or CONFIRMED
priority: Service ticket priority, such as VERY_HIGH, HIGH, MEDIUM or LOW.
type: Service ticket type.
classification: Service ticket classification.

TicketNumber information

The property ticketNumber allows you to assign a human-readable value as an identifier for the service ticket. To assign a service ticket number externally, you must guarantee that it is unique.

If you do not provide a ticketNumber value, or if you leave the value of the property empty, as shown below, the service automatically generates a service ticket number:

{
  ...,

  "ticketNumber" : "",
  ...
}

Transcript information

This property allows the processor of the service ticket to enter additional information about the processing status.

{

    ...,
    "transcript":
    [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    ...

}

Extend Service Ticket Information

Each service ticket contains a set of properties that uniquely identifies and defines it. For example, the service ticket id property identifies a specified service ticket instance, and the customerId property identifies the customer that the service ticket was opened for.

The few properties that are defined by the service ticket schema are common to all items of the service ticket type. These properties are flexible and adjustable and can vary from one service ticket to the other. You can define additional properties and reuse them in different service tickets.

The service ticket mixin feature lets you define a set of reusable properties for use in different service tickets. You can assign one mixin to many service tickets, or you can use many mixins in one service ticket. This approach supports flexibility, reusability, and structural consistency among all your service tickets.

To use mixins, first create the service ticket mixin schema in the Schema service, and then apply it by referring to the URL of the schema. Another way to add mixins is to include definition of mixin schema into the service request call. For information about creating a mixin, see Mixin Schema. For information about using a mixin, see Use the Mixin Schema.

Mixin schema

To create a mixin, define the mixin within a schema using the Schema service, or you can create the mixin within the service request.

If you create the mixin in the Schema service, you only have to call the mixin URL and assign a value to the mixin within the request.
If you create the mixin directly in the request call (inline schema), enter the same properties each time you add the mixin to the service ticket.

This is an example of the mixin structure for both methods:

{

    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
      "instruction": {
        "type": "string"
      }
    }

}

You can use the mixin to extend the service ticket. The properties in mixin are not part of the service ticket schema, but are part of the mixin schema.

Use the mixin schema

After you create a mixin schema, you can add the mixin to the service ticket either when you create a new service ticket, or when you update an existing service ticket.

This example shows a mixin schema added to the service ticket by including definition of the mixin.

{
    ...,
    "mixins" : {
        "additionalCode" : {
            "code" : "ABC"
        }
    },
    "metadata" : {
        "mixins" : {
            "additionalCode" : {
                "$schema" : "http://json-schema.org/draft-04/schema#",
                "type" : "object",
                "properties" : {
                    "code" : {
                        "type" : "string"
                    }
                }

            }
        }
    },
    ...
}

This example shows a mixin schema added to the service ticket by referring to the URL.

{

    ...,
    "mixins":{
      "additionalCode": {
        "code": "ABC"
      }
    },
    "metadata": {
      "mixins": {
        "additionalCode": "https://api.beta.yaas.io/hybris/schema/v1/myexampleshop/example-schema.json"
      }
    },
    ...

}

For tutorials about how to add mixins to a service ticket, see Extend Service Ticket with Mixins.

Service Ticket Attachments

You can upload files as attachments to a service ticket. Currently, PDF, MP4, JPG, PNG, and TXT file types are supported.

Use these endpoints to perform operations on attachments:

/{tenant}/serviceTickets/{id}/attachments: Upload an attachment, delete all attachments, or retrieve metadata for all attachments in a service ticket.
/{tenant}/serviceTickets/{id}/attachments/{fileId}: Update the attachment metadata, delete an attachment, or retrieve the download link for the specified attachment.

Service Ticket Priorities

The service ticket priority defines the importance or urgency of a service ticket. Use the /{tenant}/serviceTicketPriorities endpoint to retrieve a complete overview of the supported values and descriptions used to define the service ticket priority.

Service Ticket Statuses

The service ticket status represents the processing status of a service ticket. Use the /{tenant}/serviceTicketStatuses endpoint to retrieve the allowed values and descriptions for the service ticket status.

Service Ticket Types

Service ticket types represent the different types of service tickets. You can define service ticket types according to the services that you provide, such as requests for repairs, servicing, and general inquiries.

Call the endpoint /{tenant}/serviceTicketTypes to configure the service ticket types using these methods:

The PUT method supports both creating and updating service ticket types.
The DELETE method deletes all the service ticket types configuration.
The GET method retrieves the current service ticket types configuration.

The service only supports full update, in which the entire configuration uses the values you provide in the PUT request. When updating the service ticket types configuration, first, retrieve the current configuration from your tenant. Then, modify the data and send it, in its entirety, in the PUT request to the endpoint, even if you just want to insert a new entry or modify an existing entry.

Service Ticket Classification

You can categorize service tickets, such as basic consulting skills, basic technical skills, advanced technical skills.

Call the endpoint /{tenant}/serviceTicketClassifications to configure the service ticket classifications using these methods:

The PUT method supports both creating and updating service ticket classifications.
The DELETE method deletes all the service ticket classifications configuration.
The GET method retrieves the current service ticket classifications configuration.

The service only supports full update, in which the entire configuration uses the values you provide in the PUT request. When updating the service ticket classifications configuration, first, retrieve the current configuration from your tenant. Then, modify the data and send it, in its entirety, in the PUT request to the endpoint, even if you just want to insert a new entry or modify an existing entry.

Create a Service Ticket

To create a service ticket, you need:

Request

Method: POST
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.

Body:

{
  "type" : "SERVICE_REQUEST",
  "priority" : "HIGH",
  "classification" :
  [{
          "classification" : "BASIC_TECHNICAL_SKILLS"
      }
  ],
  "status" : "IN_PROCESS",
  "dueAt" : "2015-06-30T23:59:59.999+0000",
  "customerId" : "C0750876755",
  "productId" : "54e60e07d26ec374ee8e769f",
  "shortDescription" : "Request for regular maintenance",
  "assignedTo" : "mandy@hybristest.com",
  "transcript" :
  [{
          "createdBy" : "mandy@hybristest.com",
          "createdAt" : "2015-06-19T12:28:07.000+0000",
          "description" : "Customer requested regular maintenance of their FOCUS MARES bike"
      }
  ],
  "createdBy" : "mandy@hybristest.com",
  "modifiedBy" : "mandy@hybristest.com"
}

Response

The successful response returns a 201 status code. An example JSON content looks similar to the following:

{
  "id": "55473b487deefe21340ae74f",
  "link": "https://api.beta.yaas.io/hybris/serviceticket/v1/myexampleshop/serviceTickets/55473b487deefe21340ae74f"
}

Update a Service Ticket

To update a service ticket, you need:

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.

Body:

{
"id" : "55473b487deefe21340ae74f",
"ticketNumber" : "TN0001",
"type" : "SERVICE_REQUEST",
"classification" :
[{
 "classification" : "BASIC_TECHNICAL_SKILLS"
}
],
"mixins" : {
"collectors_info" : {
 "CollectorsValue" : {
  "usd" : 51.22,
  "eur" : 23.44
 }
}
},
"priority" : "HIGH",
"status" : "IN_PROCESS",
"customerId" : "C0750876755",
"productId" : "54e60e07d26ec374ee8e769f",
"shortDescription" : "Request for regular maintenance",
"assignedTo" : "mandy@hybristest.com",
"transcript" :
[{
 "createdBy" : "mandy@hybristest.com",
 "createdAt" : "2015-06-19T12:28:07.000+0000",
 "description" : "Customer requested regular maintenance of their FOCUS MARES bike"
}
],
"createdBy" : "mandy@hybristest.com",
"modifiedBy" : "mandy@hybristest.com",
"metadata" : {
"version" : 1,
"mixins" : {
 "collectors_info" : "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
}
}
}

Response

The successful response returns a 204 status code.

The error code 409 means the specified service ticket was updated immediately preceding your update attempt. If you receive this error code, retrieve the service ticket and update it again.

Delete a Service Ticket

To delete a service ticket, you need:

Request

Method: DELETE
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_delete.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.

Response

The successful response returns a 204 status code.

Retrieve a Service Ticket

To retrieve a service ticket, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_view.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "typeDescription": "Service Request",
    "classification":
    [
         {
             "classification": "BASIC_TECHNICAL_SKILLS",
             "description": "Basic technical skills required"
         }
    ],
    "mixins" : 
    {
        "collectors_info" : 
        {
            "CollectorsValue": 
            {
                "usd": 30.99,
                "eur": 23.99
            }
          }  
    },
    "priority": "HIGH",
    "priorityDescription": "High",
    "status": "IN_PROCESS",
    "statusDescription": "In Process",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "processingTime": 432000,
    "customerId": "C0750876755",
    "productId" : "54e60e07d26ec374ee8e769f",
    "shortDescription" : "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript":
    [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata":
    {
        "createdAt": "2015-06-19T12:28:07.000+0000",
        "modifiedAt": "2015-06-19T12:28:07.000+0000",
        "version": 1,
        "mixins" : 
        {
           "collectors_info" : "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
        }
    }
}

Retrieve All Service Tickets

To retrieve a collection of service tickets, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_view.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "typeDescription": "Service Request",
    "classification":
    [
         {
             "classification": "BASIC_TECHNICAL_SKILLS",
             "description": "Basic technical skills required"
         }
    ],
    "mixins" : 
    {
        "collectors_info" : 
        {
            "CollectorsValue": 
            {
                "usd": 30.99,
                "eur": 23.99
            }
          } 
    },
    "priority": "HIGH",
    "priorityDescription": "High",
    "status": "IN_PROCESS",
    "statusDescription": "In Process",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "processingTime": 432000,
    "customerId": "C0750876755",
    "productId" : "54e60e07d26ec374ee8e769f",
    "shortDescription" : "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript":
    [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata":
    {
        "createdAt": "2015-06-19T12:28:07.000+0000",
        "modifiedAt": "2015-06-19T12:28:07.000+0000",
        "version": 1,
        "mixins" : 
        {
           "collectors_info" : "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
        }
    }
}

Extend Service Ticket with Mixins

To retrieve a collection of service tickets, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_view.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "typeDescription": "Service Request",
    "classification":
    [
         {
             "classification": "BASIC_TECHNICAL_SKILLS",
             "description": "Basic technical skills required"
         }
    ],
    "mixins" : 
    {
        "collectors_info" : 
        {
            "CollectorsValue": 
            {
                "usd": 30.99,
                "eur": 23.99
            }
          } 
    },
    "priority": "HIGH",
    "priorityDescription": "High",
    "status": "IN_PROCESS",
    "statusDescription": "In Process",
    "dueAt": "2015-06-30T23:59:59.999+0000",
    "processingTime": 432000,
    "customerId": "C0750876755",
    "productId" : "54e60e07d26ec374ee8e769f",
    "shortDescription" : "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript":
    [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested to perform regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata":
    {
        "createdAt": "2015-06-19T12:28:07.000+0000",
        "modifiedAt": "2015-06-19T12:28:07.000+0000",
        "version": 1,
        "mixins" : 
        {
           "collectors_info" : "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
        }
    }
}

Update Service Ticket Status

To update the status of a service ticket, you need:

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.
Body:

{
    "id": "55473b487deefe21340ae74f",
    "ticketNumber": "1000000001",
    "type": "SERVICE_REQUEST",
    "classification":
    [
         {
             "classification": "BASIC_TECHNICAL_SKILLS"
         }
    ],
     "mixins" : 
    {
        "collectors_info" : 
        {
            "CollectorsValue": 
            {
                "usd": 51.22,
                "eur": 23.44
            }
          } 
    },
    "priority": "HIGH",
    "status": "IN_PROCESS",
    "customerId": "C0750876755",
    "productId" : "54e60e07d26ec374ee8e769f",
    "shortDescription" : "Request for regular maintenance",
    "assignedTo": "mandy@hybristest.com",
    "transcript":
    [
        {
            "createdBy": "mandy@hybristest.com",
            "createdAt": "2015-06-19T12:28:07.000+0000",
            "description": "Customer requested regular maintenance of their FOCUS MARES bike"
        }
    ],
    "createdBy": "mandy@hybristest.com",
    "modifiedBy": "mandy@hybristest.com",
    "metadata":
    {
        "version": 1,
        "mixins" : 
        {
            "collectors_info" : "https://devportal.yaas.io/services/document/latest/download/comicCollectorValue_v1.json"
        }
    }
}

Response

The successful response returns a 204 status code.

Add an Attachment to a Service Ticket

The example code in this section shows how to upload a file as an attachment for a service ticket. To upload attachments, use the multipart/form-data content type in the request body.

To add an attachment to a service ticket, you need

Request

Method: POST
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}/attachments
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.

var file;
loadFile('filePlaceholder', 'readAsArrayBuffer', function(e) {
 file = e.target.result;
 }); 
file

var request = jQuery.ajax({
 url: requestUrl,
 type: 'POST',
 contentType: 'multipart/form-data',
 data: file,
 processData: false,
 async: false 
}).done(function(){console.log('attachment uploaded');});
request.status

Response

The successful response returns a 201 status code. An example JSON content looks similar to the following:

{
    "id": "57173ab02e9465001db61956",
    "link": "https://api.beta.yaas.io/hybris/serviceticket/v1/myexampleshop/serviceTickets/565cb63d9aae8a28f217a8b7/attachments/57173ab02e9465001db61956"
}

Delete an Attachment for a Service Ticket

To delete an attachment for a service ticket, you need:

Request

Method: DELETE
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}/attachments/{fileId}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.
- {fileId}: The identifier of the specified attachment.

Response

The successful response returns a 204 status code.

Update the Metadata for an Attachment

To update the metadata for an attachment for a service ticket, you need:

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}/attachments/{fileId}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_manage.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.
- {fileId}: The identifier of the specified attachment.
Body: This is an example of the attachment metadata to send with your PUT request. Include the file name in the JSON-formatted property name.

{
  "name": "attachment.jpg"
}

Response

The successful response returns a 204 status code.

Retrieve the Download Link for an Attachment

To retrieve the download link for an attachment, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}/attachments/{fileId}
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_view.
URI Parameters
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.
- {fileId}: The identifier of the specified attachment.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

{
  "link": "https://s3.amazonaws.com/bucket/7367728b18aef6ef24a04e39?x-amz-security-token=AQoDYXdz..."
}

Retrieve all Attachments for a Service Ticket

To retrieve all attachments metadata for a service ticket, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTickets/{id}/attachments
Headers:
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_view.
URI Parameters:
- {tenant}: The name of the current tenant.
- {id}: The identifier of the specified service ticket.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
  {
    "id": "5367728b18aef6ef24a04e38",
    "metadata": {
      "name": "attachment1.jpg",
      "size": "1024000",
      "createdBy": "mandy@hybristest.com",
      "createdAt": "1459335611324",
      "modifiedBy": "mandy@hybristest.com",
      "modifiedAt": "1459335611324"
    }
  },
  {
    "id": "5367728b18aef6ef24a04e39",
    "metadata": {
      "name": "attachment1.zip",
      "size": "1024000",
      "createdBy": "mandy@hybristest.com",
      "createdAt": "1459335611324",
      "modifiedBy": "mandy@hybristest.com",
      "modifiedAt": "1459335611324"
    }
  }
]

Retrieve Help Values of Statuses

To retrieve the allowed values for the service ticket status, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketStatuses
Headers:
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_view.
- hybris-languages: Provide language identifiers to retrieve the required language version for the status descriptions from the service. The service supports multiple language identifier values. Separate multiple language identifiers with commas. If you do not provide a language identifier, the service returns all available versions of the status description. For example, if you specify the language identifier de, the service returns only the e German version of the status description.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
    {
        "status": "OPEN",
        "description":
        {
            "en": "Open",
            "de": "Offen"
        }
    },
    {
        "status": "IN_PROCESS",
        "description":
        {
            "en": "In Process",
            "de": "In Bearbeitung"
        }
    },
    {
        "status": "COMPLETED",
        "description":
        {
            "en": "Completed",
            "de": "Abgeschlossen"
        }
    },
    {
        "status": "CONFIRMED",
        "description":
        {
            "en": "Confirmed",
            "de": "Bestätigt"
        }
    }
]

Retrieve Help Values of Priorities

To retrieve the allowed values for the service ticket priorities, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketPriorities
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_view.
- hybris-languages: Provide language identifiers to retrieve the required language version for the priority descriptions from the service. The service supports multiple language identifier values. Separate multiple language identifiers with commas. If you do not provide a language identifier, the service returns all available versions of the priority descriptions. For example, if you specify the language identifier de, the service returns only the German version of the priority descriptions.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
    {
        "priority": "VERY_HIGH",
        "description": 
        {
            "en": "Very high",
            "de": "Sehr hoch"
        }
    },
    {
        "priority": "HIGH",
        "description": 
        {
            "en": "High",
            "de": "Hoch"
        }
    }, 
    {
        "priority": "MEDIUM",
        "description":
        {
            "en": "Medium",
            "de": "Mittel"
        }
    },
    {
        "priority": "LOW",
        "description":
        {
            "en": "Low",
            "de": "Niedrig"
        }
    }
]

Manage Service Ticket Types

To retrieve the configured service ticket types, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketTypes
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_view.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
    {
        "active": true,
        "type": "GENERAL_INQUIRY",
        "description":
        {
            "en": "General Inquiry",
            "de": "Allgemeine Anfrage"
        }
    },
    {
        "active": false,
        "type": "REPAIR",
        "description":
        {
            "en": "Repair",
            "de": "Reparatur"
        }
    },
    {
        "active": true,
        "type": "SERVICE_REQUEST",
        "description":
        {
            "en": "Service Request",
            "de": "Serviceanfrage"
        }
    }
]

To update the service ticket types, you need:

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketTypes
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_manage.
URI Parameters
- {tenant}: The name of the current tenant.

Body: This is an example of a request body for service ticket types:

[
  {
      "active": true,
      "type": "GENERAL_INQUIRY",
      "description":
      {
          "en": "General Inquiry",
          "de": "Allgemeine Anfrage"
      }
  },
  {
      "active": false,
      "type": "REPAIR",
      "description":
      {
          "en": "Repair",
          "de": "Reparatur"
      }
  },
  {
      "active": true,
      "type": "SERVICE_REQUEST",
      "description":
      {
          "en": "Service Request",
          "de": "Serviceanfrage"
      }
  }
]

Response

The successful response returns a 204 status code.

To delete the service ticket types, you need:

Request

Method: DELETE
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketTypes
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_delete.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 204 status code.

Manage Service Ticket Classifications

To retrieve the configured service ticket classifications, you need:

Request

Method: GET
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1 /{tenant}/serviceTicketClassifications
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_view.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 200 status code. An example JSON content looks similar to the following:

[
    {
        "active": false,
        "classification": "BASIC_CONSULTING_SKILLS",
        "description":
        {
            "en": "Basic consulting skills required",
            "de": "Consulting-Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "BASIC_TECHNICAL_SKILLS",
        "description":
        {
            "en": "Basic technical skills required",
            "de": "Technische Grundkenntnisse erforderlich"
        }
    },
    {
        "active": true,
        "classification": "ADVANCED_TECHNICAL_SKILLS",
        "description":
        {
            "en": "Advanced technical skills required",
            "de": "Fortgeschrittene technische Kenntnisse erforderlich"
        }
    }
]

To update the service ticket classifications, you need:

Request

Method: PUT
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTicketClassifications
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_manage.
URI Parameters
- {tenant}: The name of the current tenant.

Body:

[
  {
      "active": false,
      "classification": "BASIC_CONSULTING_SKILLS",
      "description":
      {
          "en": "Basic consulting skills required",
          "de": "Consulting-Grundkenntnisse erforderlich"
      }
  },
  {
      "active": true,
      "classification": "BASIC_TECHNICAL_SKILLS",
      "description":
      {
          "en": "Basic technical skills required",
          "de": "Technische Grundkenntnisse erforderlich"
      }
  },
  {
      "active": true,
      "classification": "ADVANCED_TECHNICAL_SKILLS",
      "description":
      {
          "en": "Advanced technical skills required",
          "de": "Fortgeschrittene technische Kenntnisse erforderlich"
      }
  }
]

Response

The successful response returns a 204 status code.

To delete the service ticket classifications, you need:

Request

Method: DELETE
Request URL: https://api.beta.yaas.io/hybris/serviceticket/v1/{tenant}/serviceTicketClassifications
Headers
- Authorization: This includes a valid OAuth2 access token. To access this method, the access token must be issued for the requested tenant and have the scope hybris.serviceticket_configuration_delete.
URI Parameters
- {tenant}: The name of the current tenant.

Response

The successful response returns a 204 status code.

Error Types

For information about error codes, see the API Reference.

Glossary

Term	Description
service ticket mixin	Customizable definition of additional properties for the service ticket. One service ticket definition can use many mixins, and one mixin can be used by many service ticket definitions.

Send feedback
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Get Help
Use our private help channel. Receive updates over email and contact our specialists directly.
hybris Experts
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.

Overview

API Reference

/{tenant}/serviceTickets

/{tenant}/serviceTickets

get /{tenant}/serviceTickets

URI Parameters

Headers

Query Parameters

HTTP status code 200

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 408

Body

HTTP status code 500

Body

post /{tenant}/serviceTickets

URI Parameters

Headers

Body

HTTP status code 201

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 408

Body

HTTP status code 500

Body

/{tenant}/serviceTickets/{id}

get /{tenant}/serviceTickets/{id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 408

Body

HTTP status code 500

Body

put /{tenant}/serviceTickets/{id}

URI Parameters

Headers

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 408

Body

HTTP status code 409

Body

HTTP status code 500

Body

delete /{tenant}/serviceTickets/{id}

URI Parameters

Headers

HTTP status code 204

HTTP status code 400