Create a data-object definition

POST

https://api.cloudraker.com/objects/definitions

POST

/objects/definitions

curl -X POST https://api.cloudraker.com/objects/definitions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "nameSingular": "contract",
  "labelSingular": "string",
  "labelPlural": "string",
  "namePlural": "string",
  "icon": "string",
  "labelFieldKey": "string",
  "fields": [
    {}
  ]
}'

{
  "definition": {
    "_id": "def_contract",
    "nameSingular": "contract",
    "namePlural": "contracts",
    "labelSingular": "Contract",
    "labelPlural": "Contracts",
    "description": "string",
    "icon": "string",
    "color": "string",
    "labelFieldKey": "string",
    "fields": [
      {}
    ],
    "fieldGroups": [
      {}
    ],
    "version": 1.1,
    "archivedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdBy": "string"
  }
}

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 }.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

nameSingularstringRequired1-64 characters

labelSingularstringRequired1-200 characters

labelPluralstringRequired1-200 characters

namePluralstringRequired1-64 characters

iconstringRequired1-64 characters

labelFieldKeystringRequired>=1 character

fieldslist of maps from strings to anyRequired

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

descriptionstringOptional<=2000 characters

Free-form description of the definition. Omitted means empty.

colorstring or nullOptional

fieldGroupslist of maps from strings to anyOptional

Response

The created definition.

definitionobject

Errors

403

Forbidden Error

422

Unprocessable Entity Error