CompanyNoteAttachments

This entity contains the attachments for the CompanyNotes entity. For more information about attachments, including call syntax, thresholds and limits, and a full list of attachment entities, refer to Working with attachments in the REST API.

IMPORTANT  Attachment behavior in the API has changed. To avoid service disruption, review our Changes to Attachment entities article for important information about this recent update.

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: CompanyNoteAttachment

Entity Path:

/atservicesrest/v1.0/CompanyNoteAttachments
Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Parent CompanyNotes
URLs CompanyNoteAttachments​/entityInformation (GET)
CompanyNoteAttachments​/entityInformation​/fields (GET)
CompanyNoteAttachments​/query (GET, POST)
CompanyNoteAttachments​/{id} (GET)
CompanyNoteAttachments​/query​/count (GET, POST)

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • creatorType
  • data
  • fileSize

Conditions and requirements

General

  • If your query supplies both an entityID and a parentID, the entityID will take precedence.

When adding an attachment to an entity via the API, the attachment must be encoded as base64 binary data.

To ensure a consistent quality of service for all users, the API uses the following thresholds when processing attachments.

  • The maximum attachment file size indicated in the Autotask Online Help does not apply to the API. The API size limit for individual attachment files is 6 to 7 MB, with a maximum of 10,000,000 bytes within a five-minute period. If your integration exceeds either of these limits, you'll receive an error message indicating condition. If the integration exceeds 10,000,000 bytes within a five-minute span, the API will also stop accepting attachment creation calls for five minutes.

NOTE  The API size limit for individual attachments is less than the 10 MB limit for individual attachment files when working through the Autotask UI.

  • Attachment types are limited to the file types allowed in Autotask. For more details, refer to Add attachments.

Attachments are external documents that are associated with one of the following entities. Attachments in Autotask can be documents uploaded to the server, file links, folder links, and URLs.

  • Account
  • Documents (REST only)
  • Expenses
  • Knowledgebase articles (REST only)
  • Task
  • Ticket
  • Task or Ticket Note
  • Time Entry
  • Asset
  • Asset Note
  • Project
  • Opportunity

The following parent entities support nested attachments. Nested attachments are a child attachment to a parent attachment, and both the parent and the child can be of the same entity type.

  • Articles
  • Companies
  • Configuration Items
  • Documents
  • Opportunities
  • Tasks
  • Tickets

NOTE  Attachments nested under note or time entry attachments are created via the parent entity URL using the parentAttachmentId. The nested attachment does not have visibility to the note or time entry, but it will reflect that the parent is an attachment with the supplied ID.

The following parent entities do not support nested attachments. For these parents, you cannot create attachments that have a parent attachment of the same type.

  • Account
  • Sales Order
  • Expense Report
  • Resource
  • Account Note
  • Contract Note
  • Project
  • Project Note

Attachments support create, delete, and query functions only. It is not possible to update an attachment.

NOTE  To retrieve a specific attachment of a resource, your query must specify the Attachment ID of the Attachments child endpoint or the appropriate <EntityName>Attachments endpoint (such as TicketAttachments, ResourceAttachments, and so forth). Refer to Retrieving an attachment of a resource for additional details.

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:

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
attachDate datetime      
attachedByContactID long   Contacts  
attachedByResourceID long   Resources  
attachmentType string (30)  

companyID

integer

 

Companies

 

companyNoteID

integer

 

CompanyNotes

 
contentType string (100)      
fullPath string (255)  
impersonatorCreatorResourceID integer   Resources  

opportunityID

integer

 

Opportunities

 
opportunityID long   Opportunities  
parentID long      
publish integer  

salesOrderID

integer

 

SalesOrders

 
title string (255)    

Additional resources