Ticket Object
Includes information about a ticket.
This object is used by the following operations:
- POST /api/tickets (Opens a new ticket.)
- GET /api/tickets/{TicketID} (Returns information about a specific ticket.)
- Operations that reference the Tickets object
The properties included in the Ticket object are listed below.
| Property | Type | Description |
|---|---|---|
| TicketID | string | The unique ID for a specific ticket. |
| APIID | string |
The unique ID for a specific API. It is the ID for the API the ticket is associated with, if applicable. |
| AppID | string | The unique ID for a specific app.It is the ID of the app the ticket is associated with. |
| Title | string | The ticket title. Required when adding a ticket. |
| Description | string | The text description of the ticket. Required when adding a ticket. |
| Environment | string | The environment to which the ticket relates (Sandbox or Production). Required when adding a ticket. |
| State | string | The current state of the ticket. For valid values, see Ticket State Values. |
| UserID | string | The unique ID for a specific user.It is the ID of the user who created the ticket. |
| UserName | string | The username of the person who created the ticket. |
| Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
| Label | string[ ] |
One or more ticket labels indicating the priority of the ticket. When setting priority, specify only one value. For valid values, see Ticket Label Values. Required when adding a ticket. |
| Tag | string[ ] | One or more user-defined tags assigned to the ticket. |
| Comments | integer | The number of comments associated with the ticket. |
| Marks | integer | The number of marks on the resource. |
| IsMarked | boolean | Indicates whether there are any marks on the resource or not. |
| Visibility | string | The visibility setting for the API; either Public, which is visible to all users, or Limited, which is visible only to API Administrators and API Scope Group members. |
| pubDate | dateTime | The publication date for the discussion, formatted in Coordinated Universal Time (UTC). |
| Action | Action[ ] |
An extensibility element for a workflow action event that possibly could be taken on a specific resource. Used to call a JavaScript action. A list of actions available on the resource. |
| TargetResources | TargetResources | Contains information about one or more resources associated with the current resource. Used only in response messages. |
| Image | Image | Contains information about an avatar associated with a resource. |
| CommentsPreview | CommentsPreview | A preview of the comments added to the resource (the last two comments plus total count). |
| Link | string | A link to the ticket. |
| AuthoringUser | AuthoringUser |
Contains information about the author of a resource. The author who created the ticket. |
| Published | boolean | Indicates whether the ticket is published. |
| DescriptionMediaType | string | Indicates the media type for the description of an artifact associated with a Board item. Valid values: text/markdown (the default if platform settings support markdown) or text/plain (the default if markdown is not supported). |
| BoardItemArtifacts | BoardItemArtifacts | Contains information about an image or other artifact associated with a Board item. Applicable only if the DescriptionMediaType for the Board item is text/markdown. |