> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cloudraker.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server. # Update an object PATCH https://api.cloudraker.com/spaces/{spaceId}/objects/{definitionId}/{objectId} Content-Type: application/json 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 }`. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/data-objects/update-object ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /spaces/{spaceId}/objects/{definitionId}/{objectId}: patch: operationId: update-object summary: Update an object description: >- 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 }`. tags: - dataObjects parameters: - name: spaceId in: path required: true schema: type: string - name: definitionId in: path required: true schema: type: string - name: objectId in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The updated object. content: application/json: schema: $ref: '#/components/schemas/DataObjectEnvelope' '403': description: Missing `space:contribute`. content: application/json: schema: description: Any type '404': description: No such object (or missing `space:read`). content: application/json: schema: description: Any type '409': description: '`field_locked` (locked/review-locked field) or `duplicate_value`.' content: application/json: schema: description: Any type '422': description: '`validation_failed` — the merged data fails the schema.' content: application/json: schema: description: Any type requestBody: description: >- At least one of `data`, a non-empty `unset`, or `fieldMeta` must be present. content: application/json: schema: type: object properties: data: type: object additionalProperties: description: Any type description: Field values to merge. unset: type: array items: type: string description: Field keys to clear. fieldMeta: type: object additionalProperties: type: object additionalProperties: description: Any type description: May lock or unlock a field without writing a value. servers: - url: https://api.cloudraker.com description: Production - url: https://api.staging.raker.one description: Staging - url: https://api.dev.raker.one description: Development components: schemas: DataObjectFieldMeta: type: object properties: modifiedBy: type: string modifiedAt: type: string format: date-time source: type: string locked: type: boolean description: A locked field refuses writes with 409. required: - modifiedBy - modifiedAt title: DataObjectFieldMeta DataObjectReviewStatus: type: string enum: - pending - approved - rejected title: DataObjectReviewStatus DataObjectReview: type: object properties: status: $ref: '#/components/schemas/DataObjectReviewStatus' by: type: string at: type: string format: date-time note: type: string required: - status - by - at title: DataObjectReview ObjectOrigin: type: object properties: actionRunId: type: string playbookRunId: type: string description: >- Set only when a playbook dispatched the run; callers cannot claim it. description: Set on create, never patchable. title: ObjectOrigin DataObject: type: object properties: _id: type: string spaceId: type: string definitionId: type: string definitionVersion: type: number format: double data: type: object additionalProperties: description: Any type description: Field values keyed by field key. fieldMeta: type: object additionalProperties: $ref: '#/components/schemas/DataObjectFieldMeta' createdAt: type: string format: date-time updatedAt: type: string format: date-time createdBy: type: string updatedBy: type: string deletedAt: type: - string - 'null' format: date-time provenance: type: object additionalProperties: type: array items: type: object additionalProperties: description: Any type description: >- Per-field grounding: field key → citation pointers, imported verbatim from the extraction feed. review: type: object additionalProperties: $ref: '#/components/schemas/DataObjectReview' description: >- Per-field review state. An approved or rejected field is locked against edits. origin: $ref: '#/components/schemas/ObjectOrigin' required: - _id - spaceId - definitionId - definitionVersion - data - fieldMeta - createdAt - updatedAt - createdBy - updatedBy - deletedAt title: DataObject DataObjectEnvelope: type: object properties: object: $ref: '#/components/schemas/DataObject' required: - object title: DataObjectEnvelope securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "object": { "_id": "obj_9f8b7c6d5e4a3b2c1d0e", "spaceId": "space_12345abcde", "definitionId": "def_67890fghij", "definitionVersion": 1.1, "data": {}, "fieldMeta": {}, "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z", "createdBy": "user_janedoe", "updatedBy": "user_janedoe", "deletedAt": "2024-01-15T09:30:00Z", "provenance": {}, "review": {}, "origin": { "actionRunId": "run_20240115_093000", "playbookRunId": "playbook_20240115_093000" } } } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/spaces/spaceId/objects/definitionId/objectId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```