ProductNotes
This entity describes notes created by an Autotask user and associated with a Product entity.
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: | ProductNotes |
|
Entity Path: |
/atservicesrest/v1.0/ProductNotes |
| Can Create: |
|
| Can Update: |
|
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
Conditions and requirements
General
-
The ability to create and update ProductNote entities in the API is governed by the user's security level permissions as defined in the Autotask Inventory > Product Notes: Add and Inventory > Product Notes: Edit settings.
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| creatorResourceID | Represents the resource ID of the creator of the note; if you create the note through impersonation, the field will represent the impersonated resource |
| description | Represents the note's description; maximum of 32,000 characters |
| productID | Represents the ID of the product to which this note is associated; editable on creation of the ProductNote (but not afterward) |
|
title |
Represents the title of the note; maximum of 250 characters |
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.
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 |
|---|---|---|---|---|---|
| createDateTime | datetime |
|
|||
| creatorResourceID | integer |
|
Resource | ||
| description | string (32000) |
|
|||
| id | long |
|
|
||
| impersonatorCreatorResourceID | integer |
|
|||
| impersonatorUpdaterResourceID | integer |
|
Resource | ||
| lastActivityDate | datetime |
|
|||
| productID | integer |
|
|
||
| title | string (250) |
|
