Note

What can you do with Note?


Properties

Property Details
id
"id": 426
Type: Number
This is the unique numeric identifier for the Note
subject
"subject": "Hello World"
Type: String
text
"text": "Hello World"
Type: String
noteTypeId
"noteTypeId": 994
Type: Number
Unique identifier for the associated NoteType object.
created
"created": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 54
Type: Number
Unique identifier for the associated User object.
updated
"updated": "2005-04-11T14:56:24"
Type: Date
updatedByUserId
"updatedByUserId": 463
Type: Number
Unique identifier for the associated User object.
showOnOverview
"showOnOverview": true
Type: Boolean
isImportant
"isImportant": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • subject
  • text
  • noteTypeId
  • created
  • createdByUserId
  • updated
  • updatedByUserId
  • showOnOverview
  • isImportant

DataFlow PATCH objects:

  • note - create, update, delete

End Points

DELETEapi/v1/Note/{id:int}
Delete an instance of the Note object.
GETapi/v1/Note
Retrieve all of the Note objects.
GETapi/v1/Note/Metadata
Retrieve all of the meta data details of the Note object.
GETapi/v1/Note/Metadata/{option}
Retrieve all the meta data details of the Note object based on provided options.
{option}Metadata options for the Note object.
GETapi/v1/Note/Paged
Retreive all of the Note objects in a paged fashion.
GETapi/v1/Note/{id:int}
Retrieve an instance of the Note object by it's ID.
{id:int}Unique identifier for the Note object.
POSTapi/v1/Note
Create a new instance of the Note object.
PUTapi/v1/Note/{id:int}
Update an existing instance of the Note object.