Get Schemas Aggregated

GET

Gets the aggregated schema.

Query parameters

custom_schema_fragment_idsstringOptional

The list of custom schema fragment DONs which are to be aggregated.

leaf_typestringOptional

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

stock_schema_fragment_idstringOptional

The stock schema fragment which is to be aggregated.

Response

Success.

schemaobject

List of custom fields from multiple source fragments.

GET

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

200Retrieved

1 {
2   "schema": {
3     "stock_field_overrides": [
4       {
5         "is_required": true,
6         "name": "name",
7         "uenum_values": [
8           {
9             "id": 1000000,
10             "label": "label",
11             "ordinal": 1000000,
12             "is_deprecated": true,
13             "tooltip": "tooltip"
14           },
15           {
16             "id": 1000000,
17             "label": "label",
18             "ordinal": 1000000,
19             "is_deprecated": true,
20             "tooltip": "tooltip"
21           }
22         ],
23         "ui": {
24           "create_view": {
25             "is_hidden": true
26           },
27           "detail_view": {
28             "is_hidden": true
29           },
30           "display_name": "display_name",
31           "filter_view": {
32             "is_hidden": true
33           },
34           "group_name": "group_name",
35           "is_active_in_detail_view": true,
36           "is_bulk_action_enabled": true,
37           "is_currency_field": true,
38           "is_groupable": true,
39           "is_hidden": true,
40           "is_hidden_during_create": true,
41           "is_read_only": true,
42           "is_required": true,
43           "is_shown_in_summary": true,
44           "is_sortable": true,
45           "list_view": {
46             "is_hidden": true
47           },
48           "order": 1,
49           "placeholder": "placeholder",
50           "summary_view": {
51             "is_hidden": true
52           },
53           "tooltip": "tooltip",
54           "unit": "unit"
55         }
56       },
57       {
58         "is_required": true,
59         "name": "name",
60         "uenum_values": [
61           {
62             "id": 1000000,
63             "label": "label",
64             "ordinal": 1000000,
65             "is_deprecated": true,
66             "tooltip": "tooltip"
67           },
68           {
69             "id": 1000000,
70             "label": "label",
71             "ordinal": 1000000,
72             "is_deprecated": true,
73             "tooltip": "tooltip"
74           }
75         ],
76         "ui": {
77           "create_view": {
78             "is_hidden": true
79           },
80           "detail_view": {
81             "is_hidden": true
82           },
83           "display_name": "display_name",
84           "filter_view": {
85             "is_hidden": true
86           },
87           "group_name": "group_name",
88           "is_active_in_detail_view": true,
89           "is_bulk_action_enabled": true,
90           "is_currency_field": true,
91           "is_groupable": true,
92           "is_hidden": true,
93           "is_hidden_during_create": true,
94           "is_read_only": true,
95           "is_required": true,
96           "is_shown_in_summary": true,
97           "is_sortable": true,
98           "list_view": {
99             "is_hidden": true
100           },
101           "order": 1,
102           "placeholder": "placeholder",
103           "summary_view": {
104             "is_hidden": true
105           },
106           "tooltip": "tooltip",
107           "unit": "unit"
108         }
109       }
110     ]
111   }
112 }

Built with

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

1	{
2	"schema": {
3	"stock_field_overrides": [
4	{
5	"is_required": true,
6	"name": "name",
7	"uenum_values": [
8	{
9	"id": 1000000,
10	"label": "label",
11	"ordinal": 1000000,
12	"is_deprecated": true,
13	"tooltip": "tooltip"
14	},
15	{
16	"id": 1000000,
17	"label": "label",
18	"ordinal": 1000000,
19	"is_deprecated": true,
20	"tooltip": "tooltip"
21	}
22	],
23	"ui": {
24	"create_view": {
25	"is_hidden": true
26	},
27	"detail_view": {
28	"is_hidden": true
29	},
30	"display_name": "display_name",
31	"filter_view": {
32	"is_hidden": true
33	},
34	"group_name": "group_name",
35	"is_active_in_detail_view": true,
36	"is_bulk_action_enabled": true,
37	"is_currency_field": true,
38	"is_groupable": true,
39	"is_hidden": true,
40	"is_hidden_during_create": true,
41	"is_read_only": true,
42	"is_required": true,
43	"is_shown_in_summary": true,
44	"is_sortable": true,
45	"list_view": {
46	"is_hidden": true
47	},
48	"order": 1,
49	"placeholder": "placeholder",
50	"summary_view": {
51	"is_hidden": true
52	},
53	"tooltip": "tooltip",
54	"unit": "unit"
55	}
56	},
57	{
58	"is_required": true,
59	"name": "name",
60	"uenum_values": [
61	{
62	"id": 1000000,
63	"label": "label",
64	"ordinal": 1000000,
65	"is_deprecated": true,
66	"tooltip": "tooltip"
67	},
68	{
69	"id": 1000000,
70	"label": "label",
71	"ordinal": 1000000,
72	"is_deprecated": true,
73	"tooltip": "tooltip"
74	}
75	],
76	"ui": {
77	"create_view": {
78	"is_hidden": true
79	},
80	"detail_view": {
81	"is_hidden": true
82	},
83	"display_name": "display_name",
84	"filter_view": {
85	"is_hidden": true
86	},
87	"group_name": "group_name",
88	"is_active_in_detail_view": true,
89	"is_bulk_action_enabled": true,
90	"is_currency_field": true,
91	"is_groupable": true,
92	"is_hidden": true,
93	"is_hidden_during_create": true,
94	"is_read_only": true,
95	"is_required": true,
96	"is_shown_in_summary": true,
97	"is_sortable": true,
98	"list_view": {
99	"is_hidden": true
100	},
101	"order": 1,
102	"placeholder": "placeholder",
103	"summary_view": {
104	"is_hidden": true
105	},
106	"tooltip": "tooltip",
107	"unit": "unit"
108	}
109	}
110	]
111	}
112	}