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

Use this method to retrieve available actions for escalations.

Sample method invocation

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

Parameters

Required Federation Parameter

Name	Value Type	Description
domain	string	Name of the domain containing the BPEL runtime systems that host the distributed resource (mutually exclusive with the systemID parameter).
systemID	string	ID of the BPEL runtime system hosting the resource (mutually exclusive with the domain parameter). If specified then this request is treated like any other request for a resource hosted by a single system, that is, the request and the response are just routed, and no pre/post-processing of parameters and results is performed by the federation layer.

Required Parameters

Name	Value Type	Description
taskIDs	string	Comma-separated list of IDs of escalations 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 escalation instances.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Escalation Actions", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "tasks": 
      [  
         {  "esiid": {"type": "string",
               "description": "Escalation instance ID."
            },
            "actions": {"type": ["string"],
               "description": "List of available actions for the escalation instance.",
               "enum":
               [  
                  "ACTION_CREATEWORKITEM",
                  "ACTION_DELETEWORKITEM",
                  "ACTION_GETCUSTOMPROPERTY",
                  "ACTION_GETDOCUMENTATION",
                  "ACTION_GETESCALATION",
                  "ACTION_GETESCALATIONTEMPLATE",
                  "ACTION_GETROLEINFO",
                  "ACTION_SETCUSTOMPROPERTY",
                  "ACTION_TRANSFERWORKITEM",
                  "ACTION_TRIGGERESCALATION",
                  "ACTION_UPDATE"   
               ]
            }
         }
      ]
   }   
}

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.
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.1

Parent topic: Escalation Actions Resource