Executes new generic process request(s) for resource(s)

Request

POST https://{hostname}:{port}
    /cli/processRequest
Accept: {contentType}

Table 1. Header parameters
Parameter	Type	Required	Description
Accept	`application/json` `application/yaml`	true

This command takes a JSON request string or file. Use the following template for the request:

{
  "processId": "ID of generic process",
  "processVersion": "(Optional) Version number of the 
  process to run against. -1 (default) represents latest 
  version",
  "properties": {"Property name": "Property value 
  (Optional)"},
  "resource": "Deprecated, use 'resources'(ID or path of 
  resource to run the process against)",
  "resources": ["Comma-separated list of IDs or paths of 
  resources to run the process against. 'resource' parameter 
  would be ignored if this is present"]
}

Example request with default version

{
    "processId" : "1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "resources" : ["1710e095-edff-9d34-831e-33ed5da7a078"]
}

Example request with specific version

{
    "processId" : "1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "processVersion" : "2",
    "resources" : ["1710e095-edff-9d34-831e-33ed5da7a078"]
}

Example request with multiple resources

{
    "processId" : "1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "resources" : [
        "1710e095-edff-9d34-831e-33ed5da7a078", 
        "170208fb-7464-4133-44c2-0587986fe1b6"
    ]
}

Example request with properties

{
    "processId" : "1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "resources" : ["1710e095-edff-9d34-831e-33ed5da7a078"],
    "properties": {
        "prop" : "This is an example of properties."
    }
}

Example response

[{
  "id": "1710e3a8-b52f-02e3-d5ed-421c17f24af2",
  "submittedTime": 1585081649980,
  "userName": "admin",
  "processPath": "processes\/1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
  "processVersion": 4
}]

Example response

[{
  "id": "1710e506-b23a-ab88-7634-563464e20ef0",
  "submittedTime": 1585083083529,
  "userName": "admin",
  "processPath": "processes\/1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
  "processVersion": 2
}]

Example response

[
  {
    "id": "1710e526-9d32-1fc1-299f-f7562b3b33f3",
    "submittedTime": 1585083214272,
    "userName": "admin",
    "processPath": "processes\/1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "processVersion": 4
  },
  {
    "id": "1710e526-9ee8-a8f1-676c-dbb25d9885a2",
    "submittedTime": 1585083214274,
    "userName": "admin",
    "processPath": "processes\/1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "processVersion": 4
  }
]

Example response

[{
  "id": "1710e560-809e-477f-d5ef-d260dbf4578c",
  "submittedTime": 1585083451381,
  "userName": "admin",
  "processPath": "processes\/1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
  "processVersion": 4
}]

Related CLI command: requestProcess.