Get a definition compiled to JSON Schema

GET

/objects/definitions/:definitionId/schema

GET

/objects/definitions/:definitionId/schema

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

1 {
2   "schema": {
3     "$schema": "http://json-schema.org/draft-07/schema#",
4     "title": "UserProfile",
5     "type": "object",
6     "properties": {
7       "id": {
8         "type": "string",
9         "format": "uuid",
10         "description": "Unique identifier for the user profile"
11       },
12       "username": {
13         "type": "string",
14         "minLength": 3,
15         "maxLength": 30,
16         "description": "User's unique username"
17       },
18       "email": {
19         "type": "string",
20         "format": "email",
21         "description": "User's email address"
22       },
23       "createdAt": {
24         "type": "string",
25         "format": "date-time",
26         "description": "Timestamp when the profile was created"
27       },
28       "isActive": {
29         "type": "boolean",
30         "description": "Indicates if the user profile is active"
31       }
32     },
33     "required": [
34       "id",
35       "username",
36       "email",
37       "createdAt",
38       "isActive"
39     ],
40     "additionalProperties": false
41   }
42 }

Returns the definition compiled to a JSON Schema ({ schema }) describing the shape objects of this definition must satisfy — useful for validating object data before a create/patch. 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 compiled JSON Schema.

schemamap from strings to any

JSON Schema an object’s data must satisfy for this definition.

Errors

404

Not Found Error