REST API - getStarterOperationInfo

The table summarizes the REST API - getStarterOperationInfo.

Request

Format 
GET <baseurl>/process/starteroperation/info/<module>/<process>/<version>/<operation>
Path parameters
  • module: Name of the module to which the process template belongs.
  • process: Name of the process template whose starter operation details are to be returned.
  • version: OSGi-style version number of the process template. (This version number is the same as that of the module.)

    The previous three parameters can be obtained using listProcessTemplates, queryProcessTemplates, and queryProcessTemplatesAlt.

  • operation: Name of the starter operation. Can be obtained from listStarterOperations.

Response

JSON Returns a JSON representation of the content of the operationInfoelement.
XML Returns the content of the operationInfoelement (from the ProcessManagementschema).

Example

Request 
GET <baseurl>/process/starteroperation/info/%2FWelcomeUsersImplementSolution%2FProcess%20Packages%2FProcessPackage.xpdl/WelcomeUsers/1.0.0.201301301125/StartEvent
Response 
{
  "xml-fragment": {
    "proc:operationName": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "#text": "StartEvent"
    },
    "proc:parameters": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "proc:templateAttribute": [
        {
          "proc:name": "PhoneNumber",
          "proc:type": "java.lang.String"
        },
        {
          "proc:name": "UserName",
          "proc:type": "java.lang.String"
        }
      ]
    }
  }
}