Create WorkflowEvent

POST {{baseUrl}}/api/v3/workflowEvents?fields=<string>&fields=<string>&createActivityLog=

Allows the creation of a new WorkflowEvent

Request Params

KeyDatatypeRequiredDescription
fieldsstringWorkflowEvent subentity fields to include in response (See OPTIONS endpoint for valid values)
fieldsstringWorkflowEvent subentity fields to include in response (See OPTIONS endpoint for valid values)
createActivityLognullBoolean 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

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;caseId&quot;:&quot;\u003clong\u003e&quot;,&quot;caseXid&quot;:&quot;\u003cstring\u003e&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;dateAdded&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;deleted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;deletedReason&quot;:&quot;\u003cstring\u003e&quot;,&quot;eventDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;link&quot;:&quot;\u003cstring\u003e&quot;,&quot;linkText&quot;:&quot;\u003cstring\u003e&quot;,&quot;notes&quot;:{&quot;count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;count_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:[{&quot;caseId&quot;:&quot;\u003clong\u003e&quot;,&quot;caseXid&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:&quot;\u003cstring\u003e&quot;,&quot;artifactId&quot;:&quot;\u003clong\u003e&quot;,&quot;author&quot;:&quot;\u003cstring\u003e&quot;,&quot;dateAdded&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;edited&quot;:&quot;\u003cboolean\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;lastModified&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;taskId&quot;:&quot;\u003clong\u003e&quot;,&quot;taskXid&quot;:&quot;\u003cstring\u003e&quot;,&quot;workflowEventId&quot;:&quot;\u003clong\u003e&quot;},{&quot;caseId&quot;:&quot;\u003clong\u003e&quot;,&quot;caseXid&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:&quot;\u003cstring\u003e&quot;,&quot;artifactId&quot;:&quot;\u003clong\u003e&quot;,&quot;author&quot;:&quot;\u003cstring\u003e&quot;,&quot;dateAdded&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;edited&quot;:&quot;\u003cboolean\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;lastModified&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;summary&quot;:&quot;\u003cstring\u003e&quot;,&quot;taskId&quot;:&quot;\u003clong\u003e&quot;,&quot;taskXid&quot;:&quot;\u003cstring\u003e&quot;,&quot;workflowEventId&quot;:&quot;\u003clong\u003e&quot;}],&quot;mode&quot;:&quot;\u003cstring\u003e&quot;,&quot;next&quot;:&quot;\u003cstring\u003e&quot;,&quot;prev&quot;:&quot;\u003cstring\u003e&quot;},&quot;systemGenerated&quot;:&quot;\u003cboolean\u003e&quot;,&quot;user&quot;:{&quot;customTqlTimeout&quot;:&quot;\u003clong\u003e&quot;,&quot;disabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;jobFunction&quot;:&quot;\u003cstring\u003e&quot;,&quot;jobRole&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastLogin&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastPasswordChange&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;locked&quot;:&quot;\u003cboolean\u003e&quot;,&quot;logoutIntervalMinutes&quot;:&quot;\u003cinteger\u003e&quot;,&quot;owner&quot;:&quot;\u003cstring\u003e&quot;,&quot;ownerRoles&quot;:{&quot;occaecat56&quot;:&quot;\u003cstring\u003e&quot;,&quot;ut1e&quot;:&quot;\u003cstring\u003e&quot;,&quot;elit40&quot;:&quot;\u003cstring\u003e&quot;,&quot;commodo_e79&quot;:&quot;\u003cstring\u003e&quot;},&quot;password&quot;:&quot;\u003cstring\u003e&quot;,&quot;passwordResetRequired&quot;:&quot;\u003cboolean\u003e&quot;,&quot;pseudonym&quot;:&quot;\u003cstring\u003e&quot;,&quot;systemRole&quot;:&quot;\u003cstring\u003e&quot;,&quot;termsAccepted&quot;:&quot;\u003cboolean\u003e&quot;,&quot;termsAcceptedDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;tqlTimeout&quot;:&quot;\u003clong\u003e&quot;,&quot;twoFactorResetRequired&quot;:&quot;\u003cboolean\u003e&quot;,&quot;uiTheme&quot;:&quot;\u003cstring\u003e&quot;,&quot;userName&quot;:&quot;\u003cstring\u003e&quot;}}