Skip to main content
POST
Validate a position-import workbook.

Authorizations

Authorization
string
header
required

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

Body

JSON request with FileName identifying the workbook and FileData as a data URL in the form data:<media-type>[;base64],<payload>. Base64 and URL-encoded payloads are accepted; no size or media-type limit is stated here.

Request to validate an uploaded position import file.

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

Name supplied for the uploaded position import file.

file_data
string | null

Data URL containing the uploaded position import file contents.

Response

Returns the parsed-file summary and its ParseFileDataContextId.

Response containing the validated position-import summary and its validation-context identifier.

$type
enum<string>
required
Available options:
Derivitec.Core.Mediators.Upload.Positions.PositionUploadValidationResponse, Derivitec.Core.Mediators
parsed_file_data
object

Parsed position-import result, including proposed position effects.

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.