Wiki source code of ObjectDataTypes Endpoints

Last modified by Achraf El Kari on 2022/06/13 13:17
Show last authors
1 = Introduction =
2
3 The following table will explain how to get the list of DataTypes using the endpoints.
4
5
6 = Endpoints =
7
8
9 |(% style="width:352px" %)**URL [method]**|(% style="width:353px" %)**Description**|(% style="width:337px" %)**Input example**|(% style="width:609px" %)**Output example**|(% style="width:609px" %)__Comments__
10 |(% style="width:352px" %)/rest/dataTypes/tracking/{trackingType} [GET]|(% style="width:353px" %)Get the dataTypes list of an indicated __**tracking type**__.|(% style="width:337px" %)The {trackingType} bracket should be replaced by the environment's Tracking type alias.|(% style="width:609px" %)(((
11 eg : for **trackingType = orderLine** 
12
13 {{code language="JSON"}}
14 [
15 {
16 "alias": "id",
17 "isId": true,
18 "translations": {
19 "fr": "Identifiant",
20 "en": "Key"
21 },
22 "type": "STRING",
23 "dataType": "orderLine",
24 "size": 40,
25 "defaultValue": null,
26 "mandatory": false,
27 "children": [],
28 "isList": false
29 },
30 {
31 "alias": "_metadata",
32 "isId": false,
33 "translations": {
34 "fr": "Metadata",
35 "en": "Metadata"
36 },
37 "type": "OBJECT",
38 "dataType": "metadata",
39 "size": 40,
40 "defaultValue": null,
41 "mandatory": false,
42 "children": [
43 {
44 "size": 40,
45 "children": [],
46 "defaultValue": null,
47 "dataType": "metadata",
48 "alias": "jobID",
49 "label": {
50 "en": "Job ID",
51 "fr": "ID du Job"
52 },
53 "type": "STRING",
54 "mandatory": false,
55 "isList": false
56 },
57 {
58 "size": 40,
59 "children": [],
60 "defaultValue": null,
61 "dataType": "metadata",
62 "alias": "fileID",
63 "label": {
64 "en": "fileID",
65 "fr": "fileID"
66 },
67 "type": "LIST",
68 "mandatory": false,
69 "isList": true
70 },
71 {
72 "size": 40,
73 "children": [],
74 "defaultValue": null,
75 "dataType": "metadata",
76 "alias": "envID",
77 "label": {
78 "en": "envID",
79 "fr": "envID"
80 },
81 "type": "STRING",
82 "mandatory": false,
83 "isList": false
84 },
85 {
86 "size": 40,
87 "children": [],
88 "defaultValue": null,
89 "dataType": "metadata",
90 "alias": "statusTracking",
91 "label": {
92 "en": "Tracking status",
93 "fr": "Status tracking"
94 },
95 "type": "STRING",
96 "mandatory": false,
97 "isList": false
98 },
99 {
100 "size": 40,
101 "children": [],
102 "defaultValue": null,
103 "dataType": "metadata",
104 "alias": "creationDate",
105 "label": {
106 "en": "Creation's date",
107 "fr": "Date de création"
108 },
109 "type": "DATE",
110 "mandatory": false,
111 "isList": false
112 },
113 {
114 "size": 40,
115 "children": [],
116 "defaultValue": null,
117 "dataType": "metadata",
118 "alias": "statusTrackingHistory",
119 "label": {
120 "en": "Tracking status history",
121 "fr": "Historique des status tracking"
122 },
123 "type": "LIST",
124 "mandatory": false,
125 "isList": true
126 }
127 ],
128 "isList": false
129 },
130 {
131 "alias": "orderLineNumber",
132 "isId": false,
133 "translations": {
134 "fr": "Numéro de commande",
135 "en": "Order Number"
136 },
137 "type": "NUMBER",
138 "dataType": "orderLine",
139 "size": 10,
140 "defaultValue": null,
141 "mandatory": true,
142 "children": [],
143 "isList": false
144 },
145 {
146 "alias": "Column1",
147 "isId": false,
148 "translations": {
149 "fr": "Column 1",
150 "en": "C1"
151 },
152 "type": "LIST<OBJECT>",
153 "dataType": "orderLine",
154 "size": null,
155 "defaultValue": null,
156 "mandatory": false,
157 "children": [
158 {
159 "alias": "description1",
160 "isId": false,
161 "translations": {
162 "fr": "Comment 1",
163 "en": "Order Number"
164 },
165 "type": "STRING",
166 "dataType": "comment",
167 "size": 10,
168 "defaultValue": null,
169 "mandatory": false,
170 "children": [],
171 "isList": false
172 },
173 {
174 "alias": "description2",
175 "isId": false,
176 "translations": {
177 "fr": "Column 1",
178 "en": "C1"
179 },
180 "type": "STRING",
181 "dataType": "comment",
182 "size": null,
183 "defaultValue": null,
184 "mandatory": false,
185 "children": [],
186 "isList": false
187 }
188 ],
189 "isList": true
190 }
191 ]
192 {{/code}}
193 )))|(% style="width:609px" %)
194 |(% style="width:352px" %)/rest/dataTypes/system/{data}|(% style="width:353px" %)Get the dataTypes list of indicated **__data__**.|(% style="width:337px" %)The {data} bracket should be replaced by the environment's data's alias.|(% style="width:609px" %)(((
195 eg : for **data = environment**
196
197 {{code language="JSON"}}
198 [
199 {
200 "isId": true,
201 "size": 10,
202 "children": [],
203 "translations": {
204 "en": "Environment ID",
205 "fr": "Environnement ID"
206 },
207 "defaultValue": null,
208 "dataType": "environment",
209 "alias": "envid",
210 "type": "NUMBER",
211 "mandatory": false,
212 "isList": false
213 },
214 {
215 "size": 10,
216 "children": [],
217 "translations": {
218 "en": "parent Environment ID",
219 "fr": "parent Environment ID"
220 },
221 "defaultValue": null,
222 "dataType": "environment",
223 "alias": "parent",
224 "type": "NUMBER",
225 "mandatory": false,
226 "isList": false
227 },
228 {
229 "size": 10,
230 "children": [],
231 "translations": {
232 "en": "Alias",
233 "fr": "Alias"
234 },
235 "defaultValue": null,
236 "dataType": "environment",
237 "alias": "alias",
238 "type": "STRING",
239 "mandatory": true,
240 "isList": false
241 },
242 {
243 "size": 10,
244 "children": [],
245 "translations": {
246 "en": "Code",
247 "fr": "Code"
248 },
249 "defaultValue": null,
250 "dataType": "environment",
251 "alias": "code",
252 "type": "STRING",
253 "mandatory": false,
254 "isList": false
255 },
256 {
257 "size": 10,
258 "children": [],
259 "translations": {
260 "en": "Send URL",
261 "fr": "Envoi de l'URL"
262 },
263 "defaultValue": null,
264 "dataType": "environment",
265 "alias": "sendurl",
266 "type": "BOOLEAN",
267 "mandatory": false,
268 "isList": false
269 },
270 {
271 "size": 10,
272 "children": [],
273 "translations": {
274 "en": "Enabled",
275 "fr": "Active"
276 },
277 "defaultValue": null,
278 "dataType": "environment",
279 "alias": "active",
280 "type": "BOOLEAN",
281 "mandatory": true,
282 "isList": false
283 },
284 {
285 "size": 10,
286 "children": [],
287 "translations": {
288 "en": "Time zone",
289 "fr": "fuseau horaire"
290 },
291 "defaultValue": null,
292 "dataType": "environment",
293 "alias": "timezone",
294 "type": "STRING",
295 "mandatory": true,
296 "isList": false
297 },
298 {
299 "size": 10,
300 "children": [],
301 "translations": {
302 "en": "git repository",
303 "fr": "git repository"
304 },
305 "defaultValue": null,
306 "dataType": "environment",
307 "alias": "gitRepository",
308 "type": "STRING",
309 "mandatory": false,
310 "isList": false
311 }
312 ]
313 {{/code}}
314
315
316
317 )))|(% style="width:609px" %)
318
319 ===== NB : =====
320
321 * Detail of each field:
322 ** **"dataType" **: the tracking type concerned
323 ** **"mandatory"**: is it obligatory or not? true or false.
324 ** **"type"**: type of data (STRING, NUMBER, BOOLEAN, DATE, LIST<OBJECT>, OBJECT, LIST)
325 ** **"alias"**: the path to the field
326
327
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian