Update a data-object definition

PATCH

/objects/definitions/:definitionId

PATCH

/objects/definitions/:definitionId

$ curl -X PATCH https://api.cloudraker.com/objects/definitions/definitionId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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 }

Applies a field-by-key diff to a definition. Authorization: organization administrators only — other callers get 403. Body is strict (immutable name/field keys rejected). Fields present are upserted; omitting an active field soft-archives it (archive-on-omit). Changing a field type while live objects exist returns 409 type_change_blocked (with fieldKey); the version bumps only on a schema-affecting change. Unknown id → 404, invalid body → 422 validation_failed. Returns { definition }.

Applies a field-by-key diff to a definition. Authorization: organization administrators only — other callers get 403. Body is strict (immutable `name`/field keys rejected). Fields present are upserted; **omitting an active field soft-archives it** (archive-on-omit). Changing a field type while live objects exist returns 409 `type_change_blocked` (with `fieldKey`); the `version` bumps only on a schema-affecting change. Unknown id → 404, invalid body → 422 `validation_failed`. Returns `{ definition }`.

Authentication

AuthorizationBearer

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

Path parameters

definitionIdstringRequired

Request

Strict: nameSingular and unknown keys are rejected. Fields present are upserted; omitting an active field soft-archives it.

labelSingularstringOptional1-200 characters

labelPluralstringOptional1-200 characters

namePluralstringOptional1-64 characters

descriptionstringOptional<=2000 characters

iconstringOptional1-64 characters

colorstring or nullOptional

labelFieldKeystringOptional>=1 character

fieldslist of maps from strings to anyOptional

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

fieldGroupslist of maps from strings to anyOptional

Response

The updated definition.

definitionobject

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error