Run Workflow

Run Workflow

Request workflow, by given workflowId, to run by the vRO configured for the current tenant.

Request
URI
POST
https://{api_host}/o11n-gateway-service/api/tenants/{tenantId}/workflows/{workflowId}
COPY
Path Parameters
string
tenantId
Required

the tenant id

string
workflowId
Required

the workflow id

Request Body
routineRunRequest of type(s) application/json
Required 
{
    "requestedBy": "string",
    "correlation": {
        "correlationType": "string",
        "correlationId": "string"
    },
    "routineRunId": "string",
    "description": "string",
    "callbackServiceId": "string",
    "requestHeader": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "requestData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    }
}
string
requestedBy
Optional

name/id of the user requested the routine run

routineRunCorrelation
correlation
Optional

correlation

string
routineRunId
Optional

optional parameter which sets the id of the routine run once created. may be disregarded

string
description
Optional

human readable description for the routine run request

string
callbackServiceId
Optional

service id to callback on routine run complete/fail

literalMap
requestHeader
Optional

requestHeader

literalMap
requestData
Optional

requestData

Responses
201

'Success' with the run request id

Operation doesn't return any data structure

On This Page
Run Operations
POST
Run Workflow