Documents
About this entity
This entity represents documents in Autotask.
Context
The Autotask Document Management feature lets you collect and reference documents related to a customer right inside of Autotask. If you are using the Client Portal, you can even share selected documents with your Client Portal customers.
Documents are always related to a specific company, the owner company. They contain information about the specific company and can even contain confidential information. As a best practice, they should only ever be published to the owner company.
EXAMPLE The document "Access protocol for the server room at Albany Medical Center" contains information on who has the key and how you will authenticate to get into the server room at this one company. It is not relevant to any other company.
Conditions and requirements
- Knowledgebase must be enabled in Autotask at
> Admin > Features & Settings > Application-Wide (Shared) Features > Knowledgebase for the API entity to function. - Documentation Management must be enabled in Autotask for document management endpoints to function.
- To create or update children of this entity, your API User must have Approve object permissions for Documents.
- Documents are created in a Published status when generated via the API. To create or update children of this entity, your API User must have Approve object permissions for Documents.
- Content is stored in the DocumentContent child collection.
- Approval status and draft content are not visible via the API.
- The API will not allow delete or update of a document if there is a version of the same document in any draft status.
- The API will only return Documents in a published status.
- The API will always return the most recent version of a Document.
Entity details
Supported request types
| Can Create | Can Delete | Can Query | Can Update | Can have UDFs |
|---|---|---|---|---|
| true | true | true | true | false |
Relationships
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/Documents |
| Entity URLs |
Documents/entityInformation (GET) Documents/entityInformation/fields (GET) |
| Parent Entity URLs | Documents/{id} (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 | Datatype | Is Required | Read-Only | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| companyID |
The company ID of the company associated with the document. |
integer |
|
Companies | ||
|
createdByResourceID |
The resource ID of the resource who created the document. |
integer |
|
|
|
|
| createdDateTime |
The date and time the document was created. |
datetime |
|
|||
| documentCategoryID |
The document category assigned to the document. |
integer |
|
Documents | ||
|
errorCodes |
The error codes the document is associated with. |
string (200) |
|
|
|
|
|
id |
The unique identifier of this entity. |
long |
|
|
|
|
|
isActive |
|
boolean |
|
|
|
|
|
keywords |
Any keywords associated with the document. |
string (300) |
|
|
|
|
|
lastModifiedByResourceID |
These fields will always match the most recent version in the entity's history. |
integer |
|
|
|
|
|
lastModifiedDateTime |
datetime |
|
|
|
|
|
|
publish |
The audience the document is published to. Options are:
|
integer |
|
|
|
|
|
referenceLink |
The link to an external document. |
string (500) |
|
|
|
|
|
title |
The title of the document. |
string (200) |
|
|
|
|
