SLslopesoftware
ModelPointFields

Create a new model point field for a product.

This endpoint will:

  • Validate the user has permission to modify the model
  • Ensure the model is not in production
  • Validate field name and alias uniqueness
  • Validate data type rules (e.g., only Decimal fields can scale)
  • Trigger validation on dependent entities
  • Initiate async file validation

Field names and aliases must be unique within the product's model point file definition. Only Decimal fields can be configured to scale on purchase or sale.

post/api/v1/ModelPointFields

Request

Request body

productIdinteger required

The ID of the product to add the model point field to.

namestring required

The name of the model point field. Must be unique within the product.

descriptionstring nullable

An optional description of the model point field, such as expected values or formats.

dataType'Integer' | 'Decimal' | 'String' | 'Date' | 'Invalid' | 'Boolean' | 'DataTable' | 'DecrementTable' | 'Dynamic' | 'ScenarioTable' | 'YieldCurve' | 'List' required
isRequiredboolean required

Whether the field is required in model point files.

isScaledOnPurchaseOrSaleboolean required

Whether the field scales on purchase or sale. Only applicable to Decimal fields.

defaultValueSource'None' | 'DefinedValue'
defaultValuestring nullable

The default value when DefaultMethodType is DefinedValue.

aliasesstring[] nullable

Alternative names for this field. Must be unique within the product.

Response

OK

idinteger

The ID of the newly created model point field.

namestring nullable

The name of the newly created model point field.

descriptionstring nullable

The description of the newly created model point field, if one was provided.

Changes

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