Create a new job workflow

1min

POST
Asynchronous API for creating a new job by specifying the following parameters in the request body.
parameters in the request body:**
ParameterDescriptionTypeValidation
objectives*List of all objectives within the job.stringminItems: 1
ㅤ↳objectiveRef*Reference IDs for individual objectives.stringminLength: 4 maxLength: 36
ㅤ↳workflow*Workflow  ID.stringminLength: 1 maxLength: 64
ㅤ↳next*Definition of what is next after this stoparray
ㅤㅤㅤ↳code*Event or Reason codestringminLength: 4 maxLength: 36
ㅤㅤㅤ↳nextObjective*Reference id for individual objectives or END for last statestringminLength: 4 maxLength: 36
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
JobWorkflowCreateRequest
*
Description
Job workflow create request
id
string
name
JobWorkflowName
*
description
string
start
string
*
objectives
ObjectiveWorkflow[]
*
tag
Tags
Responses
201
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/job-workflows' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "start": "",
  "objectives": [
    {
      "objectiveRef": "",
      "workflow": "",
      "next": [
        {
          "nextObjective": ""
        }
      ]
    }
  ]
}'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/job-workflows' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "start": "",
  "objectives": [
    {
      "objectiveRef": "",
      "workflow": "",
      "next": [
        {
          "nextObjective": ""
        }
      ]
    }
  ]
}'
Responses
201
400
401
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

Parameter	Description	Type	Validation
`objectives`*	List of all objectives within the job.	string	minItems: 1
ㅤ↳`objectiveRef`*	Reference IDs for individual objectives.	string	minLength: 4 maxLength: 36
ㅤ↳`workflow`*	Workflow ID.	string	minLength: 1 maxLength: 64
ㅤ↳`next`*	Definition of what is next after this stop	array
ㅤㅤㅤ↳`code`*	Event or Reason code	string	minLength: 4 maxLength: 36
ㅤㅤㅤ↳`nextObjective`*	Reference id for individual objectives or `END` for last state	string	minLength: 4 maxLength: 36
*This is required.

HTTP Status Code Summary

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.

Updated 03 Aug 2023

Did this page help you?

Create a new job workflow draft

Get job workflow by job workflow id