v1

latestOpenAPI 3.0.1Apache 2.02026-07-1424096195.5 KB
Tasks

Update Task by ID

Allows the updating of an existing Task

put/v3/tasks/{uniqueId}

Path parameters

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

param ID of the Task that needs to be updated

ID of the Task to be updated

Query parameters

fieldsstring[]

Task 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
xidstring
namestring required
descriptionstring
configTaskJsonNode
configPlaybookstring
workflowPhaseinteger
workflowStepinteger
dueDatestring date-time
requiredboolean
dependentOnIdinteger
statusstring
completedBystring
completedDatestring date-time
durationinteger
durationTypestring
ownerstring

Response

The updated Task

idinteger
caseIdinteger required
caseXidstring required
xidstring
namestring required
descriptionstring
configTaskJsonNode
configPlaybookstring
workflowPhaseinteger
workflowStepinteger
dueDatestring date-time
requiredboolean
dependentOnIdinteger
statusstring
completedBystring
completedDatestring date-time
durationinteger
durationTypestring
ownerstring