GET List/TicketStatus/Items/{id}
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
GET /api/v1/List/TicketStatus/Items/{id}
Gets a TicketStatusEntity list item.
Calls the List agent service GetTicketStatusEntity.
Path Part | Type | Description |
---|---|---|
id | int32 | The id of the TicketStatusEntity to return. Required |
Request Headers
Parameter Name | Description |
---|---|
Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
Accept | Content-type(s) you would like the response in: application/json , text/json , application/xml , text/xml , application/json-patch+json , application/merge-patch+json |
Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Response:
OK
Response | Description |
---|---|
200 | OK |
404 | Not Found. |
Response body: TicketStatusEntity
Property Name | Type | Description |
---|---|---|
TicketStatusId | int32 | The primary key (auto-incremented) |
Name | string | Name of user defined ticket status |
Status | string | The 'classic' ticket status. I.e. active/closed/postponed/deleted |
TimeCounter | string | Which field in ticket we count time spent on (queue, internal, external) |
NoEmailReopen | bool | Whether inbound emails can reopen requests with this status or not |
IsDefault | bool | Indicates if status is default one as there might be more than one status with same internal status |
UsedInQueue | bool | If set, status is used in GetNext calculations |
TableRight | TableRight | The carrier's table right |
FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
GET /api/v1/List/TicketStatus/Items/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"TicketStatusId": 382,
"Name": "Mosciski-Johns",
"Status": "Active",
"TimeCounter": "Externally",
"NoEmailReopen": true,
"IsDefault": true,
"UsedInQueue": true,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 207
}
}
}