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
*
Unique RequestId
X-COREOS-TID
string
*
Tenant id
X-COREOS-ACCESS
string
*
Access Token
X-COREOS-USERINFO
string
*
user info
BODY PARAMETERS
body
JobWorkflowCreateRequest
*
Job workflow create request
id
string
Id of the job-workflow draft
name
JobWorkflowName
*
Name of the job workflow
description
string
Description of job workflow
start
string
*
Starting objective reference
objectives
ObjectiveWorkflow[]
*
List of all objectives within the job
tag
Tags
Array of key-value pair tag
RESPONSES
201
OK
SuccessResponse
error
Error
*
Error information
request
Request
*
data
object
Example: [object Object]
400
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*
﻿
﻿

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