Retrieve Notes
GET {{baseUrl}}/api/v3/notes?tql=&fields=<string>&fields=<string>&count=<string>&sorting=<string>
Returns a list of all notes
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
tql | null | TQL query string for filtering response list | |
fields | string | Note subentity fields to include in response (See OPTIONS endpoint for valid values) | |
fields | string | Note subentity fields to include in response (See OPTIONS endpoint for valid values) | |
count | string | Boolean that detnotes whether counts should be returned in the resultset | |
sorting | string | Sorting order for resultset |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"caseId":"\u003clong\u003e","caseXid":"\u003cstring\u003e","text":"\u003cstring\u003e","artifactId":"\u003clong\u003e","author":"\u003cstring\u003e","dateAdded":"\u003cdateTime\u003e","edited":"\u003cboolean\u003e","id":"\u003clong\u003e","lastModified":"\u003cdateTime\u003e","summary":"\u003cstring\u003e","taskId":"\u003clong\u003e","taskXid":"\u003cstring\u003e","workflowEventId":"\u003clong\u003e"},{"caseId":"\u003clong\u003e","caseXid":"\u003cstring\u003e","text":"\u003cstring\u003e","artifactId":"\u003clong\u003e","author":"\u003cstring\u003e","dateAdded":"\u003cdateTime\u003e","edited":"\u003cboolean\u003e","id":"\u003clong\u003e","lastModified":"\u003cdateTime\u003e","summary":"\u003cstring\u003e","taskId":"\u003clong\u003e","taskXid":"\u003cstring\u003e","workflowEventId":"\u003clong\u003e"}]