TaskNotes

This entity describes notes created by an Autotask user and associated with a Task entity. Autotask users manage Task Notes on Project Tasks. Users can add notes to a new or existing task.

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

Entity Path:

/atservicesrest/v1.0/TaskNotes

Parent Entity:

Tasks

Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

  • If Autotask receives a create, update, or delete request for this entity and its corresponding module is unavailable, the API will return the error message, "The logged in Resource does not have the adequate permissions to update this entity type." For more information about installed modules, refer to our Modules article.
  • Task notes associated with projects of Type = Baseline are read-only and cannot be created, updated or deleted via the API.

Contact impersonation validation rules for creating entities

  1. The API user security level has access to contact impersonation for task notes.
  2. Publish must always be ALL.
  3. The task belongs to the contact's account or to a child account of the contact's account.
  4. The contact is active.
  5. The contact's account is active.

NOTE  If the API user does not have the Contacts impersonation option enabled, it will be unable to specify custom values for the AttachedByContactID and the CreatedByContactID fields. Any entities or attachments that the account creates will be attributed to "API User." Refer to Web Services API security settings.

Special field attributes

Field Conditions and Requirements
description

When you use the API to update this field, the REST API will return the text-only version of its content. If you send the content back, the Rich Text and all images that it contains will be lost. You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method.

To learn more, refer to The Rich Text editor.
title

The title field will be required if the "Require titles on task notes" Task Category setting is enforced.

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.

NOTE  API queries for TaskNote entities with publish = 1 include all System Workflow Notes. If you do not want system workflow notes returned, you must modify the query to include a condition that excludes TaskNote.noteType = 13.

Field Name Datatype Read-Only Is Required Reference Name Picklist
createDateTime datetime      

createdByContactID

integer

 

 

Contacts

 
creatorResourceID integer   Resources  
description string (3200)      
id long    
impersonatorCreatorResourceID integer   Resources  
impersonatorUpdaterResourceID integer   Resources  
lastActivityDate datetime      
noteType integer    
publish integer    
taskID integer   Tasks  
title string (250)        

Additional resources