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

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