customization

Custom Schema Fragments Get

GET
Gets a custom schema fragment.

Query parameters

idstringRequired
The ID of the custom schema fragment.

Response

This endpoint returns an object
fragment
union
GET
1curl -G https://api.devrev.ai/schemas.custom.get \
2 -H "Authorization: <apiKey>" \
3 -d id=string
200
Retrieved
1{
2 "fragment": {
3 "type": "app_fragment",
4 "id": "string",
5 "app": "string",
6 "conditions": [
7 {
8 "string": {}
9 }
10 ],
11 "created_by": {
12 "type": "dev_user",
13 "id": "string",
14 "display_id": "string",
15 "display_name": "string",
16 "display_picture": {
17 "id": "string",
18 "display_id": "string"
19 },
20 "email": "string",
21 "full_name": "string",
22 "state": "active"
23 },
24 "created_date": "2023-01-01T00:00:00Z",
25 "deprecated": true,
26 "description": "string",
27 "display_id": "string",
28 "fields": [
29 {
30 "field_type": "array",
31 "value": {
32 "base_type": "bool",
33 "name": "string",
34 "default_value": [
35 true
36 ],
37 "description": "string",
38 "eq_items": 0,
39 "is_filterable": true,
40 "is_immutable": true,
41 "is_pii": true,
42 "is_required": true,
43 "max_items": 0,
44 "mfz": {
45 "string": {}
46 },
47 "min_items": 0,
48 "oasis": {
49 "string": {}
50 },
51 "origin": "string",
52 "ui": {
53 "create_view": {
54 "is_hidden": true
55 },
56 "detail_view": {
57 "is_hidden": true
58 },
59 "display_name": "string",
60 "filter_view": {
61 "is_hidden": true
62 },
63 "group_name": "string",
64 "is_active_in_detail_view": true,
65 "is_bulk_action_enabled": true,
66 "is_groupable": true,
67 "is_hidden": true,
68 "is_hidden_during_create": true,
69 "is_read_only": true,
70 "is_shown_in_summary": true,
71 "is_sortable": true,
72 "list_view": {
73 "is_hidden": true
74 },
75 "placeholder": "string",
76 "summary_view": {
77 "is_hidden": true
78 },
79 "tooltip": "string"
80 }
81 }
82 }
83 ],
84 "fragment_type": "app",
85 "leaf_type": "string",
86 "modified_by": {
87 "type": "dev_user",
88 "id": "string",
89 "display_id": "string",
90 "display_name": "string",
91 "display_picture": {
92 "id": "string",
93 "display_id": "string"
94 },
95 "email": "string",
96 "full_name": "string",
97 "state": "active"
98 },
99 "modified_date": "2023-01-01T00:00:00Z",
100 "new_fragment_ref": {
101 "type": "app_fragment",
102 "id": "string",
103 "display_id": "string"
104 },
105 "old_fragment_ref": {
106 "type": "app_fragment",
107 "id": "string",
108 "display_id": "string"
109 }
110 }
111}