Get Workflow By Id
Get workflow by given workflowId from the vRO configured for the current tenant.
Request
URI
GET
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
Responses
200
'Success' with the workflow
Returns
o11n-workflow
of type(s)
*/*
{
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"outputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
}
string
name
Required
Constraints:
minLength: 0
maxLength: 255
Workflow name
string
description
Required
Constraints:
minLength: 0
maxLength: 2000
Workflow description
string
id
Required
Constraints:
minLength: 0
maxLength: 255
Workflow id
array of
object
inputParameters
Optional
Workflow input parameters
array of
object
outputParameters
Optional
Workflow output parameters
404
'Not found' if no workflow with provided workflowId in current tenant
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/o11n-gateway-service/api/tenants/{tenantId}/workflows/{workflowId}