Appointments
The Appointments entity describes an Autotask Appointment, that is, scheduled time that is not a service call. Autotask users manage appointments through their calendar. In addition, Dispatchers can view and schedule appointments through the Dispatcher's Workshop.
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: | Appointments |
|
Entity Path: |
/atservicesrest/v1.0/Appointments |
| Can Create: |
|
| Can Update: |
|
| Can Query: |
|
| Can Delete: |
|
| Can Have UDFs: |
Conditions and Requirements
All users can create, update, and delete only their own appointments. Users whose security level allows access to Admin > Resources or access to All tickets, and the Autotask service desk system setting "Allow users that can view all tickets to create, edit, and delete appointments for other resources" is enabled can manage appointment for other users.
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 |
|---|---|---|---|---|---|
| createDateTime | datetime |
|
|||
| creatorResourceID | integer |
|
Resources | ||
| description | string (8000) | ||||
| endDateTime | datetime |
|
|||
| id | long |
|
|
||
| resourceID | integer |
|
Resources | ||
| startDateTime | datetime |
|
|||
| title | string (256) |
|
|||
| updateDateTime | datetime |
|
