Get Workflow

1min
GET
This endpoint is for retrieving an Execution Workflow.
   
Path Parameters
workflowId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
version
string
Responses
200
OK - The request succeeded.
WorkflowResult
error
Error
request
Request
data
Workflow
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/workflow-service/workflows/{workflowId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{base_url}/core/api/v1/workflow-service/workflows/{workflowId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "tenantId": "",
    "id": "",
    "name": "",
    "description": "",
    "tag": [
      {
        "name": "",
        "value": ""
      }
    ],
    "flows": [
      {
        "next": [
          {
            "condition": {
              "": ""
            },
            "task": ""
          }
        ],
        "description": "",
        "id": "",
        "name": "",
        "inputs": {}
      }
    ],
    "createdAt": "",
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedAt": "",
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "version": 0,
    "canMerge": false,
    "meta": "",
    "status": ""
  }
}
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "tenantId": "",
    "id": "",
    "name": "",
    "description": "",
    "tag": [
      {
        "name": "",
        "value": ""
      }
    ],
    "flows": [
      {
        "next": [
          {
            "condition": {
              "": ""
            },
            "task": ""
          }
        ],
        "description": "",
        "id": "",
        "name": "",
        "inputs": {}
      }
    ],
    "createdAt": "",
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedAt": "",
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "version": 0,
    "canMerge": false,
    "meta": "",
    "status": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Update Workflow