pp108 : PerformTaskAction

PerformTaskAction


This method is used to perform an action on the task.

SOAP Request

<PerformTaskAction xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <TaskId>{7F806D59-D288-4C4D-975F-52B7BF42DBAC}</TaskId>
    <Action>START</Action>
    <Memo>Sample Memo</Memo>
    <Data/>
</PerformTaskAction>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

TaskId

Unique identifier of the Task

Action

Contains the action that can be performed on the task.

The following are the list of actions:

  • START
  • STOP
  • PAUSE
  • RESUME
  • SUSPEND
  • REVOKECLAIM
  • COMPLETE
  • SKIP

Data

Contains the data that will be sent as output to the next action state.

Memo

Memo that has to be sent

The actual content in the memo.

SOAP Response

<PerformTaskActionResponse xmlns="http://schemas.cordys.com/notification/workflow/1.0">
    <State>INPROGRESS</State>
    <LastModified>2011-05-06T06:41:51.55</LastModified>
    <PageFlowTaskId>001CC438-8F47-11E2-FB19-B3FE4C217F9E</PageFlowTaskId>
    <PossibleActions>
        <STOP/>
        <COMPLETE/>
        <PAUSE/>
        <SKIP/>
        <SUSPEND/>
        <DELEGATE/>
        <FORWARD/>
        <TRANSFER/>
        <REVOKECLAIM/>
        <EXECUTE/>
        <VIEW/>
    </PossibleActions>
</PerformTaskActionResponse>

Response Parameters

Parameter

Description

State

Contains the current state of the task.
LastModified Last Modified date and time of that task.

PageFlowTaskId (optional field)

 Contains the page flow task ID. This element is displayed only if only for the page flow tasks.

PossibleActions

Contains the list of actions that are possible for the task. The list is populated based on the state of the task.For example,

  • If the task is in InProgress state - The STOP, REVOKECLAIM, COMPLETE, PAUSE, DELEGATE*, SKIP, FORWARD, TRANSFER, VIEW, EXECUTE, and SUSPEND actions can be performed.
  • If the task is in Created state - Only the ASSIGN and SKIP actions can be performed.
  • If the task is in Assigned state - Only the START, REVOKECLAIM, COMPLETE, SKIP, and SUSPEND actions can be performed.

    *A task can be delegated to only one person at a time. So once a task is delegated, the DELEGATE action will be disabled until the delegation is revoked either by the owner of the task or the delegatee himself. So performing REVOKECLAIM on a delegated task revokes the delegation first (also enables the DELEGATE action). The REVOKECLAIM of task ownership will happen only when the action is performed again (which means the REVOKECLAIM action should be performed twice to revoke the claim on a delegated task). Similarly the REVOKECLAIM action will be enabled for the delegatee implying that he can revoke on the delegation(not that he has manager permissions and that he can revoke the task ownership).