Get Schemas Aggregated

GET

Gets the aggregated schema.

Query parameters

custom_schema_fragment_idslist of stringsOptional

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

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.

stock_schema_fragment_idstringOptionalformat: "id"

The stock schema fragment which is to be aggregated.

Response

Success.

schemaobject

List of custom fields from multiple source fragments.

Errors

GET

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

200aggregatedSchemaGetExample

1 {
2   "schema": {
3     "conditions": [
4       {
5         "effects": [
6           {
7             "fields": [
8               "foo"
9             ],
10             "allowed_values": [
11               "foo"
12             ],
13             "immutable": true,
14             "invalid": true,
15             "require": true,
16             "show": true
17           }
18         ],
19         "expression": "foo"
20       }
21     ],
22     "stock_field_overrides": [
23       {
24         "is_required": true,
25         "name": "foo",
26         "uenum_values": [
27           {
28             "id": 42,
29             "label": "foo",
30             "ordinal": 42,
31             "is_deprecated": true,
32             "tooltip": "foo"
33           }
34         ],
35         "ui": {
36           "client_overrides": [
37             {
38               "client_name": "foo",
39               "display_name": "foo",
40               "is_groupable": true,
41               "is_hidden": true,
42               "is_required": true,
43               "placeholder": "foo",
44               "tooltip": "foo",
45               "view_overrides": [
46                 {
47                   "display_name": "foo",
48                   "is_groupable": true,
49                   "is_hidden": true,
50                   "is_required": true,
51                   "placeholder": "foo",
52                   "tooltip": "foo",
53                   "view_name": "foo"
54                 }
55               ]
56             }
57           ],
58           "create_view": {
59             "is_hidden": true
60           },
61           "detail_view": {
62             "is_hidden": true
63           },
64           "display_name": "foo",
65           "filter_view": {
66             "is_hidden": true
67           },
68           "group_name": "foo",
69           "is_active_in_detail_view": true,
70           "is_bulk_action_enabled": true,
71           "is_currency_field": true,
72           "is_groupable": true,
73           "is_hidden": true,
74           "is_hidden_during_create": true,
75           "is_read_only": true,
76           "is_required": true,
77           "is_shown_in_summary": true,
78           "is_sortable": true,
79           "list_view": {
80             "is_hidden": true
81           },
82           "order": 42,
83           "placeholder": "foo",
84           "summary_view": {
85             "is_hidden": true
86           },
87           "tooltip": "foo",
88           "unit": "foo"
89         }
90       }
91     ]
92   }
93 }

Get Schemas Aggregated (POST)

Up Next

Built with

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

1	{
2	"schema": {
3	"conditions": [
4	{
5	"effects": [
6	{
7	"fields": [
8	"foo"
9	],
10	"allowed_values": [
11	"foo"
12	],
13	"immutable": true,
14	"invalid": true,
15	"require": true,
16	"show": true
17	}
18	],
19	"expression": "foo"
20	}
21	],
22	"stock_field_overrides": [
23	{
24	"is_required": true,
25	"name": "foo",
26	"uenum_values": [
27	{
28	"id": 42,
29	"label": "foo",
30	"ordinal": 42,
31	"is_deprecated": true,
32	"tooltip": "foo"
33	}
34	],
35	"ui": {
36	"client_overrides": [
37	{
38	"client_name": "foo",
39	"display_name": "foo",
40	"is_groupable": true,
41	"is_hidden": true,
42	"is_required": true,
43	"placeholder": "foo",
44	"tooltip": "foo",
45	"view_overrides": [
46	{
47	"display_name": "foo",
48	"is_groupable": true,
49	"is_hidden": true,
50	"is_required": true,
51	"placeholder": "foo",
52	"tooltip": "foo",
53	"view_name": "foo"
54	}
55	]
56	}
57	],
58	"create_view": {
59	"is_hidden": true
60	},
61	"detail_view": {
62	"is_hidden": true
63	},
64	"display_name": "foo",
65	"filter_view": {
66	"is_hidden": true
67	},
68	"group_name": "foo",
69	"is_active_in_detail_view": true,
70	"is_bulk_action_enabled": true,
71	"is_currency_field": true,
72	"is_groupable": true,
73	"is_hidden": true,
74	"is_hidden_during_create": true,
75	"is_read_only": true,
76	"is_required": true,
77	"is_shown_in_summary": true,
78	"is_sortable": true,
79	"list_view": {
80	"is_hidden": true
81	},
82	"order": 42,
83	"placeholder": "foo",
84	"summary_view": {
85	"is_hidden": true
86	},
87	"tooltip": "foo",
88	"unit": "foo"
89	}
90	}
91	]
92	}
93	}