Skip to main content
POST
Upload positions from a tabular payload.

Authorizations

Authorization
string
header
required

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

Body

Required non-null Positions JSON row table. A non-empty SecurityType is required in practice when the table has no name; its accepted values are not exhaustively defined here. CreateMissingBooks and UseBestEffort default to false; FileTemplate defaults to DerivitecMixed.

One tabular position set and the security-type label used to interpret an unnamed table.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Positions.ApiPositionDataTableUploadRequest, Derivitec.Web.Core
create_missing_books
boolean

Whether the legacy import may create books named by otherwise valid position rows; defaults to false.

file_template
enum<string>

Column-layout convention used by portfolio-history upload; the current single-table legacy upload does not consult it. Defaults to derivitec_mixed.

Available options:
derivitec_mixed,
derivitec_by_security_type,
eze
use_best_effort
boolean

Whether a snapshot-enabled user requests import of valid rows despite parsing failures; defaults to false.

positions
object[] | null

JSON row table of positions to validate and, when accepted, import.

security_type
string | null

Table or security-type label used when the submitted table has no name; the schema does not enumerate accepted values.

Response

Returns parse details, import status, and errors or warnings; the normal import status determines IsSuccess.

Validation details, import status, and errors returned by a legacy position-table upload.

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

parse_import_data_table_response
object

Public validation details for a legacy tabular position import.

status
enum<string>

Final import status; success with warnings counts as aggregate success, while success with retained errors does not.

Available options:
none,
succeeded,
succeeded_with_warnings,
succeeded_with_errors,
failed