ServiceCallTickets
NOTE This entity works in combination with the Service Call and Service Call-related entities. Before working with this entity, review the topic ServiceCall.
The ServiceCallTickets entity describes an Autotask ticket assigned to a service call. Service calls are instances of time scheduled to perform work for a service request. A ticket associated with a service call describes work that must be performed during the scheduled time.
You create Tickets through the Service Desk module or by clicking the New Service Request button in the sub-navigation menu. You associate tickets to a service call when you create the service call, through the Service Desk module, or through Dispatcher's Workshop.
A ServiceCallTickets entity is associated with a ServiceCalls entity and requires a serviceCallID value; for additional information, refer to ServiceCalls.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
| Entity Name: | ServiceCallTickets |
|
Entity Path: |
/atservicesrest/v1.0/ServiceCallTickets |
| Can Create: |
|
| Can Update: | |
| Can Query: |
|
| Can Delete: |
|
| Can Have UDFs: |
IMPORTANT Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.
Entity URLs and relationships
- If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity.
- If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities.
- To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.
| Parent | |
| URLs | ServiceCallTickets/query (GET, POST) ServiceCallTickets/{id} (GET) ServiceCallTickets/query/count (GET, POST) ServiceCallTickets/entityInformation (GET) ServiceCallTickets/entityInformation/fields (GET) ServiceCallTickets/entityInformation/userDefinedFields (GET) |
Child collection access URLs
The following child collection access URLs are available for this entity:
| GET: | /atservicesrest/v1.0/ServiceCallTickets/{parentId}/Resources/ |
|
POST: |
/atservicesrest/v1.0/ServiceCallTickets/{parentId}/Resources/ |
|
DELETE: |
/atservicesrest/v1.0/ServiceCallTickets/{parentId}/Resources/{id} |
Conditions and requirements
General
- This entity will be read-only if the module with which it is associated is not active. For more information, refer to Activations.
- All tasks and tickets associated with a service call must be for the same account. There are no parent/child account loopholes.
- A single task or ticket can be associated with multiple service calls at the same time.
- Any resource can create service calls and associate/disassociate tasks/tickets to service calls.
- API will respect the system setting "Automatically complete service calls when completing the last non-complete task or ticket associated with the service call" . When this rule is enabled and the last open ticket associated with the service call is set to complete, the service call is set to complete.
Field definitions
About this table
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
| Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|
| id | long |
|
|
||
| serviceCallID | integer |
|
ServiceCalls | ||
| ticketID | integer |
|
Tickets |
