> ## Documentation Index > Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt > Use this file to discover all available pages before exploring further. # List available risk-definition control schemas. > Returns the input schemas and allowed enum choices clients can use to construct a risk report definition. These controls describe available inputs; they are not a saved definition and do not initiate a report run. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json get /api/ReportDefinition/ListReportDefinitionsControls openapi: 3.0.4 info: title: Derivitec Api 1.0 version: '1.0' servers: - url: https://api.riskportal.activeviam.com security: - oauth2: [] - apikey: [] tags: - name: AdminUser - name: AtotiReport - name: AtotiSession - name: BloombergOAuth - name: Bond - name: BondYieldCurvePage - name: BookAccess - name: Books - name: Commodity - name: Counterparties - name: Currencies - name: Equity - name: EquityDividend - name: EquityPage - name: FeatureFlag - name: Fx - name: FxPage - name: GroupAccess - name: Home - name: LegacyPosition - name: MarketData - name: MarketDataProvider - name: MarketDataProviderAccess - name: Meta - name: Notification - name: Organisation - name: PnLReport - name: PortfolioAccess - name: Portfolios - name: Position - name: PositionFilter - name: PricingEnvironment - name: PricingEnvironmentAccess - name: RateAsset - name: RateAssetPage - name: Report - name: ReportDefinition - name: ReportHistoryLauncherQuery - name: ReportLauncher - name: ReportQuery - name: ReportQueryViewUser - name: ReportRestriction - name: ReportView - name: RiskReport - name: Tradable - name: TradeBooking - name: User - name: VarReport - name: VarReportQuery - name: YieldCurvePage paths: /api/ReportDefinition/ListReportDefinitionsControls: get: tags: - ReportDefinition summary: List available risk-definition control schemas. description: >- Returns the input schemas and allowed enum choices clients can use to construct a risk report definition. These controls describe available inputs; they are not a saved definition and do not initiate a report run. operationId: ListReportDefinitionsControls responses: '200': description: >- Returns the available risk-definition control schemas and their allowed options. content: application/json: schema: $ref: '#/components/schemas/ApiGetReportDefinitionControlsResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetReportDefinitionControlsResponse: required: - $type type: object properties: is_success: type: boolean description: >- Whether the operation completed successfully. The default is `true`; error outcomes set it to `false`. example: true error_messages: type: array items: type: string description: >- Messages explaining operation-level failures. The collection is empty by default. nullable: true schemas: type: object additionalProperties: $ref: '#/components/schemas/RiskMeasureSchema' description: >- Control schemas keyed by the public risk-measure or scenario type name. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.RiskEngine.ApiGetReportDefinitionControlsResponse, Derivitec.Web.Core additionalProperties: false description: >- Returns client-control metadata for supported risk-measure and scenario definitions. RiskMeasureSchema: required: - $type type: object properties: controls: type: array items: $ref: '#/components/schemas/VueRiskControl' description: Ordered control descriptors for configurable properties of the type. nullable: true risk_measure_type: enum: - risk_measure - scenario type: string description: Whether the schema describes a risk measure or a scenario. $type: type: string enum: - >- Derivitec.Web.Core.RiskEngine.RiskMeasureSchema, Derivitec.Web.Core additionalProperties: false description: >- Describes the controls and category for one risk-measure or scenario type. VueRiskControl: required: - $type type: object properties: property_name: type: string description: Serialized property path to which the control applies. nullable: true property_options: type: array items: type: string description: >- Available serialized option names for an enum property; empty when the property has no enumerated options. nullable: true display_name: type: string description: Human-readable label for the property. nullable: true read_only: type: boolean description: Whether clients should present this property as read-only. component: enum: - text_box - number_input - date_picker - underlyer_dropdown - enum_dropdown - check_box - bond_instrument_dropdown - percent_input - stored_scenario_selector - scenario - risk_measure - vol_surface_selector - number_slider - tenor_list - dictionary_text_box_percent_input - dictionary_underlyer_dropdown_percent_input - currency_drop_down - vol_shock_func - dictionary_fx_pair_vol_shock_func - rate_asset_dropdown - dictionary_currency_dropdown_percent_input - dictionary_rate_asset_dropdown_percent_input - discount_curve_bump - dictionary_currenecy_dropdown_discount_curve_bump - func_double_double - scenarios - dividend_bump - dictionary_text_box_dividend_bump - composite_component - not_set type: string description: >- Suggested control kind for the property, or null when no specific control is assigned. nullable: true parent_component: enum: - text_box - number_input - date_picker - underlyer_dropdown - enum_dropdown - check_box - bond_instrument_dropdown - percent_input - stored_scenario_selector - scenario - risk_measure - vol_surface_selector - number_slider - tenor_list - dictionary_text_box_percent_input - dictionary_underlyer_dropdown_percent_input - currency_drop_down - vol_shock_func - dictionary_fx_pair_vol_shock_func - rate_asset_dropdown - dictionary_currency_dropdown_percent_input - dictionary_rate_asset_dropdown_percent_input - discount_curve_bump - dictionary_currenecy_dropdown_discount_curve_bump - func_double_double - scenarios - dividend_bump - dictionary_text_box_dividend_bump - composite_component - not_set type: string description: >- Suggested parent control kind for nested input, or null when the property has no parent-control hint. nullable: true $type: type: string enum: - Derivitec.Web.Core.RiskEngine.VueRiskControl, Derivitec.Web.Core additionalProperties: false description: Describes how a client can present one configurable risk property. securitySchemes: oauth2: type: oauth2 description: >- OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header flows: implicit: authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize scopes: {} apikey: type: apiKey description: API-Key requested via the site and provided as a header name: x-api-key in: header ````