Create a data-object definition

POST

/objects/definitions

POST

/objects/definitions

$ curl -X POST https://api.cloudraker.com/objects/definitions \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "nameSingular": "contract",
>   "labelSingular": "Contract",
>   "labelPlural": "Contracts",
>   "namePlural": "contracts",
>   "icon": "file-contract",
>   "labelFieldKey": "title",
>   "fields": [
>     {}
>   ]
> }'

1 {
2   "definition": {
3     "_id": "def_contract",
4     "nameSingular": "contract",
5     "namePlural": "contracts",
6     "labelSingular": "Contract",
7     "labelPlural": "Contracts",
8     "description": "A legal agreement between two or more parties outlining terms and conditions.",
9     "icon": "file-contract",
10     "color": "#4A90E2",
11     "labelFieldKey": "title",
12     "fields": [
13       {}
14     ],
15     "fieldGroups": [
16       {}
17     ],
18     "version": 1.1,
19     "archivedAt": "2024-01-15T09:30:00Z",
20     "createdAt": "2024-01-15T09:30:00Z",
21     "updatedAt": "2024-01-15T09:30:00Z",
22     "createdBy": "admin_user_123"
23   }
24 }

Creates a new organization-level definition. Authorization: organization administrators only — other callers get 403. Body describes the schema: nameSingular/namePlural, labels, fields[] (13 field types, plus composites), fieldGroups[], labelFieldKey, icon/color. Invalid schema returns 422 validation_failed (with issues). Returns 201 with { definition }.

Creates a new organization-level definition. Authorization: organization administrators only — other callers get 403. Body describes the schema: `nameSingular`/`namePlural`, labels, `fields[]` (13 field types, plus composites), `fieldGroups[]`, `labelFieldKey`, `icon`/`color`. Invalid schema returns 422 `validation_failed` (with `issues`). Returns 201 with `{ definition }`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

nameSingularstringRequired1-64 characters

labelSingularstringRequired1-200 characters

labelPluralstringRequired1-200 characters

namePluralstringRequired1-64 characters

iconstringRequired1-64 characters

labelFieldKeystringRequired>=1 character

fieldslist of maps from strings to anyRequired

Field descriptors. Each names a key, a type and its type-specific options.

descriptionstringOptional<=2000 characters

Defaults to ''.

colorstring or nullOptional

fieldGroupslist of maps from strings to anyOptional

Response

The created definition.

definitionobject

Errors

403

Forbidden Error

422

Unprocessable Entity Error