Register Task

1min
POST
This endpoint is for creating a new Execution Task (ET).
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
CreateTaskRequest
description
Description
inputs
object
*
name
Name
*
entityCode
string
*
output
object
*
documentation
string
tag
Tag[]
canMerge
boolean
*
imageUrl
string
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/tasks' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "inputs": {},
  "name": "",
  "entityCode": "",
  "output": {},
  "tag": [
    {
      "name": "",
      "value": ""
    }
  ],
  "canMerge": false
}'
curl --location --globoff 'https://{base_url}/core/api/v1/workflow-service/tasks' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "inputs": {},
  "name": "",
  "entityCode": "",
  "output": {},
  "tag": [
    {
      "name": "",
      "value": ""
    }
  ],
  "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?
Get the status of batch file request
Get Task