Skip to main content
POST
Retrieve a VaR report run's current status.

Authorizations

Authorization
string
header
required

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

Body

The body containing the opaque ReportId for the VaR report run.

Selector for checking the current state of one report run.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetReportStatusByIdRequest, Derivitec.Web.Core
report_id
string | null

Opaque identifier of the report run to retrieve or query. The value must not be null or empty.

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set

Response

Returns the current status for the identified VaR report run in the standard response envelope.

Current state returned for the selected report run.

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

status
enum<string>

Lifecycle state recorded for the report run or scheduled item.

Available options:
none,
succeeded,
failed,
running,
warning