Skip to main content
POST
List proposed position changes by book.

Authorizations

Authorization
string
header
required

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

Body

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.

Request to retrieve proposed position-effect rows from an import-validation context.

$type
enum<string>
required
Available options:
Derivitec.Core.Mediators.Upload.Positions.GetPositionEffectsRowsRequest, Derivitec.Core.Mediators
id
string | null

Validation-context GUID returned by position-import validation.

Example:

"8d55f901-8e1d-4d3d-a5ef-4dfde90a73c1"

ag_grid_query
object

Client grid query for selecting, grouping, filtering, and sorting report rows.

Response

Returns the requested rows and LastRow for the selected level.

Response containing proposed position-effect rows for the selected grid level.

$type
enum<string>
required
Available options:
Derivitec.Core.Mediators.Upload.Positions.GetPositionEffectsRowsResponse, Derivitec.Core.Mediators
last_row
integer<int32>

Number of rows available at the selected grouping level.

Example:

25

position_effects
object[] | null

Proposed position-effect rows returned for the selected grid page or grouping level.

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.