REST interface for BPEL-related process resources - Process instance operation list Resource - GET Method

Use this method to retrieve operations associated with a specified process instance.

Sample method invocation

GET /rest/bpm/bfm/v1/process/{piid}/operationTemplates?type={string}

Parameters

Required Parameters

Name

Value Type

Description

type

string

Type of operations associated with the process instance.

Value	Description
waiting	Operations associated with waiting activities.

Request Content

None

Response Content

List of operations.

The default content-type is application/json.

MIME Type: application/json

Schema

{ "description": "Process Operation List", 
  "type": "object",
  "properties":
   {  "identifier": {"type": "string"}, 
      "items": 
      [
         {  "activityDescription": {"type": "string", "optional": true,
               "description": "Description of the associated activity."
            },
            "activityDisplayName": {"type": "string", "optional": true,
               "description": "Display name of the associated activity."
            },
            "activityName": {"type": "string", "optional": true,
               "description": "Name of the associated activity."
            },
            "inputType": {"type": "string", 
               "description": "Name of the input message type. The value has the format {namespace}localname."
            },
            "isTwoWayOperation": {"type": "boolean", "optional": true,
               "description": "States whether the operation is a request-response operation."
            },
            "operationName": {"type": "string",
               "description": "Name of the operation."
            },
            "partnerLinkName": {"type": "string",
               "description": "Name of the partner link."
            },
            "portType": {"type": "string", 
               "description": "Name of the port type. The value has the format {namespace}localname."
            },
            "processTemplateID": {"type": "string",
               "description": "ID of the process template this activity is part of."
            },
            "processTemplateName": {"type": "string",
               "description": "Name of the process template this activity is part of."
            },
            "taskTemplateID": {"type": "string", 
               "description": "ID of the associated task template. This is the ID of an invocation task template for incoming requests."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "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."
      }
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
404 Not Found	The process instance 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.

Available since

6.2

Parent topic: Process instance operation list Resource