WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Process Template Operation List Resource - GET Method

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

Resource URI

GET /v1/processTemplate/{ptid}/operationTemplates?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
type string
Type of operations associated with the process template.
ValueDescription
start
Operations associated with start activities.

Request Content

None.

Response Content

List of operations.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ "description": "BFM 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


+ View Schema
{  "description": "BFM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text 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:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
404 Not Found
The process template does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Process Template Operation List Resource