DocumentPlainTextContent
About this entity
The DocumentPlainTextContent entity contains the plain text version of body content held by a Document Management document.
Entity info
Supported request types
Can Create | Can Delete | Can Query | Can Update | Can have UDFs |
---|---|---|---|---|
false |
false |
true | true | false |
Relationships
Parent | Children |
---|---|
Documents | none |
[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/DocumentPlainTextContent |
Entity URLs |
DocumentPlainTextContent/entityInformation (GET) DocumentPlainTextContent/entityInformation/fields (GET) |
Parent Entity URLs | Documents/{id} (GET) |
Field definitions
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 |
---|---|---|---|---|---|---|
contentData |
The API user must have Can access documentation and Add, Edit and Delete object permission to make changes to the document. IMPORTANT Updates to the contentData field will remove any rich text formatting. |
string (3200) | ||||
id |
The unique identifier of this entity |
long |
Additional resources
- Using Postman to explore the REST API
- Using Swagger UI to explore REST API requests
- Working with attachments in the REST API