KIX REST API
Version v1
Description
This API can be used to communicate with the KIX backend (core) application. It has been designed with respect to the structure and relationships of the internal business objects.
At this stage it is not intended to be a perfect REST API following any concept out there. Therefore it doesn't support full discoverability yet and also not all response headers (like counts etc.) are available.
Nonetheless it's an extremely powerful API to support any client-to-server communication necessary to handle KIX. Additionally it can easily be expanded by extensions.
Base URI
http://{fqdn}:{port}/api/v1| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fqdn | string | The FQDN of the KIX backend server. | ||
| port | string | The port the KIX backend server uses. |
Getting started
First of all you need to authenticate and create a new user session represented by a so called WebToken. This is done by doing a POST request to the /auth resource including an AuthRequest object.
If the system was able to authenticate the user it will respond with an AuthResponse object containing the resulting WebToken. Use this token for all secured resources. You can find the relevant information in the security section of each request description.
Responses
In case of a successful execution of the request the API responds with an appropriate HTTP code and the corresponding JSON response as the content. If an error occurs the API returns a simple error object. You can find the structure of these objects in the response description for each API resource.
Populate queries
Query collections
When querying collections you can use some special functions to influence the resulting response. Those special functions are (in order of execution)
Query items
When requesting items there are also special functions to change the resulting response. Those special functions are (in order of execution)
Please note that when querying collections the collection resource uses the corresponding item resource to populate the data of each item to prepare the response. Therefore you can use those special functions in queries of the corresponding collection resource as well.
Search objects
Some collection resources support the query parameter search which means that you can define the properties of objects that will be searched in the backends datasources. In contrast to the optional filter the search function depends on the abilities of the core modules and the underlying datasources (DBMS) with their relationships. Therefore not everything that can be done with filters can be done with a search function. But since searches are executed at datasource level they can improve the performance of a request significantly.
Usage in URL
.../<resource>?search={...}The search definition is a JSON object identical to a filter function. Please see the filter function for a detailed description of this structure.
Whether a collection resource supports the search function and which properties can be searched (fields/object attributes, operators, etc.) can be found in the description of the relevant resource.
Filter results
You can use an optional filter function to filter the items in the response of collections. The filter function will be executed at API level and therefore is a lot more powerful in terms of complexity than the search function. Also the filter function is available for all collection resources. Since it works on all the data coming back from the datasource level please carefully tune the combination of search and filter to achieve the best performance.
Usage in URL
.../<resource>?filter={...}The filter definition is a JSON object in the following form:
{
"<Object>": {
"AND": [
{
"Field": "<Fieldname>",
"Operator": "<Operator>",
"Value": "<Value>"[,]
["Type": "<Type>",]
["Not": <Not>,]
},
...next field...
],
"OR": [
{
"Field": "<Fieldname>",
"Operator": "<Operator>",
"Value": "<Value>"[,]
["Type": "<Type>",]
["Not": <Not>,]
},
...next field...
]
}
}Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | yes | The object in the JSON response to be filtered. |
<Fieldname> | yes | The attribute in each item of the response to be filtered. |
<Operator> | yes | The compare operator to be used. |
<Value> | yes | The value to compare to. Filters are working case-insensitive. If the value starts with a $ character it will be interpreted as a reference to another attribute and the actual value will be taken from the referenced attribute. |
<Type> | The type of data that should be used to compare the value. If not given, the value will be interpreted as a string. | |
<Not> | To negate the comparison set this to true. |
If both lists are given (AND and OR) they will be combines using a logical AND operation.
Supported types
| Type | Description |
|---|---|
STRING | The value will be treated as a text of ASCII characters. |
NUMERIC | The value will be treated as a number (integer or float). |
DATE | The value will be treated as a date of the form YYYY-MM-DD |
DATETIME | The value will be treated as a date + time combination of the form YYYY-MM-DD HH24:MI:SS |
Supported operators
| Operator | Meaning | Valid for datatypes | Description |
|---|---|---|---|
EQ | equal to | all | The data value must be exactly identical to the filter value. |
NE | not equal to | all | The data value must not be identical to the filter value. |
LT | less than | NUMERIC, DATE, DATETIME | The data value must be less than the filter value. |
LTE | less than or equal | NUMERIC, DATE, DATETIME | The data value must be less than or equal to the filter value. |
GT | greater than | NUMERIC, DATE, DATETIME | The data value must be greater than the filter value. |
GTE | greater than or equal | NUMERIC, DATE, DATETIME | The data value must be greater than or equal to the filter value. |
IN | exists in list | all | The data value must be one of the given list of filter values. This is identical to separate OR filters with EQ operators for each filter value |
CONTAINS | contains a pattern | STRING | The filter value is contained in the data value at any position. |
STARTSWITH | starts with a pattern | STRING | The data value starts with the filter value. |
ENDSWITH | ends with a pattern | STRING | The data value end with the filter value. |
LIKE | matches pattern | STRING | The data value matches the filter value which represents a pattern. The wildcard * can be used multiple times. Without a wildcard the LIKE operator works like the EQ operator. |
Example
Return all users whose UserID isn't 1, 2 oder 3 and whose first name doesn't begin with their last name and whose email address ends with "cape-it.de".
{
"User": {
"AND": [
{
"Field": "UserEmail",
"Operator": "ENDSWITH",
"Value": "cape-it.de"
},
{
"Field": "UserID",
"Operator": "IN",
"Value": [ 1, 2, 3 ],
"Type": "numeric",
"Not": true
},
{
"Field": "UserFirstname",
"Operator": "STARTSWITH",
"Value": "$UserLastname",
"Not": true
}
]
}
}Sort results
Every collection resource supports the sorting of items in the response. This can be done with the optional query parameter sort.
Usage in URL
.../<resource>?sort=<Object>.[-]<Fieldname>[:<Type>]Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | yes | The object in the JSON response to be sorted. |
<Fieldname> | yes | The attribute in each item of the response to be sorted by. If the fieldname starts with - the attribute will be sorted in descending order. |
<Type> | The type of data that should be used to compare the value. If not given, the the value will be sorted as ASCII text and case-insensitive. |
Supported types
| Type | Description |
|---|---|
numeric | The attribute value will be sorted as a number (integer or float). |
textual | The attribute value will be sorted as ASCII text. Case and spaces will be ignored. |
natural | Multi-type-sort. Sorting of different parts of value, starting with spaces, followed by numbers, non-text characters and text characters. Additionally subsidiary words will be moved to the end of the value. Example: "The Book of Verse" will be sorted as "Book of Verse, The" |
date | The attribute value will be sorted as a date in the form YYYY-MM-DD |
datetime | The attribute value will be sorted as a date in the form YYYY-MM-DD HH24:MI:SS |
Multiple attributes can be sorted by separating the sort definition with comma.
Example
Query all users and sort the result for the creation time ascending + UserID descending + first name ascending.
.../users?sort=User.CreateTime:date,User.-UserID:numeric,User.UserFirstnameLimit results
There are two optional functions offset and limit to limit the number of items in a response of a collection resource. The combination of both functions is a powerful instrument to create paged responses.
Using offsets
By using the optional query parameter offset a collection resource can be forced to return its response starting at a specific array index. This function will be executed before the limit function.
Usage in URL
.../<resource>?offset=[<Object>:]<Offset>Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | The object in the JSON response to apply an offset to. If omitted the offset will be applied to all object lists in the response (if the response contains such). | |
<Offset> | yes | The numeric offset to apply. |
If a response contains different objects in different lists, separate offsets can be applied by separating them the with comma.
Example
.../users?offset=100,User:10Limit API results
The optional query parameter limit allows to limit the number objects contained in the response of a collection.
Usage in URL
.../<resource>?limit=[<Object>:]<Limit>Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | The object in the JSON response to apply a limit to. If omitted the limit will be applied to all object lists in the response (if the response contains such). | |
<Limit> | yes | The numeric limit to apply. |
If a response contains different objects in different lists, separate limits can be applied by separating them the with comma.
Example
.../users?limit=100,User:10Limit Search results
The optional query parameter searchlimit is provided to the core search and limits the search result at database layer.
Usage in URL
.../<resource>?searchlimit=[<Object>:]<Limit>Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | The object in the JSON response to apply a limit to. If omitted the limit will be applied to all object lists in the response (if the response contains such). | |
<SearchLimit> | yes | The numeric limit to apply. |
Example
.../users?searchlimit=100,Ticket:10Select properties
With the use of the optional query parameter fields it is possible to select which properties of an object should be included in the response. There are three ways to do this: a general style, a compact style and the use of pre-defined fieldsets.
Usage in URL
General:
.../<resource>?fields=<Object>.<Property>Compact:
.../<resource>?fields=<Object>.[<Property>;<Property>;<Property>]Please note that the "[]" characters do not declare optional content but define an actual array list in this case.
Fieldset:
.../<resource>?fields=:<Fieldset>Explanation
| Parameter | Required? | Description |
|---|---|---|
<Object> | yes | The object in the JSON response for which the properties should be selected. |
<Property> | yes | The name of the property that should be included in the response. |
When using the general style, multiple properties can be selected by multiplying the whole
A fieldset is a pre-defined property selection with a name. Please see the documentation of a specific resource whether fieldsets are available.
Example
Only select the attributes "UserLogin" and "UserID" from the users collection. In our example a fieldset named "Short" exists which selects those two properties.
General:
.../users?fields=User.UserLogin,User.UserIDCompact:
.../users?fields=User.[UserLogin;UserID]Fieldset:
.../users?fields=:ShortInclude more information
When requesting items it is possible to include more information into the response than the base object data. To do this you can use the optional query parameter include. Every resource can always include its own direct sub-resources. What exactly can be included additionally, depends on the actual resource you are querying. Therefore it will be documented in the description of the resource.
Usage in URL
.../<resource>?include=<What>Explanation
| Parameter | Required? | Description |
|---|---|---|
<What> | yes | The additional data to include into the response. You can separate multiple ones by comma. |
There are some generic includes that can be used in every query regardless of a specific resource. At the moment those generic includes are:
| Generic Include | Description |
|---|---|
Links | Include all the the linked objects of this item. |
ObjectIcon | Include the icon for this item. |
AssignedPermissions | Include the assigned base permissions for this item. |
Watchers | Include the watchers for this object if possible. |
DynamicFields | Include the dynamic field values for this object if possible. |
Please note that the include extends each item in the response with an additional attribute that is named like the include itself. Also the including of data that is not related to sub-resources sometimes results in a list of IDs of the relevant objects. Please see the optional function expand for information on how to transform these IDs to actual objects.
The AssignedPermissions include adds an array property that contains the relevant base permissions. At the moment only Queues can have base permissions.
*Example
Query all organisations and include a list of tickets and contacts of each organisation.
.../organisations?include=Tickets,ContactsExpand objects
When requesting items and using the optional function include to include another depending resource, a list of IDs will be the result. This can be used to count the relevant objects without the need to include unnecessary and huge additional data. To replace this list of IDs with the actual objects you can use the optional query parameter expand. Whether a resource supports expanding of includes and which includes can be expanded can be found in the documentation of the specific resource.
Usage in URL
.../<resource>?expand=<What>Explanation
| Parameter | Required? | Description |
|---|---|---|
<What> | yes | The includes in the response that should be expanded. You can specify multiple ones by separating them with comma. |
Example
Query all organisations and include a list of tickets and contacts of each organisation. Expand the list of tickets with the actual ticket objects.
.../organisations?include=Tickets,Contacts&expand=TicketsResources
Authentication
/auth post
post /auth
Manage existing sessions.
Body
Media type: application/json
Type: AuthRequest
Schema:
{
"$id" : "AuthRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An authorization object.",
"type" : "object",
"properties" : {
"NegotiationToken" : {
"type" : "string"
},
"Password" : {
"description" : "required if no NegitiationToken is given",
"type" : "string"
},
"UserLogin" : {
"description" : "required if no NegitiationToken is given",
"type" : "string"
},
"UserType" : {
"type" : "string",
"enum" : [
"Agent",
"Customer"
]
}
},
"required" : [
"UserType"
]
}
Example:
{
"UserLogin": "root@localhost",
"UserType": "Agent",
"Password": "root"
}Possible Responses
HTTP status code 201
Body
Media type: application/json
Type: AuthResponse
Schema:
{
"$id" : "AuthResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The auth response.",
"type" : "object",
"properties" : {
"Token" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Token"
]
}
Example:
{
"Token": "eyJhbGciOiJIUzI1NiJ9.eyJEZXNjcmlwdGlvbiI6IiIsIlVzZXJJRCI6IjEiLCJVc2VyVHlwZSI6IkFnZW50IiwiQWxsb3dlZE9wZXJhdGlvbnMiOltdLCJJZ25vcmVNYXhJZGxlVGltZSI6MCwiRGVuaWVkT3BlcmF0aW9ucyI6W10sIlJlbW90ZUlQIjoiOjpmZmZmOjE3Mi4xNy4wLjEiLCJUb2tlblR5cGUiOiJOb3JtYWwiLCJDcmVhdGVUaW1lVW5peCI6MTUzNTQ1NjA5NSwiVmFsaWRVbnRpbFRpbWVVbml4IjoxNTM1NTEzNjk1fQ.Ny0LWwELBS7c2K-784_9SpPBEz_HsgJ4s2xQTMSjCso"
}
Client Registrations
get /clientregistrations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ClientRegistrationCollectionResponse
Schema:
{
"$id" : "ClientRegistrationCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of client registrations.",
"type" : "object",
"properties" : {
"ClientRegistration" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ClientRegistration_json"
}
}
},
"required" : [
"ClientRegistration"
],
"definitions" : {
"_ClientRegistration_json" : {
"$id" : "ClientRegistration.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The client registration object.",
"type" : "object",
"properties" : {
"Authorization" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ClientID" : {
"type" : "string",
"readOnly" : true
},
"LastNotificationTimestamp" : {
"anyOf" : [
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"NotificationInterval" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"NotificationURL" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Plugins" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Description" : {
"type" : "string"
},
"ExtendedData" : {
"description" : "a key-value list of additional attributes",
"type" : "object"
},
"Product" : {
"type" : "string"
},
"Requires" : {
"type" : "string"
},
"Version" : {
"type" : "string"
}
},
"required" : [
"BuildNumber",
"Product"
]
}
},
"Requires" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Operator" : {
"description" : "supported operators: <, >, =, !",
"type" : "string"
},
"Product" : {
"type" : "string"
}
},
"required" : [
"Product"
]
}
}
},
"required" : [
"ClientID"
]
}
}
}
Example:
{
"ClientRegistration": [
{
"ClientID": "KIX-Frontend",
"Authentication": "test123",
"CallbackURL": "https://kix.example.org/backendfeedback"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /clientregistrations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ClientRegistrationPostRequest
Schema:
{
"$id" : "ClientRegistrationPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The client registration request object for creation.",
"type" : "object",
"properties" : {
"ClientRegistration" : {
"type" : "object",
"properties" : {
"Authorization" : {
"type" : "string"
},
"ClientID" : {
"type" : "string"
},
"NotificationInterval" : {
"type" : "integer"
},
"NotificationURL" : {
"type" : "string"
},
"Plugins" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Description" : {
"type" : "string"
},
"ExtendedData" : {
"description" : "a key-value list of additional attributes",
"type" : "object"
},
"Product" : {
"type" : "string"
},
"Requires" : {
"type" : "string"
},
"Version" : {
"type" : "string"
}
},
"required" : [
"BuildNumber",
"Product"
]
}
},
"Requires" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Operator" : {
"description" : "supported operators: <, >, =, !",
"type" : "string"
},
"Product" : {
"type" : "string"
}
},
"required" : [
"Product"
]
}
},
"Tanslations" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Content" : {
"description" : "base64 encoded content of the PO file",
"type" : "string"
},
"Language" : {
"type" : "string"
}
},
"required" : [
"Language",
"Content"
]
}
}
},
"required" : [
"ClientID"
]
}
},
"required" : [
"ClientRegistration"
]
}
Example:
{
"ClientRegistration": {
"ClientID": "KIX-Frontend",
"Authorization": "test123",
"NotificationURL": "http://kix-frontend.example.org/notifications",
"NotificationInterval": 30
}
}Possible Responses
HTTP status code 201
The ClientRegistration has been created successfully.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /clientregistrations/{clientId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| clientId | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ClientRegistrationResponse
Schema:
{
"$id" : "ClientRegistrationResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a client registration GET request.",
"type" : "object",
"properties" : {
"ClientRegistration" : {
"$ref" : "#/definitions/_ClientRegistration_json"
}
},
"required" : [
"ClientRegistration"
],
"definitions" : {
"_ClientRegistration_json" : {
"$id" : "ClientRegistration.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The client registration object.",
"type" : "object",
"properties" : {
"Authorization" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ClientID" : {
"type" : "string",
"readOnly" : true
},
"LastNotificationTimestamp" : {
"anyOf" : [
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"NotificationInterval" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"NotificationURL" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Plugins" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Description" : {
"type" : "string"
},
"ExtendedData" : {
"description" : "a key-value list of additional attributes",
"type" : "object"
},
"Product" : {
"type" : "string"
},
"Requires" : {
"type" : "string"
},
"Version" : {
"type" : "string"
}
},
"required" : [
"BuildNumber",
"Product"
]
}
},
"Requires" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"BuildNumber" : {
"type" : "integer"
},
"Operator" : {
"description" : "supported operators: <, >, =, !",
"type" : "string"
},
"Product" : {
"type" : "string"
}
},
"required" : [
"Product"
]
}
}
},
"required" : [
"ClientID"
]
}
}
}
Example:
{
"ClientRegistration": {
"ClientID": "KIX-Frontend",
"Authorization": "test123",
"NotificationURL": "https://kix.example.org/backendfeedback",
"NotificationInterval": 10
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /clientregistrations/{clientId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| clientId | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
CMDB
The top-level /cmdb resource is no collection resource itself. It's purpose is to act as a container for all the CMDB resources.
Configuration Items
Special search behaviour
Since the properties of the version (i.e. the name) don't belong to the Config Item object itself, they must be referenced in the search definition using the prefix "CurrentVersion.", i.e. "CurrentVersion.Name". Attributes that are part of the sub-object "Data" of the "CurrentVersion" object have to be referenced with the prefix "CurrentVersion.Data.". Each structural level in the "Data" object has to be separated by ".", i.e. "CurrentVersion.Data.SectionNetwork.FQDN".
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
CurrentVersion | Adds the current version of the Config Item to the response. See sub-resource "versions". |
get /cmdb/configitems
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemCollectionResponse
Schema:
{
"$id" : "ConfigItemCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item objects.",
"type" : "object",
"properties" : {
"ConfigItem" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItem_json"
}
}
},
"required" : [
"ConfigItem"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemHistory_json" : {
"$id" : "ConfigItemHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item history object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryEntryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"UserFirstname" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLastname" : {
"type" : "string",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"HistoryEntryID",
"HistoryType",
"HistoryTypeID",
"UserID",
"UserFirstname",
"UserLastname",
"UserLogin"
]
},
"_ConfigItemImage_json" : {
"$id" : "ConfigItemImage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Comment",
"ConfigItemID",
"ContentType",
"Filename",
"ID"
]
},
"_ConfigItemVersion_json" : {
"$id" : "ConfigItemVersion.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplState" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurDeplStateType" : {
"type" : "string",
"readOnly" : true
},
"CurInciState" : {
"type" : "string",
"readOnly" : true
},
"CurInciStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurInciStateType" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"description" : "added via include \"Data\"",
"type" : "object"
},
"Definition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"DeplState" : {
"type" : "string",
"readOnly" : true
},
"DeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"DeplStateType" : {
"type" : "string",
"readOnly" : true
},
"InciState" : {
"type" : "string",
"readOnly" : true
},
"InciStateID" : {
"type" : "integer",
"readOnly" : true
},
"InciStateType" : {
"type" : "string",
"readOnly" : true
},
"IsLastVersion" : {
"description" : " if this version is last version, else value is 0",
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"PreparedData" : {
"description" : "added via include \"PreparedData\"",
"type" : "object"
},
"VersionID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"ConfigItemID",
"CreateBy",
"CreateTime",
"CurDeplState",
"CurDeplStateID",
"CurDeplStateType",
"CurInciState",
"CurInciStateID",
"CurInciStateType",
"DeplState",
"DeplStateID",
"DeplStateType",
"InciState",
"InciStateID",
"InciStateType",
"IsLastVersion",
"Name",
"VersionID"
]
},
"_ConfigItem_json" : {
"$id" : "ConfigItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CurInciStateID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CurrentVersion" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemHistory_json"
}
},
"Images" : {
"description" : "added via include \"Images\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemImage_json"
}
},
"LastVersionID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Versions" : {
"description" : "added via include \"Versions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
}
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"ConfigItemID",
"LinkCount",
"Name"
]
}
}
}
Example:
{
"ConfigItem": [
{
"ChangeBy": 1,
"ChangeTime": "2018-07-31 16:07:38",
"Class": "Computer",
"ClassID": 22,
"ConfigItemID": 61,
"CreateBy": 1,
"CreateTime": "2018-07-31 16:07:38",
"LinkCount": 0,
"Name": "notebook1",
"Number": "1022000001"
},
{
"ChangeBy": 1,
"ChangeTime": "2018-07-31 16:47:48",
"Class": "Computer",
"ClassID": 22,
"ConfigItemID": 62,
"CreateBy": 1,
"CreateTime": "2018-07-31 16:47:48",
"LinkCount": 0,
"Name": "notebook2",
"Number": "1022000002"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /cmdb/configitems
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ConfigItemPostRequest
Schema:
{
"$id" : "ConfigItemPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item object for creation.",
"type" : "object",
"properties" : {
"ConfigItem" : {
"type" : "object",
"properties" : {
"ClassID" : {
"type" : "integer"
},
"Images" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemImagePostItem_json"
}
},
"Version" : {
"$ref" : "#/definitions/_ConfigItemVersionPostItem_json"
}
},
"required" : [
"ClassID",
"Version"
]
}
},
"required" : [
"ConfigItem"
],
"definitions" : {
"_ConfigItemImagePostItem_json" : {
"$id" : "ConfigItemImagePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image request object for creation.",
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Content" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Filename" : {
"type" : "string"
}
},
"required" : [
"Content",
"ContentType",
"Filename"
]
},
"_ConfigItemVersionPostItem_json" : {
"$id" : "ConfigItemVersionPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version request object for creation.",
"type" : "object",
"properties" : {
"Data" : {
"type" : "object"
},
"DeplStateID" : {
"type" : "integer"
},
"InciStateID" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
}
},
"required" : [
"Name",
"DeplStateID",
"InciStateID"
]
}
}
}
Example:
{
"ConfigItem": {
"ClassID": 22,
"Version": {
"Name": "test ci 1",
"DeplStateID": 35,
"InciStateID": 2,
"Data": {
"Vendor": "testvendor",
"NIC": [
{
"NIC": "e1000",
"IPoverDHCP": [
38
],
"IPAddress": [
"192.168.1.0",
"192.168.1.1",
"192.168.1.2",
"192.168.1.3"
]
}
]
}
},
"Images": [
{
"Filename": "SomeImage.jpg",
"Content": "..."
}
]
}
}Possible Responses
HTTP status code 201
The ConfigItem has been created successfully.
Body
Media type: application/json
Type: ConfigItemPostPatchResponse
Schema:
{
"$id" : "ConfigItemPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated config item.",
"type" : "object",
"properties" : {
"ConfigItemID" : {
"type" : "integer"
}
},
"required" : [
"ConfigItemID"
]
}
Example:
{
"ConfigItemID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /cmdb/configitems/{configItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemResponse
Schema:
{
"$id" : "ConfigItemResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item GET request.",
"type" : "object",
"properties" : {
"ConfigItem" : {
"$ref" : "#/definitions/_ConfigItem_json"
}
},
"required" : [
"ConfigItem"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemHistory_json" : {
"$id" : "ConfigItemHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item history object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryEntryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"UserFirstname" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLastname" : {
"type" : "string",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"HistoryEntryID",
"HistoryType",
"HistoryTypeID",
"UserID",
"UserFirstname",
"UserLastname",
"UserLogin"
]
},
"_ConfigItemImage_json" : {
"$id" : "ConfigItemImage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Comment",
"ConfigItemID",
"ContentType",
"Filename",
"ID"
]
},
"_ConfigItemVersion_json" : {
"$id" : "ConfigItemVersion.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplState" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurDeplStateType" : {
"type" : "string",
"readOnly" : true
},
"CurInciState" : {
"type" : "string",
"readOnly" : true
},
"CurInciStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurInciStateType" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"description" : "added via include \"Data\"",
"type" : "object"
},
"Definition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"DeplState" : {
"type" : "string",
"readOnly" : true
},
"DeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"DeplStateType" : {
"type" : "string",
"readOnly" : true
},
"InciState" : {
"type" : "string",
"readOnly" : true
},
"InciStateID" : {
"type" : "integer",
"readOnly" : true
},
"InciStateType" : {
"type" : "string",
"readOnly" : true
},
"IsLastVersion" : {
"description" : " if this version is last version, else value is 0",
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"PreparedData" : {
"description" : "added via include \"PreparedData\"",
"type" : "object"
},
"VersionID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"ConfigItemID",
"CreateBy",
"CreateTime",
"CurDeplState",
"CurDeplStateID",
"CurDeplStateType",
"CurInciState",
"CurInciStateID",
"CurInciStateType",
"DeplState",
"DeplStateID",
"DeplStateType",
"InciState",
"InciStateID",
"InciStateType",
"IsLastVersion",
"Name",
"VersionID"
]
},
"_ConfigItem_json" : {
"$id" : "ConfigItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CurInciStateID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CurrentVersion" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemHistory_json"
}
},
"Images" : {
"description" : "added via include \"Images\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemImage_json"
}
},
"LastVersionID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Versions" : {
"description" : "added via include \"Versions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
}
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"ConfigItemID",
"LinkCount",
"Name"
]
}
}
}
Example:
{
"ConfigItem": {
"ChangeBy": 1,
"ChangeTime": "2018-07-31 16:07:38",
"Class": "Computer",
"CurInciStateID": null,
"ClassID": 22,
"CurDeplStateID": null,
"ConfigItemID": 61,
"Number": "1022000001",
"Name": "notebook1",
"CreateBy": 1,
"LastVersionID": null,
"LinkCount": 0,
"CreateTime": "2018-07-31 16:07:38"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /cmdb/configitems/{configItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Body
Media type: application/json
Type: ConfigItemPatchRequest
Schema:
{
"$id" : "ConfigItemPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item object for update.",
"type" : "object",
"properties" : {
"ConfigItem" : {
"type" : "object",
"properties" : {
"DeplStateID" : {
"type" : "integer"
},
"InciStateID" : {
"type" : "integer"
}
}
}
},
"required" : [
"ConfigItem"
]
}
Example:
{
"ConfigItem": {
"DeplStateID": 35,
"InciStateID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemPostPatchResponse
Schema:
{
"$id" : "ConfigItemPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated config item.",
"type" : "object",
"properties" : {
"ConfigItemID" : {
"type" : "integer"
}
},
"required" : [
"ConfigItemID"
]
}
Example:
{
"ConfigItemID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /cmdb/configitems/{configItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Can not resolve ../descriptions/resources/cmdb/configitems/graph.md
/cmdb/configitems/{configItemId}/graph
History of a Config Item
/cmdb/configitems/{configItemId}/history get
get /cmdb/configitems/{configItemId}/history
Get all ConfigItemHistory items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemHistoryCollectionResponse
Schema:
{
"$id" : "ConfigItemHistoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item history objects.",
"type" : "object",
"properties" : {
"ConfigItemHistory" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItemHistory_json"
}
}
},
"required" : [
"ConfigItemHistory"
],
"definitions" : {
"_ConfigItemHistory_json" : {
"$id" : "ConfigItemHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item history object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryEntryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"UserFirstname" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLastname" : {
"type" : "string",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"HistoryEntryID",
"HistoryType",
"HistoryTypeID",
"UserID",
"UserFirstname",
"UserLastname",
"UserLogin"
]
}
}
}
Example:
{
"ConfigItemHistory": [
{
"Comment": "61%%1022000001",
"ConfigItemID": 61,
"CreateBy": 1,
"CreateTime": "2018-07-31 16:07:38",
"HistoryEntryID": 1900,
"HistoryType": "ConfigItemCreate",
"HistoryTypeID": 1,
"UserFirstname": "Admin",
"UserID": 1,
"UserLastname": "KIX",
"UserLogin": "root@localhost"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/cmdb/configitems/{configItemId}/history/{historyId} get
get /cmdb/configitems/{configItemId}/history/{historyId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer | |||
| historyId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemHistoryResponse
Schema:
{
"$id" : "ConfigItemHistoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item history GET request.",
"type" : "object",
"properties" : {
"ConfigItemHistory" : {
"$ref" : "#/definitions/_ConfigItemHistory_json"
}
},
"required" : [
"ConfigItemHistory"
],
"definitions" : {
"_ConfigItemHistory_json" : {
"$id" : "ConfigItemHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item history object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryEntryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"UserFirstname" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLastname" : {
"type" : "string",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"HistoryEntryID",
"HistoryType",
"HistoryTypeID",
"UserID",
"UserFirstname",
"UserLastname",
"UserLogin"
]
}
}
}
Example:
{
"ConfigItemHistory": {
"Comment": "61%%1022000001",
"ConfigItemID": 61,
"CreateBy": 1,
"CreateTime": "2018-07-31 16:07:38",
"HistoryEntryID": 1900,
"HistoryType": "ConfigItemCreate",
"HistoryTypeID": 1,
"UserFirstname": "Admin",
"UserID": 1,
"UserLastname": "KIX",
"UserLogin": "root@localhost"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Images for a Config Item
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
Content | Adds the base64 encoded content of the image to the response. |
Please note
During a POST request the given filename will be replaced with an internal ID. It just works as a validation attribute during the creation of the image item.
get /cmdb/configitems/{configItemId}/images
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemImageCollectionResponse
Schema:
{
"$id" : "ConfigItemImageCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item images.",
"type" : "object",
"properties" : {
"Image" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItemImage_json"
}
}
},
"required" : [
"Image"
],
"definitions" : {
"_ConfigItemImage_json" : {
"$id" : "ConfigItemImage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Comment",
"ConfigItemID",
"ContentType",
"Filename",
"ID"
]
}
}
}
Example:
{
"Image": [
{
"Comment": "",
"ConfigItemID": 6,
"ContentType": "image/jpeg",
"Filename": "20180817003018.90113.jpg",
"ID": "20180817003018.90113"
},
{
"Comment": "",
"ConfigItemID": 6,
"ContentType": "image/jpeg",
"Filename": "20180817003719.70337.jpg",
"ID": "20180817003719.70337"
},
{
"Comment": "this is a test",
"ConfigItemID": 6,
"ContentType": "image/jpeg",
"Filename": "20180817004645.20986.jpg",
"ID": "20180817004645.20986"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /cmdb/configitems/{configItemId}/images
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Body
Media type: application/json
Type: ConfigItemImagePostRequest
Schema:
{
"$id" : "ConfigItemImagePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image request object for creation.",
"type" : "object",
"properties" : {
"Image" : {
"$ref" : "#/definitions/_ConfigItemImagePostItem_json"
}
},
"required" : [
"Image"
],
"definitions" : {
"_ConfigItemImagePostItem_json" : {
"$id" : "ConfigItemImagePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image request object for creation.",
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Content" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Filename" : {
"type" : "string"
}
},
"required" : [
"Content",
"ContentType",
"Filename"
]
}
}
}
Example:
{
"Image": {
"Comment": "this is a test",
"Content": "....",
"ContentType": "image/jpeg",
"Filename": "test123.jpg"
}
}Possible Responses
HTTP status code 201
The ConfigItemImage has been created successfully.
Body
Media type: application/json
Type: ConfigItemImagePostResponse
Schema:
{
"$id" : "ConfigItemImagePostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created config item image.",
"type" : "object",
"properties" : {
"ImageID" : {
"type" : "string"
}
},
"required" : [
"ImageID"
]
}
Example:
{
"ImageID": "20180817010501.76120"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /cmdb/configitems/{configItemId}/images/{imageId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer | |||
| imageId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemImageResponse
Schema:
{
"$id" : "ConfigItemImageResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item image GET request.",
"type" : "object",
"properties" : {
"Image" : {
"$ref" : "#/definitions/_ConfigItemImage_json"
}
},
"required" : [
"Image"
],
"definitions" : {
"_ConfigItemImage_json" : {
"$id" : "ConfigItemImage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item image object.",
"type" : "object",
"properties" : {
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Comment",
"ConfigItemID",
"ContentType",
"Filename",
"ID"
]
}
}
}
Example:
{
"Image": {
"Comment": "this is a test",
"ConfigItemID": 6,
"ContentType": "image/jpeg",
"Filename": "20180817004645.20986.jpg",
"ID": "20180817004645.20986"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /cmdb/configitems/{configItemId}/images/{imageId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer | |||
| imageId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Versions of a Config Item
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
Definition | Adds the corresponding definition of the Config Item class to the response. See sub-resource "definitions". |
Data | Adds the version data to the response. |
PreparedData | Adds the prepared data to the response. The structure of this object is based on the structure of the definition. For every value in the Data object an array item will be created. Please see the description below. |
Structure of the Data attribute
The structure of the Data attribute is based on the structure and configuration of the corresponding Config Item class definition. The following rules apply:
1. The Keyin the attribute definition is the attribute name
{
"AttributeKey": ...
}2. If CountMax in the attribute definition is 1 (or omitted) the value is assigned directly
{
"AttributeKey": "Value"
}3. If CountMax in the attribute definition is > 1 the value is assigned as an array
{
"AttributeKey": [
"Value1",
"Value2",
"Value3"
]
}4. If the attribute has a value AND also contains values in a sub-structure, the attribute is an object and its value will be assigned to an attribute with the same name with this object
{
"AttributeKey": {
"AttributeKey": "Value",
"SubAttributKey1": "...",
"SubAttributKey2": {
"SubSubAttributKey1": "..."
}
}
}Format of the PreparedData array items
{
"Key": "<the key from the attribute definition>",
"Label": "<the name from the attribute definition>",
"Type": "<the type from the attribute definition>",
"Value": "<the internal value of the attribute>",
"DisplayValue": "<the display value of the attribute>",
"Sub": [...]
}The Sub attribute only exists if the attribute definition contains a sub-structure and ony if the sub-structure contains data.
The DisplayValue attribute is not available for attribute of the type Attachment
Supported attribute types
When creating a version of a Config Item only the following attribute types are supported:
| Attribute type | Description | Value in request | Example in POST |
|---|---|---|---|
Attachment | An attachment object containing the attributes Filename, ContentType, Content. The content has to be base64 encoded. | attachment object | "MyAttachment": [ { "Filename": "test.pdf", "ContentType": "application/pdf", "Content": "..." } ] |
CIClassReference | A reference to another Config Item | numeric ID of the referenced Config Item | "ReferencedCI": 612 |
Contact | A reference to a contact | ContactID | "MyContact": 123 |
Organisation | A reference to an organisation | OrganisationID | "MyOrganisation": 456 |
Date | A date value in the form "YYYY-MM-DD" | string | "MyDate": "2018-08-28" |
DateTime | A date+time value in the form "YYYY-MM-DD HH24:MI:SS" | string | "MyDateTime": "2018-08-28 09:23:58" |
Dummy | An empty object to create sub-structures | sub-structure | "MyDummy": {} |
GeneralCatalog | A reference to a GeneralCatalog item | numeric ID of the GeneralCatalog item | "MyGeneralCatalogItem": 123 |
TextArea | A multi-line text | string | "MyTextArea": "This\nis\njust\na\ntest." |
Text | A single-line text | string | "MyText": "This is just a test." |
get /cmdb/configitems/{configItemId}/versions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemVersionCollectionResponse
Schema:
{
"$id" : "ConfigItemVersionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item versions.",
"type" : "object",
"properties" : {
"ConfigItemVersion" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
}
}
},
"required" : [
"ConfigItemVersion"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemVersion_json" : {
"$id" : "ConfigItemVersion.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplState" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurDeplStateType" : {
"type" : "string",
"readOnly" : true
},
"CurInciState" : {
"type" : "string",
"readOnly" : true
},
"CurInciStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurInciStateType" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"description" : "added via include \"Data\"",
"type" : "object"
},
"Definition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"DeplState" : {
"type" : "string",
"readOnly" : true
},
"DeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"DeplStateType" : {
"type" : "string",
"readOnly" : true
},
"InciState" : {
"type" : "string",
"readOnly" : true
},
"InciStateID" : {
"type" : "integer",
"readOnly" : true
},
"InciStateType" : {
"type" : "string",
"readOnly" : true
},
"IsLastVersion" : {
"description" : " if this version is last version, else value is 0",
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"PreparedData" : {
"description" : "added via include \"PreparedData\"",
"type" : "object"
},
"VersionID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"ConfigItemID",
"CreateBy",
"CreateTime",
"CurDeplState",
"CurDeplStateID",
"CurDeplStateType",
"CurInciState",
"CurInciStateID",
"CurInciStateType",
"DeplState",
"DeplStateID",
"DeplStateType",
"InciState",
"InciStateID",
"InciStateType",
"IsLastVersion",
"Name",
"VersionID"
]
}
}
}
Example:
{
"ConfigItemVersion": [
{
"Class": "Computer",
"ClassID": 22,
"ConfigItemID": 82,
"CreateBy": 1,
"CreateTime": "2018-08-01 12:42:18",
"CurDeplState": "Production",
"CurDeplStateID": 32,
"CurDeplStateType": "productive",
"CurInciState": "Operational",
"CurInciStateID": 1,
"CurInciStateType": "operational",
"DeplState": "Production",
"DeplStateID": 32,
"DeplStateType": "productive",
"InciState": "Operational",
"InciStateID": 1,
"InciStateType": "operational",
"IsLastVersion": 0,
"Name": "test ci",
"Number": "1022000022",
"VersionID": 561
},
{
"Class": "Computer",
"ClassID": 22,
"ConfigItemID": 82,
"CreateBy": 1,
"CreateTime": "2018-08-01 15:57:55",
"CurDeplState": "Production",
"CurDeplStateID": 32,
"CurDeplStateType": "productive",
"CurInciState": "Operational",
"CurInciStateID": 1,
"CurInciStateType": "operational",
"DeplState": "Production",
"DeplStateID": 32,
"DeplStateType": "productive",
"InciState": "Operational",
"InciStateID": 1,
"InciStateType": "operational",
"IsLastVersion": 1,
"Name": "test ci 2",
"Number": "1022000022",
"VersionID": 562
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /cmdb/configitems/{configItemId}/versions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer |
Body
Media type: application/json
Type: ConfigItemVersionPostRequest
Schema:
{
"$id" : "ConfigItemVersionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version request object for creation.",
"type" : "object",
"properties" : {
"ConfigItemVersion" : {
"$ref" : "#/definitions/_ConfigItemVersionPostItem_json"
}
},
"required" : [
"ConfigItemVersion"
],
"definitions" : {
"_ConfigItemVersionPostItem_json" : {
"$id" : "ConfigItemVersionPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version request object for creation.",
"type" : "object",
"properties" : {
"Data" : {
"type" : "object"
},
"DeplStateID" : {
"type" : "integer"
},
"InciStateID" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
}
},
"required" : [
"Name",
"DeplStateID",
"InciStateID"
]
}
}
}
Example:
{
"ConfigItemVersion": {
"Name": "test ci 1",
"DeplStateID": 35,
"InciStateID": 2,
"Data": {
"Vendor": "testvendor",
"NIC": [
{
"NIC": "e1000",
"IPoverDHCP": [
38
],
"IPAddress": [
"192.168.1.0",
"192.168.1.1",
"192.168.1.2",
"192.168.1.3"
]
}
]
}
}
}Possible Responses
HTTP status code 201
The ConfigItemVersion has been created successfully.
Body
Media type: application/json
Type: ConfigItemVersionPostResponse
Schema:
{
"$id" : "ConfigItemVersionPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created config item version.",
"type" : "object",
"properties" : {
"VersionID" : {
"type" : "integer"
}
},
"required" : [
"VersionID"
]
}
Example:
{
"VersionID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/cmdb/configitems/{configItemId}/versions/{versionId} get
get /cmdb/configitems/{configItemId}/versions/{versionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer | |||
| versionId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemVersionResponse
Schema:
{
"$id" : "ConfigItemVersionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item version GET request.",
"type" : "object",
"properties" : {
"ConfigItemVersion" : {
"$ref" : "#/definitions/_ConfigItemVersion_json"
}
},
"required" : [
"ConfigItemVersion"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemVersion_json" : {
"$id" : "ConfigItemVersion.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item version object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"ConfigItemID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurDeplState" : {
"type" : "string",
"readOnly" : true
},
"CurDeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurDeplStateType" : {
"type" : "string",
"readOnly" : true
},
"CurInciState" : {
"type" : "string",
"readOnly" : true
},
"CurInciStateID" : {
"type" : "integer",
"readOnly" : true
},
"CurInciStateType" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"description" : "added via include \"Data\"",
"type" : "object"
},
"Definition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"DeplState" : {
"type" : "string",
"readOnly" : true
},
"DeplStateID" : {
"type" : "integer",
"readOnly" : true
},
"DeplStateType" : {
"type" : "string",
"readOnly" : true
},
"InciState" : {
"type" : "string",
"readOnly" : true
},
"InciStateID" : {
"type" : "integer",
"readOnly" : true
},
"InciStateType" : {
"type" : "string",
"readOnly" : true
},
"IsLastVersion" : {
"description" : " if this version is last version, else value is 0",
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"PreparedData" : {
"description" : "added via include \"PreparedData\"",
"type" : "object"
},
"VersionID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"ConfigItemID",
"CreateBy",
"CreateTime",
"CurDeplState",
"CurDeplStateID",
"CurDeplStateType",
"CurInciState",
"CurInciStateID",
"CurInciStateType",
"DeplState",
"DeplStateID",
"DeplStateType",
"InciState",
"InciStateID",
"InciStateType",
"IsLastVersion",
"Name",
"VersionID"
]
}
}
}
Example:
{
"ConfigItemVersion": {
"Class": "Computer",
"ClassID": 22,
"ConfigItemID": 82,
"CreateBy": 1,
"CreateTime": "2018-08-01 15:57:55",
"CurDeplState": "Production",
"CurDeplStateID": 32,
"CurDeplStateType": "productive",
"CurInciState": "Operational",
"CurInciStateID": 1,
"CurInciStateType": "operational",
"DeplState": "Production",
"DeplStateID": 32,
"DeplStateType": "productive",
"InciState": "Operational",
"InciStateID": 1,
"InciStateType": "operational",
"IsLastVersion": 1,
"Name": "rbo test ci 2",
"Number": "1022000022",
"VersionID": 562
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Downloading Attachments
Please note
The content is base64 encoded.
/cmdb/configitems/{configItemId}/versions/{versionId}/attachments/{attachmentId} get
get /cmdb/configitems/{configItemId}/versions/{versionId}/attachments/{attachmentId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| configItemId | integer | |||
| versionId | integer | |||
| attachmentId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemAttachmentResponse
Schema:
{
"$id" : "ConfigItemAttachmentResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item attachment GET request.",
"type" : "object",
"properties" : {
"Attachment" : {
"$ref" : "#/definitions/_ConfigItemAttachment_json"
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_ConfigItemAttachment_json" : {
"$id" : "ConfigItemAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item attachment object.",
"type" : "object",
"properties" : {
"AttachmentID" : {
"type" : "integer"
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"AttachmentID",
"ContentType",
"Content",
"Filesize",
"FilesizeRaw",
"Filename"
]
}
}
}
Example:
{
"Attachment": {
"AttachmentID": 14,
"Content": "...",
"ContentType": "image/png",
"Filename": "01_Ticketinfo-breit (3).png",
"Filesize": "219.6 KBytes",
"FilesizeRaw": 224831
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Contacts
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
TicketStats | Adds some statistics to the response, about the tickets of this contact. It will contain the number of tickets that are in a state of types "new" and "open", the number of pending tickets and the number of escalated tickets. |
AssignedConfigItems | Adds assigend configitems (as IDs) to the response. It can be expanded to get the relevant configitems. The Assignment is configured in sysconfig option AssignedConfigItemsMapping |
User | Adds the corresponding user to the response. If no user is assigned to this contact, the attribute is empty (the relevant "link" attribute is "AssignedUserID"). A User is necessary to allow access to the system for the contact (the contact itself contains only the personal data). |
DynamicFields | Includes the assigned Dynamic Fields and their prepared values. You can disable the preparation of specific DF types with the URI parameter NoDynamicFieldDisplayValues, which is a comma separated list of DF types. |
This resource supports a special search property
| Search | Description |
|---|---|
Fulltext | Searches with the given value in the following contact attributes: login, firstname, lastname, email, title, phone, fax, mobile, street, zip, city, country. Some logical operators are possible: "+" or "&" as AND, "|" as OR and "*" as any string, e.g. "john&doe" or "j*+doe|james" |
get /contacts
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ContactCollectionResponse
Schema:
{
"$id" : "ContactCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of contacts.",
"type" : "object",
"properties" : {
"Contact" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Contact_json"
}
}
},
"required" : [
"Contact"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Contact": [
{
"AssignedUserID": null,
"ChangeBy":1,
"ChangeTime":"2019-03-12 18:26:07",
"City":"Musterstadt",
"Comment":"",
"Country":"Germany",
"CreateBy":1,
"CreateTime":"2018-11-01 15:13:53",
"Email":"contact047@nomail.org",
"Fax":"",
"Firstname":"George",
"Fullname": "George Black",
"ID":102,
"Lastname":"Black",
"Login":"contact047",
"Mobile":"+49 170 111 222 333",
"OrganisationIDs":[
1,
2
],
"Phone":"+49 123 45 67 8",
"PrimaryOrganisationID":1,
"Street":"Musterstraße 1",
"Title":"Herr",
"ValidID":1,
"Zip":"12345"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /contacts
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ContactPostRequest
Schema:
{
"$id" : "ContactPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact request object for creation.",
"type" : "object",
"properties" : {
"Contact" : {
"type" : "object",
"properties" : {
"AssignedUserID" : {
"description" : "Id of an user, but should not be already in use for another contact.",
"type" : "integer"
},
"City" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Country" : {
"type" : "string"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Email" : {
"type" : "string"
},
"Fax" : {
"type" : "string"
},
"Firstname" : {
"type" : "string"
},
"Lastname" : {
"type" : "string"
},
"Mobile" : {
"type" : "string"
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"Phone" : {
"type" : "string"
},
"PrimaryOrganisationID" : {
"type" : "integer"
},
"Street" : {
"type" : "string"
},
"Title" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
},
"Zip" : {
"type" : "string"
}
},
"required" : [
"Firstname",
"Lastname",
"OrganisationIDs",
"PrimaryOrganisationID"
]
}
},
"required" : [
"Contact"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Contact": {
"Email": "mamu@example.org",
"Firstname": "Max",
"Lastname": "Mustermann",
"OrganisationIDs": [
1,
2
],
"PrimaryOrganisationID": 1
}
}Possible Responses
HTTP status code 201
The Contact has been created successfully.
Body
Media type: application/json
Type: ContactPostPatchResponse
Schema:
{
"$id" : "ContactPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated contact.",
"type" : "object",
"properties" : {
"ContactID" : {
"type" : "integer"
}
},
"required" : [
"ContactID"
]
}
Example:
{
"ContactID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /contacts/{contactId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| contactId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ContactResponse
Schema:
{
"$id" : "ContactResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a contact GET request.",
"type" : "object",
"properties" : {
"Contact" : {
"$ref" : "#/definitions/_Contact_json"
}
},
"required" : [
"Contact"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Contact": {
"AssignedConfigItems": [
33
],
"AssignedUserID": 3,
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:26:07",
"City": "Musterstadt",
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2018-11-01 15:13:53",
"Email": "john.doe@example.com",
"Fax": "",
"Firstname": "John",
"Fullname": "John Doe",
"ID": 102,
"Lastname": "Doe",
"Login": "jdoe",
"Mobile": "+49 170 111 222 333",
"OrganisationIDs": [
1,
2
],
"Phone": "+49 123 45 67 8",
"PrimaryOrganisationID": 1,
"Street": "Musterstraße 1",
"TicketStats": {
"EscalatedCount": 0,
"NewCount": 2,
"OpenCount": 4,
"PendingReminderCount": 1
},
"Title": "Herr",
"User": {
"ChangeBy": 1,
"ChangeTime": "2018-10-01 12:01:53",
"CreateBy": 1,
"CreateTime": "2019-03-15 18:59:54",
"IsAgent": 1,
"IsCustomer": 0,
"UsageContext": 1,
"UserComment": null,
"UserID": 3,
"UserLogin": "jdoe",
"ValidID": 1
},
"ValidID": 1,
"Zip": "12345"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /contacts/{contactId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| contactId | integer |
Body
Media type: application/json
Type: ContactPatchRequest
Schema:
{
"$id" : "ContactPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact request object for update.",
"type" : "object",
"properties" : {
"Contact" : {
"type" : "object",
"properties" : {
"AssignedUserID" : {
"description" : "Id of an user, but should not be already in use for another contact.",
"type" : "integer"
},
"City" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Country" : {
"type" : "string"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set (if no new value given, an already exiting value will be unchanged)",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Email" : {
"type" : "string"
},
"Fax" : {
"type" : "string"
},
"Firstname" : {
"type" : "string"
},
"Lastname" : {
"type" : "string"
},
"Mobile" : {
"type" : "string"
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"Phone" : {
"type" : "string"
},
"PrimaryOrganisationID" : {
"type" : "integer"
},
"Street" : {
"type" : "string"
},
"Title" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
},
"Zip" : {
"type" : "string"
}
}
}
},
"required" : [
"Contact"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Contact": {
"Title": "Dr."
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ContactPostPatchResponse
Schema:
{
"$id" : "ContactPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated contact.",
"type" : "object",
"properties" : {
"ContactID" : {
"type" : "integer"
}
},
"required" : [
"ContactID"
]
}
Example:
{
"ContactID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /contacts/{contactId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| contactId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/contacts/{contactId}/tickets get
get /contacts/{contactId}/tickets
Get all Ticket items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| contactId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketCollectionResponse
Schema:
{
"$id" : "TicketCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of tickets.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
}
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Ticket": [
{
"Age": 1316865,
"ChangeBy": 1,
"Changed": "2020-04-24 13:23:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:25:15",
"DynamicFields": [
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 5,
"Label": "Plan Begin",
"Name": "PlanBegin",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
},
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 6,
"Label": "Plan End",
"Name": "PlanEnd",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
}
],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 5,
"QueueID": 3,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 49,
"TicketNumber": "2020040917000014",
"Title": "Some title",
"TypeID": 1,
"Unseen": 0,
"UntilTime": 0
},
{
"Age": 1316731,
"ChangeBy": 1,
"Changed": "2020-04-24 13:24:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:28:19",
"DynamicFields": [],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 3,
"QueueID": 2,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 50,
"TicketNumber": "2020040917000015",
"Title": "another title",
"TypeID": 2,
"Unseen": 0,
"UntilTime": 0,
"WatcherID": 101
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
FAQ
The top-level /faq resource is no collection resource itself. It's purpose is to act as a container for all the FAQ related resources.
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
Rating | Adds the number of votes and the average rating |
DynamicFields | Includes the assigned Dynamic Fields and their prepared values. You can disable the preparation of specific DF types with the URI parameter NoDynamicFieldDisplayValues, which is a comma separated list of DF types. |
get /faq/articles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQArticleCollectionResponse
Schema:
{
"$id" : "FAQArticleCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all FAQ articles.",
"type" : "object",
"properties" : {
"FAQArticle" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQArticle_json"
}
}
},
"required" : [
"FAQArticle"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_FAQArticle_json" : {
"$id" : "FAQArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article object.",
"type" : "object",
"properties" : {
"Approved" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachment_json"
},
"readOnly" : true
},
"CategoryID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Field1" : {
"description" : "symptom",
"type" : "string",
"readOnly" : true
},
"Field2" : {
"description" : "problem",
"type" : "string",
"readOnly" : true
},
"Field3" : {
"description" : "solution",
"type" : "string",
"readOnly" : true
},
"Field4" : {
"type" : "string",
"readOnly" : true
},
"Field5" : {
"type" : "string",
"readOnly" : true
},
"Field6" : {
"description" : "comment",
"type" : "string",
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQHistory_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "added via include \"Rating\"",
"type" : "number",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"VoteCount" : {
"description" : "added via include \"Rating\"",
"type" : "integer",
"readOnly" : true
},
"Votes" : {
"description" : "added via include \"Votes\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQVote_json"
},
"readOnly" : true
}
},
"required" : [
"Approved",
"CategoryID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"CustomerVisible",
"Field1",
"Field2",
"Field3",
"Field4",
"Field5",
"Field6",
"ID",
"Keywords",
"Language",
"LinkCount",
"Name",
"Number",
"Title",
"ValidID"
]
},
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
},
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQArticle": [
{
"Approved": 1,
"CategoryID": 2,
"Changed": "2019-08-09 08:13:38",
"ChangedBy": 1,
"ContentType": "text/html",
"Created": "2019-08-09 08:13:38",
"CreatedBy": 1,
"CustomerVisible": 1,
"DynamicFields": [],
"Field1": "",
"Field2": "<p><span style=\"font-size:small\">Es wird ein erster Überblick benötigt, wie mit KIX Cloud gearbeitet werden kann.</span></p>\n",
"Field3": "<p><span style=\"font-size:small\"><b>Hinweise zum Aufbau</b></span></p>\n\n<p><span style=\"font-size:small\">Die Anwendung ist aufgebaut aus Modul [...] Wie suche ich mit KIX </span><span style=\"font-size:small\">Cloud</span><span style=\"font-size:small\">".</span></p>\n",
"Field4": "",
"Field5": "",
"Field6": "",
"ID": 1,
"Keywords": [],
"Language": "de",
"LinkCount": 0,
"Name": "1563537571-45.0767307683304",
"Number": "17001",
"Title": "Allgemeine Hinweise zum Arbeiten mit KIX 18",
"ValidID": 1
},
{
"Approved": 1,
"CategoryID": 2,
"Changed": "2019-08-09 08:13:38",
"ChangedBy": 1,
"ContentType": "text/html",
"Created": "2019-08-09 08:13:38",
"CreatedBy": 1,
"CustomerVisible": 1,
"DynamicFields": [
{
"DisplayValue": "Prometheus, Zeus",
"DisplayValueHTML": "Prometheus, Zeus",
"DisplayValueShort": "Prometheus, Zeus",
"ID": 34,
"Label": "Related Assets",
"Name": "RelatedAssets",
"PreparedValue": [
"Prometheus",
"Zeus"
],
"Value": [
"2",
"4"
]
}
],
"Field1": "",
"Field2": "<p><span style=\"font-size:small\">It is necessary to get a first overview on how to work with KIX Cloud.</span></p>\n",
"Field3": "<p><span style=\"font-size:small\"><b>Structure</b></span></p>\n\n<p><span style=\"font-size:small\">The application consists in a Modul [...] How to search in KIX 18“.</span></span></span></p>\n",
"Field4": "",
"Field5": "",
"Field6": "",
"ID": 2,
"Keywords": [],
"Language": "en",
"LinkCount": 1,
"Name": "1563537503-86.2410868161835",
"Number": "17002",
"Title": "General information on how to work with KIX 18",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /faq/articles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: FAQArticlePostRequest
Schema:
{
"$id" : "FAQArticlePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article request object for create.",
"type" : "object",
"properties" : {
"FAQArticle" : {
"type" : "object",
"properties" : {
"ApprovalOff" : {
"description" : "if set to 1 approval is ignored",
"type" : "integer"
},
"Approved" : {
"type" : "integer"
},
"Attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachmentPostItem_json"
}
},
"CategoryID" : {
"type" : "integer"
},
"ContentType" : {
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Field1" : {
"description" : "symptom",
"type" : "string"
},
"Field2" : {
"description" : "problem",
"type" : "string"
},
"Field3" : {
"description" : "solution",
"type" : "string"
},
"Field4" : {
"type" : "string"
},
"Field5" : {
"type" : "string"
},
"Field6" : {
"description" : "comment",
"type" : "string"
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
}
},
"Language" : {
"type" : "string"
},
"Number" : {
"type" : "string"
},
"Title" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"CategoryID",
"Title"
]
}
},
"required" : [
"FAQArticle"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
},
"_FAQAttachmentPostItem_json" : {
"$id" : "FAQAttachmentPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment request object for creation.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "base64 encoded file content string",
"type" : "string"
},
"ContentType" : {
"description" : "if not given, fallback to SysConfig FAQ::Attachment::ContentType::Fallback",
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"Filename" : {
"type" : "string"
},
"Inline" : {
"description" : " if attachment is an inline attachment of a text field property (e.g. \"Field1\") or 0 if not",
"type" : "integer"
}
},
"required" : [
"Content",
"Filename"
]
}
}
}
Example:
{
"FAQArticle": {
"Approved": 1,
"Attachments": [
{
"Content": "base64 coded file content",
"ContentType": "text/xml",
"Filename": "somename.xml",
"Inline": 0
}
],
"CategoryID": 2,
"ContentType": "text/html",
"CustomerVisible": 1,
"DynamicFields": [
{
"Name": "RelatedAssets",
"Value": [
2
]
}
],
"Field1": "some symptom",
"Field2": "problem",
"Field3": "solution",
"Field4": "",
"Field5": "",
"Field6": "comment",
"ID": 2,
"Keywords": [
"some",
"keyword"
],
"Language": "en",
"Number": "17002",
"Title": "Some title",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The FAQArticle has been created successfully.
Body
Media type: application/json
Type: FAQArticlePostPatchResponse
Schema:
{
"$id" : "FAQArticlePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ article.",
"type" : "object",
"properties" : {
"FAQArticleID" : {
"type" : "integer"
}
},
"required" : [
"FAQArticleID"
]
}
Example:
{
"FAQArticleID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /faq/articles/{faqArticleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQArticleResponse
Schema:
{
"$id" : "FAQArticleResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a execution FAQ article GET request.",
"type" : "object",
"properties" : {
"FAQArticle" : {
"$ref" : "#/definitions/_FAQArticle_json"
}
},
"required" : [
"FAQArticle"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_FAQArticle_json" : {
"$id" : "FAQArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article object.",
"type" : "object",
"properties" : {
"Approved" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachment_json"
},
"readOnly" : true
},
"CategoryID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Field1" : {
"description" : "symptom",
"type" : "string",
"readOnly" : true
},
"Field2" : {
"description" : "problem",
"type" : "string",
"readOnly" : true
},
"Field3" : {
"description" : "solution",
"type" : "string",
"readOnly" : true
},
"Field4" : {
"type" : "string",
"readOnly" : true
},
"Field5" : {
"type" : "string",
"readOnly" : true
},
"Field6" : {
"description" : "comment",
"type" : "string",
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQHistory_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "added via include \"Rating\"",
"type" : "number",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"VoteCount" : {
"description" : "added via include \"Rating\"",
"type" : "integer",
"readOnly" : true
},
"Votes" : {
"description" : "added via include \"Votes\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQVote_json"
},
"readOnly" : true
}
},
"required" : [
"Approved",
"CategoryID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"CustomerVisible",
"Field1",
"Field2",
"Field3",
"Field4",
"Field5",
"Field6",
"ID",
"Keywords",
"Language",
"LinkCount",
"Name",
"Number",
"Title",
"ValidID"
]
},
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
},
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQArticle": {
"Approved": 1,
"CategoryID": 2,
"Changed": "2019-08-09 08:13:38",
"ChangedBy": 1,
"ContentType": "text/html",
"Created": "2019-08-09 08:13:38",
"CreatedBy": 1,
"CustomerVisible": 1,
"DynamicFields": [
{
"DisplayValue": "Prometheus, Zeus",
"DisplayValueHTML": "Prometheus, Zeus",
"DisplayValueShort": "Prometheus, Zeus",
"ID": 34,
"Label": "Related Assets",
"Name": "RelatedAssets",
"PreparedValue": [
"Prometheus",
"Zeus"
],
"Value": [
"2",
"4"
]
}
],
"Field1": "",
"Field2": "<p><span style=\"font-size:small\">It is necessary to get a first overview on how to work with KIX Cloud.</span></p>\n",
"Field3": "<p><span style=\"font-size:small\"><b>Structure</b></span></p>\n\n<p><span style=\"font-size:small\">The application consists in a Modul [...] How to search in KIX 18“.</span></span></span></p>\n",
"Field4": "",
"Field5": "",
"Field6": "",
"ID": 2,
"Keywords": [],
"Language": "en",
"LinkCount": 0,
"Name": "1563537503-86.2410868161835",
"Number": "17002",
"Title": "General information on how to work with KIX 18",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /faq/articles/{faqArticleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Body
Media type: application/json
Type: FAQArticlePatchRequest
Schema:
{
"$id" : "FAQArticlePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article request object for update.",
"type" : "object",
"properties" : {
"FAQArticle" : {
"type" : "object",
"properties" : {
"ApprovalOff" : {
"description" : "if set to 1 approval is ignored",
"type" : "integer"
},
"Approved" : {
"type" : "integer"
},
"CategoryID" : {
"type" : "integer"
},
"ContentType" : {
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set (if no new value given, an already exiting value will be unchanged)",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Field1" : {
"description" : "symptom",
"type" : "string"
},
"Field2" : {
"description" : "problem",
"type" : "string"
},
"Field3" : {
"description" : "solution",
"type" : "string"
},
"Field4" : {
"type" : "string"
},
"Field5" : {
"type" : "string"
},
"Field6" : {
"description" : "comment",
"type" : "string"
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
}
},
"Language" : {
"type" : "string"
},
"Number" : {
"type" : "string"
},
"Title" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"FAQArticle"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"FAQArticle": {
"Approved": 1,
"CategoryID": 2,
"ContentType": "text/html",
"CustomerVisible": 2,
"DynamicFields": [
{
"Name": "RelatedAssets",
"Value": [
4
]
}
],
"Field3": "changed text",
"Keywords": [
"new keyword"
],
"Title": "New title",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQArticlePostPatchResponse
Schema:
{
"$id" : "FAQArticlePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ article.",
"type" : "object",
"properties" : {
"FAQArticleID" : {
"type" : "integer"
}
},
"required" : [
"FAQArticleID"
]
}
Example:
{
"FAQArticleID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /faq/articles/{faqArticleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Downloading Attachments
Please note
The content is base64 encoded and have to be included as "Content".
get /faq/articles/{faqArticleId}/attachments
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQAttachmentCollectionResponse
Schema:
{
"$id" : "FAQAttachmentCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all FAQ attachments of an FAQ article.",
"type" : "object",
"properties" : {
"Attachment" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachment_json"
}
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
}
}
}
Example:
{
"Attachment": [
{
"ArticleID": 1,
"Changed": "2019-08-09 08:13:38",
"ChangedBy": 1,
"ContentID": "<pasted.1563537680.585160@yourhost.example.com>",
"ContentType": "img/png",
"Created": "2019-08-09 08:13:38",
"CreatedBy": 1,
"Disposition": "inline",
"Filename": "pasted-1563537680-407593.png",
"Filesize": "106.8 KBytes",
"FilesizeRaw": "109337",
"ID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /faq/articles/{faqArticleId}/attachments
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Body
Media type: application/json
Type: FAQAttachmentPostRequest
Schema:
{
"$id" : "FAQAttachmentPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment request object for create.",
"type" : "object",
"properties" : {
"Attachment" : {
"$ref" : "#/definitions/_FAQAttachmentPostItem_json"
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_FAQAttachmentPostItem_json" : {
"$id" : "FAQAttachmentPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment request object for creation.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "base64 encoded file content string",
"type" : "string"
},
"ContentType" : {
"description" : "if not given, fallback to SysConfig FAQ::Attachment::ContentType::Fallback",
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"Filename" : {
"type" : "string"
},
"Inline" : {
"description" : " if attachment is an inline attachment of a text field property (e.g. \"Field1\") or 0 if not",
"type" : "integer"
}
},
"required" : [
"Content",
"Filename"
]
}
}
}
Example:
{
"Attachment": {
"Content": "base64 encoded file content",
"ContentType": "text/xml",
"Filename": "somename.xml",
"Inline": 0
}
}Possible Responses
HTTP status code 201
The FAQAttachment has been created successfully.
Body
Media type: application/json
Type: FAQAttachmentPostPatchResponse
Schema:
{
"$id" : "FAQAttachmentPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ attachment.",
"type" : "object",
"properties" : {
"FAQAttachmentID" : {
"type" : "integer"
}
},
"required" : [
"FAQAttachmentID"
]
}
Example:
{
"FAQAttachmentID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /faq/articles/{faqArticleId}/attachments/{faqAttachmentId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer | |||
| faqAttachmentId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQAttachmentResponse
Schema:
{
"$id" : "FAQAttachmentResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a execution FAQ attachment GET request.",
"type" : "object",
"properties" : {
"Attachment" : {
"$ref" : "#/definitions/_FAQAttachment_json"
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
}
}
}
Example:
{
"Attachment": {
"ArticleID": 1,
"Changed": "2019-08-09 08:13:38",
"ChangedBy": 1,
"ContentID": "<pasted.1563537680.585160@yourhost.example.com>",
"ContentType": "img/png",
"Content": "some base64 content string",
"Created": "2019-08-09 08:13:38",
"CreatedBy": 1,
"Disposition": "inline",
"Filename": "pasted-1563537680-407593.png",
"Filesize": "106.8 KBytes",
"FilesizeRaw": "109337",
"ID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /faq/articles/{faqArticleId}/attachments/{faqAttachmentId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer | |||
| faqAttachmentId | string | |||
| classId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
History of a FAQ article
/faq/articles/{faqArticleId}/history get
get /faq/articles/{faqArticleId}/history
Get all FAQHistory items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQHistoryCollectionResponse
Schema:
{
"$id" : "FAQHistoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all FAQ history entries of an FAQ article.",
"type" : "object",
"properties" : {
"FAQHistory" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQHistory_json"
}
}
},
"required" : [
"FAQHistory"
],
"definitions" : {
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
}
}
}
Example:
{
"FAQHistory": [
{
"ArticleID": 1,
"Created": "2020-02-10 13:41:06",
"CreatedBy": 1,
"ID": 10,
"Name": "Updated"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/faq/articles/{faqArticleId}/history/{faqAttachmentId} get
get /faq/articles/{faqArticleId}/history/{faqAttachmentId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer | |||
| faqAttachmentId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQHistoryResponse
Schema:
{
"$id" : "FAQHistoryResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a execution FAQ history GET request.",
"type" : "object",
"properties" : {
"FAQHistory" : {
"$ref" : "#/definitions/_FAQHistory_json"
}
},
"required" : [
"FAQHistory"
],
"definitions" : {
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
}
}
}
Example:
{
"FAQHistory": {
"ArticleID": 1,
"Created": "2020-02-10 13:41:06",
"CreatedBy": 1,
"ID": 10,
"Name": "Updated"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Votes of a FAQ article
get /faq/articles/{faqArticleId}/votes
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQVoteCollectionResponse
Schema:
{
"$id" : "FAQVoteCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all votes of an FAQ article.",
"type" : "object",
"properties" : {
"FAQVote" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQVote_json"
}
}
},
"required" : [
"FAQVote"
],
"definitions" : {
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQVote": [
{
"ArticleID": 5,
"Created": "2020-02-10 13:29:17",
"CreatedBy": "max.mustermann@nomail.org",
"ID": 1,
"IPAddress": "1.1.1.1",
"Interface": "agent",
"Rating": 2
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /faq/articles/{faqArticleId}/votes
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer |
Body
Media type: application/json
Type: FAQVotePostRequest
Schema:
{
"$id" : "FAQVotePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote request object for create.",
"type" : "object",
"properties" : {
"FAQVote" : {
"type" : "object",
"properties" : {
"CreatedBy" : {
"type" : "string"
},
"IPAddress" : {
"type" : "string"
},
"Interface" : {
"description" : "\"agent\" or \"customer\"",
"type" : "string"
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer"
}
},
"required" : [
"IPAddress",
"Interface",
"Rating"
]
}
},
"required" : [
"FAQVote"
]
}
Example:
{
"FAQVote": {
"CreatedBy": "max.mustermann@nomail.org",
"IPAddress": "1.1.1.1",
"Interface": "agent",
"Rating": 2
}
}Possible Responses
HTTP status code 201
The FAQVote has been created successfully.
Body
Media type: application/json
Type: FAQVotePostPatchResponse
Schema:
{
"$id" : "FAQVotePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ vote.",
"type" : "object",
"properties" : {
"FAQVoteID" : {
"type" : "integer"
}
},
"required" : [
"FAQVoteID"
]
}
Example:
{
"FAQVoteID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /faq/articles/{faqArticleId}/votes/{faqVoteId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer | |||
| faqVoteId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQVoteResponse
Schema:
{
"$id" : "FAQVoteResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a execution FAQ vote GET request.",
"type" : "object",
"properties" : {
"FAQVote" : {
"$ref" : "#/definitions/_FAQVote_json"
}
},
"required" : [
"FAQVote"
],
"definitions" : {
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQVote": {
"ArticleID": 5,
"Created": "2020-02-10 13:29:17",
"CreatedBy": "1",
"ID": 1,
"IPAddress": "1.1.1.1",
"Interface": "agent",
"Rating": 2
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /faq/articles/{faqArticleId}/votes/{faqVoteId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqArticleId | string | |||
| classId | integer | |||
| faqVoteId | string | |||
| classId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Keywords used
This resource returns a list of all existing keywords in the FAQ.
/faq/articles/keywords get
get /faq/articles/keywords
Get all FAQKeyword items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQKeywordCollectionResponse
Schema:
{
"$id" : "FAQKeywordCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all FAQ article keywords.",
"type" : "object",
"properties" : {
"FAQKeyword" : {
"type" : "array",
"items" : {
"type" : "string",
"readOnly" : true
}
}
},
"required" : [
"FAQKeyword"
]
}
Example:
{
"FAQKeyword": [
"Database",
"Incident",
"Password",
"Printer",
"Sales"
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
i18n
The top-level /i18n resource is no collection resource itself. It's purpose is to act as a container for all the i18n related resources.
/i18n/translations get
get /i18n/translations
Get all Translation items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TranslationCollectionResponse
Schema:
{
"$id" : "TranslationCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of translations.",
"type" : "object",
"properties" : {
"Translation" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Languages" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "string",
"readOnly" : true
}
}
},
"Pattern" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Languages",
"Pattern"
]
}
}
},
"required" : [
"Translation"
]
}
Example:
{
"Translation": [
{
"Pattern": "Incident",
"Languages": {
"de": "Störung"
}
},
{
"Pattern": "Delete this item ?",
"Languages": {
"de": "Diesen Eintrag löschen ?"
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Links
get /links
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LinkCollectionResponse
Schema:
{
"$id" : "LinkCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of links.",
"type" : "object",
"properties" : {
"Link" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Link_json"
}
}
},
"required" : [
"Link"
],
"definitions" : {
"_Link_json" : {
"$id" : "Link.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The link object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"SourceKey" : {
"description" : "The primary ID of the source object.",
"type" : "string",
"readOnly" : true
},
"SourceObject" : {
"description" : "The type of the source object. See resource /links/types for possible object types.",
"type" : "string",
"readOnly" : true
},
"TargetKey" : {
"description" : "The primary ID of the target object.",
"type" : "string",
"readOnly" : true
},
"TargetObject" : {
"description" : "The type of the target object. See resource /links/types for possible object types.",
"type" : "string",
"readOnly" : true
},
"Type" : {
"description" : "One of the available link types from resource /links/types.",
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"ID",
"SourceKey",
"SourceObject",
"TargetKey",
"TargetObject",
"Type"
]
}
}
}
Example:
{
"Link": [
{
"CreateBy": 1,
"CreateTime": "2009-01-20 09:27:53",
"ID": 1781974,
"SourceKey": "180",
"SourceObject": "Ticket",
"TargetKey": "22",
"TargetObject": "Ticket",
"Type": "Normal"
},
{
"CreateBy": 1,
"CreateTime": "2017-12-21 16:54:26",
"ID": 2208907,
"SourceKey": "1",
"SourceObject": "Ticket",
"TargetKey": "2",
"TargetObject": "Ticket",
"Type": "Normal"
},
{
"CreateBy": 1,
"CreateTime": "2017-12-27 12:16:54",
"ID": 2208908,
"SourceKey": "1",
"SourceObject": "Ticket",
"TargetKey": "3",
"TargetObject": "Ticket",
"Type": "Normal"
},
{
"CreateBy": 1,
"CreateTime": "2017-12-27 12:23:03",
"ID": 2208909,
"SourceKey": "1",
"SourceObject": "Ticket",
"TargetKey": "4",
"TargetObject": "Ticket",
"Type": "Normal"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /links
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: LinkPostRequest
Schema:
{
"$id" : "LinkPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The link request object for creation.",
"type" : "object",
"properties" : {
"Link" : {
"type" : "object",
"properties" : {
"SourceKey" : {
"description" : "The primary ID of the source object.",
"type" : "string"
},
"SourceObject" : {
"description" : "The type of the source object. See resource /links/types for possible object types.",
"type" : "string"
},
"TargetKey" : {
"description" : "The primary ID of the target object.",
"type" : "string"
},
"TargetObject" : {
"description" : "The type of the target object. See resource /links/types for possible object types.",
"type" : "string"
},
"Type" : {
"description" : "One of the available link types from resource /links/types.",
"type" : "string"
}
},
"required" : [
"SourceKey",
"SourceObject",
"TargetKey",
"TargetObject",
"Type"
]
}
},
"required" : [
"Link"
]
}
Example:
{
"Link": {
"SourceKey": "180",
"SourceObject": "Ticket",
"TargetKey": "22",
"TargetObject": "Ticket",
"Type": "Normal"
}
}Possible Responses
HTTP status code 201
The Link has been created successfully.
Body
Media type: application/json
Type: LinkPostResponse
Schema:
{
"$id" : "LinkPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created link.",
"type" : "object",
"properties" : {
"LinkID" : {
"type" : "integer"
}
},
"required" : [
"LinkID"
]
}
Example:
{
"LinkID": 123456
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/links/types get
get /links/types
Get all LinkType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LinkTypeCollectionResponse
Schema:
{
"$id" : "LinkTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of link types.",
"type" : "object",
"properties" : {
"LinkType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_LinkType_json"
}
}
},
"required" : [
"LinkType"
],
"definitions" : {
"_LinkType_json" : {
"$id" : "LinkType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The link type object.",
"type" : "object",
"properties" : {
"Name" : {
"type" : "string",
"readOnly" : true
},
"Pointed" : {
"description" : "If set to 1, what is source and what is target matters.",
"type" : "integer",
"readOnly" : true
},
"Source" : {
"description" : "The type of the source object.",
"type" : "string",
"readOnly" : true
},
"SourceName" : {
"description" : "The name of the link when viewed from the target object.",
"type" : "string",
"readOnly" : true
},
"Target" : {
"description" : "The type of the target object.",
"type" : "string",
"readOnly" : true
},
"TargetName" : {
"description" : "The name of the link when viewed from the source object.",
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Name",
"Pointed",
"Source",
"SourceName",
"Target",
"TargetName",
"TypeID"
]
}
}
}
Example:
{
"LinkType": [
{
"Name": "Normal",
"Pointed": 0,
"Source": "Ticket",
"SourceName": "Normal",
"Target": "Ticket",
"TargetName": "Normal",
"TypeID": 1
},
{
"Name": "ParentChild",
"Pointed": 1,
"Source": "Ticket",
"SourceName": "Parent",
"Target": "Ticket",
"TargetName": "Child",
"TypeID": 2
},
{
"Name": "Normal",
"Pointed": 0,
"Source": "Ticket",
"SourceName": "Normal",
"Target": "FAQArticle",
"TargetName": "Normal",
"TypeID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /links/{linkId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| linkId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LinkResponse
Schema:
{
"$id" : "LinkResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a link GET request.",
"type" : "object",
"properties" : {
"Link" : {
"$ref" : "#/definitions/_Link_json"
}
},
"required" : [
"Link"
],
"definitions" : {
"_Link_json" : {
"$id" : "Link.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The link object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"SourceKey" : {
"description" : "The primary ID of the source object.",
"type" : "string",
"readOnly" : true
},
"SourceObject" : {
"description" : "The type of the source object. See resource /links/types for possible object types.",
"type" : "string",
"readOnly" : true
},
"TargetKey" : {
"description" : "The primary ID of the target object.",
"type" : "string",
"readOnly" : true
},
"TargetObject" : {
"description" : "The type of the target object. See resource /links/types for possible object types.",
"type" : "string",
"readOnly" : true
},
"Type" : {
"description" : "One of the available link types from resource /links/types.",
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"ID",
"SourceKey",
"SourceObject",
"TargetKey",
"TargetObject",
"Type"
]
}
}
}
Example:
{
"Link": {
"CreateBy": 1,
"CreateTime": "2009-01-20 09:27:53",
"ID": 1781974,
"SourceKey": "180",
"SourceObject": "Ticket",
"TargetKey": "22",
"TargetObject": "Ticket",
"Type": "Normal"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /links/{linkId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| linkId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Organisations
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
TicketStats | Adds some statistics to the response, about the tickets of this organisation. It will contain the number of tickets that are in a state of types "new" and "open", the number of pending tickets and the number of escalated tickets. |
AssignedConfigItems | Adds assigend configitems (as IDs) to the response. It can be expanded to get the relevant configitems. The Assignment is configured in sysconfig option AssignedConfigItemsMapping |
User | If the corresponding contacts are included, this adds the corresponding users on their contacts. If the contacts are not included, this has no effect. |
DynamicFields | Includes the assigned Dynamic Fields and their prepared values. You can disable the preparation of specific DF types with the URI parameter NoDynamicFieldDisplayValues, which is a comma separated list of DF types. |
get /organisations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OrganisationCollectionResponse
Schema:
{
"$id" : "OrganisationCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of organisations.",
"type" : "object",
"properties" : {
"Organisation" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Organisation_json"
}
}
},
"required" : [
"Organisation"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_Organisation_json" : {
"$id" : "Organisation.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The organisation object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Contacts" : {
"description" : "added via include \"Contacts\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Contact_json"
},
"readOnly" : true
},
"Country" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Street" : {
"type" : "string",
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Url" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Number",
"ValidID"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Organisation": [
{
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:18",
"City": "Rostock",
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2018-11-01 14:21:35",
"ID": 10,
"Name": "Albatros Reederei",
"Number": "ALB",
"Street": "Kurfürstendamm 89",
"Url": "http://www.albatros-shipping.eu",
"ValidID": 1,
"Zip": "18010"
},
{
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:18",
"City": "Iserlohn",
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2018-11-01 14:21:35",
"ID": 11,
"Name": "Delta-Hertz EDV-Beratung",
"Number": "DHZ",
"Street": "Knesebeckstraße 47",
"Url": "http://www.delta-hertz-edv.de",
"ValidID": 1,
"Zip": "58644"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /organisations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: OrganisationPostRequest
Schema:
{
"$id" : "OrganisationPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The organisation request object for creation.",
"type" : "object",
"properties" : {
"Organisation" : {
"type" : "object",
"properties" : {
"City" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Country" : {
"type" : "string"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Name" : {
"type" : "string"
},
"Number" : {
"type" : "string"
},
"Street" : {
"type" : "string"
},
"Url" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
},
"Zip" : {
"type" : "string"
}
},
"required" : [
"Name",
"Number"
]
}
},
"required" : [
"Organisation"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Organisation": {
"Number": "K12345678",
"Name": "Test Organisation 123"
}
}Possible Responses
HTTP status code 201
The Organisation has been created successfully.
Body
Media type: application/json
Type: OrganisationPostPatchResponse
Schema:
{
"$id" : "OrganisationPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated organisation.",
"type" : "object",
"properties" : {
"OrganisationID" : {
"type" : "integer"
}
},
"required" : [
"OrganisationID"
]
}
Example:
{
"OrganisationID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /organisations/{organisationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| organisationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OrganisationResponse
Schema:
{
"$id" : "OrganisationResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a organisation GET request.",
"type" : "object",
"properties" : {
"Organisation" : {
"$ref" : "#/definitions/_Organisation_json"
}
},
"required" : [
"Organisation"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_Organisation_json" : {
"$id" : "Organisation.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The organisation object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Contacts" : {
"description" : "added via include \"Contacts\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Contact_json"
},
"readOnly" : true
},
"Country" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Street" : {
"type" : "string",
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Url" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Number",
"ValidID"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Organisation": {
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:18",
"City": "Rostock",
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2018-11-01 14:21:35",
"ID": 10,
"Name": "Albatros Reederei",
"Number": "ALB",
"Street": "Kurfürstendamm 89",
"Url": "http://www.albatros-shipping.eu",
"ValidID": 1,
"Zip": "18010"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /organisations/{organisationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| organisationId | integer |
Body
Media type: application/json
Type: OrganisationPatchRequest
Schema:
{
"$id" : "OrganisationPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The organisation request object for update.",
"type" : "object",
"properties" : {
"Organisation" : {
"type" : "object",
"properties" : {
"City" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Country" : {
"type" : "string"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set (if no new value given, an already exiting value will be unchanged)",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"Name" : {
"type" : "string"
},
"Number" : {
"type" : "string"
},
"Street" : {
"type" : "string"
},
"Url" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
},
"Zip" : {
"type" : "string"
}
}
}
},
"required" : [
"Organisation"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Organisation": {
"City": "Rostock"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OrganisationPostPatchResponse
Schema:
{
"$id" : "OrganisationPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated organisation.",
"type" : "object",
"properties" : {
"OrganisationID" : {
"type" : "integer"
}
},
"required" : [
"OrganisationID"
]
}
Example:
{
"OrganisationID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /organisations/{organisationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| organisationId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/organisations/{organisationId}/contacts get
get /organisations/{organisationId}/contacts
Get all Contact items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| organisationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ContactCollectionResponse
Schema:
{
"$id" : "ContactCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of contacts.",
"type" : "object",
"properties" : {
"Contact" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Contact_json"
}
}
},
"required" : [
"Contact"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Contact": [
{
"AssignedUserID": null,
"ChangeBy":1,
"ChangeTime":"2019-03-12 18:26:07",
"City":"Musterstadt",
"Comment":"",
"Country":"Germany",
"CreateBy":1,
"CreateTime":"2018-11-01 15:13:53",
"Email":"contact047@nomail.org",
"Fax":"",
"Firstname":"George",
"Fullname": "George Black",
"ID":102,
"Lastname":"Black",
"Login":"contact047",
"Mobile":"+49 170 111 222 333",
"OrganisationIDs":[
1,
2
],
"Phone":"+49 123 45 67 8",
"PrimaryOrganisationID":1,
"Street":"Musterstraße 1",
"Title":"Herr",
"ValidID":1,
"Zip":"12345"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/organisations/{organisationId}/tickets get
get /organisations/{organisationId}/tickets
Get all Ticket items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| organisationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketCollectionResponse
Schema:
{
"$id" : "TicketCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of tickets.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
}
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Ticket": [
{
"Age": 1316865,
"ChangeBy": 1,
"Changed": "2020-04-24 13:23:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:25:15",
"DynamicFields": [
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 5,
"Label": "Plan Begin",
"Name": "PlanBegin",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
},
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 6,
"Label": "Plan End",
"Name": "PlanEnd",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
}
],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 5,
"QueueID": 3,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 49,
"TicketNumber": "2020040917000014",
"Title": "Some title",
"TypeID": 1,
"Unseen": 0,
"UntilTime": 0
},
{
"Age": 1316731,
"ChangeBy": 1,
"Changed": "2020-04-24 13:24:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:28:19",
"DynamicFields": [],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 3,
"QueueID": 2,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 50,
"TicketNumber": "2020040917000015",
"Title": "another title",
"TypeID": 2,
"Unseen": 0,
"UntilTime": 0,
"WatcherID": 101
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Reporting
The top-level /reporting resource is no collection resource itself. It's purpose is to act as a container for all the Reporting resources.
Report Data Sources
A report definition is based on a specific data source for the data contained in the report. Each of the available data sources has specific options and is described by this resource.
/reporting/datasources get
get /reporting/datasources
Get all DataSource items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DataSourceCollectionResponse
Schema:
{
"$id" : "DataSourceCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of data sources.",
"type" : "object",
"properties" : {
"DataSource" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DataSource_json"
}
}
},
"required" : [
"DataSource"
],
"definitions" : {
"_DataSource_json" : {
"$id" : "DataSource.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report data source object.",
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Options" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Label",
"Name"
]
}
}
}
},
"required" : [
"Description",
"Name"
]
}
}
}
Example:
{
"DataSource": [
{
"Description": "Allows to retrieve report data based on an SQL statement.",
"DisplayName": "Generic SQL",
"Name": "GenericSQL",
"Options": {
"SQL": {
"Description": "The SQL statement. You can use column aliases.",
"Label": "SQL",
"Name": "SQL",
"Required": 1
}
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Output Formats
A report result can be generated in different output formats. Each of the available output formats has specific options and is described by this resource.
/reporting/outputformats get
get /reporting/outputformats
Get all OutputFormat items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OutputFormatCollectionResponse
Schema:
{
"$id" : "OutputFormatCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of output formats.",
"type" : "object",
"properties" : {
"OutputFormat" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_OutputFormat_json"
}
}
},
"required" : [
"OutputFormat"
],
"definitions" : {
"_OutputFormat_json" : {
"$id" : "OutputFormat.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The output format object.",
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Options" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Label",
"Name"
]
}
}
}
},
"required" : [
"Description",
"Name"
]
}
}
}
Example:
{
"OutputFormat": [
{
"Description": "Converts the report data to CSV.",
"DisplayName": "CSV",
"Name": "CSV",
"Options": {
"Columns": {
"Description": "A list (Array) of the columns to be contained in the order in which they should occur in the output result.",
"Label": "Columns",
"Name": "Columns",
"Required": 1
},
"IncludeColumnHeader": {
"Description": "Determine if a header containing the column names should be contained. Default: 1 (true).",
"Label": "Include Column Headers",
"Name": "IncludeColumnHeader",
"Required": 0
},
"Quote": {
"Description": "The quote character to be used. Default: \" (Double Quote).",
"Label": "Quote",
"Name": "Quote",
"Required": 0
},
"Separator": {
"Description": "The value separator to be used. Default: , (Comma).",
"Label": "Separator",
"Name": "Separator",
"Required": 0
},
"Title": {
"Description": "A simple title, contained in the first row/cell of the output result.",
"Label": "Title",
"Name": "Title",
"Required": 0
}
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Report Definitions
Creating a report definition
Each report definition contains a config property. This constists of upto three separate configurations for
- the report type
- the parameters used in the report type configuration (this is optional, if no parameters are used)
- the output formats
Here is an example of such a config with parameters for report type GenericSQL:
{
"Config": {
"DataSource": {
"SQL": {
"any": "SELECT count(*) as Total FROM ticket WHERE type_id IN [${Parameters.TypeIDList}]"
}
},
"Parameters": [
{
"Name": "TypeIDList",
"Label": "Type Selection",
"Datatype": "NUMERIC",
"Description": "Please select the ticket types.",
"Required": 1,
"Multiple": 1,
"References": "TicketType.ID",
"Default": [0]
}
],
"OutputFormats": {
"CSV": {
"Columns": ["Total"]
}
}
}
}The contents of the DataSource section can be taken from the description of the data source (see resource "datasources").
The OutputFormats section has to contain all relevant options to configure the output formats that should be available for a report based on this definition. The possible configuration options can be found in the description of each output format (see resource "outputformats").
Defining parameters
The goal of this parameter definition is to tell an API client what exactly to provide when creating a report. Additionally it helps GUI based API clients to determine what kind of GUI element is needed and in which order the parameters should be displayed (array index).
Each parameter used in the DataSource config, which should be given in the report creation, has to be defined in Parameters at least by a Name and a DataType. The following table describes all possible config options for a parameter.
| Option | Required | Description |
|---|---|---|
Name | X | The name of the parameter which will be used in the DataSource configuration. |
DataType | X | The type of the data of this parameter. The following types are supported: STRING, NUMERIC, DATE, TIME, DATETIME |
Label | The label to be displayed in a GUI environment. If the label is not defined, then the name should be used as the label. | |
Description | A describing text to explain the parameter. | |
References | A hint for a report creator (human or algorithm) what this parameter is all about, to make sure the correct thing is provided. Example: TicketType.ID | |
Multiple | Set this to 1 if this parameter is an array of values. | |
Required | Set this to 1 if this parameter is required to be given in a report creation. | |
ReadOnly | Set this to 1 if this parameter is only a read only information when creating a report. | |
Default | The default value of the parameter, in case it's optional. | |
PossibleValues | The range of possible values to select from. |
Using parameters
How a parameter is used and defined, you can find in the example above. Simply write the name of the parameter in ${Parameters.<Name>}.
Supported Includes
This resource supports the following includes.
| Include | Description |
|---|---|
Reports | Adds the list of reports for this report definition to the response. See resource "reports". |
get /reporting/reportdefinitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportDefinitionCollectionResponse
Schema:
{
"$id" : "ReportDefinitionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of report definitions.",
"type" : "object",
"properties" : {
"ReportDefinition" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ReportDefinition_json"
}
}
},
"required" : [
"ReportDefinition"
],
"definitions" : {
"_ReportDefinition_json" : {
"$id" : "ReportDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report definition object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"Config" : {
"type" : "object",
"properties" : {
"DataSource" : {
"type" : "object",
"readOnly" : true
},
"OutputFormats" : {
"type" : "object",
"readOnly" : true
},
"Parameters" : {
"type" : "array",
"item" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"DataType" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Label",
"DataType"
],
"readOnly" : true
}
}
}
},
"Title" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"DataSource"
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DataSource" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsPeriodic" : {
"type" : "integer",
"readOnly" : true
},
"MaxReports" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Reports" : {
"description" : "added via include \"Reports\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_Report_json"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"DataSource",
"Config",
"ValidID"
]
},
"_ReportResult_json" : {
"$id" : "ReportResult.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report result object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentSize" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"ReportID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"Format",
"ID",
"ReportID"
]
},
"_Report_json" : {
"$id" : "Report.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report object.",
"type" : "object",
"properties" : {
"Config" : {
"type" : "object",
"properties" : {
"OutputFormats" : {
"type" : "array",
"item" : {
"readOnly" : true,
"type:" : "string"
},
"readOnly" : true
},
"Parameters" : {
"type" : "object",
"readOnly" : true
}
},
"required" : [
"OutputFormats"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Results" : {
"description" : "added via include \"Results\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ReportResult_json"
},
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"DefinitionID",
"ID",
"Config"
]
}
}
}
Example:
{
"ReportDefinition": [
{
"ChangeBy": 1,
"ChangeTime": "2021-03-01 16:16:32",
"Comment": "",
"Config": {
"OutputFormats": {
"CSV": {
"Columns": [
"id",
"name",
"CreatedByUser"
]
}
},
"Parameters": [
{
"Name": "Name_Pattern",
"DataType": "STRING",
"Label": "Name Pattern"
}
],
"DataSource": {
"SQL": {
"any": "SELECT id, name, create_by AS CreatedByUser FROM valid WHERE name LIKE '${Name_Pattern}%'"
}
}
},
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:32",
"DataSource": "GenericSQL",
"ID": 1,
"IsPeriodic": 1,
"MaxReports": 1,
"Name": "just a test",
"Reports": [
{
"Config": null,
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"DefinitionID": 1,
"ID": 1,
"Parameters": {
"OutputFormats": [
"CSV"
],
"Parameters": {
"Name_Pattern": "in"
}
},
"Results": [
{
"ContentSize": "48",
"ContentType": "text/csv",
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"Format": "CSV",
"ID": 1,
"ReportID": 1
}
]
}
],
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /reporting/reportdefinitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ReportDefinitionPostRequest
Schema:
{
"$id" : "ReportDefinitionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report definition request object for creation.",
"type" : "object",
"properties" : {
"ReportDefinition" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Config" : {
"type" : "object",
"properties" : {
"DataSource" : {
"type" : "object"
},
"OutputFormats" : {
"type" : "object"
},
"Parameters" : {
"type" : "array",
"item" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"DataType" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Description" : {
"type" : "string"
},
"Label" : {
"type" : "string"
},
"Required" : {
"type" : "integer"
},
"Type" : {
"type" : "string"
}
},
"required" : [
"Label",
"DataType"
]
}
}
}
},
"Title" : {
"type" : "string"
}
},
"required" : [
"DataSource"
]
},
"DataSource" : {
"description" : "The data source to use.",
"type" : "string"
},
"IsPeriodic" : {
"type" : "integer"
},
"MaxReports" : {
"type" : "integer"
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Config",
"DataSource"
]
}
},
"required" : [
"ReportDefinition"
]
}
Example:
{
"ReportDefinition": {
"DataSource": "GenericSQL",
"Name": "test",
"Config": {
"Title": "this is a test",
"DataSource": {
"SQL": {
"any": "SELECT id, name, create_by FROM valid WHERE name LIKE '${Name_Pattern}%'"
}
},
"Parameters": [
{
"Name": "Name_Pattern",
"Label": "Name Pattern",
"DataType": "STRING"
}
],
"OutputFormats": {
"CSV": {
"Columns": [
"id",
"name",
"CreatedByUser"
],
"IncludeColumnHeader": 1
}
}
}
}
}Possible Responses
HTTP status code 201
The ReportDefinition has been created successfully.
Body
Media type: application/json
Type: ReportDefinitionPostPatchResponse
Schema:
{
"$id" : "ReportDefinitionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated report definition.",
"type" : "object",
"properties" : {
"ReportDefinitionID" : {
"type" : "integer"
}
},
"required" : [
"ReportDefinitionID"
]
}
Example:
{
"ReportDefinitionID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /reporting/reportdefinitions/{reportDefinitionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportDefinitionId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportDefinitionResponse
Schema:
{
"$id" : "ReportDefinitionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a report definition GET request.",
"type" : "object",
"properties" : {
"ReportDefinition" : {
"$ref" : "#/definitions/_ReportDefinition_json"
}
},
"required" : [
"ReportDefinition"
],
"definitions" : {
"_ReportDefinition_json" : {
"$id" : "ReportDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report definition object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"Config" : {
"type" : "object",
"properties" : {
"DataSource" : {
"type" : "object",
"readOnly" : true
},
"OutputFormats" : {
"type" : "object",
"readOnly" : true
},
"Parameters" : {
"type" : "array",
"item" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"DataType" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Label",
"DataType"
],
"readOnly" : true
}
}
}
},
"Title" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"DataSource"
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DataSource" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsPeriodic" : {
"type" : "integer",
"readOnly" : true
},
"MaxReports" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Reports" : {
"description" : "added via include \"Reports\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_Report_json"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"DataSource",
"Config",
"ValidID"
]
},
"_ReportResult_json" : {
"$id" : "ReportResult.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report result object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentSize" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"ReportID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"Format",
"ID",
"ReportID"
]
},
"_Report_json" : {
"$id" : "Report.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report object.",
"type" : "object",
"properties" : {
"Config" : {
"type" : "object",
"properties" : {
"OutputFormats" : {
"type" : "array",
"item" : {
"readOnly" : true,
"type:" : "string"
},
"readOnly" : true
},
"Parameters" : {
"type" : "object",
"readOnly" : true
}
},
"required" : [
"OutputFormats"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Results" : {
"description" : "added via include \"Results\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ReportResult_json"
},
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"DefinitionID",
"ID",
"Config"
]
}
}
}
Example:
{
"ReportDefinition": {
"ChangeBy": 1,
"ChangeTime": "2021-03-01 16:16:32",
"Comment": "",
"Config": {
"OutputFormats": {
"CSV": {
"Columns": [
"id",
"name",
"CreatedByUser"
]
}
},
"Parameters": [
{
"Name:": "Name_Pattern",
"DataType": "STRING",
"Label": "Name Pattern"
}
],
"DataSource": {
"SQL": {
"any": "SELECT id, name, create_by AS CreatedByUser FROM valid WHERE name LIKE '${Name_Pattern}%'"
}
}
},
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:32",
"DataSource": "GenericSQL",
"ID": 1,
"IsPeriodic": 1,
"MaxReports": 1,
"Name": "just a test",
"Reports": [
{
"Config": null,
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"DefinitionID": 1,
"ID": 1,
"Parameters": {
"OutputFormats": [
"CSV"
],
"Parameters": {
"Name_Pattern": "in"
}
},
"Results": [
{
"ContentSize": "48",
"ContentType": "text/csv",
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"Format": "CSV",
"ID": 1,
"ReportID": 1
}
]
}
],
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /reporting/reportdefinitions/{reportDefinitionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportDefinitionId | integer |
Body
Media type: application/json
Type: ReportDefinitionPatchRequest
Schema:
{
"$id" : "ReportDefinitionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report definition request object for creation.",
"type" : "object",
"properties" : {
"ReportDefinition" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Config" : {
"type" : "object",
"properties" : {
"DataSource" : {
"type" : "object"
},
"OutputFormats" : {
"type" : "object"
},
"Parameters" : {
"type" : "array",
"item" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"DataType" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "number"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Description" : {
"type" : "string"
},
"Label" : {
"type" : "string"
},
"Required" : {
"type" : "integer"
},
"Type" : {
"type" : "string"
}
},
"required" : [
"Label",
"DataType"
]
}
}
}
},
"Title" : {
"type" : "string"
}
},
"required" : [
"DataSource"
]
},
"DataSource" : {
"description" : "The data source to use.",
"type" : "string"
},
"IsPeriodic" : {
"type" : "integer"
},
"MaxReports" : {
"type" : "integer"
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"ReportDefinition"
]
}
Example:
{
"ReportDefinition": {
"Name": "this is a test"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportDefinitionPostPatchResponse
Schema:
{
"$id" : "ReportDefinitionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated report definition.",
"type" : "object",
"properties" : {
"ReportDefinitionID" : {
"type" : "integer"
}
},
"required" : [
"ReportDefinitionID"
]
}
Example:
{
"ReportDefinitionID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /reporting/reportdefinitions/{reportDefinitionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportDefinitionId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Reports
Creating a report
Each report contains a Config property. All required parameters defined in the report definition have to be present here with a value as well as all output formats the report should be created for.
Here is an example of such a parameters property:
{
"Config": {
"Parameters": {
"NameFilter": "inv"
},
"OutputFormats": ["CSV"]
}
}The OutputFormats property can only contain output formats defined in the report definition.
This resource supports a special search property
| Search | Description |
|---|---|
DefinitionID | Restricts the database query to the given DefinitionID. Only the operator "EQ" is supported. |
get /reporting/reports
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportCollectionResponse
Schema:
{
"$id" : "ReportCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of reports.",
"type" : "object",
"properties" : {
"Report" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Report_json"
}
}
},
"required" : [
"Report"
],
"definitions" : {
"_ReportResult_json" : {
"$id" : "ReportResult.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report result object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentSize" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"ReportID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"Format",
"ID",
"ReportID"
]
},
"_Report_json" : {
"$id" : "Report.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report object.",
"type" : "object",
"properties" : {
"Config" : {
"type" : "object",
"properties" : {
"OutputFormats" : {
"type" : "array",
"item" : {
"readOnly" : true,
"type:" : "string"
},
"readOnly" : true
},
"Parameters" : {
"type" : "object",
"readOnly" : true
}
},
"required" : [
"OutputFormats"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Results" : {
"description" : "added via include \"Results\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ReportResult_json"
},
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"DefinitionID",
"ID",
"Config"
]
}
}
}
Example:
{
"Report": [
{
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"DefinitionID": 1,
"ID": 1,
"IsPeriodic": 1,
"MaxReports": 1,
"Config": {
"OutputFormats": [
"CSV"
],
"Parameters": {
"Name_Pattern": "in"
}
},
"Results": [
{
"ContentSize": "48",
"ContentType": "text/csv",
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"Format": "CSV",
"ID": 1,
"ReportID": 1
}
]
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /reporting/reports
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ReportPostRequest
Schema:
{
"$id" : "ReportPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report definition request object for creation.",
"type" : "object",
"properties" : {
"Report" : {
"type" : "object",
"properties" : {
"Config" : {
"type" : "object",
"properties" : {
"OutputFormats" : {
"type" : "array",
"item" : {
"type:" : "string"
}
},
"Parameters" : {
"type" : "object"
}
},
"required" : [
"OutputFormats"
]
},
"DefinitionID" : {
"type" : "integer"
}
},
"required" : [
"DefinitionID",
"Config"
]
}
},
"required" : [
"Report"
]
}
Example:
{
"Report": {
"DefinitionID": 1,
"Config": {
"Parameters": {
"Name_Pattern": "in"
},
"OutputFormats": [
"CSV"
]
}
}
}Possible Responses
HTTP status code 201
The Report has been created successfully.
Body
Media type: application/json
Type: ReportPostResponse
Schema:
{
"$id" : "ReportPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created report.",
"type" : "object",
"properties" : {
"ReportID" : {
"type" : "integer"
}
},
"required" : [
"ReportID"
]
}
Example:
{
"ReportID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/reporting/reports/{reportId} get
get /reporting/reports/{reportId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportResponse
Schema:
{
"$id" : "ReportResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a report GET request.",
"type" : "object",
"properties" : {
"Report" : {
"$ref" : "#/definitions/_Report_json"
}
},
"required" : [
"Report"
],
"definitions" : {
"_ReportResult_json" : {
"$id" : "ReportResult.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report result object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentSize" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"ReportID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"Format",
"ID",
"ReportID"
]
},
"_Report_json" : {
"$id" : "Report.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report object.",
"type" : "object",
"properties" : {
"Config" : {
"type" : "object",
"properties" : {
"OutputFormats" : {
"type" : "array",
"item" : {
"readOnly" : true,
"type:" : "string"
},
"readOnly" : true
},
"Parameters" : {
"type" : "object",
"readOnly" : true
}
},
"required" : [
"OutputFormats"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Results" : {
"description" : "added via include \"Results\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ReportResult_json"
},
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"DefinitionID",
"ID",
"Config"
]
}
}
}
Example:
{
"Report": {
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"DefinitionID": 1,
"ID": 1,
"Config": {
"OutputFormats": [
"CSV"
],
"Parameters": {
"Name_Pattern": "in"
}
},
"Results": [
{
"ContentSize": "48",
"ContentType": "text/csv",
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"Format": "CSV",
"ID": 1,
"ReportID": 1
}
]
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Results for a report
A report result contains the content of the report generated by a specific output format, i.e. CSV or PDF etc.
Supported Includes
This resource supports the following includes.
| Include | Description |
|---|---|
Content | Adds the base64 encoded content of the report result. |
/reporting/reports/{reportId}/results get
get /reporting/reports/{reportId}/results
Get all ReportResult items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ReportResultCollectionResponse
Schema:
{
"$id" : "ReportResultCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of report results.",
"type" : "object",
"properties" : {
"ReportResult" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ReportResult_json"
}
}
},
"required" : [
"ReportResult"
],
"definitions" : {
"_ReportResult_json" : {
"$id" : "ReportResult.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The report result object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentSize" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"ReportID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"Format",
"ID",
"ReportID"
]
}
}
}
Example:
{
"ReportResult": [
{
"Content": "IjIiOyJpbnZhbGlkIjsiMSIKIjMiOyJpbnZhbGlkLXRlbXBvcmFyaWx5IjsiMSIK\n",
"ContentSize": "48",
"ContentType": "text/csv",
"CreateBy": 1,
"CreateTime": "2021-03-01 16:16:37",
"Format": "CSV",
"ID": 1,
"ReportID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/reporting/reports/{reportId}/results/{reportResultId} delete
delete /reporting/reports/{reportId}/results/{reportResultId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| reportId | integer | |||
| reportResultId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Current Session
get /session
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SessionResponse
Schema:
{
"$id" : "SessionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a session GET request.",
"type" : "object",
"properties" : {
"Session" : {
"$ref" : "#/definitions/_Session_json"
}
},
"required" : [
"Session"
],
"definitions" : {
"_Session_json" : {
"$id" : "Session.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The extracted web token data.",
"type" : "object",
"properties" : {
"AllowedOperations" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"DeniedOperations" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"IgnoreMaxIdleTime" : {
"type" : "integer",
"readOnly" : true
},
"LastRequestTime" : {
"type" : "string",
"readOnly" : true
},
"LastRequestTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"RemoteIP" : {
"type" : "string",
"readOnly" : true
},
"TokenType" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserType" : {
"type" : "string",
"enum" : [
"Agent",
"Customer"
],
"readOnly" : true
},
"ValidUntilTime" : {
"type" : "string",
"readOnly" : true
},
"ValidUntilTimeUnix" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"AllowedOperations",
"CreateTime",
"CreateTimeUnix",
"DeniedOperations",
"TokenType",
"UserID",
"UserType",
"ValidUntilTime",
"ValidUntilTimeUnix"
]
}
}
}
Example:
{
"Session": {
"AllowedOperations": [],
"CreateTime": "2018-08-28 11:34:55",
"CreateTimeUnix": 1535456095,
"DeniedOperations": [],
"Description": "",
"IgnoreMaxIdleTime": 0,
"LastRequestTime": "2018-08-28 13:10:31",
"LastRequestTimeUnix": 1535461831,
"RemoteIP": "::ffff:172.17.0.1",
"TokenType": "Normal",
"UserID": 1,
"UserType": "Agent",
"ValidUntilTime": "2018-08-29 03:34:55",
"ValidUntilTimeUnix": 1535513695
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /session
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /session/user
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserResponse
Schema:
{
"$id" : "UserResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a user GET request.",
"type" : "object",
"properties" : {
"User" : {
"$ref" : "#/definitions/_User_json"
}
},
"required" : [
"User"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
},
"_User_json" : {
"$id" : "User.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Contact" : {
"$ref" : "#/definitions/_Contact_json"
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"IsAgent" : {
"description" : "Defines if user can use the agent portal.",
"type" : "integer",
"readOnly" : true
},
"IsCustomer" : {
"description" : "Defines if user can use the self service portal (customer portal).",
"type" : "integer",
"readOnly" : true
},
"Preferences" : {
"description" : "added via include \"Preferences\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_UserPreference_json"
},
"readOnly" : true
},
"RoleIDs" : {
"description" : "added via include \"RoleIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"UsageContext" : {
"description" : "Shows for which context the user is enabled (1 = agent portal; 2 = self service portal; 3 = both).",
"type" : "integer",
"readOnly" : true
},
"UserComment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"IsAgent",
"IsCustomer",
"UsageContext",
"UserComment",
"UserID",
"UserLogin",
"ValidID"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"User": {
"ChangeBy": 1,
"ChangeTime": "2020-01-20 11:30:26",
"Contact": {
"AssignedUserID": 3,
"ChangeBy": 1,
"ChangeTime": "2020-01-20 11:59:04",
"City": null,
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2020-01-20 11:51:50",
"Email": "jdoe@john-doe.com",
"Fax": null,
"Firstname": "John",
"Fullname": "John Doe",
"ID": 5,
"Lastname": "Doe",
"Mobile": null,
"OrganisationIDs": [
15
],
"Phone": null,
"PrimaryOrganisationID": 15,
"Street": "somewhere avenue 1",
"Title": "",
"UserID": 5,
"ValidID": 1,
"Zip": null
},
"CreateBy": 1,
"CreateTime": "2020-01-20 11:30:26",
"IsAgent": 1,
"IsCustomer": 0,
"Preferences": [
{
"ID": "UserLanguage",
"UserID": 5,
"Value": "en"
}
],
"RoleIDs": [
2,
13
],
"UsageContext": 1,
"UserComment": null,
"UserID": 3,
"UserLogin": "jdoe",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /session/user
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: UserPatchRequest
Schema:
{
"$id" : "UserPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user request object for update.",
"type" : "object",
"properties" : {
"User" : {
"type" : "object",
"properties" : {
"ExecGenerateToken" : {
"description" : "ACTION TRIGGER (non-persistent attribute)! If set to 1 a new access token will be generated for this user.",
"type" : "integer"
},
"IsAgent" : {
"type" : "integer"
},
"IsCustomer" : {
"type" : "integer"
},
"UserComment" : {
"type" : "string"
},
"UserLogin" : {
"type" : "string"
},
"UserPw" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"User"
]
}
Example:
{
"User": {
"UserPw": "n3w_s3cr37-p4ssw0rD",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPostPatchResponse
Schema:
{
"$id" : "UserPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user.",
"type" : "object",
"properties" : {
"UserID" : {
"type" : "integer"
}
},
"required" : [
"UserID"
]
}
Example:
{
"UserID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
This resource returns the most relevant ticket counters.
/session/user/counters get
get /session/user/counters
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: CounterResponse
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
This resource returns the ticket list for the given counter, i.e. Owned, OwnedAndLocked, ... The requested counter must be given as the URL parameter Counter.
Example
/session/user/tickets?Counter=OwnedAndLocked/session/user/tickets get
get /session/user/tickets
Get all Ticket items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketCollectionResponse
Schema:
{
"$id" : "TicketCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of tickets.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
}
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Ticket": [
{
"Age": 1316865,
"ChangeBy": 1,
"Changed": "2020-04-24 13:23:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:25:15",
"DynamicFields": [
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 5,
"Label": "Plan Begin",
"Name": "PlanBegin",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
},
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 6,
"Label": "Plan End",
"Name": "PlanEnd",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
}
],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 5,
"QueueID": 3,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 49,
"TicketNumber": "2020040917000014",
"Title": "Some title",
"TypeID": 1,
"Unseen": 0,
"UntilTime": 0
},
{
"Age": 1316731,
"ChangeBy": 1,
"Changed": "2020-04-24 13:24:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:28:19",
"DynamicFields": [],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 3,
"QueueID": 2,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 50,
"TicketNumber": "2020040917000015",
"Title": "another title",
"TypeID": 2,
"Unseen": 0,
"UntilTime": 0,
"WatcherID": 101
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /session/user/preferences
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferenceCollectionResponse
Schema:
{
"$id" : "UserPreferenceCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of user preferences.",
"type" : "object",
"properties" : {
"UserPreference" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_UserPreference_json"
}
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
}
}
}
Example:
{
"UserPreference": [
{
"UserID": 3,
"ID": "UserLanguage",
"Value": "de"
},
{
"UserID": 1,
"ID": "UserLanguage",
"Value": "en"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /session/user/preferences
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: UserPreferencePostRequest
Schema:
{
"$id" : "UserPreferencePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for creation.",
"type" : "object",
"properties" : {
"UserPreference" : {
"$ref" : "#/definitions/_UserPreferencePostItem_json"
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreferencePostItem_json" : {
"$id" : "UserPreferencePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for creation.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string"
},
"Value" : {
"type" : "string"
}
},
"required" : [
"ID",
"Value"
]
}
}
}
Example:
{
"UserPreference": {
"ID": "UserListLimit",
"Value": "10"
}
}Possible Responses
HTTP status code 201
The UserPreference has been created successfully.
Body
Media type: application/json
Type: UserPreferencePostPatchResponse
Schema:
{
"$id" : "UserPreferencePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user preference.",
"type" : "object",
"properties" : {
"UserPreferenceID" : {
"type" : "string"
}
},
"required" : [
"UserPreferenceID"
]
}
Example:
{
"UserPreferenceID": "UserLanguage"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /session/user/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| preferenceId | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferenceResponse
Schema:
{
"$id" : "UserPreferenceResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a user preference GET request.",
"type" : "object",
"properties" : {
"UserPreference" : {
"$ref" : "#/definitions/_UserPreference_json"
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
}
}
}
Example:
{
"UserPreference": {
"UserID": 3,
"ID": "UserLanguage",
"Value": "de"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /session/user/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| preferenceId | string |
Body
Media type: application/json
Type: UserPreferencePatchRequest
Schema:
{
"$id" : "UserPreferencePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for update.",
"type" : "object",
"properties" : {
"UserPreference" : {
"type" : "object",
"properties" : {
"Value" : {
"type" : "string"
}
}
}
},
"required" : [
"UserPreference"
]
}
Example:
{
"UserPreference": {
"Value": "de"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferencePostPatchResponse
Schema:
{
"$id" : "UserPreferencePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user preference.",
"type" : "object",
"properties" : {
"UserPreferenceID" : {
"type" : "string"
}
},
"required" : [
"UserPreferenceID"
]
}
Example:
{
"UserPreferenceID": "UserLanguage"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /session/user/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| preferenceId | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
ObjectSearch
Supported Attributes
Returns all supported attributes of the selected object type.
/objectsearch/{objecttype} get
get /objectsearch/{objecttype}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| objecttype | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ObjectSearchSupportedAttributesResponse
Schema:
{
"$id" : "ObjectSearchSupportedAttributesResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a object supported attributes GET request.",
"type" : "object",
"properties" : {
"SupportedAttributes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ObjectSearchSupportedAttributes_json"
}
}
},
"required" : [
"SupportedAttributes"
],
"definitions" : {
"_ObjectSearchSupportedAttributes_json" : {
"$id" : "ObjectSearchSupportedAttributes.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A object search supported attributes object.",
"type" : "object",
"properties" : {
"IsSearchable" : {
"type" : "number",
"readOnly" : true
},
"IsSortable" : {
"type" : "number",
"readOnly" : true
},
"ObjectSpecifics" : {
"description" : "contains object type specific paramters",
"type" : "object",
"readOnly" : true
},
"ObjectType" : {
"type" : "string",
"readOnly" : true
},
"Operators" : {
"type" : "array",
"readOnly" : true
},
"Property" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Property",
"ObjectType"
]
}
}
}
Example:
{
"SupportedAttributes": [
{
"Property": "Type",
"Operators": [
"EQ",
"NE",
"STARTSWITH",
"ENDSWITH",
"LIKE",
"LT",
"LTE",
"GT",
"GTE",
"IN",
"!IN"
],
"ObjectSpecifics": null,
"IsSearchable": 1,
"IsSortable": 1,
"ObjectType": "Ticket"
},
{
"Property": "Data.example.xy.IP",
"Operators": [
"EQ",
"NE",
"IN",
"!IN"
],
"IsSearchable": 1,
"IsSortable": 0,
"ObjectType": "ConfigItem",
"ObjectSpecifics": {
"Class": "Network",
"ClassID": 1
}
}
]
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Tickets
Supported Includes
In addition to its sub-resources and generic includes this resource supports the following additional includes.
| Include | Description |
|---|---|
AccountedTime | Adds the sum of all time units for the ticket (its articles) |
DynamicFields | Includes the assigned Dynamic Fields and their prepared values. You can disable the preparation of specific DF types with the URI parameter NoDynamicFieldDisplayValues, which is a comma separated list of DF types. |
get /tickets
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketCollectionResponse
Schema:
{
"$id" : "TicketCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of tickets.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
}
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Ticket": [
{
"Age": 1316865,
"ChangeBy": 1,
"Changed": "2020-04-24 13:23:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:25:15",
"DynamicFields": [
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 5,
"Label": "Plan Begin",
"Name": "PlanBegin",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
},
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 6,
"Label": "Plan End",
"Name": "PlanEnd",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
}
],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 5,
"QueueID": 3,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 49,
"TicketNumber": "2020040917000014",
"Title": "Some title",
"TypeID": 1,
"Unseen": 0,
"UntilTime": 0
},
{
"Age": 1316731,
"ChangeBy": 1,
"Changed": "2020-04-24 13:24:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:28:19",
"DynamicFields": [],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 3,
"QueueID": 2,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 50,
"TicketNumber": "2020040917000015",
"Title": "another title",
"TypeID": 2,
"Unseen": 0,
"UntilTime": 0,
"WatcherID": 101
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /tickets
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: TicketPostRequest
Schema:
{
"$id" : "TicketPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket request object for creation.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "object",
"properties" : {
"Articles" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_TicketArticlePostItem_json"
}
},
"ContactID" : {
"description" : "if not given, the contact of the current API user will be used",
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"LockID" : {
"type" : "integer"
},
"OrganisationID" : {
"type" : "integer"
},
"OwnerID" : {
"type" : "integer"
},
"PendingTime" : {
"type" : "string"
},
"PriorityID" : {
"type" : "integer"
},
"QueueID" : {
"type" : "integer"
},
"ResponsibleID" : {
"type" : "integer"
},
"StateID" : {
"type" : "integer"
},
"Title" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
}
},
"required" : [
"Title"
]
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
},
"_TicketArticleAttachmentPostItem_json" : {
"$id" : "TicketArticleAttachmentPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object for creation.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "base63 encoded file content",
"type" : "string"
},
"ContentType" : {
"description" : "if not given, fallback to SysConfig Ticket::Article::Attachment::ContentType::Fallback",
"type" : "string"
},
"Filename" : {
"type" : "string"
}
},
"required" : [
"Content",
"Filename"
]
},
"_TicketArticlePostItem_json" : {
"$id" : "TicketArticlePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object for creation.",
"type" : "object",
"properties" : {
"Attachments" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_TicketArticleAttachmentPostItem_json"
}
},
"Bcc" : {
"type" : "string"
},
"Body" : {
"type" : "string"
},
"Cc" : {
"type" : "string"
},
"ChannelID" : {
"type" : "integer"
},
"Charset" : {
"description" : "Required if no ContentType is given or MimeType is given.",
"type" : "string"
},
"ContentType" : {
"description" : "If not given MimeType and Charset is required.",
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"DoNotSendEmail" : {
"description" : "Prevent system from sending this article as email",
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"ExcludeMuteNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"ExcludeNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"ForceNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"From" : {
"type" : "string"
},
"HistoryComment" : {
"type" : "string"
},
"HistoryType" : {
"type" : "string"
},
"InReplyTo" : {
"type" : "string"
},
"IncomingTime" : {
"description" : "date time sting as \"YYYY-MM-DD HH24:MM:SS\"",
"type" : "string"
},
"MessageID" : {
"type" : "string"
},
"MimeType" : {
"description" : "Required if no ContentType is given or Charset is given.",
"type" : "string"
},
"NoAgentNotify" : {
"type" : "integer"
},
"PlainEmail" : {
"description" : "Only used for channel 'email' and when article is NOT send by system.",
"type" : "string"
},
"References" : {
"type" : "string"
},
"ReplyTo" : {
"type" : "string"
},
"SenderTypeID" : {
"type" : "integer"
},
"Subject" : {
"type" : "string"
},
"TimeUnit" : {
"type" : "integer"
},
"To" : {
"type" : "string"
}
},
"required" : [
"Body",
"Subject"
]
}
}
}
Example:
{
"Ticket": {
"Articles": [
{
"Attachment": [
{
"Content": "base64encodedContentString",
"ContentType": "image/png",
"Filename": "printer-error.png"
}
],
"Body": "\nThe printer responsed with <b>Error 123</b>.\n\n",
"ChannelID": 2,
"Charset": "utf8",
"ContentType": "text/html; charset=utf8",
"CustomerVisible": 1,
"ForceNotificationToUserID": [3],
"From": "someone@somecorp.com",
"MimeType": "text/html",
"SenderTypeID": 3,
"Subject": "The printer does not work!",
"TimeUnits": 12345,
"To": "someoneelse@somecorp.com,\"another one\" <anotherone@anothercorp.com>"
}
],
"ContactID" : 2,
"DynamicFields": [
{
"Name": "RelevantAssets",
"Value": [3,156]
},
{
"Name": "DueDate",
"Value": ["2020-05-02 12:00:00"]
}
],
"LockID": 1,
"OrganisationID" : 2,
"OwnerID": 4,
"PriorityID" : 1,
"QueueID": 13,
"ResponsibleID": 4,
"ServiceID": 2,
"StateID": 3,
"Title": "The printer does not work!",
"TypeID": 6
}
}Possible Responses
HTTP status code 201
The Ticket has been created successfully.
Body
Media type: application/json
Type: TicketPostPatchResponse
Schema:
{
"$id" : "TicketPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket.",
"type" : "object",
"properties" : {
"TicketID" : {
"type" : "integer"
}
},
"required" : [
"TicketID"
]
}
Example:
{
"TicketID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /tickets/{ticketId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketResponse
Schema:
{
"$id" : "TicketResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket GET request.",
"type" : "object",
"properties" : {
"Ticket" : {
"$ref" : "#/definitions/_Ticket_json"
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Ticket": {
"Age": 1316865,
"Articles": [
{
"ArticleID": 31,
"Bcc": "admin@localhost",
"BccRealname": "admin@localhost",
"Body": "\nThe printer responsed with <b>Error 123</b>.\n\n",
"Cc": "admin@localhost",
"CcRealname": "admin@localhost",
"ChangeTime": "2020-04-22 08:19:48",
"ChangedBy": 1,
"Channel": "note",
"ChannelID": 1,
"Charset": "utf8",
"ContentCharset": "utf8",
"ContentType": "text/plain; charset=utf8",
"CreateTime": "2020-04-09 08:25:16",
"CreatedBy": 1,
"CustomerVisible": 1,
"From": "admin@localhost",
"FromRealname": "admin@localhost",
"InReplyTo": "",
"IncomingTime": 1586413516,
"MessageID": "",
"MimeType": "text/plain",
"References": "",
"ReplyTo": "",
"SenderType": "agent",
"SenderTypeID": 1,
"Subject": "The printer does not work!",
"TicketID": 49,
"TimeUnits": 0,
"To": "\"Some one\" <someone@somecorp.com>",
"ToRealname": "Some one"
}
],
"ChangeBy": 1,
"Changed": "2020-04-24 13:23:20",
"ContactID": "1",
"CreateBy": 1,
"Created": "2020-04-09 08:25:15",
"DynamicFields": [
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 5,
"Label": "Plan Begin",
"Name": "PlanBegin",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
},
{
"DisplayValue": "20.04.2020 10:33",
"DisplayValueHTML": "20.04.2020 10:33",
"DisplayValueShort": "20.04.2020 10:33",
"ID": 6,
"Label": "Plan End",
"Name": "PlanEnd",
"PreparedValue": [
"2020-04-20 10:33:00"
],
"Value": [
"2020-04-20 10:33:00"
]
}
],
"LinkCount": 0,
"LockID": 1,
"OrganisationID": "1",
"OwnerID": 1,
"PendingTime": "",
"PendingTimeUnix": 0,
"PriorityID": 5,
"QueueID": 3,
"ResponsibleID": 1,
"StateID": 1,
"TicketID": 49,
"TicketNumber": "2020040917000014",
"Title": "Some title",
"TypeID": 1,
"Unseen": 0,
"UntilTime": 0
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /tickets/{ticketId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Body
Media type: application/json
Type: TicketPatchRequest
Schema:
{
"$id" : "TicketPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket request object for update.",
"type" : "object",
"properties" : {
"Ticket" : {
"type" : "object",
"properties" : {
"ContactID" : {
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set (if no new value given, an already exiting value will be unchanged)",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"LockID" : {
"type" : "integer"
},
"OrganisationID" : {
"type" : "integer"
},
"OwnerID" : {
"type" : "integer"
},
"PendingTime" : {
"type" : "string"
},
"PriorityID" : {
"type" : "integer"
},
"QueueID" : {
"type" : "integer"
},
"ResponsibleID" : {
"type" : "integer"
},
"ServiceID" : {
"type" : "integer"
},
"StateID" : {
"type" : "integer"
},
"Title" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Ticket"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Ticket": {
"ContactID" : 5,
"DynamicFields": [
{
"Name": "Keywords",
"Value": ["Problem","Server"]
}
],
"LockID": 2,
"TypeID": 4
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketPostPatchResponse
Schema:
{
"$id" : "TicketPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket.",
"type" : "object",
"properties" : {
"TicketID" : {
"type" : "integer"
}
},
"required" : [
"TicketID"
]
}
Example:
{
"TicketID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /tickets/{ticketId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
Attachments | Adds an ID list of the attachments on an article - if expanded the list will be objects with the meta-data (without content) |
Plain | Adds the plain source string of a message of an email article (channel) |
get /tickets/{ticketId}/articles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleCollectionResponse
Schema:
{
"$id" : "TicketArticleCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket articles.",
"type" : "object",
"properties" : {
"Article" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
}
}
},
"required" : [
"Article"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
}
}
}
Example:
{
"Article": [
{
"ArticleID": 31,
"Bcc": "admin@localhost",
"BccRealname": "admin@localhost",
"Body": "\nThe printer responsed with <b>Error 123</b>.\n\n",
"Cc": "admin@localhost",
"CcRealname": "admin@localhost",
"ChangeTime": "2020-04-22 08:19:48",
"ChangedBy": 1,
"Channel": "email",
"ChannelID": 2,
"Charset": "utf8",
"ContentCharset": "utf8",
"ContentType": "text/plain; charset=utf8",
"CreateTime": "2020-04-09 08:25:16",
"CreatedBy": 123,
"CustomerVisible": 1,
"From": "\"Some one\" <someone@somecorp.com>",
"FromRealname": "Some one",
"InReplyTo": "",
"IncomingTime": 1586413516,
"MessageID": "",
"MimeType": "text/plain",
"Plain": "MIME-Version: 1.0\nX-Mailer: ...\n",
"References": "",
"ReplyTo": "",
"SenderType": "external",
"SenderTypeID": 2,
"Subject": "The printer does not work!",
"TicketID": 49,
"TimeUnits": 0,
"To": "agent@myorganisation.com",
"ToRealname": "agent@myorganisation.com",
"Unseen": 1
},
{
"ArticleID": 33,
"Bcc": "",
"BccRealname": "",
"Body": "\nHi ...\n\n",
"Cc": "",
"CcRealname": "",
"ChangeTime": "2020-04-09 08:25:20",
"ChangedBy": 1,
"Channel": "email",
"ChannelID": 2,
"Charset": "utf8",
"ContentCharset": "utf8",
"ContentType": "text/plain; charset=utf8",
"CreateTime": "2020-04-09 08:25:20",
"CreatedBy": 7,
"CustomerVisible": 1,
"From": "agent@myorganisation.com",
"FromRealname": "agent@myorganisation.com",
"InReplyTo": "",
"IncomingTime": 1586413516,
"MessageID": "",
"MimeType": "text/plain",
"Plain": "MIME-Version: 1.0\nX-Mailer: ...\n",
"References": "",
"ReplyTo": "",
"SenderType": "agent",
"SenderTypeID": 1,
"Subject": "RE: The printer does not work!",
"TicketID": 49,
"TimeUnits": 0,
"To": "\"Some one\" <someone@somecorp.com>",
"ToRealname": "Some one",
"Unseen": 0
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /tickets/{ticketId}/articles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Body
Media type: application/json
Type: TicketArticlePostRequest
Schema:
{
"$id" : "TicketArticlePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article request object for creation.",
"type" : "object",
"properties" : {
"Article" : {
"$ref" : "#/definitions/_TicketArticlePostItem_json"
}
},
"required" : [
"Article"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
},
"_TicketArticleAttachmentPostItem_json" : {
"$id" : "TicketArticleAttachmentPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object for creation.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "base63 encoded file content",
"type" : "string"
},
"ContentType" : {
"description" : "if not given, fallback to SysConfig Ticket::Article::Attachment::ContentType::Fallback",
"type" : "string"
},
"Filename" : {
"type" : "string"
}
},
"required" : [
"Content",
"Filename"
]
},
"_TicketArticlePostItem_json" : {
"$id" : "TicketArticlePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object for creation.",
"type" : "object",
"properties" : {
"Attachments" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_TicketArticleAttachmentPostItem_json"
}
},
"Bcc" : {
"type" : "string"
},
"Body" : {
"type" : "string"
},
"Cc" : {
"type" : "string"
},
"ChannelID" : {
"type" : "integer"
},
"Charset" : {
"description" : "Required if no ContentType is given or MimeType is given.",
"type" : "string"
},
"ContentType" : {
"description" : "If not given MimeType and Charset is required.",
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"DoNotSendEmail" : {
"description" : "Prevent system from sending this article as email",
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"ExcludeMuteNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"ExcludeNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"ForceNotificationToUserID" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"From" : {
"type" : "string"
},
"HistoryComment" : {
"type" : "string"
},
"HistoryType" : {
"type" : "string"
},
"InReplyTo" : {
"type" : "string"
},
"IncomingTime" : {
"description" : "date time sting as \"YYYY-MM-DD HH24:MM:SS\"",
"type" : "string"
},
"MessageID" : {
"type" : "string"
},
"MimeType" : {
"description" : "Required if no ContentType is given or Charset is given.",
"type" : "string"
},
"NoAgentNotify" : {
"type" : "integer"
},
"PlainEmail" : {
"description" : "Only used for channel 'email' and when article is NOT send by system.",
"type" : "string"
},
"References" : {
"type" : "string"
},
"ReplyTo" : {
"type" : "string"
},
"SenderTypeID" : {
"type" : "integer"
},
"Subject" : {
"type" : "string"
},
"TimeUnit" : {
"type" : "integer"
},
"To" : {
"type" : "string"
}
},
"required" : [
"Body",
"Subject"
]
}
}
}
Example:
{
"Article": {
"Attachments": [
{
"Content": "base64encodedContentString",
"ContentType": "image/png",
"Filename": "printer-error.png"
}
],
"Body": "\nThe printer responsed with <b>Error 123</b>.\n\n",
"ChannelID": 2,
"Charset": "utf8",
"ContentType": "text/html; charset=utf8",
"CustomerVisible": 1,
"ForceNotificationToUserID": [3],
"From": "someone@somecorp.com",
"MimeType": "text/html",
"SenderTypeID": 3,
"Subject": "The printer does not work!",
"TimeUnit": 12345,
"To": "someoneelse@somecorp.com,\"another one\" <anotherone@anothercorp.com>"
}
}Possible Responses
HTTP status code 201
The TicketArticle has been created successfully.
Body
Media type: application/json
Type: TicketArticlePostPatchResponse
Schema:
{
"$id" : "TicketArticlePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket article.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer"
}
},
"required" : [
"ArticleID"
]
}
Example:
{
"ArticleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /tickets/{ticketId}/articles/{articleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleResponse
Schema:
{
"$id" : "TicketArticleResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket article GET request.",
"type" : "object",
"properties" : {
"Article" : {
"$ref" : "#/definitions/_TicketArticle_json"
}
},
"required" : [
"Article"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
}
}
}
Example:
{
"Article": {
"ArticleID": 31,
"Bcc": "admin@localhost",
"BccRealname": "admin@localhost",
"Body": "\nThe printer responsed with <b>Error 123</b>.\n\n",
"Cc": "admin@localhost",
"CcRealname": "admin@localhost",
"ChangeTime": "2020-04-22 08:19:48",
"ChangedBy": 1,
"Channel": "note",
"ChannelID": 1,
"Charset": "utf8",
"ContentCharset": "utf8",
"ContentType": "text/plain; charset=utf8",
"CreateTime": "2020-04-09 08:25:16",
"CreatedBy": 1,
"CustomerVisible": 1,
"From": "admin@localhost",
"FromRealname": "admin@localhost",
"InReplyTo": "",
"IncomingTime": 1586413516,
"MessageID": "",
"MimeType": "text/plain",
"NotSentError": "",
"References": "",
"ReplyTo": "",
"SenderType": "agent",
"SenderTypeID": 1,
"Subject": "The printer does not work!",
"TicketID": 49,
"TimeUnits": 0,
"To": "\"Some one\" <someone@somecorp.com>",
"ToRealname": "Some one",
"Unseen": 0
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /tickets/{ticketId}/articles/{articleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Body
Media type: application/json
Type: TicketArticlePatchRequest
Schema:
{
"$id" : "TicketArticlePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article request object for update.",
"type" : "object",
"properties" : {
"Article" : {
"Bcc" : {
"type" : "string"
},
"Body" : {
"type" : "string"
},
"Cc" : {
"type" : "string"
},
"CustomerVisible" : {
"type" : "integer"
},
"DynamicFields" : {
"description" : "list of dynamic field values to be set",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValueSetItem_json"
}
},
"From" : {
"type" : "string"
},
"IncomingTime" : {
"description" : "date time sting as \"YYYY-MM-DD HH24:MM:SS\"",
"type" : "string"
},
"ReplyTo" : {
"type" : "string"
},
"SenderTypeID" : {
"type" : "integer"
},
"Subject" : {
"type" : "string"
},
"TicketID" : {
"description" : "to move the article to another ticket",
"type" : "integer"
},
"TimeUnit" : {
"type" : "integer"
},
"To" : {
"type" : "string"
}
}
},
"required" : [
"Article"
],
"definitions" : {
"_DynamicFieldValueSetItem_json" : {
"$id" : "DynamicFieldValueSetItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object to set it for an object.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the name of the relevant dynamic field",
"type" : "string"
},
"Value" : {
"description" : "value type depends on the dynamic field (can also be an array of value type)",
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"Article": {
"CustomerVisible": 2,
"TicketID": 42,
"TimeUnit": 6789
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticlePostPatchResponse
Schema:
{
"$id" : "TicketArticlePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket article.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer"
}
},
"required" : [
"ArticleID"
]
}
Example:
{
"ArticleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /tickets/{ticketId}/articles/{articleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
Content | Adds the base64 encoded file contents of the attachments. |
get /tickets/{ticketId}/articles/{articleId}/attachments
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleAttachmentCollectionResponse
Schema:
{
"$id" : "TicketArticleAttachmentCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket article attachments.",
"type" : "object",
"properties" : {
"Attachment" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
}
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
}
}
}
Example:
{
"Attachment": [
{
"Content": "somebase64encodedContentString",
"ContentAlternative": "",
"ContentID": "",
"ContentType": "text/html; charset=\"utf8\"",
"Disposition": "inline",
"Filename": "file-2",
"Filesize": "15 Bytes",
"FilesizeRaw": "15",
"ID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /tickets/{ticketId}/articles/{articleId}/attachments
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Body
Media type: application/json
Type: TicketArticleAttachmentPostRequest
Schema:
{
"$id" : "TicketArticleAttachmentPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment request object for creation.",
"type" : "object",
"properties" : {
"Attachment" : {
"$ref" : "#/definitions/_TicketArticleAttachmentPostItem_json"
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_TicketArticleAttachmentPostItem_json" : {
"$id" : "TicketArticleAttachmentPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object for creation.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "base63 encoded file content",
"type" : "string"
},
"ContentType" : {
"description" : "if not given, fallback to SysConfig Ticket::Article::Attachment::ContentType::Fallback",
"type" : "string"
},
"Filename" : {
"type" : "string"
}
},
"required" : [
"Content",
"Filename"
]
}
}
}
Example:
{
"Attachment": {
"Content": "somebase64encodedContentString",
"ContentType": "image/png",
"Filename": "printer-error.png"
}
}Possible Responses
HTTP status code 201
The TicketArticleAttachment has been created successfully.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/tickets/{ticketId}/articles/{articleId}/attachments/{attachmentId} get
get /tickets/{ticketId}/articles/{articleId}/attachments/{attachmentId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer | |||
| attachmentId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleAttachmentResponse
Schema:
{
"$id" : "TicketArticleAttachmentResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket article attachment GET request.",
"type" : "object",
"properties" : {
"Attachment" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
}
},
"required" : [
"Attachment"
],
"definitions" : {
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
}
}
}
Example:
{
"Attachment": {
"Content": "somebase64encodedContentString",
"ContentAlternative": "",
"ContentID": "",
"ContentType": "text/html; charset=\"utf8\"",
"Disposition": "inline",
"Filename": "file-2",
"Filesize": "15 Bytes",
"FilesizeRaw": "15",
"ID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Returns an attachment object whose content is a base64 encoded zip of all attachments (without the article body html attachment) of the ticket article.
/tickets/{ticketId}/articles/{articleId}/attachments/zip get
get /tickets/{ticketId}/articles/{articleId}/attachments/zip
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleAttachmentZipResponse
Schema:
{
"$id" : "TicketArticleAttachmentZipResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket article attachments as zip GET request.",
"type" : "object",
"properties" : {
"Attachment" : {
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded zip content)",
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentType",
"Filename",
"Filesize",
"FilesizeRaw"
]
}
},
"required" : [
"Attachment"
]
}
Example:
{
"Attachment": {
"Content": "somebase64encodedContentString",
"ContentType": "application/zip",
"Filename": "Ticket_2020040917000014_Article_31.zip",
"Filesize": "15 Bytes",
"FilesizeRaw": 15
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
This resource returns a list of all flags of an ticket article.
get /tickets/{ticketId}/articles/{articleId}/flags
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleFlagCollectionResponse
Schema:
{
"$id" : "TicketArticleFlagCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket article flags.",
"type" : "object",
"properties" : {
"ArticleFlag" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
}
}
},
"required" : [
"ArticleFlag"
],
"definitions" : {
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
}
}
}
Example:
{
"ArticleFlag": [
{
"ArticleID": 31,
"Name": "Seen",
"Value": "1"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /tickets/{ticketId}/articles/{articleId}/flags
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer |
Body
Media type: application/json
Type: TicketArticleFlagPostRequest
Schema:
{
"$id" : "TicketArticleFlagPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag request object for creation.",
"type" : "object",
"properties" : {
"ArticleFlag" : {
"properties" : {
"Name" : {
"type" : "string"
},
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
},
"required" : [
"Name",
"Value"
]
}
},
"required" : [
"ArticleFlag"
]
}
Example:
{
"ArticleFlag": {
"Name": "Seen",
"Value": 1
}
}Possible Responses
HTTP status code 201
The TicketArticleFlag has been created successfully.
Body
Media type: application/json
Type: TicketArticleFlagPostPatchResponse
Schema:
{
"$id" : "TicketArticleFlagPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The name of the created or updated ticket article flag.",
"type" : "object",
"properties" : {
"FlagName" : {
"type" : "string"
}
},
"required" : [
"FlagName"
]
}
Example:
{
"FlagName": "Seen"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /tickets/{ticketId}/articles/{articleId}/flags/{flagName}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer | |||
| flagName | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleFlagResponse
Schema:
{
"$id" : "TicketArticleFlagResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket article flag GET request.",
"type" : "object",
"properties" : {
"ArticleFlag" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
}
},
"required" : [
"ArticleFlag"
],
"definitions" : {
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
}
}
}
Example:
{
"ArticleFlag": {
"ArticleID": 31,
"Name": "Seen",
"Value": "1"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /tickets/{ticketId}/articles/{articleId}/flags/{flagName}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| articleId | integer | |||
| flagName | integer |
Body
Media type: application/json
Type: TicketArticleFlagPatchRequest
Schema:
{
"$id" : "TicketArticleFlagPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag request object for update.",
"type" : "object",
"properties" : {
"ArticleFlag" : {
"properties" : {
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
},
"required" : [
"Value"
]
}
},
"required" : [
"ArticleFlag"
]
}
Example:
{
"ArticleFlag": {
"Value": 0
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketArticleFlagPostPatchResponse
Schema:
{
"$id" : "TicketArticleFlagPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The name of the created or updated ticket article flag.",
"type" : "object",
"properties" : {
"FlagName" : {
"type" : "string"
}
},
"required" : [
"FlagName"
]
}
Example:
{
"FlagName": "Seen"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
This resource returns the history of a ticket.
/tickets/{ticketId}/history get
get /tickets/{ticketId}/history
Get all TicketHistory items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketHistoryCollectionResponse
Schema:
{
"$id" : "TicketHistoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket history entries.",
"type" : "object",
"properties" : {
"History" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
}
}
},
"required" : [
"History"
],
"definitions" : {
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
}
}
}
Example:
{
"History": [
{
"ArticleID": 0,
"CreateBy": 1,
"CreateTime": "2020-04-27 16:31:26",
"HistoryID": 883,
"HistoryType": "NewTicket",
"HistoryTypeID": 1,
"Name": "New Ticket [2020042717000016] created (Q=Service Desk::Monitoring;P=3 normal;S=new).",
"OwnerID": 1,
"PriorityID": 3,
"QueueID": 2,
"StateID": 1,
"TicketID": 53,
"TypeID": 1
},
{
"ArticleID": 0,
"CreateBy": 1,
"CreateTime": "2020-04-27 16:31:26",
"HistoryID": 884,
"HistoryType": "ServiceUpdate",
"HistoryTypeID": 32,
"Name": "Updated Service to %s \"NULL\" (ID=).",
"OwnerID": 1,
"PriorityID": 3,
"QueueID": 2,
"StateID": 1,
"TicketID": 53,
"TypeID": 1
},
{
"ArticleID": 0,
"CreateBy": 1,
"CreateTime": "2020-04-27 16:31:26",
"HistoryID": 886,
"HistoryType": "OwnerUpdate",
"HistoryTypeID": 18,
"Name": "New owner is \"someAgent\" (ID=2).",
"OwnerID": 2,
"PriorityID": 3,
"QueueID": 2,
"StateID": 1,
"TicketID": 53,
"TypeID": 1
},
{
"ArticleID": 38,
"CreateBy": 1,
"CreateTime": "2020-04-27 16:31:27",
"HistoryID": 887,
"HistoryType": "AddNote",
"HistoryTypeID": 10,
"Name": "Added note ()",
"OwnerID": 2,
"PriorityID": 3,
"QueueID": 2,
"StateID": 1,
"TicketID": 53,
"TypeID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/tickets/{ticketId}/history/{historyId} get
get /tickets/{ticketId}/history/{historyId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| ticketId | integer | |||
| historyId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketHistoryResponse
Schema:
{
"$id" : "TicketHistoryResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket history GET request.",
"type" : "object",
"properties" : {
"History" : {
"$ref" : "#/definitions/_TicketHistory_json"
}
},
"required" : [
"History"
],
"definitions" : {
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
}
}
}
Example:
{
"History": {
"ArticleID": 0,
"CreateBy": 1,
"CreateTime": "2020-04-27 16:31:26",
"HistoryID": 883,
"HistoryType": "NewTicket",
"HistoryTypeID": 1,
"Name": "New Ticket [2020042717000016] created (Q=Service Desk::Monitoring;P=3 normal;S=new).",
"OwnerID": 1,
"PriorityID": 3,
"QueueID": 2,
"StateID": 1,
"TicketID": 53,
"TypeID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Watchers
get /watchers
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: WatcherCollectionResponse
Schema:
{
"$id" : "WatcherCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of watchers.",
"type" : "object",
"properties" : {
"Watcher" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
}
}
},
"required" : [
"Watcher"
],
"definitions" : {
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"Watcher": [
{
"ChangeBy": 1,
"ChangeTime": "2009-01-20 09:27:53",
"CreateBy": 1,
"CreateTime": "2009-01-20 09:27:53",
"ID": 1,
"Object": "Ticket",
"ObjectID": "180",
"UserID": 99
},
{
"ChangeBy": 1,
"ChangeTime": "2009-01-20 10:43:17",
"CreateBy": 1,
"CreateTime": "2009-01-20 10:43:17",
"ID": 2,
"Object": "Ticket",
"ObjectID": "180",
"UserID": 7
},
{
"ChangeBy": 1,
"ChangeTime": "2011-01-20 09:28:32",
"CreateBy": 1,
"CreateTime": "2011-01-20 09:28:32",
"ID": 3,
"Object": "Ticket",
"ObjectID": "181",
"UserID": 99
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /watchers
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: WatcherPostRequest
Schema:
{
"$id" : "WatcherPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher request object for creation.",
"type" : "object",
"properties" : {
"Watcher" : {
"type" : "object",
"properties" : {
"Object" : {
"description" : "The type of the object.",
"type" : "string"
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string"
},
"UserID" : {
"description" : "The ID of the watching user.",
"type" : "integer"
}
},
"required" : [
"Object",
"ObjectID",
"UserID"
]
}
},
"required" : [
"Watcher"
]
}
Example:
{
"Watcher": {
"Object": "Ticket",
"ObjectID": "123",
"UserID": 99
}
}Possible Responses
HTTP status code 201
The Watcher has been created successfully.
Body
Media type: application/json
Type: WatcherPostResponse
Schema:
{
"$id" : "WatcherPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created watcher.",
"type" : "object",
"properties" : {
"WatcherID" : {
"type" : "integer"
}
},
"required" : [
"WatcherID"
]
}
Example:
{
"WatcherID": 12
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/watchers/{watcherId} delete
delete /watchers/{watcherId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| watcherId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Automation
This /system/automation resource is no collection resource itself. It's purpose is to act as a container for all the Automation resources.
Jobs
This resource allows read, create, update and delete operation for jobs.
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
ExecPlans | Adds the assigned execution plans to the response. |
Macros | Adds the assigend macros to the response. |
get /system/automation/jobs
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobCollectionResponse
Schema:
{
"$id" : "JobCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of jobs.",
"type" : "object",
"properties" : {
"Job" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Job_json"
}
}
},
"required" : [
"Job"
],
"definitions" : {
"_ExecPlan_json" : {
"$id" : "ExecPlan.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"description" : "Parameters of the execution plan, when and/or by what the corresponding job of this execution plan will be triggert",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string",
"readOnly" : true
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
}
},
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
},
"_Job_json" : {
"$id" : "Job.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecPlanIDs" : {
"description" : "IDs of assigned execution plans - added via include \"ExecPlanIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ExecPlans" : {
"description" : "assigned execution plans - added via include \"ExecPlans\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ExecPlan_json"
},
"readOnly" : true
},
"Filter" : {
"description" : "List of and/or search criteria (see chapter \"Search objects\" and \"Filter results\" for more details).",
"type" : "array"
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"LastExecutionTime" : {
"type" : "string",
"readOnly" : true
},
"MacroIDs" : {
"description" : "IDs of assigned macros - added via include \"MacroIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"Macros" : {
"description" : "assigned macros - added via include \"Macros\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_Macro_json"
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Filter",
"ID",
"Name",
"Type",
"ValidID"
]
},
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
},
"_Macro_json" : {
"$id" : "Macro.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro object.",
"type" : "object",
"properties" : {
"Actions" : {
"description" : "added via include \"Actions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_MacroAction_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecOrder" : {
"description" : "Order of corresponding macro actions as IDs.",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"Job": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ExecPlanIDs": [ 1,5 ],
"Filter": [
{
"AND": [
{
"Field": "Title",
"Operator": "CONTAINS",
"Type": "STRING",
"Value": "some title"
}
]
}
],
"ID": 1,
"LastExecutionTime": "",
"MacroIDs": [],
"Name": "Some Job",
"Type": "...",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-10-01 15:30:14",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-10-01 15:30:14",
"ExecPlanIDs": [ 2 ],
"Filter": null,
"ID": 2,
"LastExecutionTime": "2019-10-01 14:00:00",
"MacroIDs": [ 2,4 ],
"Name": "Another Job",
"Type": "...",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/jobs
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: JobPostRequest
Schema:
{
"$id" : "JobPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job request object for creation.",
"type" : "object",
"properties" : {
"Job" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"ExecPlanIDs" : {
"type" : "array",
"item" : {
"type" : "integer"
}
},
"Filter" : {
"description" : "List of and/or search criteria (see chapter \"Search objects\" and \"Filter results\" for more details).",
"type" : "array"
},
"MacroIDs" : {
"type" : "array",
"item" : {
"type" : "integer"
}
},
"Name" : {
"type" : "string"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Type"
]
}
},
"required" : [
"Job"
]
}
Example:
{
"Job": {
"Comment": "some comment",
"Name": "new job",
"Type": "Ticket",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The Job has been created successfully.
Body
Media type: application/json
Type: JobPostPatchResponse
Schema:
{
"$id" : "JobPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated job.",
"type" : "object",
"properties" : {
"JobID" : {
"type" : "integer"
}
},
"required" : [
"JobID"
]
}
Example:
{
"JobID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/types get
get /system/automation/jobs/types
Get all JobType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/automation/jobs/{jobId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobResponse
Schema:
{
"$id" : "JobResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a job GET request.",
"type" : "object",
"properties" : {
"Job" : {
"$ref" : "#/definitions/_Job_json"
}
},
"required" : [
"Job"
],
"definitions" : {
"_ExecPlan_json" : {
"$id" : "ExecPlan.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"description" : "Parameters of the execution plan, when and/or by what the corresponding job of this execution plan will be triggert",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string",
"readOnly" : true
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
}
},
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
},
"_Job_json" : {
"$id" : "Job.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecPlanIDs" : {
"description" : "IDs of assigned execution plans - added via include \"ExecPlanIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ExecPlans" : {
"description" : "assigned execution plans - added via include \"ExecPlans\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ExecPlan_json"
},
"readOnly" : true
},
"Filter" : {
"description" : "List of and/or search criteria (see chapter \"Search objects\" and \"Filter results\" for more details).",
"type" : "array"
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"LastExecutionTime" : {
"type" : "string",
"readOnly" : true
},
"MacroIDs" : {
"description" : "IDs of assigned macros - added via include \"MacroIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"Macros" : {
"description" : "assigned macros - added via include \"Macros\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_Macro_json"
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Filter",
"ID",
"Name",
"Type",
"ValidID"
]
},
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
},
"_Macro_json" : {
"$id" : "Macro.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro object.",
"type" : "object",
"properties" : {
"Actions" : {
"description" : "added via include \"Actions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_MacroAction_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecOrder" : {
"description" : "Order of corresponding macro actions as IDs.",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"Job": {
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ExecPlanIDs": [ 1,5 ],
"Filter": [
{
"AND": [
{
"Field": "Title",
"Operator": "CONTAINS",
"Type": "STRING",
"Value": "some title"
}
]
}
],
"ID": 1,
"LastExecutionTime": "",
"MacroIDs": [ 1 ],
"Macros": [
{
"Actions": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:45",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:40:12",
"ID": 1,
"MacroID": 1,
"Name": "Some Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
],
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:45",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:40:12",
"ExecOrder": [
1
],
"ID": 1,
"Name": "Some Macro",
"Type": "Ticket",
"ValidID": 1
}
],
"Name": "Some Job",
"Type": "Ticket",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/automation/jobs/{jobId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Body
Media type: application/json
Type: JobPatchRequest
Schema:
{
"$id" : "JobPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job request object for update.",
"type" : "object",
"properties" : {
"Job" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Filter" : {
"description" : "List of and/or search criteria (see chapter \"Search objects\" and \"Filter results\" for more details).",
"type" : "array"
},
"Name" : {
"type" : "string"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Job"
]
}
Example:
{
"Job": {
"Comment": "new comment",
"Name": "new job name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobPostPatchResponse
Schema:
{
"$id" : "JobPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated job.",
"type" : "object",
"properties" : {
"JobID" : {
"type" : "integer"
}
},
"required" : [
"JobID"
]
}
Example:
{
"JobID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/automation/jobs/{jobId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
ExecPlanIDs of a Job
With this resource you can get the assigned execustion plans to the given job as id list, create new assignments and delete existing ones.
get /system/automation/jobs/{jobId}/execplanids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobExecPlanIDCollectionResponse
Schema:
{
"$id" : "JobExecPlanIDCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a job - execution plan IDs GET request.",
"type" : "object",
"properties" : {
"ExecPlanID" : {
"description" : "List of IDs of assigned execution plans of the job",
"type" : "array",
"item" : {
"type" : "integer"
}
}
},
"required" : [
"ExecPlanID"
]
}
Example:
{
"ExecPlanID": [
1,2,3
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/jobs/{jobId}/execplanids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Body
Media type: application/json
Type: JobExecPlanIDPostRequest
Schema:
{
"$id" : "JobExecPlanIDPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job - execution plan ID request object for creation.",
"type" : "object",
"properties" : {
"ExecPlanID" : {
"type" : "integer"
}
},
"required" : [
"ExecPlanID"
]
}
Example:
{
"ExecPlanID": 1
}Possible Responses
HTTP status code 201
The JobExecPlanID has been created successfully.
Body
Media type: application/json
Type: JobExecPlanIDPostResponse
Schema:
{
"$id" : "JobExecPlanIDPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a job - execution plan ID POST request.",
"type" : "object",
"properties" : {
"ExecPlanID" : {
"type" : "integer"
}
},
"required" : [
"ExecPlanID"
]
}
Example:
{
"ExecPlanID": 21,
"JobID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/{jobId}/execplanids/{execPlanId} delete
delete /system/automation/jobs/{jobId}/execplanids/{execPlanId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer | |||
| execPlanId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
MacroIDs of a Job
With this resource you can get the assigned macros to the given job as id list, create new assignments and delete existing ones.
get /system/automation/jobs/{jobId}/macroids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobMacroIDCollectionResponse
Schema:
{
"$id" : "JobMacroIDCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a job - macro IDs GET request.",
"type" : "object",
"properties" : {
"MacroID" : {
"description" : "List of IDs of assigned macros of the job",
"type" : "array",
"item" : {
"type" : "integer"
}
}
},
"required" : [
"MacroID"
]
}
Example:
{
"MacroID": [
1,2,3
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/jobs/{jobId}/macroids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Body
Media type: application/json
Type: JobMacroIDPostRequest
Schema:
{
"$id" : "JobMacroIDPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job - macro ID request object for creation.",
"type" : "object",
"properties" : {
"MacroID" : {
"type" : "integer"
}
},
"required" : [
"MacroID"
]
}
Example:
{
"MacroID": 1
}Possible Responses
HTTP status code 201
The JobMacroID has been created successfully.
Body
Media type: application/json
Type: JobMacroIDPostResponse
Schema:
{
"$id" : "JobMacroIDPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a job - macro ID POST request.",
"type" : "object",
"properties" : {
"MacroID" : {
"type" : "integer"
}
},
"required" : [
"MacroID"
]
}
Example:
{
"JobID": 42,
"MacroID": 21
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/{jobId}/macroids/{macroId} delete
delete /system/automation/jobs/{jobId}/macroids/{macroId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer | |||
| macroId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/{jobId}/runs get
get /system/automation/jobs/{jobId}/runs
Get all JobRun items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobRunCollectionResponse
Schema:
{
"$id" : "JobRunCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of job runs.",
"type" : "object",
"properties" : {
"JobRun" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_JobRun_json"
}
}
},
"required" : [
"JobRun"
],
"definitions" : {
"_JobRunLog_json" : {
"$id" : "JobRun.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job run object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"JobID" : {
"type" : "integer",
"readOnly" : true
},
"MacroActionID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"MacroID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"RunID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"ID",
"JobID",
"Priority",
"RunID"
]
},
"_JobRun_json" : {
"$id" : "JobRun.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job run object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"EndTime" : {
"type" : "string",
"readOnly" : true
},
"Filter" : {
"type" : "object",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"JobID" : {
"type" : "integer",
"readOnly" : true
},
"Logs" : {
"description" : "execution logs of this run - added via include \"Logs\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_JobRunLog_json"
},
"readOnly" : true
},
"StartTime" : {
"type" : "string",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"StartTime",
"ID",
"JobID",
"State",
"StateID"
]
}
}
}
Example:
{
"JobRun": [
{
"CreateBy": 1,
"EndTime": "2019-11-25 16:55:26",
"Filter": {},
"ID": 1,
"JobID": 293,
"Logs": [],
"StartTime": "2019-11-25 16:55:26",
"State": "warning",
"StateID": 3
},
{
"CreateBy": 1,
"EndTime": "2019-11-25 17:11:28",
"Filter": {},
"ID": 10,
"JobID": 293,
"Logs": [],
"StartTime": "2019-11-25 17:11:28",
"State": "finished",
"StateID": 2
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/{jobId}/runs/{runId} get
get /system/automation/jobs/{jobId}/runs/{runId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer | |||
| runId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/jobs/{jobId}/runs/{runId}/logs get
get /system/automation/jobs/{jobId}/runs/{runId}/logs
Get all JobRunLog items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| jobId | integer | |||
| runId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: JobRunLogCollectionResponse
Schema:
{
"$id" : "JobRunLogCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of job run logs.",
"type" : "object",
"properties" : {
"JobRunLog" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_JobRunLog_json"
}
}
},
"required" : [
"JobRunLog"
],
"definitions" : {
"_JobRunLog_json" : {
"$id" : "JobRun.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The job run object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"JobID" : {
"type" : "integer",
"readOnly" : true
},
"MacroActionID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"MacroID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"RunID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"CreateTime",
"ID",
"JobID",
"Priority",
"RunID"
]
}
}
}
Example:
{
"JobRunLog": [
{
"CreateBy": 1,
"CreateTime": "2019-11-25 18:07:50",
"ID": 2090,
"JobID": 293,
"MacroActionID": null,
"MacroID": null,
"Message": "job execution finished successfully.",
"ObjectID": null,
"Priority": "info",
"RunID": 1000
},
{
"CreateBy": 1,
"CreateTime": "2019-11-25 18:07:50",
"ID": 2089,
"JobID": 293,
"MacroActionID": null,
"MacroID": 208,
"Message": "executing macro \"Macro for Job \"test\"\" with 1 macro actions on ObjectID 97.",
"ObjectID": 97,
"Priority": "info",
"RunID": 1000
},
{
"CreateBy": 1,
"CreateTime": "2019-11-25 18:07:50",
"ID": 2088,
"JobID": 293,
"MacroActionID": null,
"MacroID": 208,
"Message": "executing macro \"Macro for Job \"test\"\" with 1 macro actions on ObjectID 96.",
"ObjectID": 96,
"Priority": "info",
"RunID": 1000
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Execution Plans
This resource allows read, create, update and delete operation for execution plans.
get /system/automation/execplans
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ExecPlanCollectionResponse
Schema:
{
"$id" : "ExecPlanCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of execution plans.",
"type" : "object",
"properties" : {
"ExecPlan" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ExecPlan_json"
}
}
},
"required" : [
"ExecPlan"
],
"definitions" : {
"_ExecPlan_json" : {
"$id" : "ExecPlan.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"description" : "Parameters of the execution plan, when and/or by what the corresponding job of this execution plan will be triggert",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string",
"readOnly" : true
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
}
},
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"ExecPlan": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"Name": "Some Job",
"Parameters": {
"Weekday": [ 0,3 ],
"Time": "10:00:00",
"Event": [ "TicketCreate" ]
},
"Type": "Ticket",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-10-01 15:30:14",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-10-01 15:30:14",
"ID": 2,
"Name": "Another Job",
"Parameters": {
"Weekday": [],
"Time": "",
"Event": [ "TicketStateUpdate" ]
},
"Type": "Ticket",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/execplans
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ExecPlanPostRequest
Schema:
{
"$id" : "ExecPlanPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan request object for creation.",
"type" : "object",
"properties" : {
"ExecPlan" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Parameters" : {
"$ref" : "#/definitions/_ExecPlanParametersPostPatchItem_json"
},
"Type" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Type"
]
}
},
"required" : [
"ExecPlan"
],
"definitions" : {
"_ExecPlanParametersPostPatchItem_json" : {
"$id" : "ExecPlanParametersPostPatchItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The parameters object for creation and update, for when and/or by what the corresponding job of the execution plan will be triggert.",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
}
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string"
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
}
}
}
}
}
}
Example:
{
"ExecPlan": {
"Comment": "some comment",
"Name": "new execution plan",
"Parameters": {
"Weekday": [ 0,3 ],
"Time": "10:00:00",
"Event": [ "TicketCreate" ]
},
"Type": "Ticket",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The ExecPlan has been created successfully.
Body
Media type: application/json
Type: ExecPlanPostPatchResponse
Schema:
{
"$id" : "ExecPlanPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated execution plan.",
"type" : "object",
"properties" : {
"ExecPlanID" : {
"type" : "integer"
}
},
"required" : [
"ExecPlanID"
]
}
Example:
{
"ExecPlanID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/execplans/types get
get /system/automation/execplans/types
Get all ExecPlanType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ExecPlanTypeCollectionResponse
Schema:
{
"$id" : "ExecPlanTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of executation plan types.",
"type" : "object",
"properties" : {
"ExecPlanType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ExecPlanType_json"
}
}
},
"required" : [
"ExecPlanType"
],
"definitions" : {
"_ExecPlanType_json" : {
"$id" : "ExecPlanType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan type object.",
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Options" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Name"
]
}
}
}
},
"required" : [
"Description",
"Name"
]
}
}
}
Example:
{
"ExecPlanType": [
{
"Description": "Allows an event based execution of automation jobs. At least one event must be configured.",
"Name": "EventBased",
"Options": {
"Event": {
"Description": "An array of events that should trigger the execution of the job.",
"Name": "Event",
"Required": 1
}
}
},
{
"Description": "Allows a time based execution of automation jobs. At least one weekday and time must be configured.",
"Name": "TimeBased",
"Options": {
"Time": {
"Description": "An array of times when the job should be executed on every configured weekday.",
"Name": "Time",
"Required": 1
},
"Weekday": {
"Description": "An array of weekdays (Mon,Tue,Wed,Thu,Fri,Sat,Sun) when the job should be executed.",
"Name": "Weekday",
"Required": 1
}
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/automation/execplans/{execPlanId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| execPlanId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ExecPlanResponse
Schema:
{
"$id" : "ExecPlanResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for an execution plan GET request.",
"type" : "object",
"properties" : {
"ExecPlan" : {
"$ref" : "#/definitions/_ExecPlan_json"
}
},
"required" : [
"ExecPlan"
],
"definitions" : {
"_ExecPlan_json" : {
"$id" : "ExecPlan.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"description" : "Parameters of the execution plan, when and/or by what the corresponding job of this execution plan will be triggert",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string",
"readOnly" : true
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
}
},
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"ExecPlan": {
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"Name": "Some Job",
"Parameters": {
"Weekday": [ 0,3 ],
"Time": "10:00:00",
"Event": [ "TicketCreate" ]
},
"Type": "Ticket",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/automation/execplans/{execPlanId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| execPlanId | integer |
Body
Media type: application/json
Type: ExecPlanPatchRequest
Schema:
{
"$id" : "ExecPlanPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The execution plan request object for update.",
"type" : "object",
"properties" : {
"ExecPlan" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Parameters" : {
"$ref" : "#/definitions/_ExecPlanParametersPostPatchItem_json"
},
"Type" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"ExecPlan"
],
"definitions" : {
"_ExecPlanParametersPostPatchItem_json" : {
"$id" : "ExecPlanParametersPostPatchItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The parameters object for creation and update, for when and/or by what the corresponding job of the execution plan will be triggert.",
"type" : "object",
"properties" : {
"Event" : {
"description" : "list of events, e.g. \"TicketCreate\"",
"type" : "array",
"item" : {
"type" : "string"
}
},
"Time" : {
"description" : "time for the weekdays as \"hh:mm:ss\"",
"type" : "string"
},
"Weekday" : {
"description" : "List of weekday: 0 = sunday, 1 = monday, ...",
"type" : "array",
"item" : {
"type" : "integer"
}
}
}
}
}
}
Example:
{
"ExecPlan": {
"Comment": "new comment",
"Name": "new execution plan name",
"Parameters": {
"Weekday": [ 1 ],
"Time": "12:00:00"
},
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ExecPlanPostPatchResponse
Schema:
{
"$id" : "ExecPlanPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated execution plan.",
"type" : "object",
"properties" : {
"ExecPlanID" : {
"type" : "integer"
}
},
"required" : [
"ExecPlanID"
]
}
Example:
{
"ExecPlanID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/automation/execplans/{execPlanId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| execPlanId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Macros
This resource allows read, create, update and delete operation for macros.
get /system/automation/macros
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroCollectionResponse
Schema:
{
"$id" : "MacroCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of macros.",
"type" : "object",
"properties" : {
"Macro" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Macro_json"
}
}
},
"required" : [
"Macro"
],
"definitions" : {
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
},
"_Macro_json" : {
"$id" : "Macro.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro object.",
"type" : "object",
"properties" : {
"Actions" : {
"description" : "added via include \"Actions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_MacroAction_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecOrder" : {
"description" : "Order of corresponding macro actions as IDs.",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"Macro": [
{
"Actions": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"MacroID": 1,
"Name": "First Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 2,
"MacroID": 1,
"Name": "Second Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
],
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ExecOrder": [ 1,2 ],
"ID": 1,
"Name": "Some Macro",
"Type": "Ticket",
"ValidID": 1
},
{
"Actions": [],
"ChangeBy": 1,
"ChangeTime": "2019-10-01 15:30:14",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-10-01 15:30:14",
"ExecOrder": [],
"ID": 2,
"Name": "Another Macro",
"Type": "Ticket",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/macros
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: MacroPostRequest
Schema:
{
"$id" : "MacroPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro request object for creation.",
"type" : "object",
"properties" : {
"Macro" : {
"type" : "object",
"properties" : {
"Actions" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_MacroActionPostItem_json"
}
},
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Type"
]
}
},
"required" : [
"Macro"
],
"definitions" : {
"_MacroActionPostItem_json" : {
"$id" : "MacroActionPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object for creation.",
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"MacroID",
"Type"
]
}
}
}
Example:
{
"Macro": {
"Actions": [
{
"Comment": "some comment",
"Name": "new macro",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
],
"Comment": "some comment",
"Name": "new macro",
"Type": "Ticket",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The Macro has been created successfully.
Body
Media type: application/json
Type: MacroPostPatchResponse
Schema:
{
"$id" : "MacroPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated macro.",
"type" : "object",
"properties" : {
"MacroID" : {
"type" : "integer"
}
},
"required" : [
"MacroID"
]
}
Example:
{
"MacroID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/macros/types get
get /system/automation/macros/types
Get all MacroType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/macros/types/{macroType} get
get /system/automation/macros/types/{macroType}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroType | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroTypeResponse
Schema:
{
"$id" : "MacroTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of macro types.",
"type" : "object",
"properties" : {
"MacroType" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Name"
]
}
}
},
"required" : [
"MacroType"
]
}
Example:
{
"MacroType": [
{
"DisplayName": "Ticket",
"Name": "Ticket"
}
]
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/macros/types/{macroType}/actiontypes get
get /system/automation/macros/types/{macroType}/actiontypes
Get all MacroActionType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroType | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroActionTypeCollectionResponse
Schema:
{
"$id" : "MacroActionTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of macro action types.",
"type" : "object",
"properties" : {
"MacroActionType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_MacroActionType_json"
}
}
},
"required" : [
"MacroActionType"
],
"definitions" : {
"_MacroActionType_json" : {
"$id" : "MacroActionType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action type object.",
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"MacroType" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Options" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Label",
"Name"
]
}
}
},
"Results" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "string",
"readOnly" : true
}
}
}
},
"required" : [
"Description",
"MacroType",
"Name"
]
}
}
}
Example:
{
"MacroActionType": [
{
"Description": "Sets the state of a ticket.",
"DisplayName": "Set Ticket State",
"MacroType": "Ticket",
"Name": "StateSet",
"Options": {
"PendingTimeDiff": {
"Description": "(Optional) The pending time in seconds. Will be added to the actual time when the macro action is executed. Used for pending states only.",
"Label": "Pending Time Difference",
"Name": "PendingTimeDiff",
"Required": 0
},
"State": {
"Description": "The name of the state to be set.",
"Label": "State",
"Name": "State",
"Required": 1
}
}
},
{
"Description": "Sets the type of a ticket.",
"DisplayName": "Set Ticket Type",
"MacroType": "Ticket",
"Name": "TypeSet",
"Options": {
"Type": {
"Description": "The name of the type to be set.",
"Label": "Type",
"Name": "Type",
"Required": 1
}
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/automation/macros/types/{macroType}/actiontypes/{macroActionType} get
get /system/automation/macros/types/{macroType}/actiontypes/{macroActionType}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroType | string | |||
| macroActionType | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroActionTypeResponse
Schema:
{
"$id" : "MacroActionTypeResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a macro action type GET request.",
"type" : "object",
"properties" : {
"MacroActionType" : {
"$ref" : "#/definitions/_MacroActionType_json"
}
},
"required" : [
"MacroActionType"
],
"definitions" : {
"_MacroActionType_json" : {
"$id" : "MacroActionType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action type object.",
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"MacroType" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Options" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Required" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Label",
"Name"
]
}
}
},
"Results" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "string",
"readOnly" : true
}
}
}
},
"required" : [
"Description",
"MacroType",
"Name"
]
}
}
}
Example:
{
"MacroActionType": {
"Description": "Sets the state of a ticket.",
"DisplayName": "Set Ticket State",
"MacroType": "Ticket",
"Name": "StateSet",
"Options": {
"PendingTimeDiff": {
"Description": "(Optional) The pending time in seconds. Will be added to the actual time when the macro action is executed. Used for pending states only.",
"Label": "Pending Time Difference",
"Name": "PendingTimeDiff",
"Required": 0
},
"State": {
"Description": "The name of the state to be set.",
"Label": "State",
"Name": "State",
"Required": 1
}
}
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/automation/macros/{macroId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroResponse
Schema:
{
"$id" : "MacroResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a macro GET request.",
"type" : "object",
"properties" : {
"Macro" : {
"$ref" : "#/definitions/_Macro_json"
}
},
"required" : [
"Macro"
],
"definitions" : {
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
},
"_Macro_json" : {
"$id" : "Macro.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro object.",
"type" : "object",
"properties" : {
"Actions" : {
"description" : "added via include \"Actions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_MacroAction_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ExecOrder" : {
"description" : "Order of corresponding macro actions as IDs.",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"Macro": {
"Actions": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"MacroID": 1,
"Name": "First Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 2,
"MacroID": 1,
"Name": "Second Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
],
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ExecOrder": [ 1,2 ],
"ID": 1,
"Name": "Some Macro",
"Type": "Ticket",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/automation/macros/{macroId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer |
Body
Media type: application/json
Type: MacroPatchRequest
Schema:
{
"$id" : "MacroPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro request object for update.",
"type" : "object",
"properties" : {
"Macro" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"ExecOrder" : {
"description" : "Order of corresponding macro actions as IDs.",
"type" : "array",
"item" : {
"type" : "number"
}
},
"Name" : {
"type" : "string"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Macro"
]
}
Example:
{
"Macro": {
"Comment": "new comment",
"ExecOrder": [ 2,1 ],
"Name": "new macro name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroPostPatchResponse
Schema:
{
"$id" : "MacroPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated macro.",
"type" : "object",
"properties" : {
"MacroID" : {
"type" : "integer"
}
},
"required" : [
"MacroID"
]
}
Example:
{
"MacroID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/automation/macros/{macroId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
MacroActions
This resource allows read, create, update and delete operation for macro actions of a specific macro.
get /system/automation/macros/{macroId}/actions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroActionCollectionResponse
Schema:
{
"$id" : "MacroActionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of macro actions.",
"type" : "object",
"properties" : {
"MacroAction" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_MacroAction_json"
}
}
},
"required" : [
"MacroAction"
],
"definitions" : {
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
}
}
}
Example:
{
"MacroAction": [
{
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"MacroID": 1,
"Name": "Some Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-10-01 15:30:14",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-10-01 15:30:14",
"ID": 2,
"MacroID": 1,
"Name": "Another Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/automation/macros/{macroId}/actions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer |
Body
Media type: application/json
Type: MacroActionPostRequest
Schema:
{
"$id" : "MacroActionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action request object for creation.",
"type" : "object",
"properties" : {
"MacroAction" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"MacroID",
"Type"
]
}
},
"required" : [
"MacroAction"
]
}
Example:
{
"MacroAction": {
"Comment": "some comment",
"MacroID": 1,
"Name": "new macro",
"Parameters": {},
"ResultVariables": {
"TicketID": "MyVariableName"
},
"Type": "Ticket",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The MacroAction has been created successfully.
Body
Media type: application/json
Type: MacroActionPostPatchResponse
Schema:
{
"$id" : "MacroActionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated macro action.",
"type" : "object",
"properties" : {
"MacroActionID" : {
"type" : "integer"
}
},
"required" : [
"MacroActionID"
]
}
Example:
{
"MacroActionID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/automation/macros/{macroId}/actions/{macroActionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer | |||
| macroActionId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroActionResponse
Schema:
{
"$id" : "MacroActionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a macro action GET request.",
"type" : "object",
"properties" : {
"MacroAction" : {
"$ref" : "#/definitions/_MacroAction_json"
}
},
"required" : [
"MacroAction"
],
"definitions" : {
"_MacroAction_json" : {
"$id" : "MacroAction.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"MacroID" : {
"description" : "ID of the corresponding macro.",
"type" : "integer"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"MacroID",
"Type",
"ValidID"
]
}
}
}
Example:
{
"MacroAction": {
"ChangeBy": 1,
"ChangeTime": "2019-10-10 09:13:05",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-02 13:35:42",
"ID": 1,
"MacroID": 1,
"Name": "Some Macro Action",
"Parameters": {},
"Type": "Ticket",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/automation/macros/{macroId}/actions/{macroActionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer | |||
| macroActionId | integer |
Body
Media type: application/json
Type: MacroActionPatchRequest
Schema:
{
"$id" : "MacroActionPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The macro action request object for update.",
"type" : "object",
"properties" : {
"MacroAction" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Parameters" : {
"description" : "",
"type" : "object"
},
"ResultVariables" : {
"description" : "An optional mapping of named results of the macro action and their variable names.",
"type" : "object"
},
"Type" : {
"description" : "",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"MacroAction"
]
}
Example:
{
"MacroAction": {
"Comment": "new comment",
"Name": "new macro action name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MacroActionPostPatchResponse
Schema:
{
"$id" : "MacroActionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated macro action.",
"type" : "object",
"properties" : {
"MacroActionID" : {
"type" : "integer"
}
},
"required" : [
"MacroActionID"
]
}
Example:
{
"MacroActionID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/automation/macros/{macroId}/actions/{macroActionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| macroId | integer | |||
| macroActionId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] CMDB
Classes of Configuration Items
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
ConfigItemStats | Adds some statistics to the response, about the Config Items of this class. It will contain the number of Config Items in pre-productive and productive deployment states |
CurrentDefinition | Adds the current definition of the Config Item class to the response. See sub-resource "definitions". |
get /system/cmdb/classes
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemClassCollectionResponse
Schema:
{
"$id" : "ConfigItemClassCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item class objects.",
"type" : "object",
"properties" : {
"ConfigItemClass" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItemClass_json"
}
}
},
"required" : [
"ConfigItemClass"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemClass_json" : {
"$id" : "ConfigItemClass.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemStats" : {
"description" : "result of include \"ConfigItemStats\"",
"type" : "object",
"properties" : {
"PreProductiveCount" : {
"type" : "integer",
"readOnly" : true
},
"ProductiveCount" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"PreProductiveCount",
"ProductiveCount"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurrentDefinition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"Definitions" : {
"description" : "added via include \"Definitions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
}
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"ConfigItemClass": [
{
"ChangeBy": 1,
"ChangeTime": "2017-08-18 22:47:00",
"ID": 22,
"CreateBy": 1,
"Comment": "",
"CreateTime": "2017-08-18 22:47:00",
"ValidID": 1,
"Name": "Computer"
},
{
"ChangeBy": 1,
"ChangeTime": "2017-08-18 22:47:00",
"Name": "Hardware",
"ValidID": 1,
"ID": 23,
"CreateBy": 1,
"CreateTime": "2017-08-18 22:47:00",
"Comment": ""
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/cmdb/classes
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ConfigItemClassPostRequest
Schema:
{
"$id" : "ConfigItemClassPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class object for creation.",
"type" : "object",
"properties" : {
"ConfigItemClass" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"DefinitionString" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name"
]
}
},
"required" : [
"ConfigItemClass"
]
}
Example:
{
"ConfigItemClass": {
"Name": "test ci class",
"Comment": "for testing purposes"
}
} Possible Responses
HTTP status code 201
The ConfigItemClass has been created successfully.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/cmdb/classes/{classId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemClassResponse
Schema:
{
"$id" : "ConfigItemClassResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item class GET request.",
"type" : "object",
"properties" : {
"ConfigItemClass" : {
"$ref" : "#/definitions/_ConfigItemClass_json"
}
},
"required" : [
"ConfigItemClass"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
},
"_ConfigItemClass_json" : {
"$id" : "ConfigItemClass.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ConfigItemStats" : {
"description" : "result of include \"ConfigItemStats\"",
"type" : "object",
"properties" : {
"PreProductiveCount" : {
"type" : "integer",
"readOnly" : true
},
"ProductiveCount" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"PreProductiveCount",
"ProductiveCount"
]
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CurrentDefinition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
},
"Definitions" : {
"description" : "added via include \"Definitions\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
}
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"ConfigItemClass": {
"ChangeTime": "2017-08-18 22:47:00",
"ChangeBy": 1,
"Name": "Computer",
"ValidID": 1,
"CreateTime": "2017-08-18 22:47:00",
"Comment": "",
"CreateBy": 1,
"ID": 22
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/cmdb/classes/{classId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer |
Body
Media type: application/json
Type: ConfigItemClassPatchRequest
Schema:
{
"$id" : "ConfigItemClassPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class object for update.",
"type" : "object",
"properties" : {
"ConfigItemClass" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"ConfigItemClass"
]
}
Example:
{
"ConfigItemClass": {
"ValidID": 2
}
} Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemClassPostPatchResponse
Schema:
{
"$id" : "ConfigItemClassPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated config item class.",
"type" : "object",
"properties" : {
"ConfigItemClassID" : {
"type" : "integer"
}
},
"required" : [
"ConfigItemClassID"
]
}
Example:
{
"ConfigItemClassID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/cmdb/classes/{classId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Definitions of Classes
get /system/cmdb/classes/{classId}/definitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemClassDefinitionCollectionResponse
Schema:
{
"$id" : "ConfigItemClassDefinitionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of config item class definitions.",
"type" : "object",
"properties" : {
"ConfigItemClassDefinition" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
}
}
},
"required" : [
"ConfigItemClassDefinition"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
}
}
}
Example:
{
"ConfigItemClassDefinition": [
{
"Class": "Computer",
"ClassID": 22,
"CreateBy": 1,
"CreateTime": "2017-08-18 22:47:00",
"Definition": [
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "Date",
"YearPeriodFuture": 10,
"YearPeriodPast": 20
},
"Key": "InstallDate",
"Name": "Install Date",
"Searchable": 1
},
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "TextArea"
},
"Key": "Note",
"Name": "Note",
"Searchable": 1
},
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "TextArea"
},
"Key": "OtherEquipment",
"Name": "Other Equipment"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Class": "ITSM::ConfigItem::Computer::Type",
"Translation": 1,
"Type": "GeneralCatalog"
},
"Key": "Type",
"Name": "Type",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "FQDN",
"Name": "FQDN",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "GraphicAdapter",
"Name": "Graphic Adapter"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "OperatingSystem",
"Name": "Operating System"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "SerialNumber",
"Name": "Serial Number",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 50,
"Size": 50,
"Type": "Text"
},
"Key": "Model",
"Name": "Model",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 50,
"Size": 50,
"Type": "Text"
},
"Key": "Vendor",
"Name": "Vendor",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "Customer"
},
"Key": "Owner",
"Name": "Assigned owner",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "Date",
"YearPeriodFuture": 10,
"YearPeriodPast": 20
},
"Key": "WarrantyExpirationDate",
"Name": "Warranty Expiration Date",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "TextArea"
},
"Key": "Description",
"Name": "Description",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 0,
"Input": {
"MaxLength": 100,
"Required": 1,
"Size": 50,
"Type": "Text"
},
"Key": "NIC",
"Name": "Network Adapter",
"Sub": [
{
"CountDefault": 0,
"CountMax": 20,
"CountMin": 0,
"Input": {
"MaxLength": 40,
"Required": 1,
"Size": 40,
"Type": "Text"
},
"Key": "IPAddress",
"Name": "IP Address",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Class": "ITSM::ConfigItem::YesNo",
"Required": 1,
"Translation": 1,
"Type": "GeneralCatalog"
},
"Key": "IPoverDHCP",
"Name": "IP over DHCP"
}
]
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "HardDisk",
"Name": "Hard Disk",
"Sub": [
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 10,
"Size": 20,
"Type": "Text"
},
"Key": "Capacity",
"Name": "Capacity"
}
]
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "Ram",
"Name": "Ram"
},
{
"CountDefault": 1,
"CountMax": 16,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "CPU",
"Name": "CPU"
}
],
"DefinitionID": 1,
"DefinitionString": "[ { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Vendor', 'Name' => 'Vendor', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Model', 'Name' => 'Model', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'TextArea' }, 'Key' => 'Description', 'Name' => 'Description', 'Searchable' => 1 }, { 'Input' => { 'Class' => 'ITSM::ConfigItem::Computer::Type', 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'Type', 'Name' => 'Type', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'Customer' }, 'Key' => 'Owner', 'Name' => 'Assigned owner', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'SerialNumber', 'Name' => 'Serial Number', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'OperatingSystem', 'Name' => 'Operating System' }, { 'CountMax' => 16, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'CPU', 'Name' => 'CPU' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Ram', 'Name' => 'Ram' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'HardDisk', 'Name' => 'Hard Disk', 'Sub' => [ { 'Input' => { 'MaxLength' => 10, 'Size' => 20, 'Type' => 'Text' }, 'Key' => 'Capacity', 'Name' => 'Capacity' } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'FQDN', 'Name' => 'FQDN', 'Searchable' => 1 }, { 'CountDefault' => 1, 'CountMax' => 10, 'CountMin' => 0, 'Input' => { 'MaxLength' => 100, 'Required' => 1, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'NIC', 'Name' => 'Network Adapter', 'Sub' => [ { 'Input' => { 'Class' => 'ITSM::ConfigItem::YesNo', 'Required' => 1, 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'IPoverDHCP', 'Name' => 'IP over DHCP' }, { 'CountDefault' => 0, 'CountMax' => 20, 'CountMin' => 0, 'Input' => { 'MaxLength' => 40, 'Required' => 1, 'Size' => 40, 'Type' => 'Text' }, 'Key' => 'IPAddress', 'Name' => 'IP Address', 'Searchable' => 1 } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'GraphicAdapter', 'Name' => 'Graphic Adapter' }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'OtherEquipment', 'Name' => 'Other Equipment' }, { 'Input' => { 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'WarrantyExpirationDate', 'Name' => 'Warranty Expiration Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'InstallDate', 'Name' => 'Install Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'Note', 'Name' => 'Note', 'Searchable' => 1} ];",
"Version": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/cmdb/classes/{classId}/definitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer |
Body
Media type: application/json
Type: ConfigItemClassDefinitionPostRequest
Schema:
{
"$id" : "ConfigItemClassDefinitionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition request object for creation.",
"type" : "object",
"properties" : {
"ConfigItemClassDefinition" : {
"type" : "object",
"properties" : {
"DefinitionString" : {
"type" : "string"
}
},
"required" : [
"DefinitionString"
]
}
},
"required" : [
"ConfigItemClassDefinition"
]
}
Example:
{
"ConfigItemClassDefinition": {
"DefinitionString": "[ { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Vendor', 'Name' => 'Vendor', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Model', 'Name' => 'Model', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'TextArea' }, 'Key' => 'Description', 'Name' => 'Description', 'Searchable' => 1 }, { 'Input' => { 'Class' => 'ITSM::ConfigItem::Computer::Type', 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'Type', 'Name' => 'Type', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'Customer' }, 'Key' => 'Owner', 'Name' => 'Assigned owner', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'SerialNumber', 'Name' => 'Serial Number', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'OperatingSystem', 'Name' => 'Operating System' }, { 'CountMax' => 16, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'CPU', 'Name' => 'CPU' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Ram', 'Name' => 'Ram' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'HardDisk', 'Name' => 'Hard Disk', 'Sub' => [ { 'Input' => { 'MaxLength' => 10, 'Size' => 20, 'Type' => 'Text' }, 'Key' => 'Capacity', 'Name' => 'Capacity' } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'FQDN', 'Name' => 'FQDN', 'Searchable' => 1 }, { 'CountDefault' => 1, 'CountMax' => 10, 'CountMin' => 0, 'Input' => { 'MaxLength' => 100, 'Required' => 1, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'NIC', 'Name' => 'Network Adapter', 'Sub' => [ { 'Input' => { 'Class' => 'ITSM::ConfigItem::YesNo', 'Required' => 1, 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'IPoverDHCP', 'Name' => 'IP over DHCP' }, { 'CountDefault' => 0, 'CountMax' => 20, 'CountMin' => 0, 'Input' => { 'MaxLength' => 40, 'Required' => 1, 'Size' => 40, 'Type' => 'Text' }, 'Key' => 'IPAddress', 'Name' => 'IP Address', 'Searchable' => 1 } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'GraphicAdapter', 'Name' => 'Graphic Adapter' }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'OtherEquipment', 'Name' => 'Other Equipment' }, { 'Input' => { 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'WarrantyExpirationDate', 'Name' => 'Warranty Expiration Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'InstallDate', 'Name' => 'Install Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'Note', 'Name' => 'Note', 'Searchable' => 1} ];"
}
}Possible Responses
HTTP status code 201
The ConfigItemClassDefinition has been created successfully.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/cmdb/classes/{classId}/definitions/{definitionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer | |||
| definitionId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConfigItemClassDefinitionResponse
Schema:
{
"$id" : "ConfigItemClassDefinitionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a config item class definition GET request.",
"type" : "object",
"properties" : {
"ConfigItemClassDefinition" : {
"$ref" : "#/definitions/_ConfigItemClassDefinition_json"
}
},
"required" : [
"ConfigItemClassDefinition"
],
"definitions" : {
"_ConfigItemClassDefinition_json" : {
"$id" : "ConfigItemClassDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The config item class definition object.",
"type" : "object",
"properties" : {
"Class" : {
"type" : "string",
"readOnly" : true
},
"ClassID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Definition" : {
"type" : "array",
"items" : {
"type" : "object"
},
"readOnly" : true
},
"DefinitionID" : {
"type" : "integer",
"readOnly" : true
},
"DefinitionString" : {
"type" : "string",
"readOnly" : true
},
"Version" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"Class",
"ClassID",
"CreateBy",
"CreateTime",
"Definition",
"DefinitionID",
"DefinitionString",
"Version"
]
}
}
}
Example:
{
"ConfigItemClassDefinition": {
"Class": "Computer",
"ClassID": 22,
"CreateBy": 1,
"CreateTime": "2017-08-18 22:47:00",
"Definition": [
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "Date",
"YearPeriodFuture": 10,
"YearPeriodPast": 20
},
"Key": "InstallDate",
"Name": "Install Date",
"Searchable": 1
},
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "TextArea"
},
"Key": "Note",
"Name": "Note",
"Searchable": 1
},
{
"CountDefault": 0,
"CountMax": 1,
"CountMin": 0,
"Input": {
"Required": 1,
"Type": "TextArea"
},
"Key": "OtherEquipment",
"Name": "Other Equipment"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Class": "ITSM::ConfigItem::Computer::Type",
"Translation": 1,
"Type": "GeneralCatalog"
},
"Key": "Type",
"Name": "Type",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "FQDN",
"Name": "FQDN",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "GraphicAdapter",
"Name": "Graphic Adapter"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "OperatingSystem",
"Name": "Operating System"
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "SerialNumber",
"Name": "Serial Number",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 50,
"Size": 50,
"Type": "Text"
},
"Key": "Model",
"Name": "Model",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 50,
"Size": 50,
"Type": "Text"
},
"Key": "Vendor",
"Name": "Vendor",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "Customer"
},
"Key": "Owner",
"Name": "Assigned owner",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "Date",
"YearPeriodFuture": 10,
"YearPeriodPast": 20
},
"Key": "WarrantyExpirationDate",
"Name": "Warranty Expiration Date",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Type": "TextArea"
},
"Key": "Description",
"Name": "Description",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 0,
"Input": {
"MaxLength": 100,
"Required": 1,
"Size": 50,
"Type": "Text"
},
"Key": "NIC",
"Name": "Network Adapter",
"Sub": [
{
"CountDefault": 0,
"CountMax": 20,
"CountMin": 0,
"Input": {
"MaxLength": 40,
"Required": 1,
"Size": 40,
"Type": "Text"
},
"Key": "IPAddress",
"Name": "IP Address",
"Searchable": 1
},
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"Class": "ITSM::ConfigItem::YesNo",
"Required": 1,
"Translation": 1,
"Type": "GeneralCatalog"
},
"Key": "IPoverDHCP",
"Name": "IP over DHCP"
}
]
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "HardDisk",
"Name": "Hard Disk",
"Sub": [
{
"CountDefault": 1,
"CountMax": 1,
"CountMin": 1,
"Input": {
"MaxLength": 10,
"Size": 20,
"Type": "Text"
},
"Key": "Capacity",
"Name": "Capacity"
}
]
},
{
"CountDefault": 1,
"CountMax": 10,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "Ram",
"Name": "Ram"
},
{
"CountDefault": 1,
"CountMax": 16,
"CountMin": 1,
"Input": {
"MaxLength": 100,
"Size": 50,
"Type": "Text"
},
"Key": "CPU",
"Name": "CPU"
}
],
"DefinitionID": 1,
"DefinitionString": "[ { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Vendor', 'Name' => 'Vendor', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 50, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Model', 'Name' => 'Model', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'TextArea' }, 'Key' => 'Description', 'Name' => 'Description', 'Searchable' => 1 }, { 'Input' => { 'Class' => 'ITSM::ConfigItem::Computer::Type', 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'Type', 'Name' => 'Type', 'Searchable' => 1 }, { 'Input' => { 'Type' => 'Customer' }, 'Key' => 'Owner', 'Name' => 'Assigned owner', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'SerialNumber', 'Name' => 'Serial Number', 'Searchable' => 1 }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'OperatingSystem', 'Name' => 'Operating System' }, { 'CountMax' => 16, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'CPU', 'Name' => 'CPU' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'Ram', 'Name' => 'Ram' }, { 'CountMax' => 10, 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'HardDisk', 'Name' => 'Hard Disk', 'Sub' => [ { 'Input' => { 'MaxLength' => 10, 'Size' => 20, 'Type' => 'Text' }, 'Key' => 'Capacity', 'Name' => 'Capacity' } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'FQDN', 'Name' => 'FQDN', 'Searchable' => 1 }, { 'CountDefault' => 1, 'CountMax' => 10, 'CountMin' => 0, 'Input' => { 'MaxLength' => 100, 'Required' => 1, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'NIC', 'Name' => 'Network Adapter', 'Sub' => [ { 'Input' => { 'Class' => 'ITSM::ConfigItem::YesNo', 'Required' => 1, 'Translation' => 1, 'Type' => 'GeneralCatalog' }, 'Key' => 'IPoverDHCP', 'Name' => 'IP over DHCP' }, { 'CountDefault' => 0, 'CountMax' => 20, 'CountMin' => 0, 'Input' => { 'MaxLength' => 40, 'Required' => 1, 'Size' => 40, 'Type' => 'Text' }, 'Key' => 'IPAddress', 'Name' => 'IP Address', 'Searchable' => 1 } ] }, { 'Input' => { 'MaxLength' => 100, 'Size' => 50, 'Type' => 'Text' }, 'Key' => 'GraphicAdapter', 'Name' => 'Graphic Adapter' }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'OtherEquipment', 'Name' => 'Other Equipment' }, { 'Input' => { 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'WarrantyExpirationDate', 'Name' => 'Warranty Expiration Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'Date', 'YearPeriodFuture' => 10, 'YearPeriodPast' => 20 }, 'Key' => 'InstallDate', 'Name' => 'Install Date', 'Searchable' => 1 }, { 'CountDefault' => 0, 'CountMin' => 0, 'Input' => { 'Required' => 1, 'Type' => 'TextArea' }, 'Key' => 'Note', 'Name' => 'Note', 'Searchable' => 1} ];",
"Version": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/cmdb/classes/{classId}/definitions/{definitionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| classId | integer | |||
| definitionId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - Channels
/system/communication/channels get
get /system/communication/channels
Get all Channel items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ChannelCollectionResponse
Schema:
{
"$id" : "ChannelCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of channels.",
"type" : "object",
"properties" : {
"Channel" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Channel_json"
}
}
},
"required" : [
"Channel"
],
"definitions" : {
"_Channel_json" : {
"$id" : "Channel.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The channel object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Channel": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "note",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "email",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/communication/channels/{channelId} get
get /system/communication/channels/{channelId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| channelId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ChannelResponse
Schema:
{
"$id" : "ChannelResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a channel GET request.",
"type" : "object",
"properties" : {
"Channel" : {
"$ref" : "#/definitions/_Channel_json"
}
},
"required" : [
"Channel"
],
"definitions" : {
"_Channel_json" : {
"$id" : "Channel.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The channel object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Channel": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "note",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - Mail Accounts
get /system/communication/mailaccounts
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailAccountCollectionResponse
Schema:
{
"$id" : "MailAccountCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of mail accounts.",
"type" : "object",
"properties" : {
"MailAccount" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_MailAccount_json"
}
}
},
"required" : [
"MailAccount"
],
"definitions" : {
"_MailAccount_json" : {
"$id" : "MailAccount.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail account object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DispatchingBy" : {
"description" : "Can be either 'PostmasterDefaultQueue', 'From' or 'Queue'.",
"type" : "string",
"readOnly" : true
},
"Host" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IMAPFolder" : {
"description" : "The IMAP folder to use if type is 'IMAP'.",
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"OAuth2_ProfileID" : {
"description" : "The ID of the oauth2 profile to use if type is kind of 'OAuth2'.",
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"description" : "The ID of the queue to dispatch to if DispatchingBy is 'Queue'.",
"type" : "integer",
"readOnly" : true
},
"Trusted" : {
"description" : "If set to 1 the KIX-X-Headers will be interpreted.",
"type" : "integer",
"readOnly" : true
},
"Type" : {
"description" : "One of the available types from resource /system/communication/mailaccounts/types.",
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"DispatchingBy",
"ID",
"Host",
"Login",
"Type",
"ValidID"
]
}
}
}
Example:
{
"MailAccount": [
{
"ChangeBy": 1,
"ChangeTime": "2019-05-29 13:13:09",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-01-03 14:47:10",
"DispatchingBy": "From",
"Host": "somehost",
"ID": 2,
"IMAPFolder": "INBOX",
"Login": "test",
"QueueID": 0,
"Trusted": 0,
"Type": "IMAP",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/communication/mailaccounts
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: MailAccountPostRequest
Schema:
{
"$id" : "MailAccountPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail account request object for creation.",
"type" : "object",
"properties" : {
"MailAccount" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"DispatchingBy" : {
"description" : "Can be either 'PostmasterDefaultQueue', 'From' or 'Queue'.",
"type" : "string"
},
"Host" : {
"type" : "string"
},
"IMAPFolder" : {
"description" : "The IMAP folder to use if type is 'IMAP'.",
"type" : "string"
},
"Login" : {
"type" : "string"
},
"Password" : {
"type" : "string"
},
"QueueID" : {
"description" : "The ID of the queue to dispatch to if DispatchingBy is 'Queue'.",
"type" : "integer"
},
"Trusted" : {
"description" : "If set to 1 the KIX-X-Headers will be interpreted.",
"type" : "integer"
},
"Type" : {
"description" : "One of the available types from resource /system/communication/mailaccounts/types.",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"DispatchingBy",
"Host",
"Login",
"Type"
]
}
},
"required" : [
"MailAccount"
]
}
Example:
{
"MailAccount": {
"DispatchingBy": "Queue",
"Host": "somehost",
"IMAPFolder": "INBOX",
"Login": "test",
"Password": "test123",
"QueueID": 1,
"Type": "IMAP",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The MailAccount has been created successfully.
Body
Media type: application/json
Type: MailAccountPostPatchResponse
Schema:
{
"$id" : "MailAccountPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated mail account.",
"type" : "object",
"properties" : {
"MailAccountID" : {
"type" : "integer"
}
},
"required" : [
"MailAccountID"
]
}
Example:
{
"MailAccountID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/communication/mailaccounts/types get
get /system/communication/mailaccounts/types
Get all MailAccountType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailAccountTypeCollectionResponse
Schema:
{
"$id" : "MailAccountTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of mail account types.",
"type" : "object",
"properties" : {
"MailAccountType" : {
"type" : "array",
"items" : {
"type" : "string",
"readOnly" : true
}
}
},
"required" : [
"MailAccountType"
]
}
Example:
{
"MailAccountType": [
"IMAP",
"IMAPS",
"IMAPTLS",
"POP3",
"POP3S",
"POP3TLS"
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/communication/mailaccounts/{mailAccountId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailAccountId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailAccountResponse
Schema:
{
"$id" : "MailAccountResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a mail account GET request.",
"type" : "object",
"properties" : {
"MailAccount" : {
"$ref" : "#/definitions/_MailAccount_json"
}
},
"required" : [
"MailAccount"
],
"definitions" : {
"_MailAccount_json" : {
"$id" : "MailAccount.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail account object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DispatchingBy" : {
"description" : "Can be either 'PostmasterDefaultQueue', 'From' or 'Queue'.",
"type" : "string",
"readOnly" : true
},
"Host" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IMAPFolder" : {
"description" : "The IMAP folder to use if type is 'IMAP'.",
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"OAuth2_ProfileID" : {
"description" : "The ID of the oauth2 profile to use if type is kind of 'OAuth2'.",
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"description" : "The ID of the queue to dispatch to if DispatchingBy is 'Queue'.",
"type" : "integer",
"readOnly" : true
},
"Trusted" : {
"description" : "If set to 1 the KIX-X-Headers will be interpreted.",
"type" : "integer",
"readOnly" : true
},
"Type" : {
"description" : "One of the available types from resource /system/communication/mailaccounts/types.",
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"DispatchingBy",
"ID",
"Host",
"Login",
"Type",
"ValidID"
]
}
}
}
Example:
{
"MailAccount": {
"ChangeBy": 1,
"ChangeTime": "2019-05-29 13:13:09",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-01-03 14:47:10",
"DispatchingBy": "From",
"Host": "somehost",
"ID": 2,
"IMAPFolder": "INBOX",
"Login": "test",
"QueueID": 0,
"Trusted": 0,
"Type": "IMAP",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/communication/mailaccounts/{mailAccountId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailAccountId | integer |
Body
Media type: application/json
Type: MailAccountPatchRequest
Schema:
{
"$id" : "MailAccountPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail account request object for update.",
"type" : "object",
"properties" : {
"MailAccount" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"DispatchingBy" : {
"description" : "Can be either 'PostmasterDefaultQueue', 'From' or 'Queue'.",
"type" : "string"
},
"ExecFetch" : {
"description" : "ACTION TRIGGER (non-persistent attribute)! If set to 1 all emails will be fetched.",
"type" : "integer"
},
"Host" : {
"type" : "string"
},
"IMAPFolder" : {
"description" : "The IMAP folder to use if type is 'IMAP'.",
"type" : "string"
},
"Login" : {
"type" : "string"
},
"Password" : {
"type" : "string"
},
"QueueID" : {
"description" : "The ID of the queue to dispatch to if DispatchingBy is 'Queue'.",
"type" : "integer"
},
"Trusted" : {
"description" : "If set to 1 the KIX-X-Headers will be interpreted.",
"type" : "integer"
},
"Type" : {
"description" : "One of the available types from resource /system/communication/mailaccounts/types.",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"MailAccount"
]
}
Example:
{
"MailAccount": {
"Comment": "new comment",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailAccountPostPatchResponse
Schema:
{
"$id" : "MailAccountPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated mail account.",
"type" : "object",
"properties" : {
"MailAccountID" : {
"type" : "integer"
}
},
"required" : [
"MailAccountID"
]
}
Example:
{
"MailAccountID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/communication/mailaccounts/{mailAccountId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailAccountId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - Mail Filters
get /system/communication/mailfilters
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailFilterCollectionResponse
Schema:
{
"$id" : "MailFilterCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of mail filters.",
"type" : "object",
"properties" : {
"MailFilter" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_MailFilter_json"
}
}
},
"required" : [
"MailFilter"
],
"definitions" : {
"_MailFilter_json" : {
"$id" : "MailFilter.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail filter object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Match" : {
"type" : "array",
"item" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant email or x-kix header",
"type" : "string"
},
"Not" : {
"description" : "to negate value",
"type" : "integer"
},
"Value" : {
"description" : "value of header, regular expression is possible",
"type" : "string"
}
}
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Set" : {
"type" : "array",
"item" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant x-kix header",
"type" : "string"
},
"Value" : {
"description" : "value for header",
"type" : "string"
}
}
},
"readOnly" : true
},
"StopAfterMatch" : {
"type" : "integer",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"MailFilter": [
{
"ChangeBy": 1,
"ChangeTime": "2019-06-11 09:00:00",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-28 11:35:42",
"ID": 1,
"Match": [
{
"Key": "From",
"Value": "email@example.com",
"Not": 0
},
{
"Key": "Subject",
"Value": "Test",
"Not": 1
}
],
"Name": "filter one",
"Set": [
{
"Key": "X-KIX-Queue",
"Value": "Some::Queue"
}
],
"StopAfterMatch": 1,
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-06-05 09:38:00",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-05 09:38:00",
"ID": 2,
"Match": [
{
"Key": "From",
"Value": "another_email@example.com",
"Not": 1
}
],
"Set": [
{
"Key": "X-KIX-State",
"Value": "SomeState"
}
],
"Name": "filter two",
"StopAfterMatch": 0,
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/communication/mailfilters
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: MailFilterPostRequest
Schema:
{
"$id" : "MailFilterPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail filter request object for creation.",
"type" : "object",
"properties" : {
"MailFilter" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Match" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant email or x-kix header",
"type" : "string"
},
"Not" : {
"description" : "to negate value",
"type" : "integer"
},
"Value" : {
"description" : "value of header, regular expression is possible",
"type" : "string"
}
},
"required" : [
"Key",
"Value"
]
}
},
"Name" : {
"type" : "string"
},
"Set" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant x-kix header",
"type" : "string"
},
"Value" : {
"description" : "value for header",
"type" : "string"
}
},
"required" : [
"Key",
"Value"
]
}
},
"StopAfterMatch" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Match",
"Name",
"Set"
]
}
},
"required" : [
"MailFilter"
]
}
Example:
{
"MailFilter": {
"Comment": "...",
"Match": [
{
"Key": "From",
"Value": "email@example.com",
"Not": 1
},
{
"Key": "Subject",
"Value": "Test"
}
],
"Name": "new filter",
"Set": [
{
"Key": "X-KIX-Queue",
"Value": "Some::Queue"
}
],
"StopAfterMatch": 1,
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The MailFilter has been created successfully.
Body
Media type: application/json
Type: MailFilterPostPatchResponse
Schema:
{
"$id" : "MailFilterPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated mail filter.",
"type" : "object",
"properties" : {
"MailFilterID" : {
"type" : "integer"
}
},
"required" : [
"MailFilterID"
]
}
Example:
{
"MailFilterID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/communication/mailfilters/{mailFilterId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailFilterId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailFilterResponse
Schema:
{
"$id" : "MailFilterResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a mail filter GET request.",
"type" : "object",
"properties" : {
"MailFilter" : {
"$ref" : "#/definitions/_MailFilter_json"
}
},
"required" : [
"MailFilter"
],
"definitions" : {
"_MailFilter_json" : {
"$id" : "MailFilter.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail filter object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Match" : {
"type" : "array",
"item" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant email or x-kix header",
"type" : "string"
},
"Not" : {
"description" : "to negate value",
"type" : "integer"
},
"Value" : {
"description" : "value of header, regular expression is possible",
"type" : "string"
}
}
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Set" : {
"type" : "array",
"item" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant x-kix header",
"type" : "string"
},
"Value" : {
"description" : "value for header",
"type" : "string"
}
}
},
"readOnly" : true
},
"StopAfterMatch" : {
"type" : "integer",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"MailFilter": {
"ChangeBy": 1,
"ChangeTime": "2019-06-11 09:00:00",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2019-05-28 11:35:42",
"ID": 1,
"Match": [
{
"Key": "From",
"Value": "email@example.com",
"Not": 0
},
{
"Key": "Subject",
"Value": "Test",
"Not": 1
}
],
"Name": "filter one name",
"Set": [
{
"Key": "X-KIX-Queue",
"Value": "Some::Queue"
}
],
"StopAfterMatch": 1,
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/communication/mailfilters/{mailFilterId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailFilterId | integer |
Body
Media type: application/json
Type: MailFilterPatchRequest
Schema:
{
"$id" : "MailFilterPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The mail filter request object for update.",
"type" : "object",
"properties" : {
"MailFilter" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Match" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant email or x-kix header",
"type" : "string"
},
"Not" : {
"description" : "to negate value",
"type" : "integer"
},
"Value" : {
"description" : "value of header, regular expression is possible",
"type" : "string"
}
},
"required" : [
"Key",
"Value"
]
}
},
"Name" : {
"type" : "string"
},
"Set" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Key" : {
"description" : "relevant x-kix header",
"type" : "string"
},
"Value" : {
"description" : "value for header",
"type" : "string"
}
},
"required" : [
"Key",
"Value"
]
}
},
"StopAfterMatch" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"MailFilter"
]
}
Example:
{
"MailFilter": {
"Comment": "new comment",
"Match": [
{
"Key": "From",
"Value": "email@example.com",
"Not": 0
}
],
"Name": "new filter name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: MailFilterPostPatchResponse
Schema:
{
"$id" : "MailFilterPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated mail filter.",
"type" : "object",
"properties" : {
"MailFilterID" : {
"type" : "integer"
}
},
"required" : [
"MailFilterID"
]
}
Example:
{
"MailFilterID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/communication/mailfilters/{mailFilterId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| mailFilterId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - Notifications
get /system/communication/notifications
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: NotificationCollectionResponse
Schema:
{
"$id" : "NotificationCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of notifications.",
"type" : "object",
"properties" : {
"Notification" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Notification_json"
}
}
},
"required" : [
"Notification"
],
"definitions" : {
"_Notification_json" : {
"$id" : "Notification.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The notification object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Message" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Body" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
}
},
"required" : [
"Body",
"ContentType",
"Subject"
]
}
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Data",
"ID",
"Name",
"Message",
"ValidID"
]
}
}
}
Example:
{
"Notification": [
{
"ChangeBy": 1,
"ChangeTime": "2017-08-08 09:23:12",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2017-08-08 09:23:12",
"Data": {
"Events": [
"NotificationPendingReminder"
],
"LockID": [
"2",
"3"
],
"OncePerDay": [
"1"
],
"Recipients": [
"AgentOwner",
"AgentResponsible"
],
"SendOnOutOfOffice": [
"1"
],
"Transports": [
"Email"
]
},
"ID": 9,
"Message": {
"de": {
"Body": "Hallo <KIX_NOTIFICATION_RECIPIENT_UserFirstname> <KIX_NOTIFICATION_RECIPIENT_UserLastname>,\n\ndie Erinnerungszeit für das gesperrte Ticket [<KIX_CONFIG_Ticket::Hook><KIX_CONFIG_Ticket::HookDivider><KIX_TICKET_TicketNumber>] wurde erreicht.\n\n<KIX_CONFIG_HttpType>://<KIX_CONFIG_FQDN>/<KIX_CONFIG_ScriptAlias>index.pl?Action=AgentTicketZoom;TicketID=<KIX_TICKET_TicketID>\n\n-- <KIX_CONFIG_NotificationSenderName>",
"ContentType": "text/plain",
"Subject": "Erinnerungszeit des gesperrten Tickets erreicht: <KIX_TICKET_Title>"
},
"en": {
"Body": "Hi <KIX_NOTIFICATION_RECIPIENT_UserFirstname>,\n\nthe pending reminder time of the locked ticket [<KIX_CONFIG_Ticket::Hook><KIX_CONFIG_Ticket::HookDivider><KIX_TICKET_TicketNumber>] has been reached.\n\n<KIX_CONFIG_HttpType>://<KIX_CONFIG_FQDN>/<KIX_CONFIG_ScriptAlias>index.pl?Action=AgentTicketZoom;TicketID=<KIX_TICKET_TicketID>\n\n-- <KIX_CONFIG_NotificationSenderName>",
"ContentType": "text/plain",
"Subject": "Locked Ticket Pending Reminder Time Reached: <KIX_TICKET_Title>"
}
},
"Name": "Ticket pending reminder notification (locked)",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-06-28 16:04:57",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-06-28 16:04:57",
"Data": {
"Events": [
"TicketQueueUpdate"
],
"Queues": [
"Postmaster"
]
},
"ID": 131,
"Message": {
"de": {
"Body": "something to tell...",
"ContentType": "text/plain",
"Subject": "test"
}
},
"Name": "test",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/communication/notifications
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: NotificationPostRequest
Schema:
{
"$id" : "NotificationPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The notification request object for creation.",
"type" : "object",
"properties" : {
"Notification" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Data" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
}
},
"Filter" : {
"type" : "object"
},
"Message" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Body" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
}
},
"required" : [
"Body",
"ContentType",
"Subject"
]
}
}
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Data",
"Message",
"Name"
]
}
},
"required" : [
"Notification"
]
}
Example:
{
"Notification": {
"Name": "test",
"Message": {
"de": {
"Subject": "test",
"Body": "something to tell...",
"ContentType": "text/plain"
}
},
"Data": {
"Events": [
"TicketQueueUpdate"
],
"Queues": [
"Postmaster"
]
}
}
}Possible Responses
HTTP status code 201
The Notification has been created successfully.
Body
Media type: application/json
Type: NotificationPostPatchResponse
Schema:
{
"$id" : "NotificationPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated notification.",
"type" : "object",
"properties" : {
"NotificationID" : {
"type" : "integer"
}
},
"required" : [
"NotificationID"
]
}
Example:
{
"NotificationID": 131
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/communication/notifications/{notificationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| notificationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: NotificationResponse
Schema:
{
"$id" : "NotificationResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a notification GET request.",
"type" : "object",
"properties" : {
"Notification" : {
"$ref" : "#/definitions/_Notification_json"
}
},
"required" : [
"Notification"
],
"definitions" : {
"_Notification_json" : {
"$id" : "Notification.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The notification object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Data" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Message" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Body" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
}
},
"required" : [
"Body",
"ContentType",
"Subject"
]
}
},
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Data",
"ID",
"Name",
"Message",
"ValidID"
]
}
}
}
Example:
{
"Notification": {
"ChangeBy": 1,
"ChangeTime": "2019-06-28 16:04:57",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-06-28 16:04:57",
"Data": {
"Events": [
"TicketQueueUpdate"
],
"Queues": [
"Postmaster"
]
},
"ID": 131,
"Message": {
"de": {
"Body": "something to tell...",
"ContentType": "text/plain",
"Subject": "test"
}
},
"Name": "test",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/communication/notifications/{notificationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| notificationId | integer |
Body
Media type: application/json
Type: NotificationPatchRequest
Schema:
{
"$id" : "NotificationPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The notification request object for update.",
"type" : "object",
"properties" : {
"Notification" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Data" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "array",
"items" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
]
}
}
}
},
"Message" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "object",
"properties" : {
"Body" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
}
},
"required" : [
"Body",
"ContentType",
"Subject"
]
}
}
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Notification"
]
}
Example:
{
"Notification": {
"Comment": "new comment",
"Name": "new name"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: NotificationPostPatchResponse
Schema:
{
"$id" : "NotificationPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated notification.",
"type" : "object",
"properties" : {
"NotificationID" : {
"type" : "integer"
}
},
"required" : [
"NotificationID"
]
}
Example:
{
"NotificationID": 131
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/communication/notifications/{notificationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| notificationId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - Sender Types
/system/communication/sendertypes get
get /system/communication/sendertypes
Get all SenderType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SenderTypeCollectionResponse
Schema:
{
"$id" : "SenderTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of sender types.",
"type" : "object",
"properties" : {
"SenderType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_SenderType_json"
}
}
},
"required" : [
"SenderType"
],
"definitions" : {
"_SenderType_json" : {
"$id" : "SenderType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The sender type object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"Name"
]
}
}
}
Example:
{
"SenderType": [
{
"ID": 1,
"Name": "system"
},
{
"ID": 2,
"Name": "agent"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/communication/sendertypes/{senderTypeId} get
get /system/communication/sendertypes/{senderTypeId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| senderTypeId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SenderTypeResponse
Schema:
{
"$id" : "SenderTypeResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a sender type GET request.",
"type" : "object",
"properties" : {
"SenderType" : {
"$ref" : "#/definitions/_SenderType_json"
}
},
"required" : [
"SenderType"
],
"definitions" : {
"_SenderType_json" : {
"$id" : "SenderType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The sender type object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"Name"
]
}
}
}
Example:
{
"SenderType": {
"ID": 1,
"Name": "system"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Communication - System Addresses
get /system/communication/systemaddresses
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SystemAddressCollectionResponse
Schema:
{
"$id" : "SystemAddressCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of system addresses.",
"type" : "object",
"properties" : {
"SystemAddress" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_SystemAddress_json"
}
}
},
"required" : [
"SystemAddress"
],
"definitions" : {
"_SystemAddress_json" : {
"$id" : "SystemAddress.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The system address object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Realname" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Realname",
"ValidID"
]
}
}
}
Example:
{
"SystemAddress": [
{
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:27:10",
"Comment": "Standard Address.",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:27:10",
"ID": 1,
"Name": "kix@localhost",
"Realname": "KIX System",
"QueueID": null,
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:36:06",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:36:06",
"ID": 2,
"Name": "temp.invalid@testtest.org",
"Realname": "[TD-Email-002] Temporarily Invalid E-Mail address",
"QueueID": 1,
"ValidID": 3
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/communication/systemaddresses
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: SystemAddressPostRequest
Schema:
{
"$id" : "SystemAddressPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The system address request object for creation.",
"type" : "object",
"properties" : {
"SystemAddress" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Realname" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Realname"
]
}
},
"required" : [
"SystemAddress"
]
}
Example:
{
"SystemAddress": {
"Name": "support@cape-it.de",
"Realname": "Helpdesk"
}
}Possible Responses
HTTP status code 201
The SystemAddress has been created successfully.
Body
Media type: application/json
Type: SystemAddressPostPatchResponse
Schema:
{
"$id" : "SystemAddressPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated system address.",
"type" : "object",
"properties" : {
"SystemAddressID" : {
"type" : "integer"
}
},
"required" : [
"SystemAddressID"
]
}
Example:
{
"SystemAddressID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/communication/systemaddresses/{systemAddressId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| systemAddressId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SystemAddressResponse
Schema:
{
"$id" : "SystemAddressResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a system address GET request.",
"type" : "object",
"properties" : {
"SystemAddress" : {
"$ref" : "#/definitions/_SystemAddress_json"
}
},
"required" : [
"SystemAddress"
],
"definitions" : {
"_SystemAddress_json" : {
"$id" : "SystemAddress.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The system address object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Realname" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"Realname",
"ValidID"
]
}
}
}
Example:
{
"SystemAddress": {
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:27:10",
"Comment": "Standard Address.",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:27:10",
"ID": 1,
"Name": "kix@localhost",
"Realname": "KIX System",
"QueueID": 1,
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/communication/systemaddresses/{systemAddressId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| systemAddressId | integer |
Body
Media type: application/json
Type: SystemAddressPatchRequest
Schema:
{
"$id" : "SystemAddressPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The system address request object for update.",
"type" : "object",
"properties" : {
"SystemAddress" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Realname" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"SystemAddress"
]
}
Example:
{
"SystemAddress": {
"Name": "support@cape-it.de",
"ValidID": 0
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SystemAddressPostPatchResponse
Schema:
{
"$id" : "SystemAddressPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated system address.",
"type" : "object",
"properties" : {
"SystemAddressID" : {
"type" : "integer"
}
},
"required" : [
"SystemAddressID"
]
}
Example:
{
"SystemAddressID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/communication/systemaddresses/{systemAddressId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| systemAddressId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Config
/system/config get
get /system/config
Get all SysConfigOption items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionCollectionResponse
Schema:
{
"$id" : "SysConfigOptionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of SysConfig option value.",
"type" : "object",
"properties" : {
"SysConfigOption" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_SysConfigOption_json"
}
}
},
"required" : [
"SysConfigOption"
],
"definitions" : {
"_SysConfigOption_json" : {
"$id" : "SysConfigOption.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option object.",
"type" : "object",
"properties" : {
"AccessLevel" : {
"type" : "string",
"readOnly" : true
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ReadOnly" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"Name"
]
}
}
}
Example:
{
"SysConfigOption": [
{
"Name": "UniqueCIName::EnableUniquenessCheck",
"Value": "0"
},
{
"Name": "UniqueCIName::UniquenessCheckScope",
"Value": "global"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/config/optiontypes get
get /system/config/optiontypes
Get all SysConfigOptionType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionTypeCollectionResponse
Schema:
{
"$id" : "SysConfigOptionTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of SysConfig option types.",
"type" : "object",
"properties" : {
"SysConfigOptionType" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [
"SysConfigOptionType"
]
}
Example:
{
"SysConfigOptionType": [
"Array",
"Base",
"Hash",
"Option",
"RichText",
"String",
"TextArea",
"TimeVacationDays",
"TimeVacationDaysOneTime"
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/config/{option}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| option | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionResponse
Schema:
{
"$id" : "SysConfigOptionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a SysConfig option GET request.",
"type" : "object",
"properties" : {
"SysConfigOption" : {
"$ref" : "#/definitions/_SysConfigOption_json"
}
},
"required" : [
"SysConfigOption"
],
"definitions" : {
"_SysConfigOption_json" : {
"$id" : "SysConfigOption.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option object.",
"type" : "object",
"properties" : {
"AccessLevel" : {
"type" : "string",
"readOnly" : true
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ReadOnly" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"Name"
]
}
}
}
Example:
{
"SysConfigOption": {
"AccessLevel": "public",
"Context": null,
"ContextMetadata": null,
"Name": "DefaultUsedLanguages",
"ReadOnly": 0,
"Value": {
"de": "German",
"en": "English"
}
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/config/{option}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| option | string |
Body
Media type: application/json
Type: SysConfigOptionPatchRequest
Schema:
{
"$id" : "SysConfigOptionPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option request object for update.",
"type" : "object",
"properties" : {
"SysConfigOption" : {
"properties" : {
"ValidID" : {
"type" : "integer"
},
"Value" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
]
}
}
}
},
"required" : [
"SysConfigOption"
]
}
Example:
{
"SysConfigOption": {
"Value": {
"de": "German",
"en": "English"
}
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/config/definitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionDefinitionCollectionResponse
Schema:
{
"$id" : "SysConfigOptionDefinitionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of SysConfig option definitions.",
"type" : "object",
"properties" : {
"SysConfigOptionDefinition" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_SysConfigOptionDefinition_json"
}
}
},
"required" : [
"SysConfigOptionDefinition"
],
"definitions" : {
"_SysConfigOptionDefinition_json" : {
"$id" : "SysConfigOptionDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option definition object.",
"type" : "object",
"properties" : {
"AccessLevel" : {
"type" : "string",
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"DefaultValidID" : {
"type" : "integer",
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"ExperienceLevel" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Group" : {
"type" : "string",
"readOnly" : true
},
"IsModified" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Setting" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"SysConfigOptionDefinition": [
{
"AccessLevel": "internal",
"ChangeBy": 1,
"ChangeTime": "2019-05-14 20:43:17",
"Comment": null,
"CreateBy": 1,
"CreateTime": "2019-05-14 20:06:44",
"Default": "15",
"DefaultValidID": 2,
"Description": "Sets the timeout (in seconds) for http/ftp downloads.",
"Group": "Framework",
"IsModified": 1,
"IsRequired": 1,
"ExperienceLevel": 200,
"Name": "WebUserAgent::Timeout",
"Setting": {
"Regex": ""
},
"Type": "String",
"ValidID": 2,
"Value": null
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/config/definitions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: SysConfigOptionDefinitionPostRequest
Schema:
{
"$id" : "SysConfigOptionDefinitionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option definition request object for creation.",
"type" : "object",
"properties" : {
"SysConfigOptionDefinition" : {
"properties" : {
"AccessLevel" : {
"type" : "string"
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"DefaultValidID" : {
"type" : "integer"
},
"Description" : {
"type" : "string"
},
"ExperienceLevel" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
]
},
"Group" : {
"type" : "string"
},
"IsRequired" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"Setting" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "null"
}
]
},
"Type" : {
"type" : "string"
}
},
"required" : [
"Description",
"Name",
"Type"
]
}
},
"required" : [
"SysConfigOptionDefinition"
]
}
Example:
{
"SysConfigOptionDefinition": {
"AccessLevel": "internal",
"Name": "test",
"Type": "String",
"Description": "this is just a test option",
"Default": "this is a test"
}
}Possible Responses
HTTP status code 201
The SysConfigOptionDefinition has been created successfully.
Body
Media type: application/json
Type: SysConfigOptionDefinitionPostPatchResponse
Schema:
{
"$id" : "SysConfigOptionDefinitionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The name of the updated SysConfig option definition.",
"type" : "object",
"properties" : {
"Option" : {
"type" : "string"
}
},
"required" : [
"Option"
]
}
Example:
{
"Option": "test"
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/config/definitions/{option}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| option | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionDefinitionResponse
Schema:
{
"$id" : "SysConfigOptionDefinitionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a SysConfig option definition GET request.",
"type" : "object",
"properties" : {
"SysConfigOptionDefinition" : {
"$ref" : "#/definitions/_SysConfigOptionDefinition_json"
}
},
"required" : [
"SysConfigOptionDefinition"
],
"definitions" : {
"_SysConfigOptionDefinition_json" : {
"$id" : "SysConfigOptionDefinition.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option definition object.",
"type" : "object",
"properties" : {
"AccessLevel" : {
"type" : "string",
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"DefaultValidID" : {
"type" : "integer",
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"ExperienceLevel" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Group" : {
"type" : "string",
"readOnly" : true
},
"IsModified" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Setting" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Name",
"Type",
"ValidID"
]
}
}
}
Example:
{
"SysConfigOptionDefinition": {
"AccessLevel": "internal",
"ChangeBy": 1,
"ChangeTime": "2019-05-14 20:43:17",
"Comment": null,
"CreateBy": 1,
"CreateTime": "2019-05-14 20:06:44",
"Default": "15",
"DefaultValidID": 2,
"Description": "Sets the timeout (in seconds) for http/ftp downloads.",
"Group": "Framework",
"IsModified": 1,
"IsRequired": 1,
"ExperienceLevel": 200,
"Name": "WebUserAgent::Timeout",
"Setting": {
"Regex": ""
},
"Type": "String",
"ValidID": 2,
"Value": null
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/config/definitions/{option}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| option | string |
Body
Media type: application/json
Type: SysConfigOptionDefinitionPatchRequest
Schema:
{
"$id" : "SysConfigOptionDefinitionPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The SysConfig option definition request object for update.",
"type" : "object",
"properties" : {
"SysConfigOptionDefinition" : {
"properties" : {
"AccessLevel" : {
"type" : "string"
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"Context" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"ContextMetadata" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"Default" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "string"
},
{
"type" : "null"
}
]
},
"DefaultValidID" : {
"type" : "integer"
},
"Description" : {
"type" : "string"
},
"ExperienceLevel" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
]
},
"Group" : {
"type" : "string"
},
"IsRequired" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"Setting" : {
"anyOf" : [
{
"type" : "object"
},
{
"type" : "null"
}
]
},
"Type" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"SysConfigOptionDefinition"
]
}
Example:
{
"SysConfigOptionDefinition": {
"Description": "this is a test",
"IsRequired": 1
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SysConfigOptionDefinitionPostPatchResponse
Schema:
{
"$id" : "SysConfigOptionDefinitionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The name of the updated SysConfig option definition.",
"type" : "object",
"properties" : {
"Option" : {
"type" : "string"
}
},
"required" : [
"Option"
]
}
Example:
{
"Option": "test"
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/config/definitions/{option}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| option | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Console Command
This resource allows the execution of KIX console commands.
get /system/console
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConsoleCommandCollectionResponse
Schema:
{
"$id" : "ConsoleCommandCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of console commands.",
"type" : "object",
"properties" : {
"ConsoleCommand" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ConsoleCommand_json"
}
}
},
"required" : [
"ConsoleCommand"
],
"definitions" : {
"_ConsoleCommand_json" : {
"$id" : "ConsoleCommand.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The console command object.",
"type" : "object",
"properties" : {
"AdditionalHelp" : {
"type" : "string",
"readOnly" : true
},
"Arguments" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Required" : {
"description" : "is required = 1",
"type" : "integer"
}
}
},
"readOnly" : true
},
"Command" : {
"type" : "string",
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string"
},
"HasValue" : {
"description" : "needs value = 1",
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"Required" : {
"description" : "is required = 1",
"type" : "integer"
}
}
},
"readOnly" : true
}
},
"required" : [
"AdditionalHelp",
"Arguments",
"Command",
"Description",
"Parameters"
]
}
}
}
Example:
{
"ConsoleCommand": [
{
"AdditionalHelp": "",
"Arguments": [],
"Command": "Maint::Cache::Delete",
"Description": "Deletes cache items created by KIX.",
"Parameters": [
{
"Description": "Delete only caches which are expired by TTL.",
"HasValue": 0,
"Name": "expired",
"Required": 0
},
{
"Description": "Define the type of cache which should be deleted (e.g. Ticket or StdAttachment).",
"HasValue": 1,
"Name": "type",
"Required": 0
},
{
"Description": "Display help for this command.",
"Name": "help"
},
{
"Description": "Do not perform ANSI terminal output coloring.",
"Name": "no-ansi"
},
{
"Description": "Suppress informative output, only retain error messages.",
"Name": "quiet"
}
]
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/console
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ConsoleCommandPostRequest
Schema:
{
"$id" : "ConsoleCommand.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The console command request object for creation/execution.",
"type" : "object",
"properties" : {
"ConsoleExecute" : {
"type" : "object",
"properties" : {
"Command" : {
"type" : "string"
}
},
"required" : [
"Command"
]
}
},
"required" : [
"ConsoleExecute"
]
}
Example:
{
"ConsoleExecute": {
"Command": "Maint::Cache::Delete"
}
}Possible Responses
HTTP status code 201
The ConsoleCommand has been created successfully.
Body
Media type: application/json
Type: ConsoleCommandPostResponse
Schema:
{
"$id" : "ConsoleCommandPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "ExitCode and result output of the command execution.",
"type" : "object",
"properties" : {
"ExitCode" : {
"description" : "ok = 0; error = 1; command not found = 127",
"type" : "integer"
},
"Output" : {
"description" : "The STDOUT and STDERR output of the command",
"type" : "string"
}
},
"required" : [
"ExitCode",
"Output"
]
}
Example:
{
"ExitCode": 0,
"Output": "Maint::Cache::Delete :$VAR1 = {\n 'Command' => 'Maint::Cache::Delete'\n};\nDeleting cache...\nDone.\n"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/console/{consoleCommand} get
get /system/console/{consoleCommand}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| consoleCommand | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ConsoleCommandResponse
Schema:
{
"$id" : "ConsoleCommand.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a console command GET request.",
"type" : "object",
"properties" : {
"ConsoleCommand" : {
"$ref" : "#/definitions/_ConsoleCommand_json"
}
},
"required" : [
"ConsoleCommand"
],
"definitions" : {
"_ConsoleCommand_json" : {
"$id" : "ConsoleCommand.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The console command object.",
"type" : "object",
"properties" : {
"AdditionalHelp" : {
"type" : "string",
"readOnly" : true
},
"Arguments" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Required" : {
"description" : "is required = 1",
"type" : "integer"
}
}
},
"readOnly" : true
},
"Command" : {
"type" : "string",
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"Parameters" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Description" : {
"type" : "string"
},
"HasValue" : {
"description" : "needs value = 1",
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"Required" : {
"description" : "is required = 1",
"type" : "integer"
}
}
},
"readOnly" : true
}
},
"required" : [
"AdditionalHelp",
"Arguments",
"Command",
"Description",
"Parameters"
]
}
}
}
Example:
{
"ConsoleCommand": {
"AdditionalHelp": "",
"Arguments": [],
"Command": "Maint::Cache::Delete",
"Description": "Deletes cache items created by KIX.",
"Parameters": [
{
"Description": "Delete only caches which are expired by TTL.",
"HasValue": 0,
"Name": "expired",
"Required": 0
},
{
"Description": "Define the type of cache which should be deleted (e.g. Ticket or StdAttachment).",
"HasValue": 1,
"Name": "type",
"Required": 0
},
{
"Description": "Display help for this command.",
"Name": "help"
},
{
"Description": "Do not perform ANSI terminal output coloring.",
"Name": "no-ansi"
},
{
"Description": "Suppress informative output, only retain error messages.",
"Name": "quiet"
}
]
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Dynamic Fields
Dynamic Fields
Allows to create, get, update and delete dynamic fields. On Update the full config has to be given if changed, else the missing attributes are lost and only not internal fields are updatable.
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
Config | Adds the config of the dynamic field depending on its field type. |
get /system/dynamicfields
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DynamicFieldCollectionResponse
Schema:
{
"$id" : "DynamicFieldCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of dynamic fields.",
"type" : "object",
"properties" : {
"DynamicField" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicField_json"
}
}
},
"required" : [
"DynamicField"
],
"definitions" : {
"_DynamicField_json" : {
"$id" : "DynamicField.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"Config" : {
"description" : "Configuration of the dynamic field depending on the field type, the shown properties are for every type - added via include \"Config\"",
"type" : "object",
"properties" : {
"CountDefault" : {
"type" : "integer",
"readOnly" : true
},
"CountMax" : {
"type" : "integer",
"readOnly" : true
},
"CountMin" : {
"type" : "integer",
"readOnly" : true
},
"ItemSeparator" : {
"type" : "string",
"readOnly" : true
}
},
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"FieldType" : {
"type" : "string",
"readOnly" : true
},
"FieldTypeDisplayName" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"InternalField" : {
"type" : "integer",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ObjectType" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"CustomerVisible",
"FieldType",
"FieldTypeDisplayName",
"ID",
"InternalField",
"Label",
"Name",
"ObjectType",
"ValidID"
]
}
}
}
Example:
{
"DynamicField": [
{
"ChangeBy": 1,
"ChangeTime": "2021-07-21 07:48:01",
"Comment": null,
"Config": {
"CountDefault": "1",
"CountMax": "1",
"CountMin": "0",
"DefaultValue": "",
"ItemSeparator": "",
"RegExList": [
{
"ErrorMessage": "Value has to be an positive integer (used as minutes).",
"Value": "^\\d+$"
}
]
},
"CreateBy": 1,
"CreateTime": "2021-05-31 08:39:59",
"CustomerVisible": 1,
"FieldType": "Text",
"FieldTypeDisplayName": "Text",
"ID": 15,
"InternalField": 0,
"Label": "Planned Effort (min)",
"Name": "PlannedEffort",
"ObjectType": "Ticket",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2022-06-10 11:59:48",
"Comment": null,
"Config": {
"CountDefault": "0",
"CountMax": "1",
"CountMin": "0",
"DateRestriction": "none",
"DefaultValue": "0",
"ItemSeparator": "",
"YearsInFuture": "0",
"YearsInPast": "0"
},
"CreateBy": 1,
"CreateTime": "2021-05-31 08:59:06",
"CustomerVisible": 0,
"FieldType": "DateTime",
"FieldTypeDisplayName": "Date / Time",
"ID": 16,
"InternalField": 0,
"Label": "Plan Begin",
"Name": "PlanBegin",
"ObjectType": "Ticket",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/dynamicfields
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: DynamicFieldPostRequest
Schema:
{
"$id" : "DynamicFieldPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field request object for creation.",
"type" : "object",
"properties" : {
"DynamicField" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Config" : {
"description" : "Configuration of the dynamic field depending on the field type, the shown properties are for every type, some further are needed for some types",
"type" : "object",
"properties" : {
"CountDefault" : {
"type" : "integer"
},
"CountMax" : {
"type" : "integer"
},
"CountMin" : {
"type" : "integer"
},
"ItemSeparator" : {
"type" : "string"
}
}
},
"CustomerVisible" : {
"description" : " or 0 as value",
"type" : "integer"
},
"FieldType" : {
"description" : "Possible values are given in the dynamic field type resource",
"type" : "string"
},
"InternalField" : {
"description" : " or 0 as value",
"type" : "integer"
},
"Label" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ObjectType" : {
"description" : "Possible values are given in the dynamic field object type resource",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Config",
"CustomerVisible",
"FieldType",
"Label",
"Name",
"ObjectType"
]
}
},
"required" : [
"DynamicField"
]
}
Example:
{
"DynamicField": {
"Name": "SimpleSelection",
"Label": "Simple selection",
"FieldType": "Multiselect",
"ObjectType": "Ticket",
"InternalField": 0,
"ValidID": 1,
"CustomerVisible": 1,
"Config": {
"CountDefault": "0",
"CountMax": "1",
"CountMin": "0",
"DefaultValue": "",
"ItemSeparator": ";",
"PossibleValues": {
"value1": "first value",
"value2": "second value",
"value3": "third value"
},
"TranslatableValues": "1"
}
}
}Possible Responses
HTTP status code 201
The DynamicField has been created successfully.
Body
Media type: application/json
Type: DynamicFieldPostPatchResponse
Schema:
{
"$id" : "DynamicFieldPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated dynamic field.",
"type" : "object",
"properties" : {
"DynamicFieldID" : {
"type" : "integer"
}
},
"required" : [
"DynamicFieldID"
]
}
Example:
{
"DynamicFieldID": 13
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Can not resolve ../../descriptions/resources/system/dynamicfields/objecttypes.md
/system/dynamicfields/objecttypes get
get /system/dynamicfields/objecttypes
Get all DynamicFieldObjectType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DynamicFieldObjectTypeCollectionResponse
Schema:
{
"$id" : "DynamicFieldTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of dynamic field object types.",
"type" : "object",
"properties" : {
"DynamicFieldObject" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"readOnly" : true
}
}
},
"required" : [
"DynamicFieldObject"
]
}
Example:
{
"DynamicFieldObject": [
{
"DisplayName": "Contact",
"Name": "Contact"
},
{
"DisplayName": "FAQ",
"Name": "FAQArticle"
},
{
"DisplayName": "News",
"Name": "News"
},
{
"DisplayName": "Organisation",
"Name": "Organisation"
},
{
"DisplayName": "Ticket",
"Name": "Ticket"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Can not resolve ../../descriptions/resources/system/dynamicfields/types.md
/system/dynamicfields/types get
get /system/dynamicfields/types
Get all DynamicFieldType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DynamicFieldTypeCollectionResponse
Schema:
{
"$id" : "DynamicFieldTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of dynamic field types.",
"type" : "object",
"properties" : {
"DynamicFieldType" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"readOnly" : true
}
}
},
"required" : [
"DynamicFieldType"
]
}
Example:
{
"DynamicFieldType": [
{
"DisplayName": "Checklist",
"Name": "CheckList"
},
{
"DisplayName": "Checkbox",
"Name": "Checkbox"
},
{
"DisplayName": "Date",
"Name": "Date"
},
{
"DisplayName": "Date / Time",
"Name": "DateTime"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/dynamicfields/{dynamicFieldId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| dynamicFieldId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DynamicFieldResponse
Schema:
{
"$id" : "DynamicFieldResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a dynamic field GET request.",
"type" : "object",
"properties" : {
"DynamicField" : {
"$ref" : "#/definitions/_DynamicField_json"
}
},
"required" : [
"DynamicField"
],
"definitions" : {
"_DynamicField_json" : {
"$id" : "DynamicField.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"Config" : {
"description" : "Configuration of the dynamic field depending on the field type, the shown properties are for every type - added via include \"Config\"",
"type" : "object",
"properties" : {
"CountDefault" : {
"type" : "integer",
"readOnly" : true
},
"CountMax" : {
"type" : "integer",
"readOnly" : true
},
"CountMin" : {
"type" : "integer",
"readOnly" : true
},
"ItemSeparator" : {
"type" : "string",
"readOnly" : true
}
},
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"FieldType" : {
"type" : "string",
"readOnly" : true
},
"FieldTypeDisplayName" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"InternalField" : {
"type" : "integer",
"readOnly" : true
},
"Label" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ObjectType" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"CustomerVisible",
"FieldType",
"FieldTypeDisplayName",
"ID",
"InternalField",
"Label",
"Name",
"ObjectType",
"ValidID"
]
}
}
}
Example:
{
"DynamicField": {
"ChangeBy": 1,
"ChangeTime": "2022-10-21 09:17:41",
"Comment": null,
"CreateBy": 1,
"CreateTime": "2021-10-06 13:16:09",
"CustomerVisible": 1,
"FieldType": "Text",
"FieldTypeDisplayName": "Text",
"ID": 46,
"InternalField": 0,
"Label": "Some Text",
"Name": "SomeText",
"ObjectType": "Ticket",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/dynamicfields/{dynamicFieldId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| dynamicFieldId | integer |
Body
Media type: application/json
Type: DynamicFieldPatchRequest
Schema:
{
"$id" : "DynamicFieldPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field request object for update.",
"type" : "object",
"properties" : {
"DynamicField" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Config" : {
"description" : "Configuration of the dynamic field depending on the field type, the shown properties are for every type, some further are needed for some types",
"type" : "object",
"properties" : {
"CountDefault" : {
"type" : "integer"
},
"CountMax" : {
"type" : "integer"
},
"CountMin" : {
"type" : "integer"
},
"ItemSeparator" : {
"type" : "string"
}
}
},
"CustomerVisible" : {
"description" : " or 0 as value",
"type" : "integer"
},
"FieldType" : {
"description" : "Possible values are given in the dynamic field type resource",
"type" : "string"
},
"Label" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ObjectType" : {
"description" : "Possible values are given in the dynamic field object type resource",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"DynamicField"
]
}
Example:
{
"DynamicField": {
"Label": "Simple selection renamed",
"Config": {
"CountDefault": "0",
"CountMax": "1",
"CountMin": "0",
"DefaultValue": "",
"ItemSeparator": ";",
"PossibleValues": {
"value1": "first value",
"value2": "second value",
"value3": "third value",
"value4": "fourth value"
},
"TranslatableValues": "1"
}
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: DynamicFieldPostPatchResponse
Schema:
{
"$id" : "DynamicFieldPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated dynamic field.",
"type" : "object",
"properties" : {
"DynamicFieldID" : {
"type" : "integer"
}
},
"required" : [
"DynamicFieldID"
]
}
Example:
{
"DynamicFieldID": 13
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/dynamicfields/{dynamicFieldId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| dynamicFieldId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] FAQ
Can not resolve ../descriptions/resources/system/faq.md
Can not resolve ../descriptions/resources/system/faq/categories.md
get /system/faq/categories
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQCategoryCollectionResponse
Schema:
{
"$id" : "FAQCategoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of all FAQ categories.",
"type" : "object",
"properties" : {
"FAQCategory" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQCategory_json"
}
}
},
"required" : [
"FAQCategory"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_FAQArticle_json" : {
"$id" : "FAQArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article object.",
"type" : "object",
"properties" : {
"Approved" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachment_json"
},
"readOnly" : true
},
"CategoryID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Field1" : {
"description" : "symptom",
"type" : "string",
"readOnly" : true
},
"Field2" : {
"description" : "problem",
"type" : "string",
"readOnly" : true
},
"Field3" : {
"description" : "solution",
"type" : "string",
"readOnly" : true
},
"Field4" : {
"type" : "string",
"readOnly" : true
},
"Field5" : {
"type" : "string",
"readOnly" : true
},
"Field6" : {
"description" : "comment",
"type" : "string",
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQHistory_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "added via include \"Rating\"",
"type" : "number",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"VoteCount" : {
"description" : "added via include \"Rating\"",
"type" : "integer",
"readOnly" : true
},
"Votes" : {
"description" : "added via include \"Votes\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQVote_json"
},
"readOnly" : true
}
},
"required" : [
"Approved",
"CategoryID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"CustomerVisible",
"Field1",
"Field2",
"Field3",
"Field4",
"Field5",
"Field6",
"ID",
"Keywords",
"Language",
"LinkCount",
"Name",
"Number",
"Title",
"ValidID"
]
},
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_FAQCategory_json" : {
"$id" : "FAQCategory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ category object.",
"type" : "object",
"properties" : {
"Articles" : {
"description" : "added via include and expand \"Articles\" (only IDs without expand)",
"type" : "array",
"items" : {
"anyOf" : [
{
"$ref" : "#/definitions/_FAQArticle_json"
},
{
"type" : "integer"
}
]
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"description" : "contains also parent category names e.g. \"parent::child::grandchild\"",
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ParentID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"SubCategories" : {
"description" : "added via include and expand \"SubCategories\" (only IDs without expand)",
"type" : "array",
"items" : [
{
"description" : "same schema like this one",
"type" : "object"
},
{
"type" : "integer"
}
],
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Comment",
"CreateBy",
"CreateTime",
"Fullname",
"ID",
"Name",
"ValidID"
]
},
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
},
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQCategory": [
{
"ChangeBy": 1,
"ChangeTime": "2019-08-29 13:44:55",
"Comment": "Misc articles",
"CreateBy": 1,
"CreateTime": "2019-08-09 08:13:38",
"Fullname": "Misc",
"ID": 1,
"Name": "Misc",
"ParentID": null,
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-08-09 08:13:38",
"Comment": "KIX related articles",
"CreateBy": 1,
"CreateTime": "2019-08-09 08:13:38",
"Fullname": "KIX",
"ID": 2,
"Name": "KIX",
"ParentID": null,
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/faq/categories
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: FAQCategoryPostRequest
Schema:
{
"$id" : "FAQCategoryPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ category request object for create.",
"type" : "object",
"properties" : {
"FAQCategory" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ParentID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name"
]
}
},
"required" : [
"FAQCategory"
]
}
Example:
{
"FAQCategory": {
"Comment": "invalid sub category",
"Name": "invalid Category",
"ParentID": 1,
"ValidID": 2
}
}Possible Responses
HTTP status code 201
The FAQCategory has been created successfully.
Body
Media type: application/json
Type: FAQCategoryPostPatchResponse
Schema:
{
"$id" : "FAQCategoryPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ category.",
"type" : "object",
"properties" : {
"FAQCategoryID" : {
"type" : "integer"
}
},
"required" : [
"FAQCategoryID"
]
}
Example:
{
"FAQCategoryID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/faq/categories/{faqCategoryId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqCategoryId | string | |||
| classId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQCategoryResponse
Schema:
{
"$id" : "FAQCategoryResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a execution FAQ category GET request.",
"type" : "object",
"properties" : {
"FAQCategory" : {
"$ref" : "#/definitions/_FAQCategory_json"
}
},
"required" : [
"FAQCategory"
],
"definitions" : {
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_FAQArticle_json" : {
"$id" : "FAQArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ article object.",
"type" : "object",
"properties" : {
"Approved" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQAttachment_json"
},
"readOnly" : true
},
"CategoryID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Field1" : {
"description" : "symptom",
"type" : "string",
"readOnly" : true
},
"Field2" : {
"description" : "problem",
"type" : "string",
"readOnly" : true
},
"Field3" : {
"description" : "solution",
"type" : "string",
"readOnly" : true
},
"Field4" : {
"type" : "string",
"readOnly" : true
},
"Field5" : {
"type" : "string",
"readOnly" : true
},
"Field6" : {
"description" : "comment",
"type" : "string",
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQHistory_json"
},
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"item" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"LinkCount" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "added via include \"Rating\"",
"type" : "number",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"VoteCount" : {
"description" : "added via include \"Rating\"",
"type" : "integer",
"readOnly" : true
},
"Votes" : {
"description" : "added via include \"Votes\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FAQVote_json"
},
"readOnly" : true
}
},
"required" : [
"Approved",
"CategoryID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"CustomerVisible",
"Field1",
"Field2",
"Field3",
"Field4",
"Field5",
"Field6",
"ID",
"Keywords",
"Language",
"LinkCount",
"Name",
"Number",
"Title",
"ValidID"
]
},
"_FAQAttachment_json" : {
"$id" : "FAQAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ attachment object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "added via include \"Content\"",
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Changed",
"ChangedBy",
"ContentType",
"Created",
"CreatedBy",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_FAQCategory_json" : {
"$id" : "FAQCategory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ category object.",
"type" : "object",
"properties" : {
"Articles" : {
"description" : "added via include and expand \"Articles\" (only IDs without expand)",
"type" : "array",
"items" : {
"anyOf" : [
{
"$ref" : "#/definitions/_FAQArticle_json"
},
{
"type" : "integer"
}
]
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"description" : "contains also parent category names e.g. \"parent::child::grandchild\"",
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ParentID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"SubCategories" : {
"description" : "added via include and expand \"SubCategories\" (only IDs without expand)",
"type" : "array",
"items" : [
{
"description" : "same schema like this one",
"type" : "object"
},
{
"type" : "integer"
}
],
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Comment",
"CreateBy",
"CreateTime",
"Fullname",
"ID",
"Name",
"ValidID"
]
},
"_FAQHistory_json" : {
"$id" : "FAQHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"Name"
]
},
"_FAQVote_json" : {
"$id" : "FAQVote.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ vote object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IPAddress" : {
"type" : "string",
"readOnly" : true
},
"Interface" : {
"description" : "if rating is from \"agent\" or \"customer\" interface",
"type" : "string",
"readOnly" : true
},
"Rating" : {
"description" : "an integer from 1 to 5",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Created",
"CreatedBy",
"ID",
"IPAddress",
"Interface",
"Rating"
]
}
}
}
Example:
{
"FAQCategory": {
"Articles": [
1, 2, 3
],
"ChangeBy": 1,
"ChangeTime": "2019-08-09 08:13:38",
"Comment": "KIX related articles",
"CreateBy": 1,
"CreateTime": "2019-08-09 08:13:38",
"Fullname": "KIX",
"ID": 2,
"Name": "KIX",
"ParentID": null,
"SubCategories": [
4
],
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/faq/categories/{faqCategoryId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqCategoryId | string | |||
| classId | integer |
Body
Media type: application/json
Type: FAQCategoryPatchRequest
Schema:
{
"$id" : "FAQCategoryPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The FAQ category request object for update.",
"type" : "object",
"properties" : {
"FAQCategory" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ParentID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"FAQCategory"
]
}
Example:
{
"FAQCategory": {
"Name": "new name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FAQCategoryPostPatchResponse
Schema:
{
"$id" : "FAQCategoryPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated FAQ category.",
"type" : "object",
"properties" : {
"FAQCategoryID" : {
"type" : "integer"
}
},
"required" : [
"FAQCategoryID"
]
}
Example:
{
"FAQCategoryID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/faq/categories/{faqCategoryId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| faqCategoryId | string | |||
| classId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] i18n
The top-level /i18n system resource is no collection resource itself. It's purpose is to act as a container for all the i18n related resources.
Translations
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
AvailableLanguages | Adds a list of languages that exist for the given pattern. This doesn't include any translation values. |
get /system/i18n/translations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TranslationCollectionResponse
Schema:
{
"$id" : "TranslationCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of translations.",
"type" : "object",
"properties" : {
"Translation" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"Languages" : {
"type" : "object",
"patternProperties" : {
"^[a-zA-Z]+$" : {
"type" : "string",
"readOnly" : true
}
}
},
"Pattern" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Languages",
"Pattern"
]
}
}
},
"required" : [
"Translation"
]
}
Example:
{
"Translation": [
{
"Pattern": "Incident",
"Languages": {
"de": "Störung"
}
},
{
"Pattern": "Delete this item ?",
"Languages": {
"de": "Diesen Eintrag löschen ?"
}
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/i18n/translations
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: application/json
Possible Responses
HTTP status code 201
The Translation has been created successfully.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/i18n/translations/{translationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/i18n/translations/{translationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer |
Body
Media type: application/json
Type: application/json
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/i18n/translations/{translationId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/i18n/translations/{translationId}/languages
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TranslationLanguageCollectionResponse
Schema:
{
"$id" : "TranslationLanguageCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of translation languages.",
"type" : "object",
"properties" : {
"TranslationLanguage" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TranslationLanguage_json"
}
}
},
"required" : [
"TranslationLanguage"
],
"definitions" : {
"_TranslationLanguage_json" : {
"$id" : "TranslationLanguage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The translation language object.",
"type" : "object",
"properties" : {
"Language" : {
"type" : "string",
"readOnly" : true
},
"PatternID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"PatternID",
"Language",
"Value"
]
}
}
}
Example:
{
"TranslationLanguage": [
{
"PatternID": 3,
"Language": "de",
"Value": "Das ist ein Test."
},
{
"PatternID": 3,
"Language": "en",
"Value": "This is a test."
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/i18n/translations/{translationId}/languages
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer |
Body
Media type: application/json
Type: TranslationLanguagePostRequest
Schema:
{
"$id" : "TranslationLanguagePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The translation language request object for creation.",
"type" : "object",
"properties" : {
"TranslationLanguage" : {
"type" : "object",
"properties" : {
"Language" : {
"type" : "string"
},
"Value" : {
"type" : "string"
}
},
"required" : [
"Language",
"Value"
]
}
},
"required" : [
"TranslationLanguage"
]
}
Example:
{
"TranslationLanguage": {
"Language": "de",
"Value": "Das ist ein Test."
}
}Possible Responses
HTTP status code 201
The TranslationLanguage has been created successfully.
Body
Media type: application/json
Type: TranslationLanguagePostPatchResponse
Schema:
{
"$id" : "TranslationLanguagePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated translation language.",
"type" : "object",
"properties" : {
"Language" : {
"type" : "string"
}
},
"required" : [
"Language"
]
}
Example:
{
"Language": "de"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/i18n/translations/{translationId}/languages/{language}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer | |||
| language | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TranslationLanguageResponse
Schema:
{
"$id" : "TranslationLanguageResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a translation language GET request.",
"type" : "object",
"properties" : {
"TranslationLanguage" : {
"$ref" : "#/definitions/_TranslationLanguage_json"
}
},
"required" : [
"TranslationLanguage"
],
"definitions" : {
"_TranslationLanguage_json" : {
"$id" : "TranslationLanguage.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The translation language object.",
"type" : "object",
"properties" : {
"Language" : {
"type" : "string",
"readOnly" : true
},
"PatternID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"PatternID",
"Language",
"Value"
]
}
}
}
Example:
{
"TranslationLanguage": {
"PatternID": 5,
"Language": "de",
"Value": "test"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/i18n/translations/{translationId}/languages/{language}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer | |||
| language | string |
Body
Media type: application/json
Type: TranslationLanguagePatchRequest
Schema:
{
"$id" : "TranslationLanguagePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user translation language object for update.",
"type" : "object",
"properties" : {
"TranslationLanguage" : {
"type" : "object",
"properties" : {
"Value" : {
"type" : "string"
}
}
}
},
"required" : [
"TranslationLanguage"
]
}
Example:
{
"TranslationLanguage": {
"Value": "Das ist ein Test"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TranslationLanguagePostPatchResponse
Schema:
{
"$id" : "TranslationLanguagePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated translation language.",
"type" : "object",
"properties" : {
"Language" : {
"type" : "string"
}
},
"required" : [
"Language"
]
}
Example:
{
"Language": "de"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/i18n/translations/{translationId}/languages/{language}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| translationId | integer | |||
| language | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] ImportExport
This /system/importexport resource is no collection resource itself. It's purpose is to act as a container for all the ImportExport resources.
Templates
This resource allows read operation for import export templates.
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
ObjectData | Some additional data of the template. |
/system/importexport/templates get
get /system/importexport/templates
Get all ImportExportTemplate items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ImportExportTemplateCollectionResponse
Schema:
{
"$id" : "ImportExportTemplateCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of import export templates.",
"type" : "object",
"properties" : {
"ImportExportTemplate" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ImportExportTemplate_json"
}
}
},
"required" : [
"ImportExportTemplate"
],
"definitions" : {
"_ImportExportTemplate_json" : {
"$id" : "ImportExportTemplate.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The import export template object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Object" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Format",
"ID",
"Name",
"Number",
"Object",
"ValidID"
]
}
}
}
Example:
{
"ImportExportTemplate": [
{
"ChangeBy": 1,
"ChangeTime": "2019-11-28 14:49:44",
"Comment": "Automatically created",
"CreateBy": 1,
"CreateTime": "2019-11-28 14:49:44",
"Format": "CSV",
"ID": 1,
"Name": "Computer (auto-created map)",
"Number": "000001",
"Object": "ITSMConfigItem",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-11-28 15:09:18",
"Comment": "Automatically created (console command)",
"CreateBy": 1,
"CreateTime": "2019-11-28 15:09:18",
"Format": "CSV",
"ID": 2,
"Name": "Network (auto-created map)",
"Number": "000002",
"Object": "ITSMConfigItem",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/importexport/templates/{templateId} get
get /system/importexport/templates/{templateId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| templateId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ImportExportTemplateResponse
Schema:
{
"$id" : "ImportExportTemplateResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a import export template GET request.",
"type" : "object",
"properties" : {
"ImportExportTemplate" : {
"$ref" : "#/definitions/_ImportExportTemplate_json"
}
},
"required" : [
"ImportExportTemplate"
],
"definitions" : {
"_ImportExportTemplate_json" : {
"$id" : "ImportExportTemplate.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The import export template object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"Format" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Number" : {
"type" : "string",
"readOnly" : true
},
"Object" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Format",
"ID",
"Name",
"Number",
"Object",
"ValidID"
]
}
}
}
Example:
{
"ImportExportTemplate": {
"ChangeBy": 1,
"ChangeTime": "2019-11-28 14:49:44",
"Comment": "Automatically created",
"CreateBy": 1,
"CreateTime": "2019-11-28 14:49:44",
"Format": "CSV",
"ID": 1,
"Name": "Computer (auto-created map)",
"Number": "000001",
"Object": "ITSMConfigItem",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
Template Runs
This resource allows read and post operation for import export template runs (imports and exports).
get /system/importexport/templates/{templateId}/runs
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| templateId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ImportExportTemplateRunCollectionResponse
Schema:
{
"$id" : "ImportExportTemplateRunCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of import export template runs (imports and exports).",
"type" : "object",
"properties" : {
"ImportExportTemplateRun" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ImportExportTemplateRun_json"
}
}
},
"required" : [
"ImportExportTemplateRun"
],
"definitions" : {
"_ImportExportTemplateRun_json" : {
"$id" : "ImportExportTemplateRun.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The import export template run object.",
"type" : "object",
"properties" : {
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"EndTime" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"FailCount" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"StartTime" : {
"type" : "string",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"SuccessCount" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TemplateID" : {
"type" : "integer",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"CreateBy",
"EndTime",
"FailCount",
"ID",
"StartTime",
"State",
"StateID",
"SuccessCount",
"TemplateID",
"Type"
]
}
}
}
Example:
{
"ImportExportTemplateRun": [
{
"CreateBy": 1,
"EndTime": null,
"FailCount": null,
"ID": 1,
"StartTime": "2019-12-03 10:45:27",
"State": "running",
"StateID": 1,
"SuccessCount": null,
"TemplateID": 4,
"Type": "import"
},
{
"CreateBy": 1,
"EndTime": "2019-12-05 23:47:12",
"FailCount": 0,
"ID": 1,
"StartTime": "2019-12-05 23:30:00",
"State": "finished",
"StateID": 1,
"SuccessCount": 12,
"TemplateID": 7,
"Type": "import"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/importexport/templates/{templateId}/runs
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| templateId | integer |
Body
Media type: application/json
Type: ImportExportTemplateRunPostRequest
Schema:
{
"$id" : "ImportExportTemplateRunPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The import export template run post request object for create.",
"type" : "object",
"properties" : {
"ImportExportTemplateRun" : {
"type" : "object",
"properties" : {
"ImportFileContent" : {
"description" : "required if type is 'import', the base64 encoded file content",
"type" : "string"
},
"Type" : {
"description" : "the type of the run: use 'import' trigger an import and 'export' for export action",
"type" : "string"
}
},
"required" : [
"Type"
]
}
},
"required" : [
"ImportExportTemplateRun"
]
}
Example:
{
"ImportExportTemplateRun": {
"Type": "import",
"ImportFileContent": "some base64 encoded file-content"
}
}Possible Responses
HTTP status code 201
The ImportExportTemplateRun has been created successfully.
Body
Media type: application/json
Type: ImportExportTemplateRunPostResponse
Schema:
{
"$id" : "ImportExportTemplateRunPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The response of the run create request.",
"type" : "object",
"properties" : {
"ExportContent" : {
"description" : "the base64 encoded export result - content for a csv file (if type is 'export')",
"type" : "string"
},
"TaskID" : {
"description" : "ID of the scheduler task wich will execute the run (if type is 'import')",
"type" : "integer"
}
}
}
Example:
{
"TaskID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] General Catalog
General Catalog Items
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
Preferences | Adds a list of existing preferences of this item. |
get /system/generalcatalog
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: GeneralCatalogItemCollectionResponse
Schema:
{
"$id" : "GeneralCatalogItemCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of GeneralCatalog items.",
"type" : "object",
"properties" : {
"GeneralCatalogItem" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_GeneralCatalogItem_json"
}
}
},
"required" : [
"GeneralCatalogItem"
],
"definitions" : {
"_GeneralCatalogItemPreference_json" : {
"$id" : "GeneralCatalogItemPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item preference object.",
"type" : "object",
"properties" : {
"Name" : {
"type" : "String",
"readOnly" : true
},
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
],
"readOnly" : true
}
},
"required" : [
"Name",
"Value"
]
},
"_GeneralCatalogItem_json" : {
"$id" : "GeneralCatalogItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Class" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ItemID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Preferences" : {
"description" : "preferences of this item",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_GeneralCatalogItemPreference_json"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Class",
"CreateBy",
"CreateTime",
"ItemID",
"Name",
"Preferences",
"ValidID"
]
}
}
}
Example:
{
"GeneralCatalogItem": [
{
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:27:10",
"Class": "ITSM::ConfigItem::Class",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:27:10",
"ItemID": 22,
"Name": "Computer",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:27:10",
"Class": "ITSM::ConfigItem::Class",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:27:10",
"ItemID": 23,
"Name": "Hardware",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2019-05-09 15:27:10",
"Class": "ITSM::ConfigItem::Class",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2019-05-09 15:27:10",
"ItemID": 24,
"Name": "Location",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/generalcatalog
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: GeneralCatalogItemPostRequest
Schema:
{
"$id" : "GeneralCatalogItemPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item request object for creation.",
"type" : "object",
"properties" : {
"GeneralCatalogItem" : {
"type" : "object",
"properties" : {
"Class" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Preferences" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_GeneralCatalogItemPreferencePostItem_json"
}
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Class",
"Name"
]
}
},
"required" : [
"GeneralCatalogItem"
],
"definitions" : {
"_GeneralCatalogItemPreferencePostItem_json" : {
"$id" : "GeneralCatalogItemPreferencePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalogItemPreference item for creation.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the preference key name",
"type" : "string"
},
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "null"
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"GeneralCatalogItem": {
"Class": "ITSM::ConfigItem::Computer::Type",
"Name": "Tablet"
}
}Possible Responses
HTTP status code 201
The GeneralCatalogItem has been created successfully.
Body
Media type: application/json
Type: GeneralCatalogItemPostPatchResponse
Schema:
{
"$id" : "GeneralCatalogItemPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated GeneralCatalog item.",
"type" : "object",
"properties" : {
"GeneralCatalogItemID" : {
"type" : "integer"
}
},
"required" : [
"GeneralCatalogItemID"
]
}
Example:
{
"GeneralCatalogItemID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/generalcatalog/{generalCatalogItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| generalCatalogItemId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: GeneralCatalogItemResponse
Schema:
{
"$id" : "GeneralCatalogItemResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a GeneralCatalog item GET request.",
"type" : "object",
"properties" : {
"GeneralCatalogItem" : {
"$ref" : "#/definitions/_GeneralCatalogItem_json"
}
},
"required" : [
"GeneralCatalogItem"
],
"definitions" : {
"_GeneralCatalogItemPreference_json" : {
"$id" : "GeneralCatalogItemPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item preference object.",
"type" : "object",
"properties" : {
"Name" : {
"type" : "String",
"readOnly" : true
},
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
}
],
"readOnly" : true
}
},
"required" : [
"Name",
"Value"
]
},
"_GeneralCatalogItem_json" : {
"$id" : "GeneralCatalogItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Class" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ItemID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Preferences" : {
"description" : "preferences of this item",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_GeneralCatalogItemPreference_json"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"Class",
"CreateBy",
"CreateTime",
"ItemID",
"Name",
"Preferences",
"ValidID"
]
}
}
}
Example:
{
"GeneralCatalogItem": {
"ChangeBy": 1,
"ChangeTime": "2021-05-31 07:59:34",
"Class": "ITSM::ConfigItem::DeploymentState",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2021-05-31 07:59:34",
"ItemID": 16,
"Name": "Production",
"Preferences": [
{
"Name": "Functionality",
"Value": "productive"
}
],
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/generalcatalog/{generalCatalogItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| generalCatalogItemId | integer |
Body
Media type: application/json
Type: GeneralCatalogItemPatchRequest
Schema:
{
"$id" : "GeneralCatalogItemPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog item request object for update.",
"type" : "object",
"properties" : {
"GeneralCatalogItem" : {
"type" : "object",
"properties" : {
"Class" : {
"type" : "string"
},
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Preferences" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_GeneralCatalogItemPreferencePostItem_json"
}
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"GeneralCatalogItem"
],
"definitions" : {
"_GeneralCatalogItemPreferencePostItem_json" : {
"$id" : "GeneralCatalogItemPreferencePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalogItemPreference item for creation.",
"type" : "object",
"properties" : {
"Name" : {
"description" : "the preference key name",
"type" : "string"
},
"Value" : {
"oneOf" : [
{
"type" : "string"
},
{
"type" : "integer"
},
{
"type" : "null"
}
]
}
},
"required" : [
"Name",
"Value"
]
}
}
}
Example:
{
"GeneralCatalogItem": {
"Name": "ProductionNew",
"ValidID": 1,
"Preferences": [
{
"Name": "Functionality",
"Value": "preproductive"
}
]
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: GeneralCatalogItemPostPatchResponse
Schema:
{
"$id" : "GeneralCatalogItemPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated GeneralCatalog item.",
"type" : "object",
"properties" : {
"GeneralCatalogItemID" : {
"type" : "integer"
}
},
"required" : [
"GeneralCatalogItemID"
]
}
Example:
{
"GeneralCatalogItemID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/generalcatalog/{generalCatalogItemId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| generalCatalogItemId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/generalcatalog/classes get
get /system/generalcatalog/classes
Get all GeneralCatalogClass items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: GeneralCatalogClassCollectionResponse
Schema:
{
"$id" : "GeneralCatalogClassCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of GeneralCatalog classes",
"type" : "object",
"properties" : {
"GeneralCatalogClass" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [
"GeneralCatalogClass"
]
}
Example:
{
"GeneralCatalogClass": [
"ITSM::ConfigItem::Class",
"ITSM::Service::Type"
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/generalcatalog/classes/{className} patch
patch /system/generalcatalog/classes/{className}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| className | string |
Body
Media type: application/json
Type: GeneralCatalogClassPatchRequest
Schema:
{
"$id" : "GeneralCatalogClassPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The GeneralCatalog class request object for update.",
"type" : "object",
"properties" : {
"Name" : {
"type" : "string"
}
},
"required" : [
"Name"
]
}
Example:
{
"Name": "Testclass"
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: GeneralCatalogClassPatchResponse
Schema:
Can not resolve ../../schemas/GeneralCatalogClassPostPatchResponse.jsonExample:
Can not resolve ../../examples/GeneralCatalogClassPostPatchResponse.jsonHTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] HTMLToPDF Convert
Convert
This ressources don't support default includes, expands, limits. Only specific queries will be allowed.
Supported Queries
| Query | Description | Required |
|---|---|---|
TemplateID | Is required to get the template to be used. (Alternatively TemplateName can be used) | x |
TemplateName | Is required to get the template to be used. (Alternatively TemplateID can be used) | x |
IdentifierType | Is required to set the identification type. IDKey or NumberKey can be set. | x |
IdentifierIDorNumber | Is required to set the identifier. This depends on what is set in IdentifierType. IDKey is the ID of the ticket and if NumberKey it would be the ticket number. | x |
Expands | This Expand means the data expansion of the object which is applied to the template. (as array or comma separated string) | - |
Filters | Optional filters can be used to restrict certain extensions (format as JSON). | - |
Allows | Defines a whitelist that only shows the attributes that are named in it. If no allow is specified, everything appears.The Allows overwrites the Allow of the specified table in the template.(format as JSON) | - |
Ignores | Defines a blacklist that removes the attributes that made it through the whitelist. If no ignore is set, the final result is the result of the allow application. If both are emptied, all information from the objects is displayed. Ignores overwrites the Ignore of the specified table in the template.(format as JSON) | - |
Filename | user-specific filename of the PDF. It is possible to use placeholders, including special ones. | - |
Special Placeholders
| Placeholder | Description |
|---|---|
<Current_Time> | Returns the current date |
<Current_User> | Returns the full name of the trigger of the print job. |
<Count> | Returns the current count. (Basically used for article numbering) |
<TIME_YYMMDD_hhmm> | Returns the current time in the format YYYYMMDD_hhmm |
<TIME_YYMMDD> | Returns the current time in the format YYYYMMDD |
<TIME_YYMMDDhhmm> | Returns the current time in the format YYYYMMDDhhmm |
Filters
Syntax
Filters can only be applied where in the template Data is contained in the block and exists as an object. (e.g. ticket, article) Only attributes that the object can supply can be filtered.
{
"<Data-Object>": {
"AND": [
{
"Field": "<Attribute>",
"Type": "<EQ|CONTAINS>",
"Value": "<ARRAY|STRING>"
}
]
}
}Example
A ticket should only take into account the articles that are visible to the customer.
{
"Article": {
"AND": [
{
"Field": "CustomerVisible",
"Type": "EQ",
"Value": "1"
}
]
}
}Allows/Ignores
Syntax
In order to address the respective table, its Reference ID is required first. This can be found in the template structure. If the ID is known, a JSON can be created that contains the attributes to be restricted. There are two options for the restriction:
- By using the shortcut
KEY, the entire attribute will be ignored or displayed without further checking. - By using a regular expression, the values of an attribute can be checked. If the respective value applies, the attribute is ignored or displayed. The regular expression is freely selectable. However, it must not contain
KEYbecauseKEYis the keyword for the entire attribute.
{
"Reference-ID": {
"Attribute": "KEY",
"Attribute": "regex"
}
}Example
{
"ArticleMeta": {
"Channel": "KEY",
"From": "cape-it.de$"
}
}/system/htmltopdf/convert get
get /system/htmltopdf/convert
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: HTMLToPDFConvertResponse
Schema:
{
"$id" : "HTMLToPDFConvertResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a htmltopdf convert GET request.",
"type" : "object",
"properties" : {
"HTMLToPDF" : {
"$ref" : "#/definitions/_HTMLToPDFConvert_json"
}
},
"required" : [
"HTMLToPDF"
],
"definitions" : {
"_HTMLToPDFConvert_json" : {
"$id" : "HTMLToPDFConvert.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The htmltopdf convert object.",
"type" : "object",
"properties" : {
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Content",
"ContentType",
"Filename"
]
}
}
}
Example:
{
"HTMLToPDF": {
"Content": "someBase64EncodedContentString",
"ContentType": "application/pdf",
"Filename": "Ticket_2023022217000032_20230222_1222.pdf"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Logs
This resource allows readable access to the logs files in the KIX backend log directory.
Tailing and Filtering
With Tail you can specify the number of lines you want to fetch from the end of the file. Additionally you can filter for log categories by giving a comma separated list as Categories. Combining both options, you can do something like "give me the last 10 errors or debug messages". The tailed and/or filtered content will only be returned, if you include Content.
Supported Includes
| Include | Description |
|---|---|
Content | Adds the content of the log file (base64 encoded). |
/system/logs get
get /system/logs
Get all LogFile items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LogFileCollectionResponse
Schema:
{
"$id" : "LogFileCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of log files.",
"type" : "object",
"properties" : {
"LogFile" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_LogFile_json"
}
}
},
"required" : [
"LogFile"
],
"definitions" : {
"_LogFile_json" : {
"$id" : "LogFile.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The log file object.",
"type" : "object",
"properties" : {
"AccessTime" : {
"type" : "string",
"readOnly" : true
},
"AccessTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "if included",
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
},
"ModifyTime" : {
"type" : "string",
"readOnly" : true
},
"ModifyTimeUnix" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"AccessTime",
"AccessTimeUnix",
"CreateTime",
"CreateTimeUnix",
"DisplayName",
"Filename",
"Filesize",
"FilesizeRaw",
"ID",
"ModifyTime",
"ModifyTimeUnix"
]
}
}
}
Example:
{
"LogFile": [
{
"AccessTime": "2019-07-12 13:32:51",
"AccessTimeUnix": 1562931171,
"CreateTime": "2019-07-12 13:00:04",
"CreateTimeUnix": 1562929204,
"DisplayName": "TicketCounter.log",
"Filename": "TicketCounter.log",
"Filesize": "14 Bytes",
"FilesizeRaw": 14,
"ID": "06e871b06488ae8f853aa425a87a6dbc",
"ModifyTime": "2019-07-05 15:34:21",
"ModifyTimeUnix": 1562333661
},
{
"AccessTime": "2019-07-12 13:36:18",
"AccessTimeUnix": 1562931378,
"CreateTime": "2019-07-12 13:00:04",
"CreateTimeUnix": 1562929204,
"DisplayName": "Daemon/SchedulerTaskWorkerERR.log",
"Filename": "Daemon_SchedulerTaskWorkerERR.log",
"Filesize": "2.0 MBytes",
"FilesizeRaw": 2061439,
"ID": "09df17cfe3875740675ddae2a37b2c19",
"ModifyTime": "2019-03-13 15:52:40",
"ModifyTimeUnix": 1552488760
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/logs/{logFileId} get
get /system/logs/{logFileId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| logFileId | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LogFileResponse
Schema:
{
"$id" : "LogFileResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a log file GET request.",
"type" : "object",
"properties" : {
"LogFile" : {
"$ref" : "#/definitions/_LogFile_json"
}
},
"required" : [
"LogFile"
],
"definitions" : {
"_LogFile_json" : {
"$id" : "LogFile.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The log file object.",
"type" : "object",
"properties" : {
"AccessTime" : {
"type" : "string",
"readOnly" : true
},
"AccessTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Content" : {
"description" : "if included",
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"DisplayName" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "string",
"readOnly" : true
},
"ModifyTime" : {
"type" : "string",
"readOnly" : true
},
"ModifyTimeUnix" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"AccessTime",
"AccessTimeUnix",
"CreateTime",
"CreateTimeUnix",
"DisplayName",
"Filename",
"Filesize",
"FilesizeRaw",
"ID",
"ModifyTime",
"ModifyTimeUnix"
]
}
}
}
Example:
{
"LogFile": {
"AccessTime": "2019-07-12 13:36:18",
"AccessTimeUnix": 1562931378,
"CreateTime": "2019-07-12 13:00:04",
"CreateTimeUnix": 1562929204,
"DisplayName": "Daemon/SchedulerTaskWorkerERR.log",
"Filename": "Daemon_SchedulerTaskWorkerERR.log",
"Filesize": "2.0 MBytes",
"FilesizeRaw": 2061439,
"ID": "09df17cfe3875740675ddae2a37b2c19",
"ModifyTime": "2019-03-13 15:52:40",
"ModifyTimeUnix": 1552488760
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] OAuth2 - Authorization Code & State
/system/oauth2/authcode post
post /system/oauth2/authcode
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: OAuth2AuthCodePostRequest
Schema:
{
"$id" : "OAuth2AuthCodePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The oauth2 authcode request object for code authorization.",
"type" : "object",
"properties" : {
"ProfileAuth" : {
"type" : "object",
"properties" : {
"Code" : {
"description" : "Authorization code provided by the authorization response.",
"type" : "string"
},
"State" : {
"description" : "State of the authorization request.",
"type" : "string"
}
},
"required" : [
"Code",
"State"
]
}
},
"required" : [
"ProfileAuth"
]
}
Example:
{
"ProfileAuth": {
"Code": "iLjCNtwdbGTF3WyBuJPeT3uJA8njrQEi",
"State": "mrgMqBWueEKYufTcLgQXeCYLzxHw6695"
}
}Possible Responses
HTTP status code 201
The OAuth2AuthCode has been created successfully.
Body
Media type: application/json
Type: OAuth2AuthCodePostResponse
Schema:
{
"$id" : "OAuth2AuthCodePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the authorized oauth2 profile.",
"type" : "object",
"properties" : {
"ProfileID" : {
"type" : "integer"
}
},
"required" : [
"ProfileID"
]
}
Example:
{
"ProfileID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] OAuth2 - Profiles
get /system/oauth2/profiles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OAuth2ProfileCollectionResponse
Schema:
{
"$id" : "OAuth2ProfileCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of oauth2 profiles.",
"type" : "object",
"properties" : {
"Profile" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_OAuth2Profile_json"
}
}
},
"required" : [
"Profile"
],
"definitions" : {
"_OAuth2Profile_json" : {
"$id" : "OAuth2Profile.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The oauth2 profile object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ClientID" : {
"description" : "ID of the OAuth2 client.",
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HasAccessToken" : {
"description" : "Shows if profile has a valid access token (1 = yes, 0 = no).",
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Scope" : {
"description" : "Scope to request for the OAuth2 token.",
"type" : "string",
"readOnly" : true
},
"URLAuth" : {
"description" : "Base URL for the OAuth2 authorization.",
"type" : "string",
"readOnly" : true
},
"URLRedirect" : {
"description" : "Base URL for redirects after OAuth2 authorization.",
"type" : "string",
"readOnly" : true
},
"URLToken" : {
"description" : "Base URL for requesting OAuth2 token.",
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"ClientID",
"CreateBy",
"CreateTime",
"HasAccessToken",
"ID",
"Name",
"Scope",
"URLAuth",
"URLToken",
"URLRedirect",
"ValidID"
]
}
}
}
Example:
{
"Profile": [
{
"ChangeBy": 1,
"ChangeTime": "2019-05-29 13:13:09",
"ClientID": "id of client",
"CreateBy": 1,
"CreateTime": "2018-01-03 14:47:10",
"HasAccessToken": 0,
"ID": 2,
"Name": "OAuth2 Profile",
"Scope": "scope to request for access token",
"URLAuth": "https://authorization-server.com/auth",
"URLRedirect": "https://localhost/authcode",
"URLToken": "https://authorization-server.com/token",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/oauth2/profiles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: OAuth2ProfilePostRequest
Schema:
{
"$id" : "OAuth2ProfilePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The oauth2 profile request object for creation.",
"type" : "object",
"properties" : {
"Profile" : {
"type" : "object",
"properties" : {
"ClientID" : {
"description" : "ID of the OAuth2 client.",
"type" : "string"
},
"ClientSecret" : {
"description" : "Secret of the OAuth2 client.",
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Scope" : {
"description" : "Scope to request for the OAuth2 token.",
"type" : "string"
},
"URLAuth" : {
"description" : "Base URL for the OAuth2 authorization.",
"type" : "string"
},
"URLRedirect" : {
"description" : "Base URL for redirects after OAuth2 authorization.",
"type" : "string"
},
"URLToken" : {
"description" : "Base URL for requesting OAuth2 token.",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ClientID",
"ClientSecret",
"Name",
"Scope",
"URLAuth",
"URLToken",
"URLRedirect",
"ValidID"
]
}
},
"required" : [
"Profile"
]
}
Example:
{
"Profile": {
"ClientID": "id of client",
"ClientSecret": "secret of client",
"Name": "OAuth2 Profile",
"Scope": "scope to request for access token",
"URLAuth": "https://authorization-server.com/auth",
"URLRedirect": "https://localhost/authcode",
"URLToken": "https://authorization-server.com/token",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The OAuth2Profile has been created successfully.
Body
Media type: application/json
Type: OAuth2ProfilePostPatchResponse
Schema:
{
"$id" : "OAuth2ProfilePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated oauth2 profile.",
"type" : "object",
"properties" : {
"ProfileID" : {
"type" : "integer"
}
},
"required" : [
"ProfileID"
]
}
Example:
{
"ProfileID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/oauth2/profiles/{profileId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| profileId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OAuth2ProfileResponse
Schema:
{
"$id" : "OAuth2ProfileResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a oauth2 profile GET request.",
"type" : "object",
"properties" : {
"Profile" : {
"$ref" : "#/definitions/_OAuth2Profile_json"
}
},
"required" : [
"Profile"
],
"definitions" : {
"_OAuth2Profile_json" : {
"$id" : "OAuth2Profile.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The oauth2 profile object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ClientID" : {
"description" : "ID of the OAuth2 client.",
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HasAccessToken" : {
"description" : "Shows if profile has a valid access token (1 = yes, 0 = no).",
"type" : "integer",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Scope" : {
"description" : "Scope to request for the OAuth2 token.",
"type" : "string",
"readOnly" : true
},
"URLAuth" : {
"description" : "Base URL for the OAuth2 authorization.",
"type" : "string",
"readOnly" : true
},
"URLRedirect" : {
"description" : "Base URL for redirects after OAuth2 authorization.",
"type" : "string",
"readOnly" : true
},
"URLToken" : {
"description" : "Base URL for requesting OAuth2 token.",
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"ClientID",
"CreateBy",
"CreateTime",
"HasAccessToken",
"ID",
"Name",
"Scope",
"URLAuth",
"URLToken",
"URLRedirect",
"ValidID"
]
}
}
}
Example:
{
"Profile": {
"ChangeBy": 1,
"ChangeTime": "2019-05-29 13:13:09",
"ClientID": "id of client",
"CreateBy": 1,
"CreateTime": "2018-01-03 14:47:10",
"HasAccessToken": 0,
"ID": 2,
"Name": "OAuth2 Profile",
"Scope": "scope to request for access token",
"URLAuth": "https://authorization-server.com/auth",
"URLRedirect": "https://localhost/authcode",
"URLToken": "https://authorization-server.com/token",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/oauth2/profiles/{profileId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| profileId | integer |
Body
Media type: application/json
Type: OAuth2ProfilePatchRequest
Schema:
{
"$id" : "OAuth2ProfilePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The oauth2 profile request object for update.",
"type" : "object",
"properties" : {
"Profile" : {
"type" : "object",
"properties" : {
"ClientID" : {
"description" : "ID of the OAuth2 client.",
"type" : "string"
},
"ClientSecret" : {
"description" : "Secret of the OAuth2 client.",
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Scope" : {
"description" : "Scope to request for the OAuth2 token.",
"type" : "string"
},
"URLAuth" : {
"description" : "Base URL for the OAuth2 authorization.",
"type" : "string"
},
"URLRedirect" : {
"description" : "Base URL for redirects after OAuth2 authorization.",
"type" : "string"
},
"URLToken" : {
"description" : "Base URL for requesting OAuth2 token.",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Profile"
]
}
Example:
{
"Profile": {
"Name": "New OAuth2 profile name",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OAuth2ProfilePostPatchResponse
Schema:
{
"$id" : "OAuth2ProfilePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated oauth2 profile.",
"type" : "object",
"properties" : {
"ProfileID" : {
"type" : "integer"
}
},
"required" : [
"ProfileID"
]
}
Example:
{
"ProfileID": 42
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/oauth2/profiles/{profileId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| profileId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/oauth2/profiles/{profileId}/authurl get
get /system/oauth2/profiles/{profileId}/authurl
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| profileId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: OAuth2ProfileAuthURLResponse
Schema:
{
"$id" : "OAuth2ProfileAuthURLResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A url for authorization of an oauth2 profile.",
"type" : "object",
"properties" : {
"AuthURL" : {
"type" : "string"
}
},
"required" : [
"AuthURL"
]
}
Example:
{
"AuthURL": "https://authorization-server.com/auth?state=mrgMqBWueEKYufTcLgQXeCYLzxHw6695"
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Object Icons
Please note
The content is base64 encoded.
get /system/objecticons
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ObjectIconCollectionResponse
Schema:
{
"$id" : "ObjectIconCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of object icons.",
"type" : "object",
"properties" : {
"ObjectIcon" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_ObjectIcon_json"
}
}
},
"required" : [
"ObjectIcon"
],
"definitions" : {
"_ObjectIcon_json" : {
"$id" : "ObjectIcon.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The object icon object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID"
]
}
}
}
Example:
{
"ObjectIcon": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Content": "...",
"ContentType": "image/png",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Object": "TicketType",
"ObjectID": "1"
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Content": "...",
"ContentType": "image/png",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Object": "TicketType",
"ObjectID": "2"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/objecticons
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: ObjectIconPostRequest
Schema:
{
"$id" : "ObjectIconPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The object icon request object for creation.",
"type" : "object",
"properties" : {
"ObjectIcon" : {
"type" : "object",
"properties" : {
"Content" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Object" : {
"type" : "string"
},
"ObjectID" : {
"type" : "string"
}
},
"required" : [
"Content",
"ContentType",
"Object",
"ObjectID"
]
}
},
"required" : [
"ObjectIcon"
]
}
Example:
{
"ObjectIcon": {
"Content": "...",
"ContentType": "image/png",
"Object": "TicketType",
"ObjectID": "1"
}
}Possible Responses
HTTP status code 201
The ObjectIcon has been created successfully.
Body
Media type: application/json
Type: ObjectIconPostPatchResponse
Schema:
{
"$id" : "ObjectIconPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated object icon.",
"type" : "object",
"properties" : {
"ObjectIconID" : {
"type" : "integer"
}
},
"required" : [
"ObjectIconID"
]
}
Example:
{
"ObjectIconID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/objecticons/{objectIconId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| objectIconId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ObjectIconResponse
Schema:
{
"$id" : "ObjectIconResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a object icon GET request.",
"type" : "object",
"properties" : {
"ObjectIcon" : {
"$ref" : "#/definitions/_ObjectIcon_json"
}
},
"required" : [
"ObjectIcon"
],
"definitions" : {
"_ObjectIcon_json" : {
"$id" : "ObjectIcon.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The object icon object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Content" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID"
]
}
}
}
Example:
{
"ObjectIcon": {
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Content": "...",
"ContentType": "image/png",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Object": "TicketType",
"ObjectID": "2"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/objecticons/{objectIconId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| objectIconId | integer |
Body
Media type: application/json
Type: ObjectIconPatchRequest
Schema:
{
"$id" : "ObjectIconPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The object icon request object for update.",
"type" : "object",
"properties" : {
"ObjectIcon" : {
"type" : "object",
"properties" : {
"Content" : {
"type" : "string"
},
"ContentType" : {
"type" : "string"
},
"Object" : {
"type" : "string"
},
"ObjectID" : {
"type" : "string"
}
}
}
},
"required" : [
"ObjectIcon"
]
}
Example:
{
"ObjectIcon": {
"Content": "...."
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ObjectIconPostPatchResponse
Schema:
{
"$id" : "ObjectIconPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated object icon.",
"type" : "object",
"properties" : {
"ObjectIconID" : {
"type" : "integer"
}
},
"required" : [
"ObjectIconID"
]
}
Example:
{
"ObjectIconID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/objecticons/{objectIconId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| objectIconId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Plugins
Can not resolve ../../descriptions/resources/system/plugins.md
/system/plugins get
get /system/plugins
Get all Plugin items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/plugins/{product}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| product | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/plugins/{product}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| product | string |
Body
Media type: application/json
Type: application/json
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Roles & Permissions
get /system/roles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: RoleCollectionResponse
Schema:
{
"$id" : "RoleCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of roles.",
"type" : "object",
"properties" : {
"Role" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Role_json"
}
}
},
"required" : [
"Role"
],
"definitions" : {
"_Permission_json" : {
"$id" : "Permission.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Target" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Target",
"Value"
]
},
"_Role_json" : {
"$id" : "Role.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The role object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Permissions" : {
"description" : "added via include \"Permissions\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Permission_json"
},
"readOnly" : true
},
"UserIDs" : {
"description" : "added via include \"UserIDs\"",
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Role": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "the admin role",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "admin",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 10:17:03",
"Comment": "the user role",
"CreateBy": 1,
"CreateTime": "2018-11-20 12:34:55",
"ID": 2,
"Name": "user",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/roles
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: RolePostRequest
Schema:
{
"$id" : "RolePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The role request object for creation.",
"type" : "object",
"properties" : {
"Role" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Permissions" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_PermissionPostItem_json"
}
},
"UserIDs" : {
"type" : "array",
"item" : {
"type" : "integer"
}
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"ValidID"
]
}
},
"required" : [
"Role"
],
"definitions" : {
"_PermissionPostItem_json" : {
"$id" : "PermissionPostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission item object for creation.",
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"IsRequired" : {
"type" : "integer"
},
"Target" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer"
}
},
"required" : [
"Target",
"TypeID",
"Value"
]
}
}
}
Example:
{
"Role": {
"Name": "the new stats role",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The Role has been created successfully.
Body
Media type: application/json
Type: RolePostPatchResponse
Schema:
{
"$id" : "RolePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated role.",
"type" : "object",
"properties" : {
"RoleID" : {
"type" : "integer"
}
},
"required" : [
"RoleID"
]
}
Example:
{
"RoleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/roles/permissiontypes get
get /system/roles/permissiontypes
Get all PermissionType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PermissionTypeCollectionResponse
Schema:
{
"$id" : "PermissionTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of permission types.",
"type" : "object",
"properties" : {
"PermissionType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_PermissionType_json"
}
}
},
"required" : [
"PermissionType"
],
"definitions" : {
"_PermissionType_json" : {
"$id" : "PermissionType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission type object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"PermissionType": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "Permission type that corresponds with a collection resource.",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "Resource",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 10:17:03",
"Comment": "Permission type that corresponds with a item resource.",
"CreateBy": 1,
"CreateTime": "2018-11-20 12:34:55",
"ID": 2,
"Name": "Object",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/roles/{roleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: RoleResponse
Schema:
{
"$id" : "RoleResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a role GET request.",
"type" : "object",
"properties" : {
"Role" : {
"$ref" : "#/definitions/_Role_json"
}
},
"required" : [
"Role"
],
"definitions" : {
"_Permission_json" : {
"$id" : "Permission.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Target" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Target",
"Value"
]
},
"_Role_json" : {
"$id" : "Role.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The role object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Permissions" : {
"description" : "added via include \"Permissions\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Permission_json"
},
"readOnly" : true
},
"UserIDs" : {
"description" : "added via include \"UserIDs\"",
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Role": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "the admin role",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "admin",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/roles/{roleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Body
Media type: application/json
Type: RolePatchRequest
Schema:
{
"$id" : "RolePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The role request object for update.",
"type" : "object",
"properties" : {
"Role" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Role"
]
}
Example:
{
"Role": {
"Name": "my special user role",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: RolePostPatchResponse
Schema:
{
"$id" : "RolePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated role.",
"type" : "object",
"properties" : {
"RoleID" : {
"type" : "integer"
}
},
"required" : [
"RoleID"
]
}
Example:
{
"RoleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/roles/{roleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/roles/{roleId}/userids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: RoleUserIDCollectionResponse
Schema:
{
"$id" : "RoleUserIDCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of user IDs.",
"type" : "object",
"properties" : {
"UserIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
}
}
},
"required" : [
"UserIDs"
]
}
Example:
{
"UserIDs": [
1,
2,
3
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/roles/{roleId}/userids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Body
Media type: application/json
Type: RoleUserIDPostRequest
Schema:
{
"$id" : "RoleUserIDPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The role user request object for creation.",
"type" : "object",
"properties" : {
"UserID" : {
"type" : "integer"
}
},
"required" : [
"UserID"
]
}
Example:
{
"UserID": 2
}Possible Responses
HTTP status code 201
The RoleUserID has been created successfully.
Body
Media type: application/json
Type: RoleUserIDPostResponse
Schema:
{
"$id" : "RoleUserIDPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The UserID of the created role user.",
"type" : "object",
"properties" : {
"UserID" : {
"type" : "integer"
}
},
"required" : [
"UserID"
]
}
Example:
{
"UserID": 2
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/roles/{roleId}/userids/{userId} delete
delete /system/roles/{roleId}/userids/{userId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer | |||
| userId | number |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
For each existing role permissions can be created. A permission item has a TypeID which references a permission type defined in the resource /roles/permissiontypes. Additionally the target for the permission has to be defined. Each permission type has its own target schema. The following table lists the possible targets for each default permission type.
| ID | Permission Type | Permission Target | Example |
|---|---|---|---|
| 1 | Resource | collection resource URI | /tickets |
| 2 | Object | item resource URI{<ObjectType>.<Property> <Operator> <Value>} | /tickets/*{Ticket.QueueID EQ 123}```/tickets/*{Ticket.QueueID EQ 123 |
| 3 | Property | item resource URI{<ObjectType>.[<PropertyList>]} | /tickets/*{Ticket.[Title,QueueID,!TicketNumber]} |
The permission value itself is a bitmask with the following values:
| Value | Permission |
|---|---|
0x0000 | NONE |
0x0001 | CREATE |
0x0002 | READ |
0x0004 | UPDATE |
0x0008 | DELETE |
0xf000 | DENY |
get /system/roles/{roleId}/permissions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PermissionCollectionResponse
Schema:
{
"$id" : "PermissionCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of permissions.",
"type" : "object",
"properties" : {
"Permission" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Permission_json"
}
}
},
"required" : [
"Permission"
],
"definitions" : {
"_Permission_json" : {
"$id" : "Permission.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Target" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Target",
"Value"
]
}
}
}
Example:
{
"Permission": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "Full access to the tickets resource",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"IsRequired": 1,
"Target": "/tickets",
"TypeID": 1,
"Value": 15
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 10:17:03",
"Comment": "Read access to queue 1",
"CreateBy": 1,
"CreateTime": "2018-11-20 12:34:55",
"ID": 2,
"IsRequired": 0,
"Target": "/queues/1",
"TypeID": 2,
"Value": 2
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/roles/{roleId}/permissions
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer |
Body
Media type: application/json
Type: PermissionPostRequest
Schema:
{
"$id" : "PermissionPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission request object for creation.",
"type" : "object",
"properties" : {
"Permission" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"IsRequired" : {
"type" : "integer"
},
"Target" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer"
}
},
"required" : [
"Target",
"TypeID",
"Value"
]
}
},
"required" : [
"Permission"
]
}
Example:
{
"Permission": {
"Target": "/tickets",
"TypeID": 1,
"Value": 12
}
}Possible Responses
HTTP status code 201
The Permission has been created successfully.
Body
Media type: application/json
Type: PermissionPostPatchResponse
Schema:
{
"$id" : "PermissionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated permission.",
"type" : "object",
"properties" : {
"PermissionID" : {
"type" : "integer"
}
},
"required" : [
"PermissionID"
]
}
Example:
{
"PermissionID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/roles/{roleId}/permissions/{permissionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer | |||
| permissionId | number |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PermissionResponse
Schema:
{
"$id" : "PermissionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a permission GET request.",
"type" : "object",
"properties" : {
"Permission" : {
"$ref" : "#/definitions/_Permission_json"
}
},
"required" : [
"Permission"
],
"definitions" : {
"_Permission_json" : {
"$id" : "Permission.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"IsRequired" : {
"type" : "integer",
"readOnly" : true
},
"Target" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Target",
"Value"
]
}
}
}
Example:
{
"Permission": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "Full access to the tickets resource",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"IsRequired": 1,
"Target": "/tickets",
"TypeID": 1,
"Value": 15
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/roles/{roleId}/permissions/{permissionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer | |||
| permissionId | number |
Body
Media type: application/json
Type: PermissionPatchRequest
Schema:
{
"$id" : "PermissionPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The permission request object for update.",
"type" : "object",
"properties" : {
"Permission" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"IsRequired" : {
"type" : "integer"
},
"Target" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"Value" : {
"description" : "bitmask, please see documentation for bit descriptions",
"type" : "integer"
}
}
}
},
"required" : [
"Permission"
]
}
Example:
{
"Permission": {
"Value": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PermissionPostPatchResponse
Schema:
{
"$id" : "PermissionPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated permission.",
"type" : "object",
"properties" : {
"PermissionID" : {
"type" : "integer"
}
},
"required" : [
"PermissionID"
]
}
Example:
{
"PermissionID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/roles/{roleId}/permissions/{permissionId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| roleId | integer | |||
| permissionId | number |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Sessions
/system/sessions get
get /system/sessions
Get all Sessions items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: application/json
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/sessions/{token}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| token | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: SessionResponse
Schema:
{
"$id" : "SessionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a session GET request.",
"type" : "object",
"properties" : {
"Session" : {
"$ref" : "#/definitions/_Session_json"
}
},
"required" : [
"Session"
],
"definitions" : {
"_Session_json" : {
"$id" : "Session.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The extracted web token data.",
"type" : "object",
"properties" : {
"AllowedOperations" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"DeniedOperations" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Description" : {
"type" : "string",
"readOnly" : true
},
"IgnoreMaxIdleTime" : {
"type" : "integer",
"readOnly" : true
},
"LastRequestTime" : {
"type" : "string",
"readOnly" : true
},
"LastRequestTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"RemoteIP" : {
"type" : "string",
"readOnly" : true
},
"TokenType" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserType" : {
"type" : "string",
"enum" : [
"Agent",
"Customer"
],
"readOnly" : true
},
"ValidUntilTime" : {
"type" : "string",
"readOnly" : true
},
"ValidUntilTimeUnix" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"AllowedOperations",
"CreateTime",
"CreateTimeUnix",
"DeniedOperations",
"TokenType",
"UserID",
"UserType",
"ValidUntilTime",
"ValidUntilTimeUnix"
]
}
}
}
Example:
{
"Session": {
"AllowedOperations": [],
"CreateTime": "2018-08-28 11:34:55",
"CreateTimeUnix": 1535456095,
"DeniedOperations": [],
"Description": "",
"IgnoreMaxIdleTime": 0,
"LastRequestTime": "2018-08-28 13:10:31",
"LastRequestTimeUnix": 1535461831,
"RemoteIP": "::ffff:172.17.0.1",
"TokenType": "Normal",
"UserID": 1,
"UserType": "Agent",
"ValidUntilTime": "2018-08-29 03:34:55",
"ValidUntilTimeUnix": 1535513695
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/sessions/{token}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| token | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Text Modules
get /system/textmodules
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TextModuleCollectionResponse
Schema:
{
"$id" : "TextModuleCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of text modules.",
"type" : "object",
"properties" : {
"TextModule" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TextModule_json"
}
}
},
"required" : [
"TextModule"
],
"definitions" : {
"_TextModule_json" : {
"$id" : "TicketState.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state object.",
"type" : "object",
"properties" : {
"Category" : {
"type" : "string",
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"Text" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Language",
"Name",
"Text",
"ValidID"
]
}
}
}
Example:
{
"TextModule": [
{
"Category": "Einstiege",
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:04",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-11-02 16:22:18",
"ID": 11,
"Keywords": [
"Danke",
"Anfrage"
],
"Language": "de",
"Name": "Anfragedank",
"Subject": "",
"Text": "Vielen Dank für Ihre Anfrage.",
"ValidID": 1
},
{
"Category": "Einstiege",
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:04",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-11-02 16:22:18",
"ID": 12,
"Keywords": [],
"Language": "de",
"Name": "Danke für Gespräch",
"Subject": "",
"Text": "Vielen Dank für das freundliche Gespräch.",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/textmodules
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: TextModulePostRequest
Schema:
{
"$id" : "TextModulePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The text module request object for creation.",
"type" : "object",
"properties" : {
"TextModule" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Keywords" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"Language" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
},
"Text" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"Text"
]
}
},
"required" : [
"TextModule"
]
}
Example:
{
"TextModule": {
"Category": "Einstiege",
"Keywords": [
"Danke",
"Anfrage"
],
"Language": "de",
"Name": "Anfragedank",
"Text": "Vielen Dank für Ihre Anfrage."
}
}Possible Responses
HTTP status code 201
The TextModule has been created successfully.
Body
Media type: application/json
Type: TextModulePostPatchResponse
Schema:
{
"$id" : "TextModulePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated text module.",
"type" : "object",
"properties" : {
"TextModuleID" : {
"type" : "integer"
}
},
"required" : [
"TextModuleID"
]
}
Example:
{
"TextModuleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/textmodules/categories get
get /system/textmodules/categories
Get all TextModuleCategory items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TextModuleCategoryCollectionResponse
Schema:
{
"$id" : "TextModuleCategoryCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of text module categories",
"type" : "object",
"properties" : {
"TextModuleCategory" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [
"TextModuleCategory"
]
}
Example:
{
"TextModuleCategory": [
"Category1",
"Category2",
"Category3"
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/textmodules/{textModuleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| textModuleId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TextModuleResponse
Schema:
{
"$id" : "TextModuleResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a text module GET request.",
"type" : "object",
"properties" : {
"TextModule" : {
"$ref" : "#/definitions/_TextModule_json"
}
},
"required" : [
"TextModule"
],
"definitions" : {
"_TextModule_json" : {
"$id" : "TicketState.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state object.",
"type" : "object",
"properties" : {
"Category" : {
"type" : "string",
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Keywords" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Language" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"Text" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Language",
"Name",
"Text",
"ValidID"
]
}
}
}
Example:
{
"TextModule": {
"Category": "Einstiege",
"ChangeBy": 1,
"ChangeTime": "2019-03-12 18:24:04",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-11-02 16:22:18",
"ID": 11,
"Keywords": [
"Danke",
"Anfrage"
],
"Language": "de",
"Name": "Anfragedank",
"Subject": "",
"Text": "Vielen Dank für Ihre Anfrage.",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/textmodules/{textModuleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| textModuleId | integer |
Body
Media type: application/json
Type: TextModulePatchRequest
Schema:
{
"$id" : "TextModulePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The text module request object for update.",
"type" : "object",
"properties" : {
"TextModule" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Keywords" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"Language" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"Subject" : {
"type" : "string"
},
"Text" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"TextModule"
]
}
Example:
{
"TextModule": {
"Keywords": [
"Danke",
"Anfrage"
],
"Text": "Vielen Dank für Ihre Anfrage."
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TextModulePostPatchResponse
Schema:
{
"$id" : "TextModulePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated text module.",
"type" : "object",
"properties" : {
"TextModuleID" : {
"type" : "integer"
}
},
"required" : [
"TextModuleID"
]
}
Example:
{
"TextModuleID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/textmodules/{textModuleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| textModuleId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Ticket Locks
/system/ticket/locks get
get /system/ticket/locks
Get all Lock items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LockCollectionResponse
Schema:
{
"$id" : "LockCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket locks.",
"type" : "object",
"properties" : {
"Lock" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Lock_json"
}
}
},
"required" : [
"Lock"
],
"definitions" : {
"_Lock_json" : {
"$id" : "Lock.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket lock object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Lock": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "unlock",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "lock",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/ticket/locks/{lockId} get
get /system/ticket/locks/{lockId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| lockId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: LockResponse
Schema:
{
"$id" : "LockResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a lock GET request.",
"type" : "object",
"properties" : {
"Lock" : {
"$ref" : "#/definitions/_Lock_json"
}
},
"required" : [
"Lock"
],
"definitions" : {
"_Lock_json" : {
"$id" : "Lock.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket lock object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Lock": {
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "lock",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Ticket Priorities
get /system/ticket/priorities
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PriorityCollectionResponse
Schema:
{
"$id" : "PriorityCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of priorities.",
"type" : "object",
"properties" : {
"Priority" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Priority_json"
}
}
},
"required" : [
"Priority"
],
"definitions" : {
"_Priority_json" : {
"$id" : "Priority.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Priority": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "1 very low",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "2 low",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/ticket/priorities
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: PriorityPostRequest
Schema:
{
"$id" : "PriorityPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority request object for creation.",
"type" : "object",
"properties" : {
"Priority" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name"
]
}
},
"required" : [
"Priority"
]
}
Example:
{
"Priority": {
"Name": "lowest",
"Comment": "just for testing purposes",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The Priority has been created successfully.
Body
Media type: application/json
Type: PriorityPostPatchResponse
Schema:
{
"$id" : "PriorityPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated priority.",
"type" : "object",
"properties" : {
"PriorityID" : {
"type" : "integer"
}
},
"required" : [
"PriorityID"
]
}
Example:
{
"PriorityID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/ticket/priorities/{priorityId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| priorityId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PriorityResponse
Schema:
{
"$id" : "PriorityResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a priority GET request.",
"type" : "object",
"properties" : {
"Priority" : {
"$ref" : "#/definitions/_Priority_json"
}
},
"required" : [
"Priority"
],
"definitions" : {
"_Priority_json" : {
"$id" : "Priority.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Priority": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "1 very low",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/ticket/priorities/{priorityId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| priorityId | integer |
Body
Media type: application/json
Type: PriorityPatchRequest
Schema:
{
"$id" : "PriorityPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority request object for update.",
"type" : "object",
"properties" : {
"Priority" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Priority"
]
}
Example:
{
"Priority": {
"Name": "highest",
"ValidID": 1
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: PriorityPostPatchResponse
Schema:
{
"$id" : "PriorityPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated priority.",
"type" : "object",
"properties" : {
"PriorityID" : {
"type" : "integer"
}
},
"required" : [
"PriorityID"
]
}
Example:
{
"PriorityID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/ticket/priorities/{priorityId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| priorityId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Ticket Queues
Supported Includes
In addition to its sub-resources (as far as they exist), this resource supports the following includes.
| Include | Description |
|---|---|
SubQueues | Adds the die tree of sub-queues to the response. |
TicketStats | Adds some statistics to the response, about the tickets in this queue. It will contain the total number of tickets and the number of locked tickets, based on the given URL parameter TicketStats.StateType or TicketStats.StateID. Both can contain multiple values separated by a comma. The two virtual StateTypes Open and Viewable represent only the viewable state types (see SysConfig option Ticket::ViewableStateType). |
Tickets | Adds the list of tickets to the response. |
Supported Generic Properties
The queues resource supports the generic property Permissions in POST and PATCH requests. This property is an array of base permission objects.
*Base Permission Object (Example) *
{
"Type": "Base",
"RoleID": 123,
"Permission": "READ+WRITE"
}get /system/ticket/queues
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: QueueCollectionResponse
Schema:
{
"$id" : "QueueCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of queues.",
"type" : "object",
"properties" : {
"Queue" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Queue_json"
}
}
},
"required" : [
"Queue"
],
"definitions" : {
"_Queue_json" : {
"$id" : "Priority.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefaultSignKey" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"FollowUpID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"FollowUpLock" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ParentID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Signature" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"SubQueues" : {
"type" : "object",
"readOnly" : true
},
"SystemAddressID" : {
"type" : "integer"
},
"TicketStats" : {
"description" : "added via include \"TicketStats\"",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"LockCount" : {
"type" : "integer",
"readOnly" : true
},
"TotalCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"readOnly" : true
},
"UnlockTimeout" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Fullname",
"QueueID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Queue": [
{
"ChangeBy": 1,
"ChangeTime": "2018-11-08 09:37:53",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-11-08 09:37:53",
"DefaultSignKey": 1,
"FollowUpID": 3,
"FollowUpLock": 0,
"Fullname": "2nd-Level",
"Name": "2nd-Level",
"ParentID": null,
"QueueID": 7,
"Signature": "",
"SystemAddressID": 1,
"UnlockTimeout": 0,
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-11-08 09:37:53",
"Comment": "",
"CreateBy": 1,
"CreateTime": "2018-11-08 09:37:53",
"DefaultSignKey": 1,
"FollowUpID": 3,
"FollowUpLock": 0,
"Fullname": "2nd-Level::Application Support",
"Name": "Application Support",
"ParentID": 7,
"QueueID": 8,
"Signature": "",
"SystemAddressID": 1,
"UnlockTimeout": 0,
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/ticket/queues
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: QueuePostRequest
Schema:
{
"$id" : "QueuePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The queue request object for creation.",
"type" : "object",
"properties" : {
"Queue" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"DefaultSignKey" : {
"type" : "integer"
},
"FollowUpID" : {
"type" : "integer"
},
"FollowUpLock" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"ParentID" : {
"type" : "integer"
},
"Signature" : {
"type" : "string"
},
"SystemAddressID" : {
"type" : "integer"
},
"UnlockTimeout" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"ValidID"
]
}
},
"required" : [
"Queue"
]
}
Example:
{
"Queue": {
"Comment": "Postmaster queue.",
"FollowUpID": 1,
"FollowUpLock": 0,
"Name": "Postmaster",
"ParentID": 1,
"RealName": "KIX System",
"SystemAddressID": 1,
"UnlockTimeout": 0,
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The Queue has been created successfully.
Body
Media type: application/json
Type: QueuePostPatchResponse
Schema:
{
"$id" : "QueuePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated queue.",
"type" : "object",
"properties" : {
"QueueID" : {
"type" : "integer"
}
},
"required" : [
"QueueID"
]
}
Example:
{
"QueueID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/ticket/queues/followuptypes get
get /system/ticket/queues/followuptypes
Get all FollowUpType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: FollowUpTypeCollectionResponse
Schema:
{
"$id" : "FollowUpTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of followup types.",
"type" : "object",
"properties" : {
"FollowUpType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_FollowUpType_json"
}
}
},
"required" : [
"FollowUpType"
],
"definitions" : {
"_FollowUpType_json" : {
"$id" : "FollowUpType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The followup type object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"FollowUpType": [
{
"ChangeBy": 1,
"ChangeTime": "2017-08-08 09:23:11",
"Comment": "Follow-ups for closed tickets are possible. Ticket will be reopened.",
"CreateBy": 1,
"CreateTime": "2017-08-08 09:23:11",
"ID": 1,
"Name": "possible",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2017-08-08 09:23:11",
"Comment": "Follow-ups for closed tickets are not possible. No new ticket will be created.",
"CreateBy": 1,
"CreateTime": "2017-08-08 09:23:11",
"ID": 2,
"Name": "reject",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2017-08-08 09:23:11",
"Comment": "Follow-ups for closed tickets are not possible. A new ticket will be created..",
"CreateBy": 1,
"CreateTime": "2017-08-08 09:23:11",
"ID": 3,
"Name": "new ticket",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/ticket/queues/{queueId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| queueId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: QueueResponse
Schema:
{
"$id" : "QueueResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a queue GET request.",
"type" : "object",
"properties" : {
"Queue" : {
"$ref" : "#/definitions/_Queue_json"
}
},
"required" : [
"Queue"
],
"definitions" : {
"_Queue_json" : {
"$id" : "Priority.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The priority object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DefaultSignKey" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"FollowUpID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"FollowUpLock" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ParentID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Signature" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"SubQueues" : {
"type" : "object",
"readOnly" : true
},
"SystemAddressID" : {
"type" : "integer"
},
"TicketStats" : {
"description" : "added via include \"TicketStats\"",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"LockCount" : {
"type" : "integer",
"readOnly" : true
},
"TotalCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"readOnly" : true
},
"UnlockTimeout" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"Fullname",
"QueueID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"Queue": {
"ChangeBy": 1,
"ChangeTime": "2018-11-08 10:35:37",
"Comment": "Postmaster queue.",
"CreateBy": 1,
"CreateTime": "2018-11-08 10:35:37",
"DefaultSignKey": null,
"FollowUpID": 1,
"FollowUpLock": 0,
"Fullname": "Postmaster",
"Name": "Postmaster",
"ParentID": null,
"QueueID": 1,
"Signature": "",
"SystemAddressID": 1,
"UnlockTimeout": 0,
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/ticket/queues/{queueId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| queueId | integer |
Body
Media type: application/json
Type: QueuePatchRequest
Schema:
{
"$id" : "QueuePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The queue request object for creation.",
"type" : "object",
"properties" : {
"Queue" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"DefaultSignKey" : {
"type" : "integer"
},
"FollowUpID" : {
"type" : "integer"
},
"FollowUpLock" : {
"type" : "integer"
},
"Name" : {
"type" : "string"
},
"ParentID" : {
"type" : "integer"
},
"Signature" : {
"type" : "string"
},
"SystemAddressID" : {
"type" : "integer"
},
"UnlockTimeout" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"Queue"
]
}
Example:
{
"Queue": {
"Comment": "Some new queue.",
"Name": "New Queue"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: QueuePostPatchResponse
Schema:
{
"$id" : "QueuePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated queue.",
"type" : "object",
"properties" : {
"QueueID" : {
"type" : "integer"
}
},
"required" : [
"QueueID"
]
}
Example:
{
"QueueID": 1
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/ticket/queues/{queueId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| queueId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Ticket States
get /system/ticket/states
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketStateCollectionResponse
Schema:
{
"$id" : "TicketStateCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket states.",
"type" : "object",
"properties" : {
"TicketState" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketState_json"
}
}
},
"required" : [
"TicketState"
],
"definitions" : {
"_TicketState_json" : {
"$id" : "TicketState.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"TypeID",
"ValidID"
]
}
}
}
Example:
{
"TicketState": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "new",
"TypeID": 1,
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "open",
"TypeID": 2,
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/ticket/states
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: TicketStatePostRequest
Schema:
{
"$id" : "TicketStatePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state request object for creation.",
"type" : "object",
"properties" : {
"TicketState" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name",
"TypeID"
]
}
},
"required" : [
"TicketState"
]
}
Example:
{
"TicketState": {
"Name": "closed with workaround",
"Comment": "just for testing purposes",
"TypeID": 3,
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The TicketState has been created successfully.
Body
Media type: application/json
Type: TicketStatePostPatchResponse
Schema:
{
"$id" : "TicketStatePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket state.",
"type" : "object",
"properties" : {
"TicketStateID" : {
"type" : "integer"
}
},
"required" : [
"TicketStateID"
]
}
Example:
{
"TicketStateID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/ticket/states/types get
get /system/ticket/states/types
Get all StateType items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: StateTypeCollectionResponse
Schema:
{
"$id" : "StateTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of state types.",
"type" : "object",
"properties" : {
"StateType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_StateType_json"
}
}
},
"required" : [
"StateType"
],
"definitions" : {
"_StateType_json" : {
"$id" : "StateType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The state type object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"Name"
]
}
}
}
Example:
{
"StateType": [
{
"ID": 1,
"Name": "new"
},
{
"ID": 2,
"Name": "open"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/ticket/states/types/{stateTypeId} get
get /system/ticket/states/types/{stateTypeId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| stateTypeId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: StateTypeResponse
Schema:
{
"$id" : "StateTypeResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a state type GET request.",
"type" : "object",
"properties" : {
"StateType" : {
"$ref" : "#/definitions/_StateType_json"
}
},
"required" : [
"StateType"
],
"definitions" : {
"_StateType_json" : {
"$id" : "StateType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The state type object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"Name"
]
}
}
}
Example:
{
"StateType": {
"ID": 2,
"Name": "open"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/ticket/states/{stateId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| stateId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketStateResponse
Schema:
{
"$id" : "TicketStateResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket state GET request.",
"type" : "object",
"properties" : {
"TicketState" : {
"$ref" : "#/definitions/_TicketState_json"
}
},
"required" : [
"TicketState"
],
"definitions" : {
"_TicketState_json" : {
"$id" : "TicketState.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"TypeID",
"ValidID"
]
}
}
}
Example:
{
"TicketState": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "new",
"TypeID": 1,
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/ticket/states/{stateId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| stateId | integer |
Body
Media type: application/json
Type: TicketStatePatchRequest
Schema:
{
"$id" : "TicketStatePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket state request object for update.",
"type" : "object",
"properties" : {
"TicketState" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"TypeID" : {
"type" : "integer"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"TicketState"
]
}
Example:
{
"TicketState": {
"Name": "closed with workaround",
"ValidID": 1
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketStatePostPatchResponse
Schema:
{
"$id" : "TicketStatePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket state.",
"type" : "object",
"properties" : {
"TicketStateID" : {
"type" : "integer"
}
},
"required" : [
"TicketStateID"
]
}
Example:
{
"TicketStateID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/ticket/states/{stateId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| stateId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Ticket Types
get /system/ticket/types
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketTypeCollectionResponse
Schema:
{
"$id" : "TicketTypeCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of ticket types.",
"type" : "object",
"properties" : {
"TicketType" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketType_json"
}
}
},
"required" : [
"TicketType"
],
"definitions" : {
"_TicketType_json" : {
"$id" : "TicketType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket type object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"TicketType": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "Incident",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"ID": 2,
"Name": "Problem",
"ValidID": 1
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/ticket/types
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: TicketTypePostRequest
Schema:
{
"$id" : "TicketTypePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket type request object for creation.",
"type" : "object",
"properties" : {
"TicketType" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"Name"
]
}
},
"required" : [
"TicketType"
]
}
Example:
{
"TicketType": {
"Name": "Change Request",
"Comment": "just for testing purposes",
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The TicketType has been created successfully.
Body
Media type: application/json
Type: TicketTypePostPatchResponse
Schema:
{
"$id" : "TicketTypePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket type.",
"type" : "object",
"properties" : {
"TicketTypeID" : {
"type" : "integer"
}
},
"required" : [
"TicketTypeID"
]
}
Example:
{
"TicketTypeID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/ticket/types/{typeId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| typeId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketTypeResponse
Schema:
{
"$id" : "TicketTypeResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a ticket type GET request.",
"type" : "object",
"properties" : {
"TicketType" : {
"$ref" : "#/definitions/_TicketType_json"
}
},
"required" : [
"TicketType"
],
"definitions" : {
"_TicketType_json" : {
"$id" : "TicketType.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket type object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Name",
"ValidID"
]
}
}
}
Example:
{
"TicketType": {
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"Comment": "...",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"ID": 1,
"Name": "Incident",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/ticket/types/{typeId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| typeId | integer |
Body
Media type: application/json
Type: TicketTypePatchRequest
Schema:
{
"$id" : "TicketTypePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket type request object for update.",
"type" : "object",
"properties" : {
"TicketType" : {
"type" : "object",
"properties" : {
"Comment" : {
"type" : "string"
},
"Name" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"TicketType"
]
}
Example:
{
"TicketType": {
"Name": "Major Incident",
"ValidID": 1
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: TicketTypePostPatchResponse
Schema:
{
"$id" : "TicketTypePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated ticket type.",
"type" : "object",
"properties" : {
"TicketTypeID" : {
"type" : "integer"
}
},
"required" : [
"TicketTypeID"
]
}
Example:
{
"TicketTypeID": 3
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/ticket/types/{typeId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| typeId | integer |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Users
Special search behaviour
Since the preferences of the user don't belong to the Config Item object itself, they must be referenced in the search definition using the prefix "Preferences.", i.e. "Preferences.MyQueues".
Supported Includes
In addition to its sub-resources this resource supports the following includes.
| Include | Description |
|---|---|
Contact | Adds the corresponding contact to this user. Returns empty if no contact exists. The contact contains the personal data for this user (names, address, ...). The relevant "link" attribute is "AssignedUserID" in the contact object. |
get /system/users
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserCollectionResponse
Schema:
{
"$id" : "UserCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of users.",
"type" : "object",
"properties" : {
"User" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_User_json"
}
}
},
"required" : [
"User"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
},
"_User_json" : {
"$id" : "User.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Contact" : {
"$ref" : "#/definitions/_Contact_json"
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"IsAgent" : {
"description" : "Defines if user can use the agent portal.",
"type" : "integer",
"readOnly" : true
},
"IsCustomer" : {
"description" : "Defines if user can use the self service portal (customer portal).",
"type" : "integer",
"readOnly" : true
},
"Preferences" : {
"description" : "added via include \"Preferences\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_UserPreference_json"
},
"readOnly" : true
},
"RoleIDs" : {
"description" : "added via include \"RoleIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"UsageContext" : {
"description" : "Shows for which context the user is enabled (1 = agent portal; 2 = self service portal; 3 = both).",
"type" : "integer",
"readOnly" : true
},
"UserComment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"IsAgent",
"IsCustomer",
"UsageContext",
"UserComment",
"UserID",
"UserLogin",
"ValidID"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"User": [
{
"ChangeBy": 1,
"ChangeTime": "2018-09-28 09:17:03",
"CreateBy": 1,
"CreateTime": "2018-08-28 11:34:55",
"IsAgent": 1,
"IsCustomer": 0,
"UsageContext": 1,
"UserComment": "some comment",
"UserID": 3,
"UserLogin": "jdoe",
"ValidID": 1
},
{
"ChangeBy": 1,
"ChangeTime": "2018-10-28 08:12:17",
"CreateBy": 1,
"CreateTime": "2018-10-28 08:10:01",
"IsAgent": 1,
"IsCustomer": 1,
"UsageContext": 3,
"UserComment": "",
"UserID": 4,
"UserLogin": "mamu",
"ValidID": 1
}
]
}
HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/users
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Body
Media type: application/json
Type: UserPostRequest
Schema:
{
"$id" : "UserPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user request object for creation.",
"type" : "object",
"properties" : {
"User" : {
"type" : "object",
"properties" : {
"IsAgent" : {
"type" : "integer"
},
"IsCustomer" : {
"type" : "integer"
},
"Preferences" : {
"type" : "array",
"item" : {
"$ref" : "#/definitions/_UserPreferencePostItem_json"
}
},
"RoleIDs" : {
"type" : "array",
"item" : {
"type" : "integer"
}
},
"UserComment" : {
"type" : "string"
},
"UserLogin" : {
"type" : "string"
},
"UserPw" : {
"description" : "A random password will be generated if not given.",
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
},
"required" : [
"UserLogin"
]
}
},
"required" : [
"User"
],
"definitions" : {
"_UserPreferencePostItem_json" : {
"$id" : "UserPreferencePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for creation.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string"
},
"Value" : {
"type" : "string"
}
},
"required" : [
"ID",
"Value"
]
}
}
}
Example:
{
"User": {
"IsAgent": 1,
"IsCustomer": 0,
"UserLogin": "jdoe",
"UserPw": "s3cr37-p4ssw0rD",
"RoleIDs": [
3
],
"ValidID": 1
}
}Possible Responses
HTTP status code 201
The User has been created successfully.
Body
Media type: application/json
Type: UserPostPatchResponse
Schema:
{
"$id" : "UserPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user.",
"type" : "object",
"properties" : {
"UserID" : {
"type" : "integer"
}
},
"required" : [
"UserID"
]
}
Example:
{
"UserID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/users/{userId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserResponse
Schema:
{
"$id" : "UserResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a user GET request.",
"type" : "object",
"properties" : {
"User" : {
"$ref" : "#/definitions/_User_json"
}
},
"required" : [
"User"
],
"definitions" : {
"_Contact_json" : {
"$id" : "Contact.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The contact object.",
"type" : "object",
"properties" : {
"AssignedConfigItems" : {
"description" : "A list of asset IDs, added via include \"AssignedConfigItems\"",
"type" : "array",
"items" : {
"type" : "number"
},
"readOnly" : true
},
"AssignedUserID" : {
"anyOf" : [
{
"type" : "integer"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"City" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Comment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Country" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Email" : {
"type" : "string",
"readOnly" : true
},
"Fax" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"Firstname" : {
"type" : "string",
"readOnly" : true
},
"Fullname" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Lastname" : {
"type" : "string",
"readOnly" : true
},
"Login" : {
"type" : "string",
"readOnly" : true
},
"Mobile" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"OrganisationIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"readOnly" : true
},
"Phone" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"PrimaryOrganisationID" : {
"type" : "integer",
"readOnly" : true
},
"Street" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"TicketStats" : {
"description" : "An object with numbers for new, open, pending and escalated tickets of this contact.",
"type" : "object",
"properties" : {
"EscalatedCount" : {
"type" : "integer",
"readOnly" : true
},
"NewCount" : {
"type" : "integer",
"readOnly" : true
},
"OpenCount" : {
"type" : "integer",
"readOnly" : true
},
"PendingReminderCount" : {
"type" : "integer",
"readOnly" : true
}
},
"readOnly" : true
},
"Tickets" : {
"description" : "added via include \"Tickets\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Ticket_json"
},
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"User" : {
"description" : "added via include \"User\". See /system/users resource for details.",
"type" : "object",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
},
"Zip" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
}
},
"required" : [
"AssignedUserID",
"ChangeBy",
"ChangeTime",
"City",
"Comment",
"Country",
"CreateBy",
"CreateTime",
"Email",
"Fax",
"Firstname",
"Fullname",
"ID",
"Lastname",
"Mobile",
"OrganisationIDs",
"Phone",
"PrimaryOrganisationID",
"Street",
"Title",
"ValidID",
"Zip"
]
},
"_DynamicFieldValue_json" : {
"$id" : "DynamicFieldValue.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The dynamic field value object.",
"type" : "object",
"properties" : {
"DisplayValue" : {
"description" : "prepared values ",
"type" : "string",
"readOnly" : true
},
"DisplayValueHTML" : {
"type" : "string",
"readOnly" : true
},
"DisplayValueShort" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"description" : "ID of the dynamic field",
"type" : "integer",
"readOnly" : true
},
"Label" : {
"description" : "label of the dynamic field",
"type" : "string",
"readOnly" : true
},
"Name" : {
"description" : "name of the dynamic field",
"type" : "string",
"readOnly" : true
},
"PreparedValue" : {
"description" : "prepared values - e.g. display values of a selection field instead of the keys",
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
},
"Value" : {
"type" : "array",
"items" : {
"type" : "string"
},
"readOnly" : true
}
},
"required" : [
"DisplayValue",
"DisplayValueHTML",
"DisplayValueShort",
"ID",
"Label",
"Name",
"PreparedValue",
"Value"
]
},
"_TicketArticleAttachment_json" : {
"$id" : "TicketArticleAttachment.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article attachment object.",
"type" : "object",
"properties" : {
"Content" : {
"description" : "added via include \"Content\" (base64 encoded)",
"type" : "string",
"readOnly" : true
},
"ContentAlternative" : {
"type" : "string",
"readOnly" : true
},
"ContentID" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"Disposition" : {
"type" : "string",
"readOnly" : true
},
"Filename" : {
"type" : "string",
"readOnly" : true
},
"Filesize" : {
"type" : "string",
"readOnly" : true
},
"FilesizeRaw" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ContentAlternative",
"ContentID",
"ContentType",
"Disposition",
"Filename",
"Filesize",
"FilesizeRaw",
"ID"
]
},
"_TicketArticleFlag_json" : {
"$id" : "TicketArticleFlag.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article flag object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Name",
"Value"
]
},
"_TicketArticle_json" : {
"$id" : "TicketArticle.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket article object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"Attachments" : {
"description" : "added via include \"Attachments\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleAttachment_json"
},
"readOnly" : true
},
"Bcc" : {
"type" : "string",
"readOnly" : true
},
"BccRealname" : {
"description" : "realnames from \"Bcc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Body" : {
"type" : "string",
"readOnly" : true
},
"Cc" : {
"type" : "string",
"readOnly" : true
},
"CcRealname" : {
"description" : "realnames from \"Cc\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"ChangedBy" : {
"type" : "integer",
"readOnly" : true
},
"ChannelID" : {
"type" : "integer",
"readOnly" : true
},
"Charset" : {
"type" : "string",
"readOnly" : true
},
"ContentCharset" : {
"type" : "string",
"readOnly" : true
},
"ContentType" : {
"type" : "string",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"CreatedBy" : {
"type" : "integer",
"readOnly" : true
},
"CustomerVisible" : {
"type" : "integer",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"Flags" : {
"description" : "added via include \"Flags\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticleFlag_json"
},
"readOnly" : true
},
"From" : {
"type" : "string",
"readOnly" : true
},
"FromRealname" : {
"description" : "realnames from \"From\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"InReplyTo" : {
"type" : "string",
"readOnly" : true
},
"IncommingTime" : {
"type" : "integer",
"readOnly" : true
},
"MessageID" : {
"type" : "string",
"readOnly" : true
},
"MimeType" : {
"type" : "string",
"readOnly" : true
},
"NotSentError" : {
"description" : "error string if article is an outgoing email article which could not be sent",
"type" : "string",
"readOnly" : true
},
"Plain" : {
"description" : "added via include \"Plain\" - the source string of the message if it is an email article (channel)",
"type" : "string",
"readOnly" : true
},
"References" : {
"type" : "string",
"readOnly" : true
},
"ReplyTo" : {
"type" : "string",
"readOnly" : true
},
"SenderType" : {
"type" : "string",
"readOnly" : true
},
"SenderTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Subject" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TimeUnits" : {
"type" : "integer",
"readOnly" : true
},
"To" : {
"type" : "string",
"readOnly" : true
},
"ToRealname" : {
"description" : "realnames from \"To\" (if email address has no real name, email address is used)",
"type" : "string",
"readOnly" : true
},
"Unseen" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"Bcc",
"BccRealname",
"Body",
"Cc",
"CcRealname",
"ChangeTime",
"ChangedBy",
"Channel",
"ChannelID",
"Charset",
"ContentCharset",
"ContentType",
"CreateTime",
"CreatedBy",
"CustomerVisible",
"From",
"FromRealname",
"InReplyTo",
"IncomingTime",
"MessageID",
"MimeType",
"NotSentError",
"References",
"ReplyTo",
"SenderType",
"SenderTypeID",
"Subject",
"TicketID",
"TimeUnits",
"To",
"ToRealname",
"Unseen"
]
},
"_TicketHistory_json" : {
"$id" : "TicketHistory.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket history object.",
"type" : "object",
"properties" : {
"ArticleID" : {
"type" : "integer",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"HistoryID" : {
"type" : "integer",
"readOnly" : true
},
"HistoryType" : {
"type" : "string",
"readOnly" : true
},
"HistoryTypeID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ArticleID",
"CreateBy",
"CreateTime",
"HistoryID",
"HistoryType",
"HistoryTypeID",
"Name",
"OwnerID",
"PriorityID",
"QueueID",
"StateID",
"TicketID",
"TypeID"
]
},
"_Ticket_json" : {
"$id" : "Ticket.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ticket object.",
"type" : "object",
"properties" : {
"AccountedTime" : {
"description" : "added via include \"AccountedTime\". Sum of all time units of the ticket and its articles.",
"type" : "integer",
"readOnly" : true
},
"Age" : {
"type" : "integer",
"readOnly" : true
},
"ArchiveFlag" : {
"type" : "string",
"readOnly" : true
},
"Articles" : {
"description" : "added via include \"Articles\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketArticle_json"
},
"readOnly" : true
},
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"Changed" : {
"type" : "string",
"readOnly" : true
},
"ContactID" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Created" : {
"type" : "string",
"readOnly" : true
},
"DynamicFields" : {
"description" : "added via include \"DynamicFields\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_DynamicFieldValue_json"
},
"readOnly" : true
},
"History" : {
"description" : "added via include \"History\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_TicketHistory_json"
},
"readOnly" : true
},
"LinkCount" : {
"description" : "added via include \"LinkCount\"",
"type" : "integer",
"readOnly" : true
},
"Lock" : {
"type" : "string",
"readOnly" : true
},
"LockID" : {
"type" : "integer",
"readOnly" : true
},
"OrganisationID" : {
"type" : "string",
"readOnly" : true
},
"Owner" : {
"type" : "string",
"readOnly" : true
},
"OwnerID" : {
"type" : "integer",
"readOnly" : true
},
"PendingTime" : {
"type" : "string",
"readOnly" : true
},
"PendingTimeUnix" : {
"type" : "integer",
"readOnly" : true
},
"Priority" : {
"type" : "string",
"readOnly" : true
},
"PriorityID" : {
"type" : "integer",
"readOnly" : true
},
"Queue" : {
"type" : "string",
"readOnly" : true
},
"QueueID" : {
"type" : "integer",
"readOnly" : true
},
"Responsible" : {
"type" : "string",
"readOnly" : true
},
"ResponsibleID" : {
"type" : "integer",
"readOnly" : true
},
"State" : {
"type" : "string",
"readOnly" : true
},
"StateID" : {
"type" : "integer",
"readOnly" : true
},
"StateType" : {
"type" : "string",
"readOnly" : true
},
"TicketID" : {
"type" : "integer",
"readOnly" : true
},
"TicketNumber" : {
"type" : "string",
"readOnly" : true
},
"Title" : {
"type" : "string",
"readOnly" : true
},
"Type" : {
"type" : "string",
"readOnly" : true
},
"TypeID" : {
"type" : "integer",
"readOnly" : true
},
"UnlockTimeout" : {
"type" : "integer",
"readOnly" : true
},
"Unseen" : {
"description" : "added via include \"Unseen\"",
"type" : "integer",
"readOnly" : true
},
"UntilTime" : {
"type" : "integer",
"readOnly" : true
},
"WatcherID" : {
"description" : "the ID of the watcher, if the current user is watching this ticket, added via include \"WatcherID\"",
"type" : "integer",
"readOnly" : true
},
"Watchers" : {
"description" : "added via include \"Watchers\"",
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Watcher_json"
},
"readOnly" : true
}
},
"required" : [
"Age",
"ChangeBy",
"Changed",
"ContactID",
"CreateBy",
"Created",
"LinkCount",
"LockID",
"OrganisationID",
"OwnerID",
"PendingTime",
"PendingTimeUnix",
"PriorityID",
"QueueID",
"ResponsibleID",
"StateID",
"TicketID",
"TicketNumber",
"Title",
"TypeID",
"Unseen",
"UntilTime"
]
},
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
},
"_User_json" : {
"$id" : "User.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"Contact" : {
"$ref" : "#/definitions/_Contact_json"
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"IsAgent" : {
"description" : "Defines if user can use the agent portal.",
"type" : "integer",
"readOnly" : true
},
"IsCustomer" : {
"description" : "Defines if user can use the self service portal (customer portal).",
"type" : "integer",
"readOnly" : true
},
"Preferences" : {
"description" : "added via include \"Preferences\"",
"type" : "array",
"item" : {
"$ref" : "#/definitions/_UserPreference_json"
},
"readOnly" : true
},
"RoleIDs" : {
"description" : "added via include \"RoleIDs\"",
"type" : "array",
"item" : {
"type" : "integer"
},
"readOnly" : true
},
"UsageContext" : {
"description" : "Shows for which context the user is enabled (1 = agent portal; 2 = self service portal; 3 = both).",
"type" : "integer",
"readOnly" : true
},
"UserComment" : {
"anyOf" : [
{
"type" : "string"
},
{
"type" : "null"
}
],
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"UserLogin" : {
"type" : "string",
"readOnly" : true
},
"ValidID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"IsAgent",
"IsCustomer",
"UsageContext",
"UserComment",
"UserID",
"UserLogin",
"ValidID"
]
},
"_Watcher_json" : {
"$id" : "Watcher.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The watcher object.",
"type" : "object",
"properties" : {
"ChangeBy" : {
"type" : "integer",
"readOnly" : true
},
"ChangeTime" : {
"type" : "string",
"readOnly" : true
},
"CreateBy" : {
"type" : "integer",
"readOnly" : true
},
"CreateTime" : {
"type" : "string",
"readOnly" : true
},
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Object" : {
"description" : "The type of the object.",
"type" : "string",
"readOnly" : true
},
"ObjectID" : {
"description" : "The ID of the object.",
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
}
},
"required" : [
"ChangeBy",
"ChangeTime",
"CreateBy",
"CreateTime",
"ID",
"Object",
"ObjectID",
"UserID"
]
}
}
}
Example:
{
"User": {
"ChangeBy": 1,
"ChangeTime": "2020-01-20 11:30:26",
"Contact": {
"AssignedUserID": 3,
"ChangeBy": 1,
"ChangeTime": "2020-01-20 11:59:04",
"City": null,
"Comment": "",
"Country": "Germany",
"CreateBy": 1,
"CreateTime": "2020-01-20 11:51:50",
"Email": "jdoe@john-doe.com",
"Fax": null,
"Firstname": "John",
"Fullname": "John Doe",
"ID": 5,
"Lastname": "Doe",
"Mobile": null,
"OrganisationIDs": [
15
],
"Phone": null,
"PrimaryOrganisationID": 15,
"Street": "somewhere avenue 1",
"Title": "",
"UserID": 5,
"ValidID": 1,
"Zip": null
},
"CreateBy": 1,
"CreateTime": "2020-01-20 11:30:26",
"IsAgent": 1,
"IsCustomer": 0,
"Preferences": [
{
"ID": "UserLanguage",
"UserID": 5,
"Value": "en"
}
],
"RoleIDs": [
2,
13
],
"UsageContext": 1,
"UserComment": null,
"UserID": 3,
"UserLogin": "jdoe",
"ValidID": 1
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/users/{userId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Body
Media type: application/json
Type: UserPatchRequest
Schema:
{
"$id" : "UserPatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user request object for update.",
"type" : "object",
"properties" : {
"User" : {
"type" : "object",
"properties" : {
"ExecGenerateToken" : {
"description" : "ACTION TRIGGER (non-persistent attribute)! If set to 1 a new access token will be generated for this user.",
"type" : "integer"
},
"IsAgent" : {
"type" : "integer"
},
"IsCustomer" : {
"type" : "integer"
},
"UserComment" : {
"type" : "string"
},
"UserLogin" : {
"type" : "string"
},
"UserPw" : {
"type" : "string"
},
"ValidID" : {
"type" : "integer"
}
}
}
},
"required" : [
"User"
]
}
Example:
{
"User": {
"UserPw": "n3w_s3cr37-p4ssw0rD",
"ValidID": 2
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPostPatchResponse
Schema:
{
"$id" : "UserPostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user.",
"type" : "object",
"properties" : {
"UserID" : {
"type" : "integer"
}
},
"required" : [
"UserID"
]
}
Example:
{
"UserID": 3
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/users/{userId}/preferences
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferenceCollectionResponse
Schema:
{
"$id" : "UserPreferenceCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of user preferences.",
"type" : "object",
"properties" : {
"UserPreference" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_UserPreference_json"
}
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
}
}
}
Example:
{
"UserPreference": [
{
"UserID": 3,
"ID": "UserLanguage",
"Value": "de"
},
{
"UserID": 1,
"ID": "UserLanguage",
"Value": "en"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/users/{userId}/preferences
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Body
Media type: application/json
Type: UserPreferencePostRequest
Schema:
{
"$id" : "UserPreferencePostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for creation.",
"type" : "object",
"properties" : {
"UserPreference" : {
"$ref" : "#/definitions/_UserPreferencePostItem_json"
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreferencePostItem_json" : {
"$id" : "UserPreferencePostItem.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for creation.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string"
},
"Value" : {
"type" : "string"
}
},
"required" : [
"ID",
"Value"
]
}
}
}
Example:
{
"UserPreference": {
"ID": "UserListLimit",
"Value": "10"
}
}Possible Responses
HTTP status code 201
The UserPreference has been created successfully.
Body
Media type: application/json
Type: UserPreferencePostPatchResponse
Schema:
{
"$id" : "UserPreferencePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user preference.",
"type" : "object",
"properties" : {
"UserPreferenceID" : {
"type" : "string"
}
},
"required" : [
"UserPreferenceID"
]
}
Example:
{
"UserPreferenceID": "UserLanguage"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/users/{userId}/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer | |||
| preferenceId | string |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferenceResponse
Schema:
{
"$id" : "UserPreferenceResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a user preference GET request.",
"type" : "object",
"properties" : {
"UserPreference" : {
"$ref" : "#/definitions/_UserPreference_json"
}
},
"required" : [
"UserPreference"
],
"definitions" : {
"_UserPreference_json" : {
"$id" : "UserPreference.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "string",
"readOnly" : true
},
"UserID" : {
"type" : "integer",
"readOnly" : true
},
"Value" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"ID",
"UserID",
"Value"
]
}
}
}
Example:
{
"UserPreference": {
"UserID": 3,
"ID": "UserLanguage",
"Value": "de"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
patch /system/users/{userId}/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer | |||
| preferenceId | string |
Body
Media type: application/json
Type: UserPreferencePatchRequest
Schema:
{
"$id" : "UserPreferencePatchRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user preference request object for update.",
"type" : "object",
"properties" : {
"UserPreference" : {
"type" : "object",
"properties" : {
"Value" : {
"type" : "string"
}
}
}
},
"required" : [
"UserPreference"
]
}
Example:
{
"UserPreference": {
"Value": "de"
}
}Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserPreferencePostPatchResponse
Schema:
{
"$id" : "UserPreferencePostPatchResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The ID of the created or updated user preference.",
"type" : "object",
"properties" : {
"UserPreferenceID" : {
"type" : "string"
}
},
"required" : [
"UserPreferenceID"
]
}
Example:
{
"UserPreferenceID": "UserLanguage"
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
delete /system/users/{userId}/preferences/{preferenceId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer | |||
| preferenceId | string |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
get /system/users/{userId}/roleids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: UserRoleIDCollectionResponse
Schema:
{
"$id" : "UserRoleIDCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of role IDs.",
"type" : "object",
"properties" : {
"RoleIDs" : {
"type" : "array",
"items" : {
"type" : "integer"
}
}
},
"required" : [
"RoleIDs"
]
}
Example:
{
"RoleIDs": [
1,
2,
3
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
post /system/users/{userId}/roleids
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer |
Body
Media type: application/json
Type: UserRoleIDPostRequest
Schema:
{
"$id" : "UserRoleIDPostRequest.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The user role request object for creation.",
"type" : "object",
"properties" : {
"RoleID" : {
"type" : "integer"
}
},
"required" : [
"RoleID"
]
}
Example:
{
"RoleID": 2
}Possible Responses
HTTP status code 201
The UserRoleID has been created successfully.
Body
Media type: application/json
Type: UserRoleIDPostResponse
Schema:
{
"$id" : "UserRoleIDPostResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The RoleID of the created user role.",
"type" : "object",
"properties" : {
"RoleID" : {
"type" : "integer"
}
},
"required" : [
"RoleID"
]
}
Example:
{
"RoleID": 2
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/users/{userId}/roleids/{roleId} delete
delete /system/users/{userId}/roleids/{roleId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| userId | integer | |||
| roleId | number |
Possible Responses
HTTP status code 204
The request has been finished successfully.
HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}HTTP status code 409
The request could not be finished to to a conflict. Common causes:
- PATCH: some data that is already in use by another item but the attribute value has to be unique
- DELETE: the item could not be deleted because depending items exist.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
[System] Valid
/system/valid get
get /system/valid
Get all Valid items.
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| filter | string | The filter to be used. | ||
| limit | number | The limit to be used to limit the number of items in the response. | ||
| offset | string | The offset where the item list in the response will start. | ||
| sort | string | The sort definition to be used to sort the items in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ValidCollectionResponse
Schema:
{
"$id" : "ValidCollectionResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A list of valid items.",
"type" : "object",
"properties" : {
"Valid" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/_Valid_json"
}
}
},
"required" : [
"Valid"
],
"definitions" : {
"_Valid_json" : {
"$id" : "Valid.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The valid object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
}
}
}
}
Example:
{
"Valid": [
{
"ID": 1,
"Name": "valid"
},
{
"ID": 2,
"Name": "invalid"
}
]
}HTTP status code 400
Please check your request.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.
/system/valid/{validId} get
get /system/valid/{validId}
Secured by webToken
The request MUST contain an Authorization header. See tab "Security" for more information.
URI Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| validId | displayName:ValidID type |
Query Parameters
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| fields | string | The list of fields to be returned in the response. |
Possible Responses
HTTP status code 200
The request has been finished.
Body
Media type: application/json
Type: ValidResponse
Schema:
{
"$id" : "ValidResponse.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "A response for a valid GET request.",
"type" : "object",
"properties" : {
"Valid" : {
"$ref" : "#/definitions/_Valid_json"
}
},
"required" : [
"Valid"
],
"definitions" : {
"_Valid_json" : {
"$id" : "Valid.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "The valid object.",
"type" : "object",
"properties" : {
"ID" : {
"type" : "integer",
"readOnly" : true
},
"Name" : {
"type" : "string",
"readOnly" : true
}
}
}
}
}
Example:
{
"Valid": {
"ID": 2,
"Name": "invalid"
}
}HTTP status code 404
The requested item could not be found.
Body
Media type: application/json
Type: Error
Schema:
{
"$id" : "Error.json",
"$schema" : "http://json-schema.org/draft-07/schema",
"description" : "An error object.",
"type" : "object",
"properties" : {
"Code" : {
"type" : "string",
"readOnly" : true
},
"Message" : {
"type" : "string",
"readOnly" : true
}
},
"required" : [
"Code",
"Message"
]
}
Example:
{
"Code": "Object.DependingObjectExists",
"Message": "Cannot delete queue. A ticket with this queue already exists."
}Secured by webToken
Headers
| Parameter | Type | Special | Description | |
|---|---|---|---|---|
| Authorization | string |
| Used to send the token |
Possible Responses
HTTP status code 401
Unauthorized. The given token is invalid.