Update a validation rule
Update or archive a validation rule on the parent schema. When archiving, archiveReason is required. The definition field uses the grammar this.fields.<systemName> = "value" with field systemName references only.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
equipment_schema_id
ID of the EquipmentSchema.
Headers
EARLY-ACCESS
Set to true to access beta operations via /api/v3.
Request
This endpoint expects an object.
validationRuleId
archive
archiveReason
definition
Formula that must evaluate to true for validation to pass. Use the grammar this.fields.<systemName> = "value" (or other supported expressions). Field references must use the field’s systemName; display names are rejected. When the expression evaluates to false, the rule fails and errorMessage is returned.
description
errorMessage
Message returned to users when an entity fails this rule during create or update.
name
Short display name for the rule, shown in lists and settings.
Response
OK
validationRuleId
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error