Get Schemas Custom

GET

Gets a custom schema fragment.

Query parameters

idstringRequiredformat: "id"

The ID of the custom schema fragment.

Response

Success.

fragmentobject

GET

1 curl -G https://api.devrev.ai/schemas.custom.get \
2      -H "Authorization: Bearer <token>" \
3      -d id=id

200Retrieved

1 {
2   "fragment": {
3     "type": "app_fragment",
4     "created_by": {
5       "type": "dev_user",
6       "display_picture": {
7         "file": {
8           "type": "type",
9           "name": "name"
10         },
11         "id": "id",
12         "display_id": "display_id"
13       },
14       "id": "id",
15       "state": "active",
16       "display_id": "display_id",
17       "display_name": "display_name",
18       "email": "email",
19       "full_name": "full_name"
20     },
21     "fragment_type": "app",
22     "id": "id",
23     "modified_by": {
24       "type": "dev_user",
25       "display_picture": {
26         "file": {
27           "type": "type",
28           "name": "name"
29         },
30         "id": "id",
31         "display_id": "display_id"
32       },
33       "id": "id",
34       "state": "active",
35       "display_id": "display_id",
36       "display_name": "display_name",
37       "email": "email",
38       "full_name": "full_name"
39     },
40     "new_fragment_ref": {
41       "type": "app_fragment",
42       "id": "id",
43       "display_id": "display_id"
44     },
45     "old_fragment_ref": {
46       "type": "app_fragment",
47       "id": "id",
48       "display_id": "display_id"
49     },
50     "app": "app",
51     "app_display_name": "app_display_name",
52     "conditions": [
53       {
54         "effects": [
55           {
56             "fields": [
57               "fields",
58               "fields"
59             ],
60             "allowed_values": [],
61             "immutable": true,
62             "invalid": true,
63             "require": true,
64             "show": true
65           },
66           {
67             "fields": [
68               "fields",
69               "fields"
70             ],
71             "allowed_values": [],
72             "immutable": true,
73             "invalid": true,
74             "require": true,
75             "show": true
76           }
77         ],
78         "expression": "expression"
79       },
80       {
81         "effects": [
82           {
83             "fields": [
84               "fields",
85               "fields"
86             ],
87             "allowed_values": [],
88             "immutable": true,
89             "invalid": true,
90             "require": true,
91             "show": true
92           },
93           {
94             "fields": [
95               "fields",
96               "fields"
97             ],
98             "allowed_values": [],
99             "immutable": true,
100             "invalid": true,
101             "require": true,
102             "show": true
103           }
104         ],
105         "expression": "expression"
106       }
107     ],
108     "created_date": "created_date",
109     "deprecated": true,
110     "description": "description",
111     "display_id": "display_id",
112     "fields": [
113       {
114         "field_type": "array",
115         "base_type": "bool",
116         "description": "description",
117         "is_filterable": true,
118         "is_immutable": true,
119         "is_pii": true,
120         "is_required": true,
121         "mfz": {},
122         "name": "name",
123         "oasis": {},
124         "origin": "origin",
125         "ui": {
126           "client_overrides": [
127             {},
128             {}
129           ],
130           "create_view": {
131             "is_hidden": true
132           },
133           "detail_view": {
134             "is_hidden": true
135           },
136           "display_name": "display_name",
137           "filter_view": {
138             "is_hidden": true
139           },
140           "group_name": "group_name",
141           "is_active_in_detail_view": true,
142           "is_bulk_action_enabled": true,
143           "is_currency_field": true,
144           "is_groupable": true,
145           "is_hidden": true,
146           "is_hidden_during_create": true,
147           "is_read_only": true,
148           "is_required": true,
149           "is_shown_in_summary": true,
150           "is_sortable": true,
151           "list_view": {
152             "is_hidden": true
153           },
154           "order": 1,
155           "placeholder": "placeholder",
156           "summary_view": {
157             "is_hidden": true
158           },
159           "tooltip": "tooltip",
160           "unit": "unit"
161         },
162         "default_value": [
163           true,
164           true
165         ],
166         "eq_items": 1000000,
167         "max_items": 1000000,
168         "min_items": 1000000
169       },
170       {
171         "field_type": "array",
172         "base_type": "bool",
173         "description": "description",
174         "is_filterable": true,
175         "is_immutable": true,
176         "is_pii": true,
177         "is_required": true,
178         "mfz": {},
179         "name": "name",
180         "oasis": {},
181         "origin": "origin",
182         "ui": {
183           "client_overrides": [
184             {},
185             {}
186           ],
187           "create_view": {
188             "is_hidden": true
189           },
190           "detail_view": {
191             "is_hidden": true
192           },
193           "display_name": "display_name",
194           "filter_view": {
195             "is_hidden": true
196           },
197           "group_name": "group_name",
198           "is_active_in_detail_view": true,
199           "is_bulk_action_enabled": true,
200           "is_currency_field": true,
201           "is_groupable": true,
202           "is_hidden": true,
203           "is_hidden_during_create": true,
204           "is_read_only": true,
205           "is_required": true,
206           "is_shown_in_summary": true,
207           "is_sortable": true,
208           "list_view": {
209             "is_hidden": true
210           },
211           "order": 1,
212           "placeholder": "placeholder",
213           "summary_view": {
214             "is_hidden": true
215           },
216           "tooltip": "tooltip",
217           "unit": "unit"
218         },
219         "default_value": [
220           true,
221           true
222         ],
223         "eq_items": 1000000,
224         "max_items": 1000000,
225         "min_items": 1000000
226       }
227     ],
228     "leaf_type": "leaf_type",
229     "modified_date": "modified_date"
230   }
231 }

