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": [
{
"value": {},
"key": "string"
}
]
},
"requestData": {
"entries": [
{
"value": {},
"key": "string"
}
]
}
}
string
requestedBy
Optional
name/id of the user requested the routine run
object
correlation
Optional
Represents a Routine run 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
object
requestHeader
Optional
Equivalent of java.util.Map
object
requestData
Optional
Equivalent of java.util.Map
Responses
201
'Success' with the run request id
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/o11n-gateway-service/api/tenants/{tenantId}/workflows/{workflowId}