TaskNote
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will be deactivated in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.
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.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | TaskNote |
| 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
- The API user security level has access to contact impersonation for task notes.
- Publish must always be ALL.
- The task belongs to the contact's account or to a child account of the contact's account.
- The contact is active.
- 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
About this table
The following table describes the standard Autotask field objects for this entity.
- To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
- For information on entity UDFs, use getUDFInfo().
- For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
For more information about fields marked as picklists, review our Understanding picklists article.
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 | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| CreateDateTime | Create Date Time | datetime |
|
|||
|
CreatedByContactID |
Created by Contact ID |
integer |
|
|
|
|
| CreatorResourceID | Creator Resource | integer |
|
Resource | ||
| Description | Description | string (3200) |
|
|||
| id | Task Note ID | long |
|
|
||
| ImpersonatorCreatorResourceID | Impersonator Creator Resource ID | integer |
|
Resource | ||
| ImpersonatorUpdaterResourceID | Impersonator Updater Resource ID | integer |
|
Resource | ||
| LastActivityDate | LastActivityDate | datetime |
|
|||
| NoteType | Note Type | integer |
|
|
||
| Publish | Publish | integer |
|
|
||
| TaskID | Task | integer |
|
Task | ||
| Title | Title | string (250) |
