Perform an Action on Tasks

put

/tasks

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

• Request
• Response

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.

Root Schema : /paths/~1tasks/put/parameters/0/schema

Example application/json

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

Response

Supported Media Types

• application/json
• application/xml

200 Response

Performs the action and displays the result.

Body

Root Schema : /paths/~1tasks/put/responses/200/schema

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
        }
    ]
}