Workflow Get One
Get a workflow definition
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/vro/workflows/{workflowId}
COPY
Path Parameters
string
workflowId
Required
workflowId
Query Parameters
string
endpointConfigurationLink
Optional
endpointConfigurationLink
boolean
expand
Optional
Constraints:
default: false
expand
Responses
200
'Success' with a single workflow definition
Returns
Workflow
of type(s)
*/*
{
"id": "string",
"name": "string",
"ownerId": "string",
"orgId": "string",
"createdOn": 0,
"modifiedOn": 0,
"description": "string",
"version": "string",
"href": "string",
"integration": {
"endpointConfigurationLink": "string",
"name": "string",
"endpointUri": "string"
},
"workflowId": "string",
"inputs": [
{
"name": "string",
"type": "string",
"description": "string",
"scope": "string"
}
],
"outputs": [
{
"name": "string",
"type": "string",
"description": "string",
"scope": "string"
}
],
"selfLink": "string"
}
string
id
Optional
id
string
name
Optional
name
string
ownerId
Optional
ownerId
string
orgId
Optional
orgId
integer As int64
As int64
createdOn
Optional
createdOn
integer As int64
As int64
modifiedOn
Optional
modifiedOn
string
description
Optional
description
string
version
Optional
version
string
href
Optional
href
object
integration
Optional
integration
string
workflowId
Optional
workflowId
array of
object
inputs
Optional
inputs
array of
object
outputs
Optional
outputs
string
selfLink
Optional
selfLink
202
Accepted
Returns
CertificateInfoServiceErrorResponse
of type(s)
*/*
"CertificateInfoServiceErrorResponse Object"
string
message
Optional
message
string
messageId
Optional
messageId
array of
string
stackTrace
Optional
stackTrace
integer As int32
As int32
statusCode
Optional
statusCode
integer As int32
As int32
errorCode
Optional
errorCode
array of
string
details
Optional
details
string
serverErrorId
Optional
serverErrorId
string
documentKind
Optional
documentKind
object
certificateInfo
Optional
certificateInfo
integer As int32
As int32
internalErrorCode
Optional
internalErrorCode
400
'Bad Request' when endpointLink not specified
Returns
ServiceErrorResponse
of type(s)
*/*
"ServiceErrorResponse Object"
string
message
Optional
message
integer As int32
As int32
messageId
Optional
messageId
array of
string
stackTrace
Optional
stackTrace
integer As int32
As int32
statusCode
Optional
statusCode
integer As int32
As int32
errorCode
Optional
errorCode
403
Forbidden
Returns
BriefServiceErrorResponse
of type(s)
*/*
"BriefServiceErrorResponse Object"
string
message
Optional
message
404
'Not Found' when workflow doesn't exist in target vRO
Returns
BriefServiceErrorResponse
of type(s)
*/*
"BriefServiceErrorResponse Object"
string
message
Optional
message
409
Conflict
Returns
BriefServiceErrorResponse
of type(s)
*/*
"BriefServiceErrorResponse Object"
string
message
Optional
message
417
Expectation Failed
Returns
BriefServiceErrorResponse
of type(s)
*/*
"BriefServiceErrorResponse Object"
string
message
Optional
message
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vro/workflows/{workflowId}