Skip to main content
POST
Delete index components from a writable environment.

Authorizations

Authorization
string
header
required

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

Body

The deletion payload containing index or ETF Identifiers, a date-only MarketDate, and the explicit writable MarketDataEnvironmentName to target.

Selects index component records to remove by identifier and market date.

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

identifiers
object[] | null

Instrument selectors that narrow the index component operation.

Instrument code qualified by an identifier namespace and optional market code.

market_date
string<date-time>

Market date for the index component operation.

Response

Returns whether the selected component data was deleted and any permission, environment, identifier, or deletion errors.

Common operation outcome containing a success indicator and any error messages.

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