> 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. # Create a data-object definition POST https://api.cloudraker.com/objects/definitions Content-Type: application/json 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 }`. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/data-objects/create-object-definition ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /objects/definitions: post: operationId: create-object-definition summary: Create a data-object definition description: >- 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 }`. tags: - dataObjects parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '201': description: The created definition. content: application/json: schema: $ref: '#/components/schemas/ObjectDefinitionEnvelope' '403': description: Caller is not an org admin. content: application/json: schema: description: Any type '422': description: '`validation_failed` — the definition body is invalid (see `issues`).' content: application/json: schema: description: Any type requestBody: content: application/json: schema: type: object properties: nameSingular: type: string labelSingular: type: string labelPlural: type: string namePlural: type: string description: type: string description: Defaults to ''. icon: type: string color: type: - string - 'null' labelFieldKey: type: string fields: type: array items: type: object additionalProperties: description: Any type description: >- Field descriptors. Each names a `key`, a `type` and its type-specific options. fieldGroups: type: array items: type: object additionalProperties: description: Any type required: - nameSingular - labelSingular - labelPlural - namePlural - icon - labelFieldKey - fields 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: ObjectDefinition: type: object properties: _id: type: string nameSingular: type: string namePlural: type: string labelSingular: type: string labelPlural: type: string description: type: string icon: type: string color: type: - string - 'null' labelFieldKey: type: string description: Field key whose value is the object’s display label. fields: type: array items: type: object additionalProperties: description: Any type description: >- The type-discriminated field model (13 field types plus composites). Emitted permissively so the resource stays navigable. fieldGroups: type: array items: type: object additionalProperties: description: Any type version: type: number format: double description: Bumps only on a schema-affecting change. archivedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time createdBy: type: string required: - _id - nameSingular - namePlural - labelSingular - labelPlural - description - icon - color - labelFieldKey - fields - fieldGroups - version - archivedAt - createdAt - updatedAt - createdBy title: ObjectDefinition ObjectDefinitionEnvelope: type: object properties: definition: $ref: '#/components/schemas/ObjectDefinition' required: - definition title: ObjectDefinitionEnvelope securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json { "nameSingular": "contract", "labelSingular": "Contract", "labelPlural": "Contracts", "namePlural": "contracts", "icon": "file-contract", "labelFieldKey": "title", "fields": [ {} ] } ``` **Response** ```json { "definition": { "_id": "def_contract", "nameSingular": "contract", "namePlural": "contracts", "labelSingular": "Contract", "labelPlural": "Contracts", "description": "A legal agreement between two or more parties outlining terms and conditions.", "icon": "file-contract", "color": "#4A90E2", "labelFieldKey": "title", "fields": [ {} ], "fieldGroups": [ {} ], "version": 1.1, "archivedAt": "2024-01-15T09:30:00Z", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z", "createdBy": "admin_user_123" } } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/objects/definitions" payload = { "nameSingular": "contract", "labelSingular": "Contract", "labelPlural": "Contracts", "namePlural": "contracts", "icon": "file-contract", "labelFieldKey": "title", "fields": [{}] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/objects/definitions'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"nameSingular":"contract","labelSingular":"Contract","labelPlural":"Contracts","namePlural":"contracts","icon":"file-contract","labelFieldKey":"title","fields":[{}]}' }; 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/objects/definitions" payload := strings.NewReader("{\n \"nameSingular\": \"contract\",\n \"labelSingular\": \"Contract\",\n \"labelPlural\": \"Contracts\",\n \"namePlural\": \"contracts\",\n \"icon\": \"file-contract\",\n \"labelFieldKey\": \"title\",\n \"fields\": [\n {}\n ]\n}") req, _ := http.NewRequest("POST", 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/objects/definitions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"nameSingular\": \"contract\",\n \"labelSingular\": \"Contract\",\n \"labelPlural\": \"Contracts\",\n \"namePlural\": \"contracts\",\n \"icon\": \"file-contract\",\n \"labelFieldKey\": \"title\",\n \"fields\": [\n {}\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.cloudraker.com/objects/definitions") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"nameSingular\": \"contract\",\n \"labelSingular\": \"Contract\",\n \"labelPlural\": \"Contracts\",\n \"namePlural\": \"contracts\",\n \"icon\": \"file-contract\",\n \"labelFieldKey\": \"title\",\n \"fields\": [\n {}\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.cloudraker.com/objects/definitions', [ 'body' => '{ "nameSingular": "contract", "labelSingular": "Contract", "labelPlural": "Contracts", "namePlural": "contracts", "icon": "file-contract", "labelFieldKey": "title", "fields": [ {} ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/objects/definitions"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"nameSingular\": \"contract\",\n \"labelSingular\": \"Contract\",\n \"labelPlural\": \"Contracts\",\n \"namePlural\": \"contracts\",\n \"icon\": \"file-contract\",\n \"labelFieldKey\": \"title\",\n \"fields\": [\n {}\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "nameSingular": "contract", "labelSingular": "Contract", "labelPlural": "Contracts", "namePlural": "contracts", "icon": "file-contract", "labelFieldKey": "title", "fields": [[]] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/objects/definitions")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ```