Get Schemas Stock (POST)

POST

Gets a stock schema fragment.

Request

This endpoint expects an object.

idstringOptionalformat: "id"

The ID of the stock schema fragment.

leaf_typestringOptionalformat: "text"

The leaf type this fragment applies to.

Response

Success.

fragmentobject

POST

1 curl -X POST https://api.devrev.ai/schemas.stock.get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

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

List Schemas Stock

Up Next

Built with

1	curl -X POST https://api.devrev.ai/schemas.stock.get \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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