Skip to main content
POST
Delete 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. Caller, organisation, definition identifier, report type, and restriction context are server-managed.

Selector for deleting a named risk report definition.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.RiskReportDefinition.ApiRiskReportDefinitionDeleteRequest, 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 deletion outcome, including non-owner and unavailable-definition failures in the response envelope.

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

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