REST interface for federated IBM BPM resources - Task Actions Resource - GET Method

Retrieve available actions for human tasks.

Sample method invocation

GET /rest/bpm/federated/htm/v1/task/actions[?domain={string}]&taskIDs={string}[&actions={string}]

Parameters

Optional Federation Parameter

Name	Value Type	Description
domain	string	Name of the domain containing the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) systems that host the distributed resource.

Required Parameters

Name	Value Type	Description
taskIDs	string	Comma-separated list of ID pairs systemID$taskID (systemID and taskID separated by a '$') for which available actions should be returned.

Optional Parameters

Name	Value Type	Description
actions	string	Comma-separated list of actions the caller is interested in, used as a filter for the response. If not specified then information about all possible actions is returned. See the task actions response description below for a list of possible values.

Request Content

None

Response Content

List of actions that can be performed on task instances.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Actions", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system." 
            },
            "errorNumber": {"type": "string", "optional": true,
               "description":"Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description":"Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description":"Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description":"Additional, exception details, for example, a stack trace."
            }
         }
      ],
      "tasks": 
      [  
         {  "systemID": {"type": "string",
               "description": "System ID of the system hosting the task."
            },
            "tkiid": {"type": "string",
               "description": "Task instance ID."
            },
            "actions": {"type": ["string"],
               "description": "List of available actions for the task instance.",
               "enum":
               [  
                  "ACTION_CALLTASK",
                  "ACTION_CANCELCLAIM", 
                  "ACTION_CLAIM", 
                  "ACTION_COMPLETE",
                  "ACTION_COMPLETEWITHFOLLOWONTASK",
                  "ACTION_CREATEFAULTMESSAGE", 
                  "ACTION_CREATEINPUTMESSAGE", 
                  "ACTION_CREATEMESSAGE", 
                  "ACTION_CREATEOUTPUTMESSAGE", 
                  "ACTION_CREATEWORKITEM", 
                  "ACTION_DELETE", 
                  "ACTION_DELETEWORKITEM", 
                  "ACTION_GETCUSTOMPROPERTY", 
                  "ACTION_GETDOCUMENTATION", 
                  "ACTION_GETFAULTMESSAGE", 
                  "ACTION_GETFAULTNAMES", 
                  "ACTION_GETINPUTMESSAGE", 
                  "ACTION_GETOUTPUTMESSAGE", 
                  "ACTION_GETROLEINFO", 
                  "ACTION_GETTASK", 
                  "ACTION_GETUISETTINGS", 
                  "ACTION_RESTARTTASK", 
                  "ACTION_RESUME", 
                  "ACTION_SETCUSTOMPROPERTY", 
                  "ACTION_SETFAULTMESSAGE", 
                  "ACTION_SETINPUTMESSAGE", 
                  "ACTION_SETOUTPUTMESSAGE", 
                  "ACTION_SETTASKREAD", 
                  "ACTION_STARTTASK", 
                  "ACTION_STARTTASKASSUBTASK", 
                  "ACTION_SUSPEND", 
                  "ACTION_SUSPENDWITHCANCELCLAIM", 
                  "ACTION_TERMINATE", 
                  "ACTION_TRANSFERTOWORKBASKET", 
                  "ACTION_TRANSFERWORKITEM", 
                  "ACTION_UPDATE", 
                  "ACTION_UPDATEINACTIVETASK"               
               ]
            }
         }
      ]
   }   
}

Error Response Content

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. The list of available actions is returned. list of available actions returned.
400 Bad Request	The parameters are not valid or they are missing.
404 Not Found	The resource does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

7.5

Parent topic: Task Actions Resource