v1

latestOpenAPI 3.0.1Apache 2.02026-07-1424096195.5 KB
Notes

Retrieve Note by ID

Returns a single note corresponding to provided uniqueId

get/v3/notes/{uniqueId}

Path parameters

uniqueId'1' | '2' | '3' required

param ID of the Note that needs to be fetched

ID of the Note to be fetched

Query parameters

fieldsstring[]

Note subentity fields to include in response (See OPTIONS endpoint for valid values)

countstring

Boolean that detnotes whether counts should be returned in the resultset

Response

The note

idinteger
caseIdinteger required
caseXidstring required
textstring required
summarystring
authorstring
dateAddedstring date-time
lastModifiedstring date-time
editedboolean
taskIdinteger
taskXidstring
artifactIdinteger
workflowEventIdinteger