TAG LINE
TAG LINE
SMALL TITLE
Represents a note made on an Account.
identity READ-ONLY | "identity": 7 Type: Number This is the unique numeric identifier for the Note |
subject | "subject": "Delivery Instuctions" Type: String User defined subject for this Note. |
text | "text": "Drop off at rear door." Type: String User defined text body for this Note. |
noteTypeId | "noteTypeId": 27 Type: Number Unique identifier for the associated NoteType object. |
noteTypeName | "noteTypeName": "Sample Name" Type: String The name of the object associated with the noteTypeId property. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
createdByUserId | "createdByUserId": 25 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date Date time stamp the last time this Note was updated The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format. |
updatedByUserId | "updatedByUserId": 5 Type: Number Unique identifier for the associated User object. |
updatedByUserName | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
showOnOverview | "showOnOverview": true Type: Boolean Whether or not to show this Note on the Account overview screen. |
isImportant | "isImportant": true Type: Boolean Whether or not this should be displayed with importance. |
DELETE | Note/{id} |
Delete an instance of the Note object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
{id} | Unique identifier for the Note object. |
Delete an instance of the Note object. DELETE Note/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "note" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } } |
GET | Note/ |
Retrieve all of the Note objects. | |
Retrieve all of the Note objects. GET Note/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 16, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 27, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 16, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } |
GET | Note/Paged |
Retrieve all of the Note objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the Note objects in a paged fashion. GET Note/Paged HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 7, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 19, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 7, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } |
GET | Note/{id} |
Retrieve an instance of the Note object by its ID. | |
{id} | Unique identifier for the Note object. |
Retrieve an instance of the Note object by its ID. GET Note/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 6, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 15, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 14, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } } |
POST | Note/ |
Create a new instance of the Note object. | |
Create a new instance of the Note object. POST Note/ { "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 13, "createdByUserId": 21, "updatedByUserId": 0, "showOnOverview": true, "isImportant": true } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 13, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 12, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 15, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } |
PUT | Note/{id} |
Update an existing instance of the Note object. | |
Update an existing instance of the Note object. PUT Note/{id} { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 26, "createdByUserId": 27, "updatedByUserId": 12, "showOnOverview": true, "isImportant": true } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 18, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 0, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 3, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } |