Get Workflow By Id

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

Workflow name

string
description
Required

Workflow description

string
id
Required

Workflow id

array of o11n-workflowParameter
inputParameters
Optional

Workflow input parameters

array of o11n-workflowParameter
outputParameters
Optional

Workflow output parameters


404

'Not found' if no workflow with provided workflowId in current tenant

Operation doesn't return any data structure

On This Page
Get Operations
GET
Get Workflow By Id
GET
Get Workflow Category
GET
Get Worklfows Root Category