Update an object

PATCH

/spaces/:spaceId/objects/:definitionId/:objectId

PATCH

/spaces/:spaceId/objects/:definitionId/:objectId

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

1 {
2   "object": {
3     "_id": "obj_9f8b7c6d5e4a3b2c1d0e",
4     "spaceId": "space_12345abcde",
5     "definitionId": "def_67890fghij",
6     "definitionVersion": 1.1,
7     "data": {},
8     "fieldMeta": {},
9     "createdAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "createdBy": "user_janedoe",
12     "updatedBy": "user_janedoe",
13     "deletedAt": "2024-01-15T09:30:00Z",
14     "provenance": {},
15     "review": {},
16     "origin": {
17       "actionRunId": "run_20240115_093000",
18       "playbookRunId": "playbook_20240115_093000"
19     }
20   }
21 }

Partially updates an object. Authorization: requires space:contribute on :spaceId — lacking it gives 403 (no space:read → 404). Body: { data?, unset?, fieldMeta? } — data merges field values, unset clears the named field keys, fieldMeta sets source/locked per key (and can lock/unlock without writing). A fieldMeta-locked or review-approved/rejected field refuses a write/unset with 409 field_locked (unless the fieldMeta lock is cleared in the same request; a review-lock must be dismissed via the review routes first). Unique collision → 409 duplicate_value, invalid data → 422, unknown object → 404. A human edit clears that field’s provenance. Returns { object }.

Partially updates an object. Authorization: requires `space:contribute` on `:spaceId` — lacking it gives **403** (no `space:read` → 404). Body: `{ data?, unset?, fieldMeta? }` — `data` merges field values, `unset` clears the named field keys, `fieldMeta` sets `source`/`locked` per key (and can lock/unlock without writing). A `fieldMeta`-locked **or** review-approved/rejected field refuses a write/unset with 409 `field_locked` (unless the `fieldMeta` lock is cleared in the same request; a review-lock must be dismissed via the review routes first). Unique collision → 409 `duplicate_value`, invalid data → 422, unknown object → 404. A human edit clears that field's `provenance`. Returns `{ object }`.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

definitionIdstringRequired

objectIdstringRequired

Request

At least one of data, a non-empty unset, or fieldMeta must be present.

datamap from strings to anyOptional

Field values to merge.

unsetlist of stringsOptional

Field keys to clear.

fieldMetamap from strings to maps from strings to anyOptional

May lock or unlock a field without writing a value.

Response

The updated object.

objectobject

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error