From version 1.1 >
edited by Outhman Moustaghfir
on 2021/11/29 14:52
To version < 1.2 >
edited by Outhman Moustaghfir
on 2021/11/29 15:02
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,13 +4,146 @@
4 4  
5 5  = Endpoints =
6 6  
7 -All datalists are grouped by envrionment.
7 +All datalists are grouped by the current envrionment.
8 8  
9 9  |(% style="width:261px" %)**URL [method]**|(% style="width:318px" %)**Description**|(% style="width:405px" %)**Input example**|(% style="width:460px" %)**Output example**|(% style="width:205px" %)**Comments**
10 -|(% style="width:261px" %)/rest/datalist [GET]|(% style="width:318px" %)get all datalists of the current environment.|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
10 +|(% style="width:261px" %)/rest/datalist [GET]|(% style="width:318px" %)get all datalists of the current environment.|(% style="width:405px" %)(no input required)|(% style="width:460px" %)(((
11 +
12 +
13 +{{code language="JSON"}}
14 +{
15 + "timestamp": 1638194413239,
16 + "status": "200",
17 + "data": [
18 + {
19 + "datalistid": null,
20 + "alias": "country",
21 + "label": {
22 + "fr": "pays",
23 + "en": "country"
24 + },
25 + "env": "iXPath",
26 + "global": true,
27 + "values": [
28 + {
29 + "alias": "Morocco",
30 + "label": {
31 + "fr": "Maroc",
32 + "en": "Morocco"
33 + },
34 + "value": "Maroc"
35 + },
36 + {
37 + "alias": "Russia",
38 + "label": {
39 + "fr": "Russie",
40 + "en": "Russia"
41 + },
42 + "value": "Russia"
43 + }
44 + ]
45 + },
46 + {
47 + "datalistid": null,
48 + "alias": "city",
49 + "label": {
50 + "fr": "Ville",
51 + "en": "City"
52 + },
53 + "env": "iXPath",
54 + "global": false,
55 + "values": [
56 + {
57 + "alias": "Casablanca",
58 + "label": {
59 + "fr": "Casablanca",
60 + "en": "Casablanca"
61 + },
62 + "value": "Casablanca"
63 + },
64 + {
65 + "alias": "Fez",
66 + "label": {
67 + "fr": "Fes",
68 + "en": "Fez"
69 + },
70 + "value": "Fez"
71 + }
72 + ]
73 + }
74 + ]
75 +}
76 +{{/code}}
77 +)))|(% style="width:205px" %)
11 11  |(% style="width:261px" %)/rest/datalist/{alias} [GET]|(% style="width:318px" %)get a datalist by alias.|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
12 -|(% style="width:261px" %)/rest/datalist [POST]|(% style="width:318px" %)add a new datalist.|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
79 +|(% style="width:261px" %)/rest/datalist [POST]|(% style="width:318px" %)add a new datalist.|(% style="width:405px" %)(((
80 +
81 +
82 +{{code language="JSON"}}
83 +{
84 + "alias" : "city",
85 + "label" : {
86 + "fr" : "Ville",
87 + "en" : "City"
88 + },
89 + "global" : false,
90 + "values" : [ {
91 + "alias" : "Casablanca",
92 + "label" : {
93 + "fr" : "Casablanca",
94 + "en" : "Casablanca"
95 + },
96 + "value" : "Casablanca"
97 + },
98 + {
99 + "alias" : "Fez",
100 + "label" : {
101 + "fr" : "Fes",
102 + "en" : "Fez"
103 + },
104 + "value" : "Fez"
105 + }]
106 +}
107 +{{/code}}
108 +)))|(% style="width:460px" %)(((
109 +the response is the object added to the database.
110 +
111 +{{code language="JSON"}}
112 +{
113 + "timestamp": 1638194247251,
114 + "status": "200",
115 + "data": {
116 + "datalistid": null,
117 + "alias": "city",
118 + "label": {
119 + "fr": "Ville",
120 + "en": "City"
121 + },
122 + "env": "iXPath",
123 + "global": false,
124 + "values": [
125 + {
126 + "alias": "Casablanca",
127 + "label": {
128 + "fr": "Casablanca",
129 + "en": "Casablanca"
130 + },
131 + "value": "Casablanca"
132 + },
133 + {
134 + "alias": "Fez",
135 + "label": {
136 + "fr": "Fes",
137 + "en": "Fez"
138 + },
139 + "value": "Fez"
140 + }
141 + ]
142 + }
143 +}
144 +{{/code}}
145 +)))|(% style="width:205px" %)
13 13  |(% style="width:261px" %)/rest/datalist/{alias} [PUT]|(% style="width:318px" %)update an existing datalist by alias|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
14 -|(% style="width:261px" %)/rest/datalist/{alias} [DELETE]|(% style="width:318px" %)delete a datalist by alias|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
147 +|(% style="width:261px" %)/rest/datalist/{alias} [DELETE]|(% style="width:318px" %)delete a datalist by alias.|(% style="width:405px" %) |(% style="width:460px" %) |(% style="width:205px" %)
15 15  
16 16  
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian