Changes for page DataList Endpoints
Last modified by Outhman Moustaghfir on 2022/06/13 13:17
edited by Outhman Moustaghfir
on 2021/11/29 15:04
on 2021/11/29 15:04
edited by Outhman Moustaghfir
on 2021/11/29 14:52
on 2021/11/29 14:52
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,196 +4,13 @@ 4 4 5 5 = Endpoints = 6 6 7 -All datalists are grouped by thecurrent envrionment.7 +All datalists are grouped by 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" %)(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" %) 78 -|(% style="width:261px" %)/rest/datalist/{alias} [GET]|(% style="width:318px" %)get a datalist by alias.|(% style="width:405px" %)((( 79 -the {alias} must be replaced by the wanted alias. 80 - 81 -eg : 82 - 83 -/rest/datalist/city 84 - 85 -/rest/datalist/country 86 - 87 - 88 -)))|(% style="width:460px" %)((( 89 -for : /rest/datalist/city, the response will look like : 90 - 91 -{{code language="JSON"}} 92 -{ 93 - "timestamp": 1638194572812, 94 - "status": "200", 95 - "data": { 96 - "datalistid": null, 97 - "alias": "city", 98 - "label": { 99 - "fr": "Ville", 100 - "en": "City" 101 - }, 102 - "env": "iXPath", 103 - "global": false, 104 - "values": [ 105 - { 106 - "alias": "Casablanca", 107 - "label": { 108 - "fr": "Casablanca", 109 - "en": "Casablanca" 110 - }, 111 - "value": "Casablanca" 112 - }, 113 - { 114 - "alias": "Fez", 115 - "label": { 116 - "fr": "Fes", 117 - "en": "Fez" 118 - }, 119 - "value": "Fez" 120 - } 121 - ] 122 - } 123 -} 124 -{{/code}} 125 - 126 - 127 - 128 -)))|(% style="width:205px" %) 129 -|(% style="width:261px" %)/rest/datalist [POST]|(% style="width:318px" %)add a new datalist.|(% style="width:405px" %)((( 130 - 131 - 132 -{{code language="JSON"}} 133 -{ 134 - "alias" : "city", 135 - "label" : { 136 - "fr" : "Ville", 137 - "en" : "City" 138 - }, 139 - "global" : false, 140 - "values" : [ { 141 - "alias" : "Casablanca", 142 - "label" : { 143 - "fr" : "Casablanca", 144 - "en" : "Casablanca" 145 - }, 146 - "value" : "Casablanca" 147 - }, 148 - { 149 - "alias" : "Fez", 150 - "label" : { 151 - "fr" : "Fes", 152 - "en" : "Fez" 153 - }, 154 - "value" : "Fez" 155 - }] 156 -} 157 -{{/code}} 158 -)))|(% style="width:460px" %)((( 159 -the response is the object added to the database. 160 - 161 -{{code language="JSON"}} 162 -{ 163 - "timestamp": 1638194247251, 164 - "status": "200", 165 - "data": { 166 - "datalistid": null, 167 - "alias": "city", 168 - "label": { 169 - "fr": "Ville", 170 - "en": "City" 171 - }, 172 - "env": "iXPath", 173 - "global": false, 174 - "values": [ 175 - { 176 - "alias": "Casablanca", 177 - "label": { 178 - "fr": "Casablanca", 179 - "en": "Casablanca" 180 - }, 181 - "value": "Casablanca" 182 - }, 183 - { 184 - "alias": "Fez", 185 - "label": { 186 - "fr": "Fes", 187 - "en": "Fez" 188 - }, 189 - "value": "Fez" 190 - } 191 - ] 192 - } 193 -} 194 -{{/code}} 195 -)))|(% style="width:205px" %) 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" %) 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" %) 196 196 |(% 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" %) 197 -|(% style="width:261px" %)/rest/datalist/{alias} [DELETE]|(% style="width:318px" %)delete a 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" %) 198 198 199 199