Schemas
Use this section when an endpoint asks for type/details or coordinates_system/coordinates_details.
How schemas relate to API calls
- A module endpoint validates the JSON fragment in
details(orcoordinates_details) against a schema chosen bytype(orcoordinates_system). - If fields do not match the selected schema, the API returns
400 Bad requestwith validation errors. - Always send the selector and payload pair together in create/update calls.
Schema groups
| Group | Used by endpoint(s) | Selector field | Payload field |
|---|---|---|---|
| Coordinates | /api/private/modules/procedure/ | coordinates_system | coordinates_details |
| ConsumableStock | /api/private/modules/consumablestock/ | type | details |
| DataAcquisition | /api/private/modules/dataacquisition/ | type | details |
| Equipment | /api/private/modules/equipment/ | type | details |
| Manipulation | /api/private/modules/manipulation/ | type | details |
| Procedure | /api/private/modules/procedure/ | type | details |
| ProcedureLog | /api/private/modules/procedurelog/ | type | details |
| SubjectLog | /api/private/modules/subjectlog/ | type | details |
Validation troubleshooting
typeorcoordinates_systemnot recognized: use one value from the target schema page quick map.- Missing required field: add all fields listed under
Required fieldsfor that schema. - Wrong nested shape: check whether field expects scalar (
string,number) vs object (value+unit) or array rows. - Unit mismatch: use one of the unit enum values documented in constraints.