Notes API (3.0.0)

note-types

getNoteTypeCollection

Return a list of note types

query Parameters

query	string Default: "cql.allRecords=1" A query expressed as a CQL string, for details see Note Types API
offset	integer [ 0 .. 2147483647 ] Default: 0 Skip over a number of elements by specifying an offset value for the query
limit	integer [ 1 .. 2147483647 ] Default: 1000 Limit the number of elements returned in the response

Responses

Response samples

200
401
422

Content type

application/json

{"noteTypes": [{"id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
"name": "Important Note"
},
{"id": "46669e09-8b45-4ede-afbd-ca73bb89cdb3",
"label": "Urgent Note"
}
],
"totalRecords": 2
}

createNoteType

Create a new note type.

Request Body schema: application/json

Note type object

id

string <uuid> (uuid)

name

required

string <= 255 characters

The unique name of this type

object (Metadata)

Metadata about creation and changes to records

createdDate required	string <date-time> Date and time when the record was created
createdByUserId	string <uuid> (uuid)
createdByUsername	string Username of the user who created the record (when available)
	object (userInfo) User Display Information
updatedDate	string <date-time> Date and time when the record was last updated
updatedByUserId	string <uuid> (uuid)
updatedByUsername	string Username of the user who updated the record (when available)
	object (userInfo) User Display Information

Responses

Request samples

Payload

Content type

application/json

{"id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
"name": "Important Note"
}

Response samples

201
401
422

Content type

application/json

{"id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
"name": "Important Note"
}

getNoteType

Retrieve note type with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
"name": "Important Note"
}

updateNoteType

Update note type with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Request Body schema: application/json

Note type object

id

string <uuid> (uuid)

name

required

string <= 255 characters

The unique name of this type

object (Metadata)

Metadata about creation and changes to records

createdDate required	string <date-time> Date and time when the record was created
createdByUserId	string <uuid> (uuid)
createdByUsername	string Username of the user who created the record (when available)
	object (userInfo) User Display Information
updatedDate	string <date-time> Date and time when the record was last updated
updatedByUserId	string <uuid> (uuid)
updatedByUsername	string Username of the user who updated the record (when available)
	object (userInfo) User Display Information

Responses

Request samples

Payload

Content type

application/json

{"id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
"name": "Important Note"
}

Response samples

401
404

Content type

text/plain

unable to perform action -- unauthorized

deleteNoteType

Delete note type with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Responses

Response samples

401
404

Content type

text/plain

unable to perform action -- unauthorized

notes

getNoteCollection

Return a list of notes

query Parameters

query	string Default: "cql.allRecords=1" A query expressed as a CQL string, for details see Notes API
offset	integer [ 0 .. 2147483647 ] Default: 0 Skip over a number of elements by specifying an offset value for the query
limit	integer [ 1 .. 2147483647 ] Default: 1000 Limit the number of elements returned in the response

Responses

Response samples

200
401
422

Content type

application/json

{"notes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}
],
"totalRecords": 0
}

createNote

Create a new note.

Request Body schema: application/json

Note object

id

string <uuid> (uuid)

typeId

required

string <uuid> (uuid)

type

string

Type of note (configured in settings)

title

required

string

Note title

domain

required

string

Domain associated with this note

content

string

Content of the note

popUpOnCheckOut

boolean

Flag that specify need of pop-up on check-out app

popUpOnUser

boolean

Flag that specify need of pop-up on users app

Array of objects (Note link)

Collection of links to associated objects

Array

id required	string Id of object linked to note
type required	string Type of object linked to note

object (Metadata)

Metadata about creation and changes to records

createdDate required	string <date-time> Date and time when the record was created
createdByUserId	string <uuid> (uuid)
createdByUsername	string Username of the user who created the record (when available)
	object (userInfo) User Display Information
updatedDate	string <date-time> Date and time when the record was last updated
updatedByUserId	string <uuid> (uuid)
updatedByUsername	string Username of the user who updated the record (when available)
	object (userInfo) User Display Information

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

Response samples

201
401
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

getNote

Retrieve note with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

updateNote

Update note with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Request Body schema: application/json

Note object

id

string <uuid> (uuid)

typeId

required

string <uuid> (uuid)

type

string

Type of note (configured in settings)

title

required

string

Note title

domain

required

string

Domain associated with this note

content

string

Content of the note

popUpOnCheckOut

boolean

Flag that specify need of pop-up on check-out app

popUpOnUser

boolean

Flag that specify need of pop-up on users app

Array of objects (Note link)

Collection of links to associated objects

Array

id required	string Id of object linked to note
type required	string Type of object linked to note

object (Metadata)

Metadata about creation and changes to records

createdDate required	string <date-time> Date and time when the record was created
createdByUserId	string <uuid> (uuid)
createdByUsername	string Username of the user who created the record (when available)
	object (userInfo) User Display Information
updatedDate	string <date-time> Date and time when the record was last updated
updatedByUserId	string <uuid> (uuid)
updatedByUsername	string Username of the user who updated the record (when available)
	object (userInfo) User Display Information

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

Response samples

401
404

Content type

text/plain

unable to perform action -- unauthorized

deleteNote

Delete note with given ID

path Parameters

id

required

string <uuid> (uuid)

The UUID of a resource

Responses

Response samples

401
404

Content type

text/plain

unable to perform action -- unauthorized

updateLinks

Add or delete links to specified list of notes

path Parameters

objectType required	string The type of link's object
objectId required	string The ID of link's object

Request Body schema: application/json

Collection of note links

required

Array of objects (noteLinkUpdate)

Array

id required	string <uuid> (uuid)
status required	string (linkStatus) Enum: "ASSIGNED" "UNASSIGNED"

Responses

Request samples

Payload

Content type

application/json

{"notes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "ASSIGNED"
}
]
}

Response samples

401
404

Content type

text/plain

unable to perform action -- unauthorized

getNoteCollectionByLink

Return a list of notes by status. A maximum of 1000 notes can be returned per request.

path Parameters

domain required	string The domain of note
objectType required	string The type of link's object
objectId required	string The ID of link's object

query Parameters

search	string Partial match case-insensitive search term for note title and note content
noteType	Array of strings Search string for note type. Note(s) is returned only if it equals to specified word or sequence of words in the titleseparated by com type name. Multiple types should be declared with query parameter sequentially as follows "noteType=a&noteType=b".
status	string (linkStatusFilter) Default: "all" Enum: "assigned" "unassigned" "all" Filtering records by status. Possible values are ASSIGNED, UNASSIGNED, ALL.
orderBy	string (notesOrderBy) Enum: "title" "content" "noteType" "updatedDate" Field by which notes are ordered. Possible values are title, content, noteType, updatedDate. The default ascending sorting is applied for title, content, noteType parameters. For updatedDate is descending.
order	string (orderDirection) Enum: "asc" "desc" Indicates order of notes. Possible values asc, desc.
offset	integer [ 0 .. 2147483647 ] Default: 0 Skip over a number of elements by specifying an offset value for the query
limit	integer [ 1 .. 2147483647 ] Default: 1000 Limit the number of elements returned in the response

Responses

Response samples

200
401
422

Content type

application/json

{"notes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
"type": "string",
"title": "string",
"domain": "string",
"content": "string",
"popUpOnCheckOut": true,
"popUpOnUser": true,
"links": [{"id": "1234-5678",
"type": "package"
}
],
"metadata": {"createdDate": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUsername": "string",
"createdBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
},
"updatedDate": "2019-08-24T14:15:22Z",
"updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",
"updatedByUsername": "string",
"updatedBy": {"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}
],
"totalRecords": 0
}