Update WorkflowEvent by ID
PUT {{baseUrl}}/api/v3/workflowEvents/:uniqueId?fields=<string>&fields=<string>&createActivityLog=
Allows the updating of an existing WorkflowEvent
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | WorkflowEvent subentity fields to include in response (See OPTIONS endpoint for valid values) | |
fields | string | WorkflowEvent subentity fields to include in response (See OPTIONS endpoint for valid values) | |
createActivityLog | null | Boolean to signal whether or not to create an alert for this action |
Request Body
{"caseId"=>"<long>", "caseXid"=>"<string>", "summary"=>"<string>", "dateAdded"=>"<dateTime>", "deleted"=>"<boolean>", "deletedReason"=>"<string>", "eventDate"=>"<dateTime>", "id"=>"<long>", "link"=>"<string>", "linkText"=>"<string>", "notes"=>{"count"=>"<integer>", "count_type"=>"<string>", "data"=>[{"caseId"=>"<long>", "caseXid"=>"<string>", "text"=>"<string>", "artifactId"=>"<long>", "author"=>"<string>", "dateAdded"=>"<dateTime>", "edited"=>"<boolean>", "id"=>"<long>", "lastModified"=>"<dateTime>", "summary"=>"<string>", "taskId"=>"<long>", "taskXid"=>"<string>", "workflowEventId"=>"<long>"}, {"caseId"=>"<long>", "caseXid"=>"<string>", "text"=>"<string>", "artifactId"=>"<long>", "author"=>"<string>", "dateAdded"=>"<dateTime>", "edited"=>"<boolean>", "id"=>"<long>", "lastModified"=>"<dateTime>", "summary"=>"<string>", "taskId"=>"<long>", "taskXid"=>"<string>", "workflowEventId"=>"<long>"}], "mode"=>"<string>", "next"=>"<string>", "prev"=>"<string>"}, "systemGenerated"=>"<boolean>", "user"=>{"customTqlTimeout"=>"<long>", "disabled"=>"<boolean>", "firstName"=>"<string>", "id"=>"<long>", "jobFunction"=>"<string>", "jobRole"=>"<string>", "lastLogin"=>"<dateTime>", "lastName"=>"<string>", "lastPasswordChange"=>"<dateTime>", "locked"=>"<boolean>", "logoutIntervalMinutes"=>"<integer>", "owner"=>"<string>", "ownerRoles"=>{"occaecat56"=>"<string>", "ut1e"=>"<string>", "elit40"=>"<string>", "commodo_e79"=>"<string>"}, "password"=>"<string>", "passwordResetRequired"=>"<boolean>", "pseudonym"=>"<string>", "systemRole"=>"<string>", "termsAccepted"=>"<boolean>", "termsAcceptedDate"=>"<dateTime>", "tqlTimeout"=>"<long>", "twoFactorResetRequired"=>"<boolean>", "uiTheme"=>"<string>", "userName"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"caseId":"\u003clong\u003e","caseXid":"\u003cstring\u003e","summary":"\u003cstring\u003e","dateAdded":"\u003cdateTime\u003e","deleted":"\u003cboolean\u003e","deletedReason":"\u003cstring\u003e","eventDate":"\u003cdateTime\u003e","id":"\u003clong\u003e","link":"\u003cstring\u003e","linkText":"\u003cstring\u003e","notes":{"count":"\u003cinteger\u003e","count_type":"\u003cstring\u003e","data":[{"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"}],"mode":"\u003cstring\u003e","next":"\u003cstring\u003e","prev":"\u003cstring\u003e"},"systemGenerated":"\u003cboolean\u003e","user":{"customTqlTimeout":"\u003clong\u003e","disabled":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","id":"\u003clong\u003e","jobFunction":"\u003cstring\u003e","jobRole":"\u003cstring\u003e","lastLogin":"\u003cdateTime\u003e","lastName":"\u003cstring\u003e","lastPasswordChange":"\u003cdateTime\u003e","locked":"\u003cboolean\u003e","logoutIntervalMinutes":"\u003cinteger\u003e","owner":"\u003cstring\u003e","ownerRoles":{"occaecat56":"\u003cstring\u003e","ut1e":"\u003cstring\u003e","elit40":"\u003cstring\u003e","commodo_e79":"\u003cstring\u003e"},"password":"\u003cstring\u003e","passwordResetRequired":"\u003cboolean\u003e","pseudonym":"\u003cstring\u003e","systemRole":"\u003cstring\u003e","termsAccepted":"\u003cboolean\u003e","termsAcceptedDate":"\u003cdateTime\u003e","tqlTimeout":"\u003clong\u003e","twoFactorResetRequired":"\u003cboolean\u003e","uiTheme":"\u003cstring\u003e","userName":"\u003cstring\u003e"}}