Get Schemas Custom (POST)

Up Next

Built with

1	curl -G https://api.devrev.ai/schemas.custom.get \
2	-H "Authorization: Bearer <token>" \
3	-d id=id

1	{
2	"fragment": {
3	"type": "app_fragment",
4	"created_by": {
5	"type": "dev_user",
6	"display_picture": {
7	"file": {
8	"type": "type",
9	"name": "name"
10	},
11	"id": "id",
12	"display_id": "display_id"
13	},
14	"id": "id",
15	"state": "active",
16	"display_id": "display_id",
17	"display_name": "display_name",
18	"email": "email",
19	"full_name": "full_name"
20	},
21	"fragment_type": "app",
22	"id": "id",
23	"modified_by": {
24	"type": "dev_user",
25	"display_picture": {
26	"file": {
27	"type": "type",
28	"name": "name"
29	},
30	"id": "id",
31	"display_id": "display_id"
32	},
33	"id": "id",
34	"state": "active",
35	"display_id": "display_id",
36	"display_name": "display_name",
37	"email": "email",
38	"full_name": "full_name"
39	},
40	"new_fragment_ref": {
41	"type": "app_fragment",
42	"id": "id",
43	"display_id": "display_id"
44	},
45	"old_fragment_ref": {
46	"type": "app_fragment",
47	"id": "id",
48	"display_id": "display_id"
49	},
50	"app": "app",
51	"app_display_name": "app_display_name",
52	"conditions": [
53	{
54	"effects": [
55	{
56	"fields": [
57	"fields",
58	"fields"
59	],
60	"allowed_values": [],
61	"immutable": true,
62	"invalid": true,
63	"require": true,
64	"show": true
65	},
66	{
67	"fields": [
68	"fields",
69	"fields"
70	],
71	"allowed_values": [],
72	"immutable": true,
73	"invalid": true,
74	"require": true,
75	"show": true
76	}
77	],
78	"expression": "expression"
79	},
80	{
81	"effects": [
82	{
83	"fields": [
84	"fields",
85	"fields"
86	],
87	"allowed_values": [],
88	"immutable": true,
89	"invalid": true,
90	"require": true,
91	"show": true
92	},
93	{
94	"fields": [
95	"fields",
96	"fields"
97	],
98	"allowed_values": [],
99	"immutable": true,
100	"invalid": true,
101	"require": true,
102	"show": true
103	}
104	],
105	"expression": "expression"
106	}
107	],
108	"created_date": "created_date",
109	"deprecated": true,
110	"description": "description",
111	"display_id": "display_id",
112	"fields": [
113	{
114	"field_type": "array",
115	"base_type": "bool",
116	"description": "description",
117	"is_filterable": true,
118	"is_immutable": true,
119	"is_pii": true,
120	"is_required": true,
121	"mfz": {},
122	"name": "name",
123	"oasis": {},
124	"origin": "origin",
125	"ui": {
126	"client_overrides": [
127	{},
128	{}
129	],
130	"create_view": {
131	"is_hidden": true
132	},
133	"detail_view": {
134	"is_hidden": true
135	},
136	"display_name": "display_name",
137	"filter_view": {
138	"is_hidden": true
139	},
140	"group_name": "group_name",
141	"is_active_in_detail_view": true,
142	"is_bulk_action_enabled": true,
143	"is_currency_field": true,
144	"is_groupable": true,
145	"is_hidden": true,
146	"is_hidden_during_create": true,
147	"is_read_only": true,
148	"is_required": true,
149	"is_shown_in_summary": true,
150	"is_sortable": true,
151	"list_view": {
152	"is_hidden": true
153	},
154	"order": 1,
155	"placeholder": "placeholder",
156	"summary_view": {
157	"is_hidden": true
158	},
159	"tooltip": "tooltip",
160	"unit": "unit"
161	},
162	"default_value": [
163	true,
164	true
165	],
166	"eq_items": 1000000,
167	"max_items": 1000000,
168	"min_items": 1000000
169	},
170	{
171	"field_type": "array",
172	"base_type": "bool",
173	"description": "description",
174	"is_filterable": true,
175	"is_immutable": true,
176	"is_pii": true,
177	"is_required": true,
178	"mfz": {},
179	"name": "name",
180	"oasis": {},
181	"origin": "origin",
182	"ui": {
183	"client_overrides": [
184	{},
185	{}
186	],
187	"create_view": {
188	"is_hidden": true
189	},
190	"detail_view": {
191	"is_hidden": true
192	},
193	"display_name": "display_name",
194	"filter_view": {
195	"is_hidden": true
196	},
197	"group_name": "group_name",
198	"is_active_in_detail_view": true,
199	"is_bulk_action_enabled": true,
200	"is_currency_field": true,
201	"is_groupable": true,
202	"is_hidden": true,
203	"is_hidden_during_create": true,
204	"is_read_only": true,
205	"is_required": true,
206	"is_shown_in_summary": true,
207	"is_sortable": true,
208	"list_view": {
209	"is_hidden": true
210	},
211	"order": 1,
212	"placeholder": "placeholder",
213	"summary_view": {
214	"is_hidden": true
215	},
216	"tooltip": "tooltip",
217	"unit": "unit"
218	},
219	"default_value": [
220	true,
221	true
222	],
223	"eq_items": 1000000,
224	"max_items": 1000000,
225	"min_items": 1000000
226	}
227	],
228	"leaf_type": "leaf_type",
229	"modified_date": "modified_date"
230	}
231	}