Workflow Run Get By Run Id
Retrieves the Workflow Run for the given run ID
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/vro/runs/{runId}
COPY
Path Parameters
string
runId
Required
runId
Responses
200
'Success' with found workflow run
Returns
WorkflowRun
of type(s)
*/*
{
"id": "string",
"name": "string",
"ownerId": "string",
"orgId": "string",
"createdOn": 0,
"modifiedOn": 0,
"configurationId": "string",
"runId": "string",
"workflowId": "string",
"runStatus": "string",
"errorMessage": "string",
"startedBy": "string",
"startedOn": 0,
"completedOn": 0,
"ebsEventId": "string",
"eventTraceEntryId": "string",
"ebsBlocking": false,
"workflowInputs": {
"workflowInputs": {}
},
"workflowOutputs": {
"workflowOutputs": {}
},
"logs": [
{
"severity": "string",
"shortDescription": "string",
"longDescription": "string",
"userName": "string",
"timestamp": "string",
"origin": "string",
"entry": {
"entry": "string"
}
}
],
"integrationId": "string",
"integrationName": "string",
"integrationSelfLink": "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
configurationId
Optional
configurationId
string
runId
Optional
runId
string
workflowId
Optional
workflowId
string
runStatus
Optional
runStatus
Possible values are :
CANCELED,
COMPLETED,
RUNNING,
SUSPENDED,
WAITING,
STATE_WAITING_ON_SIGNAL,
FAILED,
RUN_NOT_FOUND,
WORKFLOW_NOT_FOUND,
WORKFLOW_NOT_STARTED,
INITIALIZING,
UNKNOWN,
string
errorMessage
Optional
errorMessage
string
startedBy
Optional
startedBy
integer As int64
As int64
startedOn
Optional
startedOn
integer As int64
As int64
completedOn
Optional
completedOn
string
ebsEventId
Optional
ebsEventId
string
eventTraceEntryId
Optional
eventTraceEntryId
boolean
ebsBlocking
Optional
ebsBlocking
object
workflowInputs
Optional
workflowInputs
object
workflowOutputs
Optional
workflowOutputs
array of
object
logs
Optional
logs
string
integrationId
Optional
integrationId
string
integrationName
Optional
integrationName
string
integrationSelfLink
Optional
integrationSelfLink
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
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
Workflow Run with this runId could not be found
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/runs/{runId}