TAG LINE
TAG LINE
SMALL TITLE
System defined type for a Note
identity READ-ONLY | "identity": 5 Type: Number This is the unique numeric identifier for the NoteType |
ownerId READ-ONLY | "ownerId": 21 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name READ-ONLY | "name": "Default" Type: String System defined name for this NoteType. |
| GET | NoteType/ |
| Retrieve all of the NoteType objects. | |
Retrieve all of the NoteType objects. GET NoteType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"name": "Default"
}
]
} | |
| GET | NoteType/Paged |
| Retrieve all of the NoteType 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 NoteType objects in a paged fashion. GET NoteType/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,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Default"
}
]
}
} | |
| GET | NoteType/{id} |
| Retrieve an instance of the NoteType object by its ID. | |
| {id} | Unique identifier for the NoteType object. |
Retrieve an instance of the NoteType object by its ID. GET NoteType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "Default"
}
} | |