Skip to main content
GET
Return a single section based on its ID.

Authorizations

Authorization
string
header
required

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

Path Parameters

section
string
required

Response

200 - application/json

OK

object
string
required

Identifies the type of object this data represents

Example:

"section"

id
string
required

The unique ID of this Risk Cloud resource

Example:

"a1b2c3d4"

sectionType
enum<string>
required

The type of the section

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
name
string
required

The name of the section

color
string
required

The icon color of the section

icon
string
required

The icon type of the section

guidance
string
required

The guidance text of the section

priority
integer<int32>
required

The arrangement priority of this section within its parent section

colspan
integer<int32>
required

The column width amount of this section

collapsed
boolean
required

If the section is collapsed

defaultState
enum<string>
required

The default state of the section, whether hidden or inactive

Available options:
HIDDEN,
INACTIVE
conditionsEnabled
boolean
required

If conditions are enabled on the section

conditionsUseAndOperator
boolean
required

If there are multiple conditions on the section

stepId
string
required

The ID of the step this section is displayed on

parentId
string
required

The ID of the parent section

subsectionIds
string[]
required

IDs of child sections nested directly within this section

numberOfColumns
integer<int32>
required

Number of columns in this section (FormSection only)

readOnly
boolean
required

Whether this section is read-only (FormSection only)

markup
string
required

HTML markup content displayed by this section (HtmlSection only)

required
boolean
required

Whether a value is required (FieldLink and WorkflowLink only)

enabled
boolean
required

Whether this field link is enabled (FieldLink only)

displayGuidance
boolean
required

Whether to display guidance for this field link (FieldLink only)

onReadOnlySubsection
boolean
required

Whether this field link is on a read-only subsection (FieldLink only)

column
integer<int32>
required

Column position of this field link within its parent (FieldLink only)

labelDisplayType
enum<string>
required

How to display the label for this field link (FieldLink only)

Available options:
VALUE,
LABEL,
ALL
fieldId
string
required

ID of the field controlled by this field link (FieldLink only)

Maximum depth of workflow linkages to be considered when returning records for relationship reports.

repeatedWorkflowPaths
boolean
required

Whether repeated workflow paths are shown in this relationship report (GraphReport only)

layoutId
string
required

ID of the layout for this relationship report (GraphReport only)

workflowId
string
required

ID of the associated workflow for this relationship report (GraphReport only)

siblingParentWorkflowId
string
required

ID of the sibling parent workflow for this relationship report (GraphReport only)

dataWarehouseId
string
required

ID of the associated data warehouse contained by this section (DataWarehouse only)

unmappable
boolean
required

Whether this linked workflow cannot be mapped to other workflows (WorkflowLink only)

searchable
boolean
required

Whether records can be searched by this linked workflow (WorkflowLink only)

bulkCreateEnabled
boolean
required

Whether bulk create is enabled for this linked workflow (WorkflowLink only)

analysisReportEnabled
boolean
required

Whether the analysis report is enabled for this linked workflow (WorkflowLink only)

analysisHighlightedColumn
enum<string>
required

The highlighted analysis output column for this linked workflow (WorkflowLink only)

Available options:
MEAN,
MEDIAN,
MODE,
MIN,
MAX,
NONE,
TENTH_PERCENTILE,
NINETIETH_PERCENTILE
analysisDisplayedColumn
enum<string>[]
required

The displayed analysis output columns for this linked workflow (WorkflowLink only)

Available options:
MEAN,
MEDIAN,
MODE,
MIN_MAX,
TENTH_NINETIETH_PERCENTILE
recommendationsActive
boolean
required

Whether recommendations are active for this linked workflow (WorkflowLink only)

recommendationsActivatedOn
string<date-time>
required

When recommendations were activated for this linked workflow (WorkflowLink only)

mappedWorkflowId
string
required

ID of the workflow this linked workflow is filtered by (WorkflowLink only)

bulkCreateWorkflowSourceIds
string[]
required

IDs of the bulk create workflow sources used by this linked workflow (WorkflowLink only)

parentRecordFieldIds
string[]
required

IDs of parent record fields for this linked workflow (WorkflowLink only)

linkedRecordFieldIds
string[]
required

IDs of linked record fields for this linked workflow (WorkflowLink only)

completeRequired
boolean
required

Whether all linked records must be complete (LogicGateWorkflowLink only)

autoStart
boolean
required

Whether linked records auto-start when created (LogicGateWorkflowLink only)

usesDefaultTableReport
boolean
required

Whether this linked workflow uses the default table report (LogicGateWorkflowLink only)

searchStepId
string
required

ID of the step used for searching linked records (LogicGateWorkflowLink only)

createStepId
string
required

ID of the step used for creating linked records (LogicGateWorkflowLink only)

tableReportId
string
required

ID of the table report for this section (LogicGateWorkflowLink and EmbeddedReport only)

creatable
boolean
required

Whether Jira issues can be created from this linked workflow (JiraWorkflowLink only)

defaultStepId
string
required

ID of the default step for evidence collection (EvidenceSection only)

defaultFieldId
string
required

ID of the default attachment field for evidence collection (EvidenceSection only)

defaultWorkflowId
string
required

ID of the default workflow for evidence collection (EvidenceSection only)

defaultAssigneeId
string
required

ID of the default assignee user for evidence collection (EvidenceSection only)

defaultCadence
integer<int64>
required

Default cadence duration for evidence collection (EvidenceSection only)

defaultCadenceUnit
enum<string>
required

Time unit for the default cadence (EvidenceSection only)

Available options:
Nanos,
Micros,
Millis,
Seconds,
Minutes,
Hours,
HalfDays,
Days,
Weeks,
Months,
Years,
Decades,
Centuries,
Millennia,
Eras,
Forever
defaultDueDateInterval
integer<int64>
required

Default due date interval for evidence collection (EvidenceSection only)

defaultDueDateIntervalUnit
enum<string>
required

Time unit for the default due date interval (EvidenceSection only)

Available options:
Nanos,
Micros,
Millis,
Seconds,
Minutes,
Hours,
HalfDays,
Days,
Weeks,
Months,
Years,
Decades,
Centuries,
Millennia,
Eras,
Forever
analysisCreationEnabled
boolean
required

Whether new analysis entries can be created (AnalysisReport only)

highlightedColumn
enum<string>
required

The highlighted analysis output column for this report (AnalysisReport only)

Available options:
MEAN,
MEDIAN,
MODE,
MIN,
MAX,
NONE,
TENTH_PERCENTILE,
NINETIETH_PERCENTILE
displayedColumns
enum<string>[]
required

The displayed analysis output columns for this report (AnalysisReport only)

Available options:
MEAN,
MEDIAN,
MODE,
MIN_MAX,
TENTH_NINETIETH_PERCENTILE