v1

latestOpenAPI 3.0.1Apache 2.02026-07-1424096195.5 KB
Notes

Update Note by ID

Allows the updating of an existing note

put/v3/notes/{uniqueId}

Path parameters

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

param ID of the Note that needs to be updated

ID of the Note to be updated

Query parameters

fieldsstring[]

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

createActivityLogstring

Boolean to signal whether or not to create an alert for this action

Request body

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

Response

The updated note

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