Overview
The Utilities API provides functionality for managing:
- Common field updates
- Record modifications
- Metadata management
- Access control
Core Concepts
Record Types
| Type | Description | Updatable Fields |
|---|
customers | Customer records | active, metadata, description |
accounts | Account records | active, description |
products | Product records | active, metadata |
orders | Order records | description, metadata |
suppliers | Supplier records | active, metadata |
Field Properties
| Field | Type | Validation | Required |
|---|
active | boolean | true/false | No |
description | string | max 1000 chars | No |
metadata | object | valid JSON | No |
| Field | Type | Example | Description |
|---|
category | string | ”premium” | Classification |
region | string | ”europe” | Geographic area |
tags | array | [“vip”] | Labels |
custom | any | User defined | Custom data |
Audit Fields
| Field | Type | Description |
|---|
modified_at | datetime | Last update time |
modified_by | uuid | User who updated |
previous_value | object | Old field values |
new_value | object | New field values |
Validation Rules
Field Rules
- Description: max 1000 chars
- Metadata: valid JSON
- Active: boolean only
- Record type: must exist
Permission Rules
- Record type level access
- Record specific access
- Update permission required
- Valid authentication
Security Requirements
- JWT authentication
- RBAC permissions
- Audit logging
- Input validation
See individual endpoint documentation for detailed request/response formats and examples.
