Get Schemas Stock

GET

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

GET

/schemas.stock.get

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

Try it

200stockSchemaFragmentsGetExample

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

Gets a stock schema fragment.

Query parameters

idstringOptionalformat: "id"

The ID of the stock schema fragment.

leaf_typestringOptionalformat: "text"

The leaf type this fragment applies to.

Response

Success.

fragmentobject

Get Schemas Stock

Headers

Query parameters

Response

Errors