Name | Type | Read-only | Mandatory | Comment |
|---|---|---|---|---|
| id | integer | yes | no | |
| contactId | integer | no | yes | User.id |
| submittedById | integer | yes | no | User.id |
| assignedToId | integer | no | yes | UserRoleGroup.id |
| priorityId | integer | no | no | TicketPriority.id |
| statusId | integer | no | no | Status.id |
| locationId | integer | no | no | Location.id |
| groupId | integer | no | yes | Group.id |
| categoryId | integer | no | no | Category.id |
| categoryOptionId | integer | no | no | CategoryOption.id |
| subject | string | no | yes | |
| note | string | no | no | |
| createdDate | date | yes | no | |
| modifiedDate | date | yes | no | |
| estimatedDate | date | no | no | |
| workTime | integer | no | no | |
| cc | string | no | no | |
| bc | string | no | no | |
| parentId | integer | no | no | Ticket.id |
| anonymousEmailAddress | string | no | no | |
| ticketHistoryIds | array | no | no | array of TicketHistory.id |
| attachmentIds | array | no | no | array of Attachment.id |
| subticketIds | array | no | no | array of Ticket.id |
| customFieldValues | array | no | no | array of CustomFieldValues.id |
| assetId | integer | no | no | Asset.id |
Url | Method | Request Data | Success Response Code | Description |
|---|---|---|---|---|
| /api/tickets | GET | 200 | Returns an Array of all Tickets | |
| /api/tickets/{id} | GET | 200 | Returns one Ticket | |
| /api/tickets | POST | Ticket | 201 | Create new Ticket |
| /api/tickets/{id} | PUT | Ticket | 204 | Update an existing Ticket |
| /api/tickets/{id} | DELETE | 200 | Delete a Ticket | |
| /api/tickets/{id}/attachments | GET | 200 | Returns an array of all Attachments for the Ticket | |
| /api/tickets/{id}/attachments | POST | Attachment | 201 | Create a new Attachment for the Ticket |
| /api/tickets/{id}/attachments/{attachmentId} | GET | 200 | Returns one Attachment | |
| /api/tickets/{id}/attachments/{attachmentId} | DELETE | 200 | Deletes an Attachment from the Ticket | |
| /api/tickets/{id}/ticket-histories | GET | 200 | Returns an array of all TicketHistorys for the Ticket | |
| /api/tickets/{id}/ticket-histories/{historyId} | GET | 200 | Returns one TicketHistory | |
| /api/tickets/{id}/ticket-histories | POST | TicketHistory | 201 | Create new TicketHistory for the Ticket |
| /api/tickets/{id}/ticket-histories/{historyId}/attachments | GET | 200 | Returns an array of all Attachments for the TicketHistory | |
| /api/tickets/{id}/ticket-histories/{historyId}/attachments/{attachmentId} | GET | 200 | Returns one Attachment | |
| /api/tickets/{id}/ticket-histories/{historyId}/attachments | POST | Attachment | 201 | Create new Attachment for TicketHistory |
| /api/tickets/{id}/custom-field-values | GET | 200 | Returns an array of all CustomFieldValues for Ticket | |
| /api/tickets/{id}/custom-field-values/{cfValueId} | GET | 200 | Returns one CustomFieldValue | |
| /api/tickets/{id}/custom-field-values | POST | CustomFieldValue | 201 | Create new CustomFieldValue for the Ticket |
| /api/tickets/{id}/custom-field-values/{cfValueId} | PUT | CustomFieldValue | 200 | Update an existing CustomFieldValue |
| /api/tickets/{id}/custom-field-values/{cfValueId} | DELETE | 200 | Delete a CustomFieldValue from the Ticket |