Admin APIFeature flags

Validate constraint

View as Markdown
Validates a constraint definition. Checks whether the context field exists and whether the applied configuration is valid. Additional properties are not allowed on data objects that you send to this endpoint.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

constraintSchema
contextNamestringRequired
The name of the context field that this constraint should apply to.
operatorenumRequired

The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

caseInsensitivebooleanOptionalDefaults to false

Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

invertedbooleanOptionalDefaults to false

Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

valueslist of stringsOptional

The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

valuestringOptional

The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

Response

The constraint is valid

Errors