Update a market-data provider.
Use this operation to rename, redescribe, activate, or deactivate an existing environment. The caller must
have owner access. The inherited current Name identifies an accessible environment; EntityId
is not the reliable client selector for this action. NewName must not match a market-data environment
already accessible to the caller. The update completes before the response returns.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
Current environment Name, NewName, NewDescription, and IsActive; the entity type is fixed to market-data provider and IsActive=false deactivates it. The current contract accepts empty new-name and new-description values.
Current market-data-environment selection and replacement display details and active state.
Derivitec.Web.Core.MarketDataProvider.ApiMarketDataProviderUpdateRequest, Derivitec.Web.Core Replacement client-visible name for the selected configurable entity.
Replacement client-visible description for the selected configurable entity.
Replacement lifecycle state: true keeps the entity available and false deactivates it.
Name of the entity to select within the request's entity category. The value must not be null or empty.
"Example entity"
Response
Returns the update result, including missing/current-name, access, missing-ID, or duplicate-new-name errors.
Outcome of updating a market-data environment.
Derivitec.Web.Core.MarketDataProvider.ApiMarketDataProviderUpdateResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.