Skip to main content
GET
Return a list of fields from a particular a workflow.

Authorizations

Authorization
string
header
required

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

Query Parameters

id
string
ids
string[]
sectionId
string
nodeId
string
stepId
string
workflowId
string
applicationId
string
query
string
global
boolean
archived
string
default:false

Return archived values.

exclude
boolean
withValues
boolean
withLabels
boolean
withInputs
boolean
withTargets
boolean
allowCurrentDateCalculations
boolean
types
enum<string>[]
Available options:
TEXT,
EXTERNAL_USER,
EXTERNAL_ID,
TEXT_AREA,
DATE_PICKER,
NUMBER,
E_SIGNATURE,
CHECKBOX,
MULTI_SELECT,
RADIO,
SELECT,
USER,
ATTACHMENT,
CALCULATION,
TEXT_CONCATENATION,
FIXED_DATE_CALCULATION,
LINKED_RECORDS_COUNT,
DUE_DATE,
DAYS_UNTIL_DUE,
EVIDENCE,
AEC_INFO,
ANNUAL_LOSS_EXPOSURE

Response

200 - application/json

OK

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

id
string
required
fieldType
enum<string>
required
Available options:
TEXT,
EXTERNAL_USER,
EXTERNAL_ID,
TEXT_AREA,
DATE_PICKER,
NUMBER,
E_SIGNATURE,
CHECKBOX,
MULTI_SELECT,
RADIO,
SELECT,
USER,
ATTACHMENT,
CALCULATION,
TEXT_CONCATENATION,
FIXED_DATE_CALCULATION,
LINKED_RECORDS_COUNT,
DUE_DATE,
DAYS_UNTIL_DUE,
EVIDENCE,
AEC_INFO,
ANNUAL_LOSS_EXPOSURE
name
string
required

The name of the field.

labels
string[]
required
label
string
required

The label will appear as the label for the field when it appears on forms for user's to complete.

tooltip
string
required

A text value that will populate any tooltip information.

helpText
string
required

A text value that supplies necessary context for a person to fill out an input field.

format
enum<string>
required
Available options:
CURRENCY,
DECIMAL
currency
enum<string>
required
Available options:
EUR,
GBP,
USD
enabledForRecordAccess
boolean
required
currentValues
object[]
required

Relationship to current values that are associated to the field. A field maybe have multiple current values associated to it.

Entity used to manage record's field data.

defaultValues
object[]
required

Relationship to current values that are defaulted to the field. A field maybe have multiple default current values associated to it.

Entity used to manage record's field data.

analysisEstimate
enum<string>
required
Available options:
CONFIDENCE,
MAXIMUM,
MINIMUM,
MOST_LIKELY
analysisType
enum<string>
required
Available options:
CONTACT_FREQUENCY,
LOSS_EVENT_FREQUENCY,
LOSS_MAGNITUDE,
PRIMARY_PRODUCTIVITY_LOSS,
PRIMARY_RESPONSE_LOSS,
PRIMARY_REPLACEMENT_LOSS,
PRIMARY_COMPETITIVE_ADVANTAGE_LOSS,
PRIMARY_FINES_OR_JUDGEMENTS_LOSS,
PRIMARY_REPUTATION_DAMAGE_LOSS,
PROBABILITY_OF_ACTION,
RESISTANCE_STRENGTH,
SECONDARY_PRODUCTIVITY_LOSS,
SECONDARY_RESPONSE_LOSS,
SECONDARY_REPLACEMENT_LOSS,
SECONDARY_COMPETITIVE_ADVANTAGE_LOSS,
SECONDARY_FINES_OR_JUDGEMENTS_LOSS,
SECONDARY_REPUTATION_DAMAGE_LOSS,
SECONDARY_LOSS_EVENT_FREQUENCY,
SECONDARY_LOSS_MAGNITUDE,
THREAT_CAPABILITY,
THREAT_EVENT_FREQUENCY,
VULNERABILITY
operators
enum<string>[]
required
Available options:
EQUALS,
NOT_EQUALS,
IS,
IS_NOT,
GREATER_THAN,
GREATER_THAN_EQUALS,
LESS_THAN,
LESS_THAN_EQUALS,
CONTAINS,
DOES_NOT_CONTAIN,
NULL,
NOT_NULL,
DATE_RANGE,
NUMERIC_RANGE
convertibleTo
string[]
required
copyRecordAccessField
boolean
required
valueType
string
global
boolean
requiresUniqueValue
boolean
analysisOutputField
boolean
discrete
boolean
crossWorkflowCalculation
boolean
validTypeForCalculationInput
boolean