Get a data-object definition

GET

/objects/definitions/:definitionId

GET

/objects/definitions/:definitionId

$ curl https://api.cloudraker.com/objects/definitions/definitionId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "definition": {
3     "_id": "def_contract",
4     "nameSingular": "contract",
5     "namePlural": "contracts",
6     "labelSingular": "Contract",
7     "labelPlural": "Contracts",
8     "description": "A legal agreement between two or more parties outlining terms and conditions.",
9     "icon": "📄",
10     "color": "#4A90E2",
11     "labelFieldKey": "contractNumber",
12     "fields": [
13       {
14         "key": "contractNumber",
15         "type": "string",
16         "label": "Contract Number",
17         "required": true,
18         "unique": true,
19         "maxLength": 20
20       },
21       {
22         "key": "startDate",
23         "type": "date",
24         "label": "Start Date",
25         "required": true
26       },
27       {
28         "key": "endDate",
29         "type": "date",
30         "label": "End Date",
31         "required": false
32       },
33       {
34         "key": "parties",
35         "type": "array",
36         "label": "Parties Involved",
37         "items": {
38           "type": "string"
39         },
40         "required": true
41       },
42       {
43         "key": "status",
44         "type": "string",
45         "label": "Status",
46         "enum": [
47           "draft",
48           "active",
49           "expired",
50           "terminated"
51         ],
52         "default": "draft"
53       }
54     ],
55     "fieldGroups": [
56       {
57         "name": "General Information",
58         "fields": [
59           "contractNumber",
60           "startDate",
61           "endDate",
62           "status"
63         ]
64       },
65       {
66         "name": "Parties",
67         "fields": [
68           "parties"
69         ]
70       }
71     ],
72     "version": 1.1,
73     "archivedAt": "2024-01-15T09:30:00Z",
74     "createdAt": "2023-11-20T14:45:00Z",
75     "updatedAt": "2024-01-10T16:20:00Z",
76     "createdBy": "user_7a9f3d2c"
77   }
78 }

Fetches one org-level definition by id, including its full field list, groups, labels, and current version. Authorization: any authenticated org member. Unknown id returns 404.

Authentication

AuthorizationBearer

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

Path parameters

definitionIdstringRequired

Response

The definition.

definitionobject

Errors

404

Not Found Error