SLslopesoftware
ModelPointFields

Update an existing model point field.

This endpoint will:

  • Validate the user has permission to modify the model
  • Ensure the model is not in production
  • Support partial updates (only send fields to be updated)
  • Validate field name and alias uniqueness
  • Enforce system field restrictions (cannot update DataType, IsRequired, or IsScaledOnPurchaseOrSale for system fields)
  • Validate data type rules (e.g., only Decimal fields can scale)
  • Prevent changing DataType to non-Decimal when IsScaledOnPurchaseOrSale is true
  • Trigger validation on model point files when critical properties change

For system model point fields, the Data Type, IsRequired flag, and Scales on Purchase or Sale flag cannot be updated. Field names and aliases must remain unique within the product's model point file definition.

patch/api/v1/ModelPointFields/{modelPointFieldId}

Request

Path parameters

modelPointFieldIdinteger required

The ID of the model point field to update

The ID of the model point field to update.

Request body

namestring nullable

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

descriptionstring nullable

The updated description of the model point field. Omit to leave unchanged; set to an empty string to clear it.

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

Whether the field is required in model point files. Cannot be changed for system fields.

isScaledOnPurchaseOrSaleboolean nullable

Whether the field scales on purchase or sale. Only applicable to Decimal fields. Cannot be changed for system 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 updated model point field.

namestring nullable

The name of the updated model point field.

descriptionstring nullable

The description of the updated model point field.

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

Whether the field is required in model point files.

isScaledOnPurchaseOrSaleboolean

Whether the field scales on purchase or sale.

defaultValueSource'None' | 'DefinedValue'
defaultValuestring nullable

The default value if using defined value method.

aliasesstring[] nullable

Alternative names for this field.

Changes

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