Skip to main content
POST
Create a workflow

Authorizations

Authorization
string
header
required

Bearer token issued via the Authentication endpoints.

Headers

Authorization
string
required

A bearer authorization header containing a Risk Cloud API access token in the format Authorization: Bearer TOKEN — replace TOKEN with your actual access token.

To obtain a Risk Cloud API access token, refer to Obtain an API Access Token in the LogicGate Help Center.

Body

application/json

Workflow (Create)

name
string
required

The name of the workflow

Minimum string length: 1
Example:

"Risk Assessments"

recordPrefix
string
required

The prefix to be used in the name of every record created from this workflow

Minimum string length: 1
Example:

"Assessment"

applicationId
string
required

The unique ID of the parent application of the workflow

Minimum string length: 1
Example:

"a1b2c3d4"

description
string

The description of the workflow

Example:

"Risk Assessment Description Text"

xpos
integer<int32>

The x-coordinate of the workflow in the application builder (must not be less than 0, defaults to 0)

Required range: x >= 0
Example:

20

ypos
integer<int32>

The y-coordinate of the workflow in the application builder (must not be less than 0, defaults to 0)

Required range: x >= 0
Example:

20

Response

Success

id
string

The unique ID of this Risk Cloud resource

Example:

"a1b2c3d4"

name
string

The name of the workflow

Example:

"Risk Assessments"

description
string

The description of the workflow

Example:

"Risk Assessment Description Text"

recordPrefix
string

The prefix to be used in the name of every record created from this workflow

Example:

"Assessment"

applicationId
string

The unique ID of the parent application of the workflow

Example:

"a1b2c3d4"

xpos
integer<int32>

The x-coordinate of the workflow in the application builder

Example:

20

ypos
integer<int32>

The y-coordinate of the workflow in the application builder

Example:

20

type
enum<string>

The type of workflow

Available options:
WORKFLOW,
JIRA_WORKFLOW,
CONTROL_WORKFLOW,
ANALYSIS_WORKFLOW
Example:

"WORKFLOW"

object
string

Identifies the type of object this data represents

Example:

"workflow"