Skip to main content
GET
Find a specific workflow.

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow
string
required

ID of the workflow to return.

Response

OK

An entity that contains information about a set of steps within a particular application.

id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
name
string
required

Name of the workflow.

description
string
required

Description of the workflow.

Maximum string length: 2000
recordPrefix
string
required

Name to be used for every record created from the workflow.

allowGroups
boolean
required

Nodes created in the workflow are allowed user groups.

requireGroups
boolean
required

Nodes created in the workflow require user groups.

xpos
integer<int32>
required

X axis position of the workflow on the application screen

ypos
integer<int32>
required

Y axis position of the workflow on the application screen

priority
integer<int32>
required

Determines the workflow's place in the application. Priority is in descending order with 0 being the first workflow.

sla
object
required

Object containing all SLA information.

allowAec
boolean
required

Enables automated evidence collection.

allowRcsa
boolean
required

Allow Risk & Control Self-Assessments.

sequence
object
required
application
object
required

Application that the workflow belongs to.

userGroups
object[]
required

User groups that are allowed access to the workflow

primaryField
object
required
workflowType
enum<string>
required
Available options:
WORKFLOW,
JIRA_WORKFLOW,
CONTROL_WORKFLOW,
ANALYSIS_WORKFLOW
currentValueUserGroupMappings
object[]
required
automatedAccessEnabled
boolean
required
automatedAccessFields
object[]
required

Fields that triggers automated access changes

Maximum array length: 6

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

automatedAccessFieldId
string
required
summaryFields
object[]
required
Maximum array length: 5
pluralizedRecordPrefix
string