Skip to main content
POST
Create 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 accessible template ReportName, unique NewReportName, and the RiskMeasures and RiskMeasureColumns for the new definition. Caller, organisation, template-definition identifier, report type, and restriction context are server-managed.

Name, measures, and columns for creating a risk report definition.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.RiskReportDefinition.ApiRiskReportDefinitionCreateRequest, 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"

new_report_name
string | null

Name requested for 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_measure_columns
object[] | null

Columns selected for the risk report definition.

Response

Created

Response envelope for an attempt to create a risk report definition.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.RiskReportDefinition.ApiRiskReportDefinitionCreateResponse, 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.