Sinch Contact Center Restful Task Interface (RTI) API documentation version v1
http://localhost:8080/RTI
Description
This interface implements RESTful version for task management for Sinch Contact Center. It requires that Task Management Interface is installed as well.
Request Header Data Requirements
To GET JSON response, the request must have "Accept = application/json" header.
To GET XML response, the request should have "Accept = application/xml" header.
To POST/PUT JSON data, the request must have "Content-Type = application/json" header.
To POST/PUT XML data, the request should have "Content-Type = application/xml" header.
POST should also have "Accept = text/html" header. It returns the ID of the created object.
PUT and DELETE do not have any response, instead they return code 201 (No Content).
/tasks
Get all open tasks.
Add new task. Returns the ID of the created task.
get /tasks
Get all open tasks.
Query Parameters
- sort: (string)
HTTP status code 200
Body
Type: application/xml
Schema:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0"
targetNamespace="urn:TMI" xmlns:tns="urn:TMI" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfTaskItem">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="TaskItem"
nillable="true" type="tns:TaskItem" />
</xs:sequence>
</xs:complexType>
<xs:element name="taskItem" type="tns:TaskItem" />
<xs:complexType name="TaskItem">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0" />
<xs:element name="type" type="xs:string" minOccurs="0" />
<xs:element name="queue" type="xs:string" minOccurs="0" />
<xs:element name="queueName" type="xs:string" minOccurs="0" />
<xs:element name="responsible" type="xs:string" minOccurs="0" />
<xs:element name="status" type="xs:string" minOccurs="0" />
<xs:element name="rowVersion" type="xs:string" minOccurs="0" />
<xs:element name="_serverDate" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:schema>
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title":"Collection of TaskItems",
"type":"array",
"items":
{
"$ref":"taskItem"
}
}
post /tasks
Add new task. Returns the ID of the created task.
Body
Type: application/json
Schema:
{
"$schema" : "http://json-schema.org/draft-03/schema" ,
"title" : "createTask" ,
"type" : "object" ,
"required" : true ,
"properties" : {
"data" : {
"required" : true ,
"$ref": "taskData"
} ,
"skills" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"Skill" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"id" : {
"required" : false ,
"type" : "string"
} ,
"value" : {
"required" : false ,
"type" : "number"
}
}
}
]
}
}
} ,
"requiredAgents" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"expiryTime" : {
"required" : true ,
"type" : "number"
} ,
"agents" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"RequiredAgent" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"id" : {
"required" : false ,
"type" : "string"
} ,
"login" : {
"required" : false ,
"type" : "string"
}
}
}
]
}
}
}
}
}
}
}
Example:
{
"data": {
"item": {
"type": "XRI",
"queue": "CEC EMail"
},
"subject": "Extremely Complicated Fun",
"body": "Can be used for e-mail keyword routing by CEM",
"fromAddress": "customer@work.corp",
"toAddress": "hp_mylab@dev-hel.sinch.corp",
"values": {
"KV": [
{"k": "From", "v": "customer@work.corp"},
{"k": "To", "v": "hp_mylab@dev-hel.sinch.corp"}
]
}
},
"skills": {
"Skill": [
{"id": "EN", "value": "2"},
{"id": "ExtSkill", "value": "3"}
]
},
"requiredAgents": {
"expiryTime": 123,
"agents": {
"RequiredAgent": [
{"login": "harri"},
{"login": "wicom1"}
]
}
}
}
Type: application/xml
Schema:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="urn:TMI" xmlns:tns="urn:TMI" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="CreateTask">
<xs:complexType>
<xs:sequence>
<xs:element name="data" type="tns:TaskData" minOccurs="0"/>
<xs:element name="skills" type="tns:ArrayOfSkill" minOccurs="0"/>
<xs:element name="requiredAgents" type="tns:RequiredAgents" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="taskData" type="tns:TaskData"/>
<xs:element name="taskItem" type="tns:TaskItem"/>
<xs:complexType name="TaskData">
<xs:sequence>
<xs:element name="item" type="tns:TaskItem" minOccurs="0"/>
<xs:element name="caseId" type="xs:string" minOccurs="0"/>
<xs:element name="cid" type="xs:string" minOccurs="0"/>
<xs:element name="subject" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="priority" type="xs:int" nillable="true"/>
<xs:element name="warningTime" type="xs:dateTime" nillable="true"/>
<xs:element name="criticalTime" type="xs:dateTime" nillable="true"/>
<xs:element name="fromAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="ccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="bccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="firstModifier" type="xs:string" minOccurs="0"/>
<xs:element name="firstModified" type="xs:dateTime" nillable="true"/>
<xs:element name="lastModifier" type="xs:string" minOccurs="0"/>
<xs:element name="lastModified" type="xs:dateTime" nillable="true"/>
<xs:element name="solutionDate" type="xs:dateTime" nillable="true"/>
<xs:element name="customer" type="xs:string" minOccurs="0"/>
<xs:element name="index" type="xs:long" nillable="true"/>
<xs:element name="values" type="tns:ArrayOfKV" minOccurs="0"/>
<xs:element name="attachments" type="tns:ArrayOfAttachment" minOccurs="0"/>
<xs:element name="body" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TaskItem">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
<xs:element name="queue" type="xs:string" minOccurs="0"/>
<xs:element name="queueName" type="xs:string" minOccurs="0"/>
<xs:element name="responsible" type="xs:string" minOccurs="0"/>
<xs:element name="status" type="xs:string" minOccurs="0"/>
<xs:element name="rowVersion" type="xs:string" minOccurs="0"/>
<xs:element name="_serverDate" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfKV">
<xs:sequence>
<xs:element name="KV" type="tns:KV" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="KV">
<xs:sequence>
<xs:element name="k" type="xs:string" minOccurs="0"/>
<xs:element name="v" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfAttachment">
<xs:sequence>
<xs:element name="Attachment" type="tns:Attachment" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Attachment">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="filename" type="xs:string" minOccurs="0"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="ext" type="xs:string" minOccurs="0"/>
<xs:element name="size" type="xs:long"/>
<xs:element name="path" type="xs:string" minOccurs="0"/>
<xs:element name="data" type="xs:base64Binary" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfSkill">
<xs:sequence>
<xs:element name="Skill" type="tns:Skill" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Skill">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="value" type="xs:int"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="RequiredAgents">
<xs:sequence>
<xs:element name="expiryTime" type="xs:int" nillable="true"/>
<xs:element name="agents" type="tns:ArrayOfRequiredAgent" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfRequiredAgent">
<xs:sequence>
<xs:element name="RequiredAgent" type="tns:RequiredAgent" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="RequiredAgent">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="login" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<createtask>
<data>
<item>
<id>str1234</id>
<type>str1234</type>
<queue>str1234</queue>
<queueName>str1234</queueName>
<responsible>str1234</responsible>
<status>str1234</status>
<rowVersion>str1234</rowVersion>
<_serverDate>str1234</_serverDate>
</item>
<caseId>str1234</caseId>
<cid>str1234</cid>
<subject>str1234</subject>
<created>1991-01-24'PSL'13:05:33</created>
<creator>str1234</creator>
<priority>123</priority>
<warningTime>1991-01-24'PSL'13:05:33</warningTime>
<criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
<fromAddress>str1234</fromAddress>
<toAddress>str1234</toAddress>
<toAddressAnswer>str1234</toAddressAnswer>
<ccAddressAnswer>str1234</ccAddressAnswer>
<bccAddressAnswer>str1234</bccAddressAnswer>
<firstModifier>str1234</firstModifier>
<firstModified>1991-01-24'PSL'13:05:33</firstModified>
<lastModifier>str1234</lastModifier>
<lastModified>1991-01-24'PSL'13:05:33</lastModified>
<solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
<customer>str1234</customer>
<index>123</index>
<values>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
</values>
<attachments>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
</attachments>
<body>str1234</body>
</data>
<skills>
<Skill>
<id>str1234</id>
<value>123</value>
</Skill>
<Skill>
<id>str1234</id>
<value>123</value>
</Skill>
</skills>
<requiredAgents>
<expiryTime>123</expiryTime>
<agents>
<RequiredAgent>
<id>str1234</id>
<login>str1234</login>
</RequiredAgent>
<RequiredAgent>
<id>str1234</id>
<login>str1234</login>
</RequiredAgent>
</agents>
</requiredAgents>
</createtask>
Number of open tasks.
Get contents of one task.
Update one task.
Delete one task. Task status is changed to Deleted.
get /tasks/{id}
Get contents of one task.
URI Parameters
- id: required (string)
Query Parameters
- filter: (string)
HTTP status code 200
Body
Type: application/xml
Schema:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="urn:TMI" xmlns:tns="urn:TMI" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="taskData" type="tns:TaskData"/>
<xs:element name="taskItem" type="tns:TaskItem"/>
<xs:complexType name="TaskData">
<xs:sequence>
<xs:element name="item" type="tns:TaskItem" minOccurs="0"/>
<xs:element name="caseId" type="xs:string" minOccurs="0"/>
<xs:element name="cid" type="xs:string" minOccurs="0"/>
<xs:element name="subject" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="priority" type="xs:int" nillable="true"/>
<xs:element name="warningTime" type="xs:dateTime" nillable="true"/>
<xs:element name="criticalTime" type="xs:dateTime" nillable="true"/>
<xs:element name="fromAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="ccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="bccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="firstModifier" type="xs:string" minOccurs="0"/>
<xs:element name="firstModified" type="xs:dateTime" nillable="true"/>
<xs:element name="lastModifier" type="xs:string" minOccurs="0"/>
<xs:element name="lastModified" type="xs:dateTime" nillable="true"/>
<xs:element name="solutionDate" type="xs:dateTime" nillable="true"/>
<xs:element name="customer" type="xs:string" minOccurs="0"/>
<xs:element name="index" type="xs:long" nillable="true"/>
<xs:element name="values" type="tns:ArrayOfKV" minOccurs="0"/>
<xs:element name="attachments" type="tns:ArrayOfAttachment" minOccurs="0"/>
<xs:element name="body" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TaskItem">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
<xs:element name="queue" type="xs:string" minOccurs="0"/>
<xs:element name="queueName" type="xs:string" minOccurs="0"/>
<xs:element name="responsible" type="xs:string" minOccurs="0"/>
<xs:element name="status" type="xs:string" minOccurs="0"/>
<xs:element name="rowVersion" type="xs:string" minOccurs="0"/>
<xs:element name="_serverDate" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfKV">
<xs:sequence>
<xs:element name="KV" type="tns:KV" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="KV">
<xs:sequence>
<xs:element name="k" type="xs:string" minOccurs="0"/>
<xs:element name="v" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfAttachment">
<xs:sequence>
<xs:element name="Attachment" type="tns:Attachment" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Attachment">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="filename" type="xs:string" minOccurs="0"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="ext" type="xs:string" minOccurs="0"/>
<xs:element name="size" type="xs:long"/>
<xs:element name="path" type="xs:string" minOccurs="0"/>
<xs:element name="data" type="xs:base64Binary" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<taskdata>
<item>
<id>str1234</id>
<type>str1234</type>
<queue>str1234</queue>
<queueName>str1234</queueName>
<responsible>str1234</responsible>
<status>str1234</status>
<rowVersion>str1234</rowVersion>
<_serverDate>str1234</_serverDate>
</item>
<caseId>str1234</caseId>
<cid>str1234</cid>
<subject>str1234</subject>
<created>1991-01-24'PSL'13:05:33</created>
<creator>str1234</creator>
<priority>123</priority>
<warningTime>1991-01-24'PSL'13:05:33</warningTime>
<criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
<fromAddress>str1234</fromAddress>
<toAddress>str1234</toAddress>
<toAddressAnswer>str1234</toAddressAnswer>
<ccAddressAnswer>str1234</ccAddressAnswer>
<bccAddressAnswer>str1234</bccAddressAnswer>
<firstModifier>str1234</firstModifier>
<firstModified>1991-01-24'PSL'13:05:33</firstModified>
<lastModifier>str1234</lastModifier>
<lastModified>1991-01-24'PSL'13:05:33</lastModified>
<solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
<customer>str1234</customer>
<index>123</index>
<values>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
</values>
<attachments>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
</attachments>
<body>str1234</body>
</taskdata>
Type: application/json
Schema:
{
"$schema" : "http://json-schema.org/draft-03/schema" ,
"type" : "object" ,
"required" : true ,
"properties" : {
"item" : {
"required" : false ,
"$ref": "taskItem"
} ,
"caseId" : {
"required" : false ,
"type" : "string"
} ,
"cid" : {
"required" : false ,
"type" : "string"
} ,
"subject" : {
"required" : false ,
"type" : "string"
} ,
"created" : {
"required" : true ,
"$ref": "dateTime"
} ,
"creator" : {
"required" : false ,
"type" : "string"
} ,
"priority" : {
"required" : true ,
"type" : "number"
} ,
"warningTime" : {
"required" : true ,
"$ref": "dateTime"
} ,
"criticalTime" : {
"required" : true ,
"$ref": "dateTime"
} ,
"fromAddress" : {
"required" : false ,
"type" : "string"
} ,
"toAddress" : {
"required" : false ,
"type" : "string"
} ,
"toAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"ccAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"bccAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"firstModifier" : {
"required" : false ,
"type" : "string"
} ,
"firstModified" : {
"required" : true ,
"$ref": "dateTime"
} ,
"lastModifier" : {
"required" : false ,
"type" : "string"
} ,
"lastModified" : {
"required" : true ,
"$ref": "dateTime"
} ,
"solutionDate" : {
"required" : true ,
"$ref": "dateTime"
} ,
"customer" : {
"required" : false ,
"type" : "string"
} ,
"index" : {
"required" : true ,
"type" : "number"
} ,
"values" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"KV" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"k" : {
"required" : false ,
"type" : "string"
} ,
"v" : {
"required" : false ,
"type" : "string"
}
}
}
]
}
}
} ,
"attachments" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"Attachment" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"id" : {
"required" : false ,
"type" : "string"
} ,
"filename" : {
"required" : false ,
"type" : "string"
} ,
"creator" : {
"required" : false ,
"type" : "string"
} ,
"created" : {
"required" : true ,
"$ref": "dateTime"
} ,
"ext" : {
"required" : false ,
"type" : "string"
} ,
"size" : {
"required" : false ,
"type" : "number"
} ,
"path" : {
"required" : false ,
"type" : "string"
} ,
"data" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "number"
}
]
}
}
}
]
}
}
} ,
"body" : {
"required" : false ,
"type" : "string"
}
}
}
Example:
{
"item": {
"type": "XRI",
"queue": "CEC EMail"
},
"subject": "Extremely Complicated Fun",
"body": "Can be used for e-mail keyword routing by CEM",
"fromAddress": "customer@work.corp",
"toAddress": "hp_mylab@dev-hel.sinch.corp",
"values": {
"KV": [
{"k": "From", "v": "customer@work.corp"},
{"k": "To", "v": "hp_mylab@dev-hel.sinch.corp"}
]
}
}
put /tasks/{id}
Update one task.
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"$schema" : "http://json-schema.org/draft-03/schema" ,
"type" : "object" ,
"required" : true ,
"properties" : {
"item" : {
"required" : false ,
"$ref": "taskItem"
} ,
"caseId" : {
"required" : false ,
"type" : "string"
} ,
"cid" : {
"required" : false ,
"type" : "string"
} ,
"subject" : {
"required" : false ,
"type" : "string"
} ,
"created" : {
"required" : true ,
"$ref": "dateTime"
} ,
"creator" : {
"required" : false ,
"type" : "string"
} ,
"priority" : {
"required" : true ,
"type" : "number"
} ,
"warningTime" : {
"required" : true ,
"$ref": "dateTime"
} ,
"criticalTime" : {
"required" : true ,
"$ref": "dateTime"
} ,
"fromAddress" : {
"required" : false ,
"type" : "string"
} ,
"toAddress" : {
"required" : false ,
"type" : "string"
} ,
"toAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"ccAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"bccAddressAnswer" : {
"required" : false ,
"type" : "string"
} ,
"firstModifier" : {
"required" : false ,
"type" : "string"
} ,
"firstModified" : {
"required" : true ,
"$ref": "dateTime"
} ,
"lastModifier" : {
"required" : false ,
"type" : "string"
} ,
"lastModified" : {
"required" : true ,
"$ref": "dateTime"
} ,
"solutionDate" : {
"required" : true ,
"$ref": "dateTime"
} ,
"customer" : {
"required" : false ,
"type" : "string"
} ,
"index" : {
"required" : true ,
"type" : "number"
} ,
"values" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"KV" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"k" : {
"required" : false ,
"type" : "string"
} ,
"v" : {
"required" : false ,
"type" : "string"
}
}
}
]
}
}
} ,
"attachments" : {
"required" : false ,
"type" : "object" ,
"properties" : {
"Attachment" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "object" ,
"properties" : {
"id" : {
"required" : false ,
"type" : "string"
} ,
"filename" : {
"required" : false ,
"type" : "string"
} ,
"creator" : {
"required" : false ,
"type" : "string"
} ,
"created" : {
"required" : true ,
"$ref": "dateTime"
} ,
"ext" : {
"required" : false ,
"type" : "string"
} ,
"size" : {
"required" : false ,
"type" : "number"
} ,
"path" : {
"required" : false ,
"type" : "string"
} ,
"data" : {
"type" : "array" ,
"required" : false ,
"items" : [
{
"required" : false ,
"type" : "number"
}
]
}
}
}
]
}
}
} ,
"body" : {
"required" : false ,
"type" : "string"
}
}
}
Example:
{
"item": {
"type": "XRI",
"queue": "CEC EMail"
},
"subject": "Extremely Complicated Fun",
"body": "Can be used for e-mail keyword routing by CEM",
"fromAddress": "customer@work.corp",
"toAddress": "hp_mylab@dev-hel.sinch.corp",
"values": {
"KV": [
{"k": "From", "v": "customer@work.corp"},
{"k": "To", "v": "hp_mylab@dev-hel.sinch.corp"}
]
}
}
Type: application/xml
Schema:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="urn:TMI" xmlns:tns="urn:TMI" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="taskData" type="tns:TaskData"/>
<xs:element name="taskItem" type="tns:TaskItem"/>
<xs:complexType name="TaskData">
<xs:sequence>
<xs:element name="item" type="tns:TaskItem" minOccurs="0"/>
<xs:element name="caseId" type="xs:string" minOccurs="0"/>
<xs:element name="cid" type="xs:string" minOccurs="0"/>
<xs:element name="subject" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="priority" type="xs:int" nillable="true"/>
<xs:element name="warningTime" type="xs:dateTime" nillable="true"/>
<xs:element name="criticalTime" type="xs:dateTime" nillable="true"/>
<xs:element name="fromAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddress" type="xs:string" minOccurs="0"/>
<xs:element name="toAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="ccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="bccAddressAnswer" type="xs:string" minOccurs="0"/>
<xs:element name="firstModifier" type="xs:string" minOccurs="0"/>
<xs:element name="firstModified" type="xs:dateTime" nillable="true"/>
<xs:element name="lastModifier" type="xs:string" minOccurs="0"/>
<xs:element name="lastModified" type="xs:dateTime" nillable="true"/>
<xs:element name="solutionDate" type="xs:dateTime" nillable="true"/>
<xs:element name="customer" type="xs:string" minOccurs="0"/>
<xs:element name="index" type="xs:long" nillable="true"/>
<xs:element name="values" type="tns:ArrayOfKV" minOccurs="0"/>
<xs:element name="attachments" type="tns:ArrayOfAttachment" minOccurs="0"/>
<xs:element name="body" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TaskItem">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
<xs:element name="queue" type="xs:string" minOccurs="0"/>
<xs:element name="queueName" type="xs:string" minOccurs="0"/>
<xs:element name="responsible" type="xs:string" minOccurs="0"/>
<xs:element name="status" type="xs:string" minOccurs="0"/>
<xs:element name="rowVersion" type="xs:string" minOccurs="0"/>
<xs:element name="_serverDate" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfKV">
<xs:sequence>
<xs:element name="KV" type="tns:KV" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="KV">
<xs:sequence>
<xs:element name="k" type="xs:string" minOccurs="0"/>
<xs:element name="v" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArrayOfAttachment">
<xs:sequence>
<xs:element name="Attachment" type="tns:Attachment" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Attachment">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0"/>
<xs:element name="filename" type="xs:string" minOccurs="0"/>
<xs:element name="creator" type="xs:string" minOccurs="0"/>
<xs:element name="created" type="xs:dateTime" nillable="true"/>
<xs:element name="ext" type="xs:string" minOccurs="0"/>
<xs:element name="size" type="xs:long"/>
<xs:element name="path" type="xs:string" minOccurs="0"/>
<xs:element name="data" type="xs:base64Binary" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Example:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<taskdata>
<item>
<id>str1234</id>
<type>str1234</type>
<queue>str1234</queue>
<queueName>str1234</queueName>
<responsible>str1234</responsible>
<status>str1234</status>
<rowVersion>str1234</rowVersion>
<_serverDate>str1234</_serverDate>
</item>
<caseId>str1234</caseId>
<cid>str1234</cid>
<subject>str1234</subject>
<created>1991-01-24'PSL'13:05:33</created>
<creator>str1234</creator>
<priority>123</priority>
<warningTime>1991-01-24'PSL'13:05:33</warningTime>
<criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
<fromAddress>str1234</fromAddress>
<toAddress>str1234</toAddress>
<toAddressAnswer>str1234</toAddressAnswer>
<ccAddressAnswer>str1234</ccAddressAnswer>
<bccAddressAnswer>str1234</bccAddressAnswer>
<firstModifier>str1234</firstModifier>
<firstModified>1991-01-24'PSL'13:05:33</firstModified>
<lastModifier>str1234</lastModifier>
<lastModified>1991-01-24'PSL'13:05:33</lastModified>
<solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
<customer>str1234</customer>
<index>123</index>
<values>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
<KV>
<k>str1234</k>
<v>str1234</v>
</KV>
</values>
<attachments>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
<Attachment>
<id>str1234</id>
<filename>str1234</filename>
<creator>str1234</creator>
<created>1991-01-24'PSL'13:05:33</created>
<ext>str1234</ext>
<size>123</size>
<path>str1234</path>
<data>123</data>
<data>123</data>
</Attachment>
</attachments>
<body>str1234</body>
</taskdata>
HTTP status code 204
The request was successful.