TimeOffRequestsApprove
About this entity
An API user has the ability to approve time off requests. This entity describes the approval action of a specific time off request (vacation, sick time, floating holiday, personal time) submitted by an Autotask resource.
An API user approves time of requests by impersonating a timesheet approver. The following conditions must be met:
- The API user's security level must be configured to enable time off approval using impersonation ("Can approve Time Off Requests (using impersonation)").
- The impersonated resource must be a timesheet approver. Note that co-managing users cannot be timesheet approvers.
- Impersonation must be allowed by the impersonated resources' (the time off approvers') security level (checkbox labeled "Allow impersonation of resources with this security level").
Refer to Web Services API security settings.
NOTE Approval by an API user will set the timeoffRequest.lastModifiedByResourceID to the API user's resource ID.
Context
Timesheets and time off requests are approved or rejected by designated users called timesheet approvers. Each resource has one or more timesheet approvers, and the approval process can include up to three approval levels. A time off request is approved when the highest-level approver assigned to the resource has approved it. For more context on timesheet approval, refer to Approving or rejecting time off requests and related topics in the UI documentation.
Entity info
Supported request types
| Can Create | Can Delete | Can Query | Can Update | Can have UDFs |
|---|---|---|---|---|
|
true |
false |
false | false | false |
Relationships
| Parent | Children |
|---|---|
| TimeOffRequests | none |
Access URLs
[n] represents the zone where your database is hosted. Refer to Querying user zone information via the REST API.
| Description | URL |
|---|---|
| Full path | https://webservices[n].autotask.net/atservicesrest/v1.0/TimeOffRequestsApprove |
| Entity URLs |
TimeOffRequestsApprove/entityInformation (GET) TimeOffRequestsApprove/entityInformation/fields (GET) |
| Parent Entity URLs | TimeOffRequests/{id}/Approve (GET) |
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.
| Field Name | Description | Data Type | Is Required | Read-Only | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| id |
The unique identifier of this entity |
long |
|
|
||
| timeOffRequestID |
The ID of the time off request being approved |
integer |
|
|
TimeOffRequests |
