Skip to main content
POST
Retrieve pricing environment settings.

Authorizations

Authorization
string
header
required

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

Body

JSON request with required environment Name. No default selection or additional format rule is declared.

Name of an accessible pricing environment whose public settings are requested.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PricingEnvironment.ApiPricingEnvironmentSettingsGetRequest, Derivitec.Web.Core
name
string | null

Name of the entity to select within the request's entity category. The value must not be null or empty.

Example:

"Example entity"

Response

Returns the selected environment's settings, or an unsuccessful envelope when it is unavailable to the caller.

Public settings for the selected pricing environment.

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

pricing_environment
object

Public index-decomposition and live-data-code settings for a pricing environment.