Get Schemas Aggregated

GET

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

GET

/schemas.aggregated.get

1 curl https://api.devrev.ai/schemas.aggregated.get \
2      -H "Authorization: Bearer <token>"

Try it

200aggregatedSchemaGetExample

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                   "is_required": true,
25                   "order": 42,
26                   "placeholder": "foo",
27                   "tooltip": "foo",
28                   "use_shorthand_notation": true,
29                   "view_overrides": [
30                     {}
31                   ]
32                 }
33               ],
34               "create_view": {
35                 "is_hidden": true
36               },
37               "decimal_places": 42,
38               "detail_view": {
39                 "is_hidden": true
40               },
41               "display_name": "foo",
42               "filter_view": {
43                 "is_hidden": true
44               },
45               "group_name": "foo",
46               "is_active_in_detail_view": true,
47               "is_bulk_action_enabled": true,
48               "is_currency_field": true,
49               "is_groupable": true,
50               "is_hidden": true,
51               "is_hidden_during_create": true,
52               "is_read_only": true,
53               "is_required": true,
54               "is_shown_in_summary": true,
55               "is_sortable": true,
56               "list_view": {
57                 "is_hidden": true
58               },
59               "order": 42,
60               "placeholder": "foo",
61               "summary_view": {
62                 "is_hidden": true
63               },
64               "tooltip": "foo",
65               "unit": "foo",
66               "use_shorthand_notation": true
67             },
68             "default_value": true
69           }
70         ],
71         "description": "foo",
72         "name": "foo"
73       }
74     ],
75     "custom_fields": [
76       {
77         "description": "foo",
78         "is_filterable": true,
79         "is_immutable": true,
80         "is_pii": true,
81         "is_required": true,
82         "mfz": {},
83         "name": "foo",
84         "oasis": {},
85         "origin": "foo",
86         "ui": {
87           "client_overrides": [
88             {
89               "client_name": "foo",
90               "decimal_places": 42,
91               "display_name": "foo",
92               "is_groupable": true,
93               "is_hidden": true,
94               "is_required": true,
95               "order": 42,
96               "placeholder": "foo",
97               "tooltip": "foo",
98               "use_shorthand_notation": true,
99               "view_overrides": [
100                 {
101                   "decimal_places": 42,
102                   "display_name": "foo",
103                   "is_groupable": true,
104                   "is_hidden": true,
105                   "is_required": true,
106                   "order": 42,
107                   "placeholder": "foo",
108                   "tooltip": "foo",
109                   "use_shorthand_notation": true,
110                   "view_name": "foo"
111                 }
112               ]
113             }
114           ],
115           "create_view": {
116             "is_hidden": true
117           },
118           "decimal_places": 42,
119           "detail_view": {
120             "is_hidden": true
121           },
122           "display_name": "foo",
123           "filter_view": {
124             "is_hidden": true
125           },
126           "group_name": "foo",
127           "is_active_in_detail_view": true,
128           "is_bulk_action_enabled": true,
129           "is_currency_field": true,
130           "is_groupable": true,
131           "is_hidden": true,
132           "is_hidden_during_create": true,
133           "is_read_only": true,
134           "is_required": true,
135           "is_shown_in_summary": true,
136           "is_sortable": true,
137           "list_view": {
138             "is_hidden": true
139           },
140           "order": 42,
141           "placeholder": "foo",
142           "summary_view": {
143             "is_hidden": true
144           },
145           "tooltip": "foo",
146           "unit": "foo",
147           "use_shorthand_notation": true
148         },
149         "default_value": true
150       }
151     ],
152     "stock_composite_schemas": [
153       {
154         "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                   "is_required": true,
174                   "order": 42,
175                   "placeholder": "foo",
176                   "tooltip": "foo",
177                   "use_shorthand_notation": true,
178                   "view_overrides": [
179                     {}
180                   ]
181                 }
182               ],
183               "create_view": {
184                 "is_hidden": true
185               },
186               "decimal_places": 42,
187               "detail_view": {
188                 "is_hidden": true
189               },
190               "display_name": "foo",
191               "filter_view": {
192                 "is_hidden": true
193               },
194               "group_name": "foo",
195               "is_active_in_detail_view": true,
196               "is_bulk_action_enabled": true,
197               "is_currency_field": true,
198               "is_groupable": true,
199               "is_hidden": true,
200               "is_hidden_during_create": true,
201               "is_read_only": true,
202               "is_required": true,
203               "is_shown_in_summary": true,
204               "is_sortable": true,
205               "list_view": {
206                 "is_hidden": true
207               },
208               "order": 42,
209               "placeholder": "foo",
210               "summary_view": {
211                 "is_hidden": true
212               },
213               "tooltip": "foo",
214               "unit": "foo",
215               "use_shorthand_notation": true
216             },
217             "default_value": true
218           }
219         ],
220         "description": "foo",
221         "name": "foo"
222       }
223     ],
224     "stock_fields": [
225       {
226         "description": "foo",
227         "is_filterable": true,
228         "is_immutable": true,
229         "is_pii": true,
230         "is_required": true,
231         "mfz": {},
232         "name": "foo",
233         "oasis": {},
234         "origin": "foo",
235         "ui": {
236           "client_overrides": [
237             {
238               "client_name": "foo",
239               "decimal_places": 42,
240               "display_name": "foo",
241               "is_groupable": true,
242               "is_hidden": true,
243               "is_required": true,
244               "order": 42,
245               "placeholder": "foo",
246               "tooltip": "foo",
247               "use_shorthand_notation": true,
248               "view_overrides": [
249                 {
250                   "decimal_places": 42,
251                   "display_name": "foo",
252                   "is_groupable": true,
253                   "is_hidden": true,
254                   "is_required": true,
255                   "order": 42,
256                   "placeholder": "foo",
257                   "tooltip": "foo",
258                   "use_shorthand_notation": true,
259                   "view_name": "foo"
260                 }
261               ]
262             }
263           ],
264           "create_view": {
265             "is_hidden": true
266           },
267           "decimal_places": 42,
268           "detail_view": {
269             "is_hidden": true
270           },
271           "display_name": "foo",
272           "filter_view": {
273             "is_hidden": true
274           },
275           "group_name": "foo",
276           "is_active_in_detail_view": true,
277           "is_bulk_action_enabled": true,
278           "is_currency_field": true,
279           "is_groupable": true,
280           "is_hidden": true,
281           "is_hidden_during_create": true,
282           "is_read_only": true,
283           "is_required": true,
284           "is_shown_in_summary": true,
285           "is_sortable": true,
286           "list_view": {
287             "is_hidden": true
288           },
289           "order": 42,
290           "placeholder": "foo",
291           "summary_view": {
292             "is_hidden": true
293           },
294           "tooltip": "foo",
295           "unit": "foo",
296           "use_shorthand_notation": true
297         },
298         "default_value": true
299       }
300     ],
301     "apps": [
302       "foo"
303     ],
304     "conditions": [
305       {
306         "effects": [
307           {
308             "fields": [
309               "foo"
310             ],
311             "allowed_values": [
312               "foo"
313             ],
314             "immutable": true,
315             "invalid": true,
316             "require": true,
317             "show": true
318           }
319         ],
320         "expression": "foo"
321       }
322     ],
323     "description": "foo",
324     "is_custom_leaf_type": true,
325     "leaf_type": "foo",
326     "stage_diagram_id": {
327       "id": "foo",
328       "display_id": "foo",
329       "name": "foo"
330     },
331     "stock_field_overrides": [
332       {
333         "is_required": true,
334         "name": "foo",
335         "uenum_values": [
336           {
337             "id": 42,
338             "label": "foo",
339             "ordinal": 42,
340             "is_deprecated": true,
341             "tooltip": "foo"
342           }
343         ],
344         "ui": {
345           "client_overrides": [
346             {
347               "client_name": "foo",
348               "decimal_places": 42,
349               "display_name": "foo",
350               "is_groupable": true,
351               "is_hidden": true,
352               "is_required": true,
353               "order": 42,
354               "placeholder": "foo",
355               "tooltip": "foo",
356               "use_shorthand_notation": true,
357               "view_overrides": [
358                 {
359                   "decimal_places": 42,
360                   "display_name": "foo",
361                   "is_groupable": true,
362                   "is_hidden": true,
363                   "is_required": true,
364                   "order": 42,
365                   "placeholder": "foo",
366                   "tooltip": "foo",
367                   "use_shorthand_notation": true,
368                   "view_name": "foo"
369                 }
370               ]
371             }
372           ],
373           "create_view": {
374             "is_hidden": true
375           },
376           "decimal_places": 42,
377           "detail_view": {
378             "is_hidden": true
379           },
380           "display_name": "foo",
381           "filter_view": {
382             "is_hidden": true
383           },
384           "group_name": "foo",
385           "is_active_in_detail_view": true,
386           "is_bulk_action_enabled": true,
387           "is_currency_field": true,
388           "is_groupable": true,
389           "is_hidden": true,
390           "is_hidden_during_create": true,
391           "is_read_only": true,
392           "is_required": true,
393           "is_shown_in_summary": true,
394           "is_sortable": true,
395           "list_view": {
396             "is_hidden": true
397           },
398           "order": 42,
399           "placeholder": "foo",
400           "summary_view": {
401             "is_hidden": true
402           },
403           "tooltip": "foo",
404           "unit": "foo",
405           "use_shorthand_notation": true
406         }
407       }
408     ],
409     "subtype": "foo",
410     "subtype_display_name": "foo",
411     "title": "foo"
412   }
413 }

Gets the aggregated schema.

Query parameters

custom_schema_spec.appslist of stringsOptional

List of apps.

custom_schema_spec.subtypestringOptionalformat: "text"

Name of the subtype.

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.

Get Schemas Aggregated

Headers

Query parameters

Response

Errors