The getEntityInfo() SOAP API call
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.
This call returns an array of the standard Autotask fields for a specified SOAP API entity with detailed information about each field. The data returned includes the field label and type, whether the field is required, read-only, or queryable, whether it references another field, and whether it is a picklist.
If the field is a picklist, the information includes the available values, their active or inactive status, and whether or not they are system values. In addition, where the picklist is a child, the name of the picklist parent is provided.
NOTE To learn about the REST API version of this call, refer to The entityInformation REST API call.
Definitions
getEntityInfo() returns the following information for each entity.
| Data | Description |
|---|---|
| EntityName as String | The Name of the entity, for example, Ticket, Note, Account. |
| CanCreate as Boolean | Indicates whether objects can be created on the specified entity using the API. The access varies by Autotask end user permission level. |
| CanUpdate as Boolean | Indicates whether objects on the specified entity can be updated using the API. The access varies by Autotask end user permission level. |
| CanQuery as Boolean | Indicates whether objects on the specified entity can be queried using the API. Note that currently all entities can be queried; however, the access varies by Autotask end user permission level. |
| CanDelete as Boolean | Indicates whether the specified entity can be deleted using the API. The access varies by Autotask end user permission level. |
| Has User Defined Fields | True or False. Indicates whether the specified entity for your organization contains user defined fields (UDFs). For more information about UDFs, refer to SOAP API: user-defined fields (UDFs). If your organization uses UDFs with an entity, the getFieldInfo() call does not return the UDFs. You must use the getUDFInfo() call to return a listing and descriptions of the UDFs. |
| UserAccessForCreate as Boolean | Indicates the API user's permission to Create objects on the specified entity: 0 (None), 1 (All), 2 (Restricted). Refer to Autotask security, below. |
| UserAccessForUpdate as Boolean | Indicates the API user's permission to Update objects on the specified entity: 0 (None), 1 (All), 2 (Restricted). Refer to Autotask security, below. |
| UserAccessForQuery as Boolean | Indicates the API user's permission to Query objects on the specified entity: 0 (None), 1 (All), 2 (Restricted). Refer to Autotask security, below. |
| UserAccessForDelete as Boolean | Indicates the API user's permission to Delete objects on the specified entity: 0 (None), 1 (All), 2 (Restricted). Refer to Autotask security, below. |
| SupportsWebhookCallouts | True or False. Indicates if the entity supports webhook callouts. |
Autotask security
In Autotask, the security level controls access to features and data. Autotask provides basic security levels, for example, System Administrator or Manager, that are pre-set to provide access to Autotask modules like Service Desk and Projects. Autotask administrators can then modify or copy the basic security levels to create custom security levels. The custom security levels set additional controls over access to features and data within the assigned modules.
The data returned by getEntityInfo() "UserAccessFor" fields corresponds to the levels of permissions assigned through basic and custom security levels:
- 0 (None) indicates the user can never perform the action (even when the entity allows the action).
- 1 (All) indicates the user can always perform the action.
- 2 (Restricted) indicates that the user can perform the action under specific conditions. These conditions normally correspond to security level permission settings like "Mine" or "My Territory," which allow access to only those items with which the user is associated. For example, a "Mine" permission on the Companies entity requires that the logged in user must be the account owner or a member of the account team. A "My Territory" permission includes the "Mine" permissions and also includes users that are associated with the same territory as the account.
NOTE The Full Access security level ensures access to all modules and features. By default, the API User (system) (API-only) security level grants full access permissions, but copies of this security level may have been modified. The API user must have access to the appropriate Autotask module for the entity type and sufficient rights to perform the specified API call.
For additional details on Autotask custom security levels, refer to the Help topic Create or edit a custom security level.
Site-Wide Restrict Deletion Installed Module
For legal or accounting reasons, some companies choose to enable the Autotask "Site-Wide Restrict Deletion" installed module. This module prevents any user from deleting Accounts, Tickets, or Time Entries. Site-Wide Restrict Deletion applies to the Web Services API.
Sample getEntityInfo() SOAP XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
<IntegrationCode>[insert your own tracking identifier]</IntegrationCode>
</AutotaskIntegrations>
</soap:Header>
<soap:Body>
<GetEntityInfo xmlns="http://autotask.net/ATWS/v1_6/">
</GetEntityInfo>
</soap:Body>
</soap:Envelope>
