Execute process

Executes a process in the specified mode (synchronous or asynchronous).

This topic includes the following sections:

Request

HTTP method: POST

URL: https://<hostname>:<port>/baocdp/rest/process/<process_name>/execute

In the URL <process_name> represents the process to execute.

Header: See HTTP request and response headers for header information, such as required authentication token.

Request parameters

Request body properties

Example request JSON

{
    "inputParameters": [
        {
            "name": "adapter name",
            "value": "HTTP Adapter"
        },
        {
            "name": "url",
            "value": "http://www.google.com"
        }
    ]
}

Example request JSON with input as XML with double quotes in the value

{
  "inputParameters":
   [
       {
            "name": "param1",
            "value": "p1"
        },
       {
            "name": "param2",
            "value": "<parent><child>Text data containing \" - double-quotes</child></parent>",
            "type": "xml"
        }
       {
            "name": "param3",
            "value": "<parent><child attr1=\"aValue\">XML node has an attribute and text data containing \" - double-quotes</child></parent>",
            "type": "xml"
        }
   ]
}

Example request JSON with input as string with double quotes

{
   "inputParameters":[  
      {  
         "name":"param1",
         "value":"p1"
      },
      {  
         "name":"param2",
         "value":"String with \"- double-quotes"
      }]
}

Example request JSON with input parameter type is XML with attributes and/or text containing double-quotes

{
  "inputParameters": [
    {
      "name": "param1",
      "value": "p1"
    },
    {
      "name": "param2",
      "value": "Text data containing \" - double-quotes",
      "type": "xml"
    },
    {
      "name": "param3",
      "value": "&lt;node1&gt;has \" double quotes&lt;/node1&gt;</node1>",
      "type": "xml"
    }
  ]
}

Response

If successful, this method executes the specified process in the specified mode.

Response body properties

Example response JSON

{
   processName: ":AutoPilot-AD-Utilities:HTTP:Get"
   jobId: "d0f120d29f779a9a:7e39082a:14c80109a76:-7ff81-1428327672246"
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

Video demonstration

The following BMC Communities video (7:30) is part one of a two-part series on using REST to execute workflows. This video demonstrates how to log into an API server, generate an authentication code, and use the code to get process details, execute a workflow (process), retrieve a list of active modules, and get a job's status.

 https://youtu.be/eOzND0JfrHc

The second part of the video demonstrates how to use the HTTP adapter to perform the same tasks and is available here and in the  Content online documentation for the HTTP adapter example section.

Related topics

Execute process synchronously example

Execute process asynchronously example

HTTP request and response headers

Format of API examples