Skip to main content
POST
Retrieve a custom risk report definition.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The body containing the required accessible ReportName. Do not supply caller, organisation, internal definition, report-type, or restriction fields as selectors.

Selector for retrieving a named risk report definition.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.RiskReportDefinition.ApiRiskReportDefinitionGetRequest, Derivitec.Web.Core
report_name
string | null

Organisation-scoped name of the report definition to select. The value must not be null or empty.

Example:

"Daily risk overview"

Response

Returns the customizer identifier, report name and description, measures, columns, and ownership flag, or an unsuccessful envelope for an unsupported definition.

Risk report-definition content and caller ownership state.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.RiskReportDefinition.ApiRiskReportDefinitionGetResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

customizer_id
string | null

Identifier of the customisation model used by the risk report definition.

report_name
string | null

Name of the report definition associated with the run, schedule, restriction, or launcher item.

report_description
string | null

Description associated with the report definition.

risk_measures
object[] | null

Risk measures associated with the risk report definition.

Common role for a named risk measure exposed through calculation and report contracts.

risk_measures_columns
object[] | null

Columns returned for the risk report definition.

is_owner
boolean

Whether the current caller is recorded as the owner of the returned report definition.