Get one ValidationRule

Retrieve a single ValidationRule record by its Id.

GET /api/sys/validationrules/{id}

Get one ValidationRule

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/validationrules/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "BusinessId": 123,
  "Name": "<string>",
  "RecordType": 123,
  "Active": true,
  "Formula": "<string>",
  "Description": "<string>",
  "ErrorMessage": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A validation rule is a location-scoped custom expression evaluated when selected records are created or updated; a false result blocks the save with its configured error message.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ValidationRule-Read role.

Path Parameters

id · integer · required

The Id of the ValidationRule record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/sys/validationrules/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId · integer

ID of the location that owns this rule; a rule on a network location is also evaluated for records in its child locations.

Name · string

Required internal name for this rule; it is returned as the failure message when ErrorMessage is null.

RecordType · integer

Record type this rule evaluates: Coworker (customer), Booking, CoworkerContract, Visitor, CoworkerProduct, ProposalContract, CoworkerInvoice, Teams, or EventAttendees. See eValidationRuleEntity enum values: 1 = Coworker, 2 = Booking, 4 = CoworkerContract, 5 = Visitor, 6 = CoworkerProduct, 7 = ProposalContract, 8 = CoworkerInvoice, 9 = Teams, 10 = EventAttendees.

Active · boolean

Whether this rule is evaluated when a matching record is created or updated; only active rules are selected for evaluation.

Formula · string

Required Flee expression that returns true to allow the record and false to reject it; use record, isCreate, isUpdate, user, and the available CustomFunctions as evaluation context.

Description · string

Optional internal notes explaining this rule; not shown to customers.

ErrorMessage · string

Message returned when Formula evaluates to false; when null, the rule Name is returned instead.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "RecordType": 0,
  "Active": false,
  "Formula": "",
  "Description": null,
  "ErrorMessage": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ValidationRule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}