Skip to main content
POST
Create a field link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

update-siblings
boolean
default:false

When true, apply the same field link to sibling steps in the workflow. Defaults to false.

Body

application/json

The field link values to update.

numberOfColumns
integer<int32>
required
readOnly
boolean
required
id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
name
string
required
color
string
required
icon
string
required
guidance
string
required
priority
integer<int32>
required
colspan
integer<int32>
required
collapsed
boolean
required
defaultState
enum<string>
required
Available options:
HIDDEN,
INACTIVE
conditionsEnabled
boolean
required
conditionsUseAndOperator
boolean
required
step
object
required

An entity to store details about a specific step within a workflow

stepId
string
required
parentId
string
required
required
boolean
required
enabled
boolean
required
displayGuidance
boolean
required
onReadOnlySubsection
boolean
required
column
integer<int32>
required
labelDisplayType
enum<string>
required
Available options:
VALUE,
LABEL,
ALL
field
object
required

An entity used to manage input fields used to capture record data for different workflows.

fieldId
string
required
sectionType
enum<string>
Available options:
CONTENT_SECTION,
DASHBOARD,
DASHBOARD_SECTION,
FIELD_LINK,
FORM_SECTION,
GRAPH_REPORT,
HTML_SECTION,
STEP_PAGE,
SUB_SECTION,
VISUAL_REPORT,
WORKFLOW_LINK,
JIRA_WORKFLOW_LINK,
ANALYSIS_REPORT,
EMBEDDED_REPORT,
EVIDENCE_SECTION,
DATA_WAREHOUSE_LINK,
SCOPING_SECTION

Response

OK

The field link values to update.

numberOfColumns
integer<int32>
required
readOnly
boolean
required
id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
name
string
required
color
string
required
icon
string
required
guidance
string
required
priority
integer<int32>
required
colspan
integer<int32>
required
collapsed
boolean
required
defaultState
enum<string>
required
Available options:
HIDDEN,
INACTIVE
conditionsEnabled
boolean
required
conditionsUseAndOperator
boolean
required
step
object
required

An entity to store details about a specific step within a workflow

stepId
string
required
parentId
string
required
required
boolean
required
enabled
boolean
required
displayGuidance
boolean
required
onReadOnlySubsection
boolean
required
column
integer<int32>
required
labelDisplayType
enum<string>
required
Available options:
VALUE,
LABEL,
ALL
field
object
required

An entity used to manage input fields used to capture record data for different workflows.

fieldId
string
required
sectionType
enum<string>
Available options:
CONTENT_SECTION,
DASHBOARD,
DASHBOARD_SECTION,
FIELD_LINK,
FORM_SECTION,
GRAPH_REPORT,
HTML_SECTION,
STEP_PAGE,
SUB_SECTION,
VISUAL_REPORT,
WORKFLOW_LINK,
JIRA_WORKFLOW_LINK,
ANALYSIS_REPORT,
EMBEDDED_REPORT,
EVIDENCE_SECTION,
DATA_WAREHOUSE_LINK,
SCOPING_SECTION