Get Schemas Aggregated (POST)

POST

https://api.devrev.ai/schemas.aggregated.get

POST

/schemas.aggregated.get

1 curl -X POST https://api.devrev.ai/schemas.aggregated.get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "schema": {
3     "custom_composite_schemas": [
4       {
5         "fields": [
6           {
7             "description": "foo",
8             "is_filterable": true,
9             "is_immutable": true,
10             "is_pii": true,
11             "is_required": true,
12             "mfz": {},
13             "name": "foo",
14             "oasis": {},
15             "origin": "foo",
16             "ui": {
17               "client_overrides": [
18                 {
19                   "client_name": "foo",
20                   "decimal_places": 42,
21                   "display_name": "foo",
22                   "is_groupable": true,
23                   "is_hidden": true,
24                   "order": 42,
25                   "placeholder": "foo",
26                   "tooltip": "foo",
27                   "use_shorthand_notation": true,
28                   "view_overrides": [
29                     {}
30                   ]
31                 }
32               ],
33               "decimal_places": 42,
34               "display_name": "foo",
35               "group_name": "foo",
36               "is_groupable": true,
37               "is_hidden": true,
38               "is_sortable": true,
39               "order": 42,
40               "placeholder": "foo",
41               "tooltip": "foo",
42               "unit": "foo",
43               "use_shorthand_notation": true
44             },
45             "default_value": true
46           }
47         ],
48         "description": "foo",
49         "name": "foo"
50       }
51     ],
52     "custom_fields": [
53       {
54         "description": "foo",
55         "is_filterable": true,
56         "is_immutable": true,
57         "is_pii": true,
58         "is_required": true,
59         "mfz": {},
60         "name": "foo",
61         "oasis": {},
62         "origin": "foo",
63         "ui": {
64           "client_overrides": [
65             {
66               "client_name": "foo",
67               "decimal_places": 42,
68               "display_name": "foo",
69               "is_groupable": true,
70               "is_hidden": true,
71               "order": 42,
72               "placeholder": "foo",
73               "tooltip": "foo",
74               "use_shorthand_notation": true,
75               "view_overrides": [
76                 {
77                   "decimal_places": 42,
78                   "display_name": "foo",
79                   "is_groupable": true,
80                   "is_hidden": true,
81                   "order": 42,
82                   "placeholder": "foo",
83                   "tooltip": "foo",
84                   "use_shorthand_notation": true,
85                   "view_name": "foo"
86                 }
87               ]
88             }
89           ],
90           "decimal_places": 42,
91           "display_name": "foo",
92           "group_name": "foo",
93           "is_groupable": true,
94           "is_hidden": true,
95           "is_sortable": true,
96           "order": 42,
97           "placeholder": "foo",
98           "tooltip": "foo",
99           "unit": "foo",
100           "use_shorthand_notation": true
101         },
102         "default_value": true
103       }
104     ],
105     "stock_composite_schemas": [
106       {
107         "fields": [
108           {
109             "description": "foo",
110             "is_filterable": true,
111             "is_immutable": true,
112             "is_pii": true,
113             "is_required": true,
114             "mfz": {},
115             "name": "foo",
116             "oasis": {},
117             "origin": "foo",
118             "ui": {
119               "client_overrides": [
120                 {
121                   "client_name": "foo",
122                   "decimal_places": 42,
123                   "display_name": "foo",
124                   "is_groupable": true,
125                   "is_hidden": true,
126                   "order": 42,
127                   "placeholder": "foo",
128                   "tooltip": "foo",
129                   "use_shorthand_notation": true,
130                   "view_overrides": [
131                     {}
132                   ]
133                 }
134               ],
135               "decimal_places": 42,
136               "display_name": "foo",
137               "group_name": "foo",
138               "is_groupable": true,
139               "is_hidden": true,
140               "is_sortable": true,
141               "order": 42,
142               "placeholder": "foo",
143               "tooltip": "foo",
144               "unit": "foo",
145               "use_shorthand_notation": true
146             },
147             "default_value": true
148           }
149         ],
150         "description": "foo",
151         "name": "foo"
152       }
153     ],
154     "stock_fields": [
155       {
156         "description": "foo",
157         "is_filterable": true,
158         "is_immutable": true,
159         "is_pii": true,
160         "is_required": true,
161         "mfz": {},
162         "name": "foo",
163         "oasis": {},
164         "origin": "foo",
165         "ui": {
166           "client_overrides": [
167             {
168               "client_name": "foo",
169               "decimal_places": 42,
170               "display_name": "foo",
171               "is_groupable": true,
172               "is_hidden": true,
173               "order": 42,
174               "placeholder": "foo",
175               "tooltip": "foo",
176               "use_shorthand_notation": true,
177               "view_overrides": [
178                 {
179                   "decimal_places": 42,
180                   "display_name": "foo",
181                   "is_groupable": true,
182                   "is_hidden": true,
183                   "order": 42,
184                   "placeholder": "foo",
185                   "tooltip": "foo",
186                   "use_shorthand_notation": true,
187                   "view_name": "foo"
188                 }
189               ]
190             }
191           ],
192           "decimal_places": 42,
193           "display_name": "foo",
194           "group_name": "foo",
195           "is_groupable": true,
196           "is_hidden": true,
197           "is_sortable": true,
198           "order": 42,
199           "placeholder": "foo",
200           "tooltip": "foo",
201           "unit": "foo",
202           "use_shorthand_notation": true
203         },
204         "default_value": true
205       }
206     ],
207     "apps": [
208       "foo"
209     ],
210     "conditions": [
211       {
212         "effects": [
213           {
214             "fields": [
215               "foo"
216             ],
217             "allowed_values": [
218               "foo"
219             ],
220             "immutable": true,
221             "require": true,
222             "show": true
223           }
224         ],
225         "expression": "foo"
226       }
227     ],
228     "description": "foo",
229     "is_custom_leaf_type": true,
230     "leaf_type": "foo",
231     "stage_diagram_id": {
232       "id": "foo",
233       "display_id": "foo",
234       "name": "foo"
235     },
236     "stock_field_overrides": [
237       {
238         "is_required": true,
239         "name": "foo",
240         "ui": {
241           "client_overrides": [
242             {
243               "client_name": "foo",
244               "decimal_places": 42,
245               "display_name": "foo",
246               "is_groupable": true,
247               "is_hidden": true,
248               "order": 42,
249               "placeholder": "foo",
250               "tooltip": "foo",
251               "use_shorthand_notation": true,
252               "view_overrides": [
253                 {
254                   "decimal_places": 42,
255                   "display_name": "foo",
256                   "is_groupable": true,
257                   "is_hidden": true,
258                   "order": 42,
259                   "placeholder": "foo",
260                   "tooltip": "foo",
261                   "use_shorthand_notation": true,
262                   "view_name": "foo"
263                 }
264               ]
265             }
266           ],
267           "decimal_places": 42,
268           "display_name": "foo",
269           "group_name": "foo",
270           "is_groupable": true,
271           "is_hidden": true,
272           "is_sortable": true,
273           "order": 42,
274           "placeholder": "foo",
275           "tooltip": "foo",
276           "unit": "foo",
277           "use_shorthand_notation": true
278         }
279       }
280     ],
281     "subtype": "foo",
282     "subtype_display_name": "foo"
283   }
284 }

Gets the aggregated schema.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

custom_schema_specobjectOptional

Custom schemas described using identifiers

is_custom_leaf_typebooleanOptional

Whether the leaf type corresponds to a custom object.

leaf_typestringOptionalformat: "text"

The leaf type. Used for inferring the default stage diagram and tenant fragment ID.

Response

Success.

schemaobject

List of custom fields from multiple source fragments.

Headers

Request

Response

Errors