Register Workflow

1min
POST
This endpoint is for creating a new Execution Workflow.
  
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
CreateWorkflowRequest
name
Name
*
description
Description
tag
Tag[]
flows
BaseFlow[]
*
inputs
BaseInput
*
conditions
BaseCondition
*
canMerge
boolean
*
meta
object
Responses
201
OK - The request succeeded.
SuccessResponse
error
Error
request
Request
data
object
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' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "tag": [
    {
      "name": "",
      "value": ""
    }
  ],
  "flows": [
    {
      "next": [
        {
          "condition": "",
          "task": ""
        }
      ],
      "description": "",
      "id": "",
      "name": ""
    }
  ],
  "inputs": {},
  "conditions": {},
  "canMerge": false
}'
curl --location --globoff 'https://{base_url}/core/api/v1/workflow-service/workflows' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "tag": [
    {
      "name": "",
      "value": ""
    }
  ],
  "flows": [
    {
      "next": [
        {
          "condition": "",
          "task": ""
        }
      ],
      "description": "",
      "id": "",
      "name": ""
    }
  ],
  "inputs": {},
  "conditions": {},
  "canMerge": false
}'
Responses
201
400
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "success": false,
    "id": ""
  }
}
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "success": false,
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Delete Macro
Get Workflow