Review a single object field

PATCH

/spaces/:spaceId/objects/:definitionId/:objectId/fields/:fieldKey/review

PATCH

/spaces/:spaceId/objects/:definitionId/:objectId/fields/:fieldKey/review

$ curl -X PATCH https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId/fields/fieldKey/review \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "status": "approved"
> }'

1 {
2   "object": {
3     "_id": "a1b2c3d4e5f6789012345678",
4     "spaceId": "space_987654321",
5     "definitionId": "def_123456789",
6     "definitionVersion": 2,
7     "data": {},
8     "fieldMeta": {},
9     "createdAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-04-20T14:45:00Z",
11     "createdBy": "user_abc123",
12     "updatedBy": "user_xyz789",
13     "deletedAt": "null",
14     "provenance": {},
15     "review": {},
16     "origin": {
17       "actionRunId": "run_20240420_001",
18       "playbookRunId": "playbook_20240420_01"
19     }
20   }
21 }

Sets the review status of one field (:fieldKey) on an object. Authorization: requires space:contribute on :spaceId — lacking it gives 403 (no space:read → 404). Body: { status, note? } where status is pending|approved|rejected; approved/rejected review-locks the field against edits, pending dismisses the lock. Archived fields are still reviewable. Unknown field key → 404, invalid status → 422 invalid_status. Returns the updated { object }.

Sets the review status of one field (`:fieldKey`) on an object. Authorization: requires `space:contribute` on `:spaceId` — lacking it gives **403** (no `space:read` → 404). Body: `{ status, note? }` where `status` is `pending`|`approved`|`rejected`; `approved`/`rejected` review-locks the field against edits, `pending` dismisses the lock. Archived fields are still reviewable. Unknown field key → 404, invalid `status` → 422 `invalid_status`. Returns the updated `{ object }`.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

definitionIdstringRequired

objectIdstringRequired

fieldKeystringRequired

Request

This endpoint expects an object.

statusenumRequired

Allowed values:

notestringOptional

Response

The object with the field's review state updated.

objectobject

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error