Previous Next

Perform an Action on Tasks

put
/tasks
Performs an action on a set of tasks defined by their IDs.

The following tables summarize the client request.

Supported Media Types
  • application/json
  • application/xml
Body Parameter
Body parameters are tasks, action, comment, identities. Parameters of tasks are taskid entries. Parameter of action is id, which can be set to ESCALATE, ACQUIRE, RELEASE, WITHDRAW, SUSPEND, RESUME, DELETE, PURGE, RENEW, or a custom action. Parameters of comment are commentStr and commentScope. Parameters of identities are id and type.
Example application/json

{
    "tasks":[
        "200041",
        "200042"
    ],
    "action":{
        "id":"REASSIGN"
    },
    "comment":{
        "commentStr":"BulkReassign",
        "commentScope":"TASK"
    },
    "identities":[
        {
            "id":"jlondon",
            "type":"user"
        },
        {
            "id":"cdickens",
            "type":"user"
        }
    ]
}

The following tables summarize the server response.

Supported Media Types
  • application/json
  • application/xml

200 Response

Performs the action and displays the result.
Body
Example application/json

{
    "totalResult":false,
    "user":{
        "rel":"user",
        "href":"http://example.com/bpm/api/3.0/identities/user/jlondon"
    },
    "hasMore":false,
    "items":[
        {
            "type":"task",
            "rel":"self",
            "title":"myTodoTaskTestingV3",
            "href":"http://example.com/bpm/api/3.0/tasks/200042",
            "hasSubTasks":false
        }
    ]
}