Retrieve an entity type object by ID

get/admin/storedObjects/{entityTypeId}

Retrieves an entity type by ID. An entity type is the metadata that is associated with documents.

Request Samples

1

Response Samples

1{
2 "id": "string",
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "lastUpdatedBy": "string",
6 "lastUpdatedAt": "2019-08-24T14:15:22Z",
7 "label": "string",
8 "description": "string",
9 "localizedLabels": [
10 {
11 "version": 0,
12 "locale": "en-US",
13 "label": "string"
14 }
15 ],
16 "localizedDescriptions": [
17 {
18 "version": 0,
19 "locale": "en-US",
20 "description": "string"
21 }
22 ],
23 "name": "string",
24 "dataStoreName": "string",
25 "tableName": "string",
26 "systemReserved": true,
27 "historyEnabled": true,
28 "version": 0,
29 "validFromFieldName": "string",
30 "validToFieldName": "string",
31 "lastUpdatedAtTimeFieldName": "string",
32 "createdAtTimeFieldName": "string",
33 "displayTextFields": [
34 {
35 "name": "string",
36 "displayIndex": 0
37 }
38 ],
39 "dataStoreAssignedTimeZone": "string",
40 "type": "MANAGED",
41 "markerColor": "#9d2b12",
42 "nodeShape": "CIRCLE",
43 "nodeColor": "#F0F1F2",
44 "borderColor": "#F0F1F2",
45 "borderWidth": -1.7976931348623157e+308,
46 "scale": -1.7976931348623157e+308,
47 "styles": [
48 {
49 "id": "string",
50 "conditionId": "string",
51 "evaluationOrder": 0,
52 "iconName": "string",
53 "markerCode": "string",
54 "nodeColor": "string",
55 "borderColor": "string",
56 "borderWidth": 0
57 }
58 ],
59 "elementGroupRoot": true,
60 "indexedForSearch": true,
61 "fields": [
62 {
63 "name": "string",
64 "columnName": "string",
65 "dataType": "BOOLEAN",
66 "length": 0,
67 "precision": 0,
68 "scale": 0,
69 "required": true,
70 "primaryKeyField": true,
71 "unique": true,
72 "autoGenerated": true,
73 "systemReserved": true,
74 "displayIndex": 0,
75 "version": 0,
76 "constrainingListName": "string",
77 "userSelectionStrategy": "USERS",
78 "allowMultipleSelections": true,
79 "primaryKeySeqNo": 0,
80 "readOnly": true,
81 "indexedForSearch": true,
82 "logicalDataType": "USER_GROUP",
83 "ownerName": "string",
84 "relatedElementName": "string"
85 }
86 ],
87 "relationshipsFrom": [
88 {
89 "reverseName": "string",
90 "reverseLabel": "string",
91 "fromObjectName": "string",
92 "fromObjectLabel": "string",
93 "toObjectName": "string",
94 "toObjectLabel": "string",
95 "required": true,
96 "cardinality": "ONE_TO_ONE",
97 "sortCriteria": {
98 "fieldName": "string",
99 "sortOrder": "asc"
100 },
101 "type": "DIRECT_CHILD",
102 "symmetric": true,
103 "managed": true,
104 "toObjectTypeFieldName": "string",
105 "toObjectTypeNames": [
106 "string"
107 ],
108 "joinKeyFieldName": "string",
109 "joinConditions": [
110 {
111 "type": "FieldRef"
112 }
113 ],
114 "fields": [
115 {
116 "name": "string",
117 "columnName": "string",
118 "dataType": "BOOLEAN",
119 "length": 0,
120 "precision": 0,
121 "scale": 0,
122 "required": true,
123 "primaryKeyField": true,
124 "unique": true,
125 "autoGenerated": true,
126 "systemReserved": true,
127 "displayIndex": 0,
128 "version": 0,
129 "constrainingListName": "string",
130 "userSelectionStrategy": "USERS",
131 "allowMultipleSelections": true,
132 "primaryKeySeqNo": 0,
133 "readOnly": true,
134 "indexedForSearch": true,
135 "logicalDataType": "USER_GROUP",
136 "ownerName": "string"
137 }
138 ],
139 "localizedReverseLabels": [
140 {
141 "version": 0,
142 "locale": "en-US",
143 "label": "string"
144 }
145 ],
146 "deleteTableName": "string",
147 "useCustomIndex": true,
148 "color": "string",
149 "width": 0,
150 "dashType": "solid",
151 "styles": [
152 {
153 "id": "string",
154 "conditionId": "string",
155 "evaluationOrder": 0,
156 "color": "string",
157 "width": 0,
158 "dashType": "solid"
159 }
160 ],
161 "reindexRequired": true
162 }
163 ],
164 "relationshipsTo": [
165 {
166 "reverseName": "string",
167 "reverseLabel": "string",
168 "fromObjectName": "string",
169 "fromObjectLabel": "string",
170 "toObjectName": "string",
171 "toObjectLabel": "string",
172 "required": true,
173 "cardinality": "ONE_TO_ONE",
174 "sortCriteria": {
175 "fieldName": "string",
176 "sortOrder": "asc"
177 },
178 "type": "DIRECT_CHILD",
179 "symmetric": true,
180 "managed": true,
181 "toObjectTypeFieldName": "string",
182 "toObjectTypeNames": [
183 "string"
184 ],
185 "joinKeyFieldName": "string",
186 "joinConditions": [],
187 "fields": [],
188 "localizedReverseLabels": [
189 {
190 "version": 0,
191 "locale": "en-US",
192 "label": "string"
193 }
194 ],
195 "deleteTableName": "string",
196 "useCustomIndex": true,
197 "color": "string",
198 "width": 0,
199 "dashType": "solid",
200 "styles": [
201 {
202 "id": "string",
203 "conditionId": "string",
204 "evaluationOrder": 0,
205 "color": "string",
206 "width": 0,
207 "dashType": "solid"
208 }
209 ],
210 "reindexRequired": true
211 }
212 ],
213 "defaultRegularIcon": {
214 "name": "string",
215 "imageType": "gif",
216 "imageLocation": "string",
217 "bytes": "string",
218 "version": 0
219 },
220 "defaultMapIcon": {
221 "name": "string",
222 "imageType": "gif",
223 "imageLocation": "string",
224 "bytes": "string",
225 "version": 0
226 },
227 "parentName": "string",
228 "allowElementGroupRootAssignment": true,
229 "deleteTableName": "string",
230 "urnFormat": "string",
231 "urnLength": 0,
232 "urnStartValue": -9223372036854776000,
233 "urnType": "UUID",
234 "requireSearchBeforeCreate": true,
235 "enableCasDistributedDataLoad": true,
236 "attachmentsIndexedForSearch": true,
237 "reindexRequired": true,
238 "mobileOfflineEnabled": true,
239 "publishCode": "OPEN"
240}

Path Parameters

NameTypeRequiredDescription
entityTypeId
string
true

The ID of the entity type object.

Query Parameters

NameTypeRequiredDescription
excludeUnauthorized
boolean
false

Specifies whether to exclude the results that the user is not authorized to view. Only admin users can set this to true.

Default:
false

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
404Not Found

The request did not find an entity type with a matching name.

Schema