MEmerqube
index

PATCH /index/{uuid}/target_portfolio/{target_portfolio_uuid}

Update an existing target portfolio

Request

Request body

status'PENDING_VALIDATION' | 'FAILED_VALIDATION' | 'PASSED_VALIDATION' | 'SELECTED' | 'UNSELECTED' | 'FINAL' | 'DELETED'

Indicates the status of a target portfolio. A portfolio can only be used in an index if status is FINAL * PENDING_VALIDATION - Custom validation is necessary, and is queued up * FAILED_VALIDATION - Custom validation has failed. * PASSED_VALIDATION - Custom validation has succeeded. The portfolio must now be selected * SELECTED - Selected for usage on a date, but has not yet been locked in / finalized * UNSELECTED - Was previously selected, but a newer portfolio has replaced it for that date * FINAL - This portfolio can now be used for the given date. * DELETED - This portfolio has been deleted or rejected for usage.

status_change_reasonstring

Response

OK, portfolio successfully updated

divisornumber

A scaling factor to apply for the SHARES of the portfolio constituents

external_idstring

An external ID to reference this portfolio with. Must be unique per index.

share_selection_datestring
target_portfolio_type'EOD' | 'INTRADAY'

Whether its an end of day portfolio or an intraday portfolio.

timestampstring required
unit_of_measure'SHARES' | 'WEIGHT' required

Used to indicate if portfolio amounts are absolute or relative. weight indicates portfolio amounts are relative weights units indicates portfolio amounts are absolute values, e.g. shares or number of contracts

created_tsstring required
finalized_tsstring
idstring required
status'PENDING_VALIDATION' | 'FAILED_VALIDATION' | 'PASSED_VALIDATION' | 'SELECTED' | 'UNSELECTED' | 'FINAL' | 'DELETED' required

Indicates the status of a target portfolio. A portfolio can only be used in an index if status is FINAL * PENDING_VALIDATION - Custom validation is necessary, and is queued up * FAILED_VALIDATION - Custom validation has failed. * PASSED_VALIDATION - Custom validation has succeeded. The portfolio must now be selected * SELECTED - Selected for usage on a date, but has not yet been locked in / finalized * UNSELECTED - Was previously selected, but a newer portfolio has replaced it for that date * FINAL - This portfolio can now be used for the given date. * DELETED - This portfolio has been deleted or rejected for usage.

status_change_reasonstring

Example response

{
  "positions": [
    {
      "asset_type": "EQUITY",
      "identifier_type": "FSYM_ID",
      "position_id": "1",
      "price": 152.34,
      "price_currency": "EUR"
    }
  ],
  "share_selection_date": "Sun, 02 Jan 2022 01:02:03 GMT",
  "timestamp": "Sun, 02 Jan 2022 01:02:03 GMT",
  "created_ts": "Sun, 02 Jan 2022 01:02:03 GMT",
  "finalized_ts": "Sun, 02 Jan 2022 01:02:03 GMT",
  "id": "0000699a-fcd7-45d4-8ce4-064a4ffeced0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.