get_constraint_list
Get all constraints for this tenant. Constraints define field-level validation rules on items (mutual exclusion between field values).| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofDataConstraint objects with constraint details including source field, target field, target mode (Include/Exclude), and associated containers.
get_constraints_for_container
Get all constraints that belong to a specific container.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
containerId | string | Yes | Container ID. Use get_containers. |
Returns
A list ofDataConstraint objects for the specified container.
create_constraint
Create a new constraint. Constraints define: whensourceFieldId has value sourceFieldDataId, then targetFieldId is constrained to targetFieldDataId values.
| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Constraint name. |
sourceFieldId | string | Yes | — | The trigger field ID. Use get_custom_field_list. |
sourceFieldDataId | string | Yes | — | The trigger field value ID. |
targetFieldId | string | Yes | — | The constrained field ID. |
targetFieldDataId | string[] | No | [] | Target field value IDs. |
targetMode | string | No | Include | Include or Exclude — whether target values are allowed or disallowed. |
containerIds | string[] | No | [] | Container IDs this constraint applies to. |
Returns
The createdDataConstraint. Requires super admin.
update_constraint
Update an existing constraint. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
constraintId | string | Yes | The constraint ID. Use get_constraint_list. |
name | string | No | New constraint name. |
targetFieldDataId | string[] | No | New target field value IDs. |
targetMode | string | No | Include or Exclude. |
Returns
The updatedDataConstraint. Requires super admin.
delete_constraint
Delete a constraint.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
constraintId | string | Yes | The constraint ID. Use get_constraint_list. |