Skip to main content
POST
Upload typed positions.

Authorizations

Authorization
string
header
required

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

Body

Required non-null, non-empty Positions; CreateMissingBooks and UseBestEffort default to false, and FileTemplate defaults to DerivitecMixed.

Typed positions submitted for synchronous validation and upload through an accessible market-data environment.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Positions.ApiPositionUploadRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

positions
object[] | null

Typed position changes to validate against contract data and editable books.

create_missing_books
boolean

Legacy typed upload may create missing books when true; the newer typed upload ignores this field. Defaults to false.

file_template
enum<string>

Compatibility template selection that current typed-upload workflows do not consult; defaults to derivitec_mixed.

Available options:
derivitec_mixed,
derivitec_by_security_type,
eze
use_best_effort
boolean

Legacy typed upload permits partial import for snapshot-enabled users when true; the newer typed upload ignores this field. Defaults to false.

Response

Returns overall success and errors, with per-row results for parsed failures; invalid tables, missing books, exceptions, and parse failures are reported in the body.

Aggregate upload outcome and available per-position results for a typed position batch.

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

results
object[] | null

Per-position successes or failures emitted by the selected upload workflow. May be null when the workflow does not produce per-position details, including when processing fails before parsing completes; use IsSuccess and ErrorMessages for the overall outcome.