> ## 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 proposed position changes by book. > Use a validation-context identifier from workbook validation to inspect proposed position effects without applying the import. With no group key, rows summarise books; the first group key returns that book's effects. Only the first sort entry is used. This is read-only. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Position/GetPositionEffectsRows 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/Position/GetPositionEffectsRows: post: tags: - Position summary: List proposed position changes by book. description: >- Use a validation-context identifier from workbook validation to inspect proposed position effects without applying the import. With no group key, rows summarise books; the first group key returns that book's effects. Only the first sort entry is used. This is read-only. operationId: GetPositionEffectsRows requestBody: description: >- JSON request with `Id` set to the validation-context GUID and a required `AgGridQuery`. The grid query uses zero-based `StartRow` (default 0), exclusive `EndRow` (default 50), `GroupKeys`, and `SortModel`; a null query does not produce rows. The first group key is a book name. content: application/json-patch+json: schema: $ref: '#/components/schemas/GetPositionEffectsRowsRequest' application/json: schema: $ref: '#/components/schemas/GetPositionEffectsRowsRequest' text/json: schema: $ref: '#/components/schemas/GetPositionEffectsRowsRequest' application/*+json: schema: $ref: '#/components/schemas/GetPositionEffectsRowsRequest' responses: '200': description: Returns the requested rows and `LastRow` for the selected level. content: application/json: schema: $ref: '#/components/schemas/GetPositionEffectsRowsResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: GetPositionEffectsRowsRequest: required: - $type type: object properties: id: type: string description: Validation-context GUID returned by position-import validation. nullable: true example: 8d55f901-8e1d-4d3d-a5ef-4dfde90a73c1 ag_grid_query: $ref: '#/components/schemas/AgGridQuery' $type: type: string enum: - >- Derivitec.Core.Mediators.Upload.Positions.GetPositionEffectsRowsRequest, Derivitec.Core.Mediators additionalProperties: false description: >- Request to retrieve proposed position-effect rows from an import-validation context. GetPositionEffectsRowsResponse: required: - $type type: object properties: last_row: type: integer description: Number of rows available at the selected grouping level. format: int32 example: 25 position_effects: type: array items: $ref: '#/components/schemas/PositionEffectViewModel' description: >- Proposed position-effect rows returned for the selected grid page or grouping level. nullable: true 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 $type: type: string enum: - >- Derivitec.Core.Mediators.Upload.Positions.GetPositionEffectsRowsResponse, Derivitec.Core.Mediators additionalProperties: false description: >- Response containing proposed position-effect rows for the selected grid level. AgGridQuery: required: - $type type: object properties: start_row: type: integer description: >- Zero-based first requested row; defaults to 0. Druid time-series requests require 0. format: int32 example: 0 end_row: type: integer description: >- Exclusive upper row bound for the requested page; defaults to 50. For Druid history, this positive value caps the most recent returned points, subject to the server maximum. format: int32 example: 50 row_group_cols: type: array items: $ref: '#/components/schemas/AgGridColumn' description: Columns used to group the requested rows. nullable: true value_cols: type: array items: $ref: '#/components/schemas/AgGridColumn' description: >- Columns used as values in the requested rows. Druid history requires exactly one selected column; the server resolves necessary expression dependencies. nullable: true group_keys: type: array items: type: string description: Group keys that identify the requested group level. nullable: true filter_model: type: array items: $ref: '#/components/schemas/AgGridFilterBase' description: Client filters applied to the requested rows. nullable: true sort_model: type: array items: $ref: '#/components/schemas/AgGridSortModel' description: Client sort instructions applied to the requested rows. nullable: true is_time_series_request: type: boolean description: >- Whether a Druid query returns the selected value across recent report runs; defaults to false. History is bounded by the server lookback ending at the report load time and by server column, execution and response limits. Defaults are a 24-hour lookback and at most 1,000 points, further limited by EndRow. StartRow must be zero and ValueCols must contain exactly one column. Grid sorting is ignored; returned points are chronological. Filters and group keys remain active. Older runs outside the window are not returned. $type: type: string enum: - Derivitec.Web.Core.ReportQuery.AgGridQuery, Derivitec.Web.Core additionalProperties: false description: >- Client grid query for selecting, grouping, filtering, and sorting report rows. PositionEffectViewModel: required: - $type type: object properties: book_id: type: integer description: Numeric Risk Portal book key assigned to the position change. format: int32 book_name: type: string description: Name of the book receiving the position change. nullable: true client_transaction_id: type: string description: >- Caller-supplied transaction reference carried through validation and import. nullable: true contract_size: type: number description: >- Optional contract-size value supplied for this position change; no universal unit is defined. format: double nullable: true counterparty: type: string description: Counterparty label carried with the position change. nullable: true deleted: type: boolean description: Whether this view represents a deleted position effect. display_name: type: string description: User-facing label for the proposed position change. nullable: true id: type: integer description: Numeric position-effect key used to relate labels to this change. format: int32 is_checked: type: boolean description: Client selection state for this proposed position change. leg: type: string description: Caller-provided leg label within a multi-leg trade structure. nullable: true position_effects_label_values: type: array items: $ref: '#/components/schemas/PositionEffectsLabelValueViewModel' description: >- Additional typed position metadata represented as label identifiers and text values. nullable: true quantity: type: number description: >- Position quantity produced or changed by this effect; this contract defines no universal unit. format: double structure: type: string description: Caller-provided grouping label for a multi-leg trade structure. nullable: true tool_tip: type: string description: >- Supplementary user-facing explanation for this proposed position change. nullable: true tradable_identifier: type: string description: Risk Portal tradable reference resolved for the position change. nullable: true tradable_type: type: string description: Product classification displayed for the resolved tradable. nullable: true trade_action: type: string description: >- Requested lifecycle action for the position, such as an amendment, deletion, close, or restoration. nullable: true upload_tradable_id_to_enfusion: type: boolean description: >- Whether the resolved Risk Portal tradable reference should be written back to the Enfusion position. $type: type: string enum: - >- Derivitec.Web.Core.Positions.PositionEffectViewModel, Derivitec.Web.Core additionalProperties: false description: >- One proposed or imported position change with book, tradable, quantity, action, and display metadata. AgGridColumn: required: - $type type: object properties: id: type: string description: Client column identifier used by the report-grid query. nullable: true display_name: type: string description: User-facing label for the report column or definition choice. nullable: true field: type: string description: Field name addressed by this grid-query item. nullable: true agg_func: type: string description: Aggregation function selected for this grid column. nullable: true $type: type: string enum: - Derivitec.Web.Core.ReportQuery.AgGridColumn, Derivitec.Web.Core additionalProperties: false description: Column reference in a client report-grid query. AgGridFilterBase: description: Common values for a client report-grid filter. discriminator: propertyName: $type mapping: Derivitec.Web.Core.ReportQuery.AgGridDateFilter, Derivitec.Web.Core: '#/components/schemas/AgGridDateFilter' Derivitec.Web.Core.ReportQuery.AgGridFilter, Derivitec.Web.Core: '#/components/schemas/AgGridFilterMintlifyShape' Derivitec.Web.Core.ReportQuery.AgGridFilterBase, Derivitec.Web.Core: '#/components/schemas/AgGridFilterBaseMintlifyShape' Derivitec.Web.Core.ReportQuery.AgGridInFilterInt, Derivitec.Web.Core: '#/components/schemas/AgGridInFilterInt' Derivitec.Web.Core.ReportQuery.AgGridInFilterPortfolioType, Derivitec.Web.Core: '#/components/schemas/AgGridInFilterPortfolioType' Derivitec.Web.Core.ReportQuery.AgGridInFilterString, Derivitec.Web.Core: '#/components/schemas/AgGridInFilterStringMintlifyShape' Derivitec.Web.Core.ReportQuery.AgGridInFilterStringList, Derivitec.Web.Core: '#/components/schemas/AgGridInFilterStringList' Derivitec.Web.Core.ReportQuery.AgGridIntNumberFilter, Derivitec.Web.Core: '#/components/schemas/AgGridIntNumberFilter' Derivitec.Web.Core.ReportQuery.AgGridMultiFilter, Derivitec.Web.Core: '#/components/schemas/AgGridMultiFilter' Derivitec.Web.Core.ReportQuery.AgGridNumberFilter, Derivitec.Web.Core: '#/components/schemas/AgGridNumberFilter' Derivitec.Web.Core.ReportQuery.AgGridPnlLookbackSetFilter, Derivitec.Web.Core: '#/components/schemas/AgGridPnlLookbackSetFilter' Derivitec.Web.Core.ReportQuery.AgGridPortfolioTypeFilter, Derivitec.Web.Core: '#/components/schemas/AgGridPortfolioTypeFilter' Derivitec.Web.Core.ReportQuery.AgGridReportStatusFilter, Derivitec.Web.Core: '#/components/schemas/AgGridReportStatusFilter' Derivitec.Web.Core.ReportQuery.AgGridSetFilter, Derivitec.Web.Core: '#/components/schemas/AgGridSetFilter' Derivitec.Web.Core.ReportQuery.AgGridStringFilter, Derivitec.Web.Core: '#/components/schemas/AgGridStringFilter' oneOf: - $ref: '#/components/schemas/AgGridDateFilter' - $ref: '#/components/schemas/AgGridFilterMintlifyShape' - $ref: '#/components/schemas/AgGridFilterBaseMintlifyShape' - $ref: '#/components/schemas/AgGridInFilterInt' - $ref: '#/components/schemas/AgGridInFilterPortfolioType' - $ref: '#/components/schemas/AgGridInFilterStringMintlifyShape' - $ref: '#/components/schemas/AgGridInFilterStringList' - $ref: '#/components/schemas/AgGridIntNumberFilter' - $ref: '#/components/schemas/AgGridMultiFilter' - $ref: '#/components/schemas/AgGridNumberFilter' - $ref: '#/components/schemas/AgGridPnlLookbackSetFilter' - $ref: '#/components/schemas/AgGridPortfolioTypeFilter' - $ref: '#/components/schemas/AgGridReportStatusFilter' - $ref: '#/components/schemas/AgGridSetFilter' - $ref: '#/components/schemas/AgGridStringFilter' AgGridSortModel: required: - $type type: object properties: col_id: type: string description: Column identifier addressed by this sort instruction. nullable: true sort: type: string description: Sort direction supplied for this column. nullable: true absolute_sorting: type: boolean description: Whether this sort instruction requests absolute sorting. $type: type: string enum: - Derivitec.Web.Core.ReportQuery.AgGridSortModel, Derivitec.Web.Core additionalProperties: false description: Sort instruction in a client report-grid query. PositionEffectsLabelValueViewModel: required: - $type type: object properties: field: type: string description: Lower-case field key derived from the position-effect label. nullable: true readOnly: true label_id: type: integer description: >- Numeric discriminator identifying which position metadata label the value represents. format: int32 position_effect_id: type: integer description: Numeric position-effect key to which this metadata value belongs. format: int32 value: type: string description: Text representation of the metadata value. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.Positions.PositionEffectsLabelValueViewModel, Derivitec.Web.Core additionalProperties: false description: >- One additional metadata value linked to a position effect by a typed label. AgGridDateFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true type: enum: - in_range - equals - not_equal - less_than - greater_than - blank - not_blank type: string description: Filter comparison or report-grid item type selected by the client. date_from: type: string description: Lower date bound for this date filter, when applicable. nullable: true date_to: type: string description: Upper date bound for this date filter, when applicable. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridDateFilter, Derivitec.Web.Core additionalProperties: false description: Date filter in a client report-grid query. AgGridFilterMintlifyShape: required: - $type type: object additionalProperties: false description: Base form of a client report-grid filter. properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true $type: type: string enum: - Derivitec.Web.Core.ReportQuery.AgGridFilter, Derivitec.Web.Core AgGridFilterBaseMintlifyShape: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridFilterBase, Derivitec.Web.Core additionalProperties: false description: Common values for a client report-grid filter. AgGridInFilterInt: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true values: type: array items: type: integer format: int32 nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridInFilterInt, Derivitec.Web.Core additionalProperties: false AgGridInFilterPortfolioType: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true values: type: array items: enum: - derivitec - enfusion - orchestrade - liquidity_book - maia - fund_studio - not_set type: string description: >- Portfolio sources supported by public portfolio and trade-booking requests. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridInFilterPortfolioType, Derivitec.Web.Core additionalProperties: false AgGridInFilterStringMintlifyShape: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true values: type: array items: type: string nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridInFilterString, Derivitec.Web.Core additionalProperties: false AgGridInFilterStringList: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true values: type: array items: type: string nullable: true type: enum: - not_populated - populated type: string operator: enum: - any - all type: string $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridInFilterStringList, Derivitec.Web.Core additionalProperties: false AgGridIntNumberFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true filter: type: integer format: int32 filter_to: type: integer format: int32 type: enum: - equals - not_equal - less_than - less_than_or_equal - greater_than - greater_than_or_equal - in_range - blank - not_blank type: string $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridIntNumberFilter, Derivitec.Web.Core additionalProperties: false AgGridMultiFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true operator: type: string nullable: true conditions: type: array items: $ref: '#/components/schemas/AgGridFilterBase' nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridMultiFilter, Derivitec.Web.Core additionalProperties: false AgGridNumberFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true filter: type: number format: double filter_to: type: number format: double type: enum: - equals - not_equal - less_than - less_than_or_equal - greater_than - greater_than_or_equal - in_range - blank - not_blank type: string double_precision: type: number format: double $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridNumberFilter, Derivitec.Web.Core additionalProperties: false AgGridPnlLookbackSetFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true int_values: type: array items: enum: - daily - month_to_date - quarter_to_date - year_to_date - annual type: string nullable: true nullable: true $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridPnlLookbackSetFilter, Derivitec.Web.Core additionalProperties: false AgGridPortfolioTypeFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true filter: enum: - derivitec - enfusion - orchestrade - liquidity_book - maia - fund_studio - not_set type: string description: >- Portfolio sources supported by public portfolio and trade-booking requests. filter_to: enum: - derivitec - enfusion - orchestrade - liquidity_book - maia - fund_studio - not_set type: string description: >- Portfolio sources supported by public portfolio and trade-booking requests. type: enum: - equals - not_equal - less_than - less_than_or_equal - greater_than - greater_than_or_equal - in_range - blank - not_blank type: string $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridPortfolioTypeFilter, Derivitec.Web.Core additionalProperties: false AgGridReportStatusFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true filter: enum: - none - succeeded - failed - running - warning type: string description: Lifecycle states exposed for report runs and saved launcher items. filter_to: enum: - none - succeeded - failed - running - warning type: string description: Lifecycle states exposed for report runs and saved launcher items. type: enum: - equals - not_equal - less_than - less_than_or_equal - greater_than - greater_than_or_equal - in_range - blank - not_blank type: string $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridReportStatusFilter, Derivitec.Web.Core additionalProperties: false AgGridSetFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true values: type: array items: type: string nullable: true $type: type: string enum: - Derivitec.Web.Core.ReportQuery.AgGridSetFilter, Derivitec.Web.Core additionalProperties: false AgGridStringFilter: required: - $type type: object properties: field: type: string description: Field name addressed by this grid-query item. nullable: true filter_type: type: string description: Filter category for this grid-query item. nullable: true filter: type: string nullable: true type: enum: - equals - not_equal - contains - not_contains - starts_with - ends_with - blank - not_blank type: string $type: type: string enum: - >- Derivitec.Web.Core.ReportQuery.AgGridStringFilter, Derivitec.Web.Core additionalProperties: false 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 ````