Get Schemas Custom

GET

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

GET

/schemas.custom.get

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

Try it

200Retrieved

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

Gets a custom schema fragment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringRequiredformat: "id"

The ID of the custom schema fragment.

Response

Success.

fragmentobject

Authentication

Query parameters

Response

Errors