Skip to main content
GET
Get a dashboard

Authorizations

Authorization
string
header
required

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

Path Parameters

dashboardId
string
required

The unique ID of the dashboard.

Response

OK

Circular reference to Section_ExtendedSectionSummary

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
creator
object
required

Entity used to manage record's field data.

owner
object
required

Entity used to manage record's field data.

editor
object
required

Entity used to manage record's field data.

filters
object[]
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
workflow
object

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

viewableTitle
string