Archive (or purge) a data-object definition

DELETE

/objects/definitions/:definitionId

DELETE

/objects/definitions/:definitionId

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

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         "contractNumber": {
15           "type": "string",
16           "required": true,
17           "description": "Unique identifier for the contract"
18         },
19         "startDate": {
20           "type": "date",
21           "required": true,
22           "description": "Contract start date"
23         },
24         "endDate": {
25           "type": "date",
26           "required": false,
27           "description": "Contract end date"
28         },
29         "parties": {
30           "type": "array",
31           "items": {
32             "type": "string"
33           },
34           "description": "List of parties involved in the contract"
35         }
36       }
37     ],
38     "fieldGroups": [
39       {
40         "general": {
41           "label": "General Information",
42           "fields": [
43             "contractNumber",
44             "startDate",
45             "endDate"
46           ]
47         },
48         "participants": {
49           "label": "Parties Involved",
50           "fields": [
51             "parties"
52           ]
53         }
54       }
55     ],
56     "version": 1.1,
57     "archivedAt": "2024-01-15T09:30:00Z",
58     "createdAt": "2023-11-20T14:00:00Z",
59     "updatedAt": "2024-01-10T16:45:00Z",
60     "createdBy": "admin_user_123"
61   }
62 }

Soft-archives a definition. Authorization: organization administrators only — other callers get 403. Query: purge=true forces removal even when live objects exist; without it, a definition that still has live objects returns 409 objects_exist (with count). Unknown id → 404. Returns the archived { definition }.

Authentication

AuthorizationBearer

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

Path parameters

definitionIdstringRequired

Query parameters

purgeenumOptional

Pass true to archive even when live objects still exist (they are left untouched).

Allowed values:

Response

The archived definition.

definitionobject

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error