gvsig-projects-pool / org.gvsig.vcsgis / trunk / org.gvsig.vcsgis / org.gvsig.vcsgis.lib / org.gvsig.vcsgis.lib.api / src / main / resources / org / gvsig / vcsgis / lib / vcsgisapiservices.json @ 2728
History | View | Annotate | Download (13.2 KB)
| 1 |
{
|
|---|---|
| 2 |
"openapi": "3.0.1", |
| 3 |
"info": {
|
| 4 |
"title": "VCSGis simple API", |
| 5 |
"description": "Simple API para acceder a los servicios de VCSGis", |
| 6 |
"version": "1.0.0" |
| 7 |
}, |
| 8 |
"paths": {
|
| 9 |
"/rowcreate": {
|
| 10 |
"post": {
|
| 11 |
"summary": "Crea un nuevo registro en una tabla/entidad", |
| 12 |
"operationId": "RowCreate", |
| 13 |
"requestBody": {
|
| 14 |
"description": "Datos para la creaci?n del nuevo registro", |
| 15 |
"content": {
|
| 16 |
"application/json": {
|
| 17 |
"schema": {
|
| 18 |
"$ref": "#/components/schemas/RowCreationRequest" |
| 19 |
} |
| 20 |
} |
| 21 |
}, |
| 22 |
"required": true |
| 23 |
}, |
| 24 |
"responses": {
|
| 25 |
"200": {
|
| 26 |
"description": "successful operation", |
| 27 |
"content": {
|
| 28 |
"application/json": {
|
| 29 |
"schema": {
|
| 30 |
"$ref": "#/components/schemas/RowCreationResponse" |
| 31 |
} |
| 32 |
} |
| 33 |
} |
| 34 |
} |
| 35 |
} |
| 36 |
} |
| 37 |
}, |
| 38 |
"/rowupdate": {
|
| 39 |
"post": {
|
| 40 |
"summary": "Actualiza un registro en una tabla/entidad", |
| 41 |
"operationId": "RowUpdate", |
| 42 |
"requestBody": {
|
| 43 |
"description": "Datos para la actualizaci?n de un registro", |
| 44 |
"content": {
|
| 45 |
"application/json": {
|
| 46 |
"schema": {
|
| 47 |
"$ref": "#/components/schemas/RowUpdateRequest" |
| 48 |
} |
| 49 |
} |
| 50 |
}, |
| 51 |
"required": true |
| 52 |
}, |
| 53 |
"responses": {
|
| 54 |
"200": {
|
| 55 |
"description": "successful operation", |
| 56 |
"content": {
|
| 57 |
"application/json": {
|
| 58 |
"schema": {
|
| 59 |
"$ref": "#/components/schemas/RowUpdateResponse" |
| 60 |
} |
| 61 |
} |
| 62 |
} |
| 63 |
} |
| 64 |
} |
| 65 |
} |
| 66 |
}, |
| 67 |
"/rowdelete": {
|
| 68 |
"post": {
|
| 69 |
"summary": "Elimina un registro en una tabla/entidad", |
| 70 |
"operationId": "RowDelete", |
| 71 |
"requestBody": {
|
| 72 |
"description": "Datos para la eliminaci?n de un registro", |
| 73 |
"content": {
|
| 74 |
"application/json": {
|
| 75 |
"schema": {
|
| 76 |
"$ref": "#/components/schemas/RowDeleteRequest" |
| 77 |
} |
| 78 |
} |
| 79 |
}, |
| 80 |
"required": true |
| 81 |
}, |
| 82 |
"responses": {
|
| 83 |
"200": {
|
| 84 |
"description": "successful operation", |
| 85 |
"content": {
|
| 86 |
"application/json": {
|
| 87 |
"schema": {
|
| 88 |
"$ref": "#/components/schemas/RowDeleteResponse" |
| 89 |
} |
| 90 |
} |
| 91 |
} |
| 92 |
} |
| 93 |
} |
| 94 |
} |
| 95 |
} |
| 96 |
}, |
| 97 |
"components": {
|
| 98 |
"schemas": {
|
| 99 |
"RowCreationRequest": {
|
| 100 |
"required": [
|
| 101 |
"EntityName",
|
| 102 |
"LocalRevisionCode",
|
| 103 |
"Data"
|
| 104 |
], |
| 105 |
"type": "object", |
| 106 |
"description": "Este objeto representa una petici?n de crear un nuevo registro en una tabla.\n\nEn el momento de creaci?n del registro se le asignara un c?digo ?nico en el VCS, sobreescribiendose el valor del atributo VCSGISCODE con el nuevo valor.\n\nUn ejemplo de petici?n para a?adir un registro a la tabla \"test\" podr?a ser algo como:\n <pre>\n {\n \"EntityName\":\"test\",\n \"LocalRevisionCode\":\"00000000000014abcdef0123456789\",\n \"EfectiveDate\":\"2020-02-18 10:11:12.123\",\n \"Comment\":\"test row create (4,ddd)\",\n \"Data\":\"\\n{\\n \\\"id\\\":4,\\n \\\"text\\\":\\\"DDD\\\",\\n \\\"VCSGISCODE\\\":\\\"\\\"\\n}\"\n }\n </pre>\n\n ", |
| 107 |
"properties": {
|
| 108 |
"EntityName": {
|
| 109 |
"type": "string", |
| 110 |
"description": "Nombre de la tabla en la que se solicita crear el nuevo registro" |
| 111 |
}, |
| 112 |
"LocalRevisionCode": {
|
| 113 |
"type": "string", |
| 114 |
"format": "string40", |
| 115 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente" |
| 116 |
}, |
| 117 |
"EfectiveDate": {
|
| 118 |
"type": "string", |
| 119 |
"format": "timestamp", |
| 120 |
"description": "Fecha de entrada en vigor de la operaci?n, en el formato yyyy-mm-dd hh:MM:ss.LLL . En caso de ser nulo se asignara la fecha actual." |
| 121 |
}, |
| 122 |
"Comment": {
|
| 123 |
"type": "string", |
| 124 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo." |
| 125 |
}, |
| 126 |
"Data": {
|
| 127 |
"type": "string", |
| 128 |
"description": "Los datos de la feature a crear en la tabla codificados como un string json. Si la feature tiene el campo VCSGISCODE sera sobreescrito, asign?ndole un nuevo c?digo." |
| 129 |
} |
| 130 |
} |
| 131 |
}, |
| 132 |
"RowCreationResponse": {
|
| 133 |
"type": "object", |
| 134 |
"description": "Este objeto representa a la respuesta a una petici?n de crear un nuevo registro en una tabla.\n\nNos informara del estado de la petici?n, as? como de:\n - El c?digo del nuevo registro creado.\n - El c?digo de la revisi?n en la que se ha quedado la \n tabla en el servidor.\n\n\nUn ejemplo de respuesta a a?adir un registro a la tabla \"test\" podr?a ser algo como:\n <pre>\n {\n \"StatusCode\":0,\n \"StatusMessage\":null,\n \"RelatedFeatureCode\":\"00000000000022abcdef0123456789\",\n \"EntityName\":\"test\",\n \"EntityCode\":\"00000000000002abcdef0123456789\",\n \"RevisionCode\":\"00000000000024abcdef0123456789\"\n }\n </pre>", |
| 135 |
"properties": {
|
| 136 |
"StatusCode": {
|
| 137 |
"type": "integer", |
| 138 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente." |
| 139 |
}, |
| 140 |
"StatusMessage": {
|
| 141 |
"type": "string", |
| 142 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema." |
| 143 |
}, |
| 144 |
"RelatedFeatureCode": {
|
| 145 |
"type": "string", |
| 146 |
"format": "string40", |
| 147 |
"description": "C?digo asignado al campo VCSGISCODE del nuevo registro, que representa al identificador de este en el VCS." |
| 148 |
}, |
| 149 |
"EntityName": {
|
| 150 |
"type": "string", |
| 151 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro" |
| 152 |
}, |
| 153 |
"EntityCode": {
|
| 154 |
"type": "string", |
| 155 |
"format": "string40", |
| 156 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica." |
| 157 |
}, |
| 158 |
"RevisionCode": {
|
| 159 |
"type": "string", |
| 160 |
"format": "string40", |
| 161 |
"description": "C?digo de la revisi?n en la que se encuentran los datos en el servidor tras realizarse la operaci?n." |
| 162 |
} |
| 163 |
} |
| 164 |
}, |
| 165 |
"RowUpdateRequest": {
|
| 166 |
"required": [
|
| 167 |
"EntityName",
|
| 168 |
"LocalRevisionCode",
|
| 169 |
"Data"
|
| 170 |
], |
| 171 |
"type": "object", |
| 172 |
"description": "Este objeto representa una petici?n para actualizar un registro en una tabla.\nEs imprescindible que el valor del atributo VCSGISCODE de los datos del registro que queremos actualizar tenga el c?digo correcto, ya que se utilizara este para identificar el registro que queremos actualizar.\nUn ejemplo de petici?n para actualizar un registro a la tabla \"test\" podr?a ser algo como:\n <pre>\n {\n \"EntityName\":\"test\",\n \"LocalRevisionCode\":\"00000000000024abcdef0123456789\",\n \"EfectiveDate\":null,\n \"Comment\":\"test row update (4,dd2)\",\n \"Data\":\"\\n{\\n \\\"id\\\":4,\\n \\\"text\\\":\\\"DD2\\\",\\n \\\"VCSGISCODE\\\":\\\"00000000000022abcdef0123456789\\\"\\n}\"\n }\n </pre>\n\n ", |
| 173 |
"properties": {
|
| 174 |
"EntityName": {
|
| 175 |
"type": "string", |
| 176 |
"description": "Nombre de la tabla en la que se solicita actualizar el registro" |
| 177 |
}, |
| 178 |
"LocalRevisionCode": {
|
| 179 |
"type": "string", |
| 180 |
"format": "string40", |
| 181 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente" |
| 182 |
}, |
| 183 |
"EfectiveDate": {
|
| 184 |
"type": "string", |
| 185 |
"format": "timestamp", |
| 186 |
"description": "Fecha de entrada en vigor de la operaci?n, en el formato yyyy-mm-dd hh:MM:ss.LLL . En caso de ser nulo se asignara la fecha actual." |
| 187 |
}, |
| 188 |
"Comment": {
|
| 189 |
"type": "string", |
| 190 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo." |
| 191 |
}, |
| 192 |
"Data": {
|
| 193 |
"type": "string", |
| 194 |
"description": "Los datos de la feature a crear en la tabla codificados como un string json. El atributo VCSGISCODE debe de tener un c?digo valido e identificara al registro que se esta actualizando." |
| 195 |
} |
| 196 |
} |
| 197 |
}, |
| 198 |
"RowUpdateResponse": {
|
| 199 |
"type": "object", |
| 200 |
"description": "Este objeto representa a la respuesta a una petici?n de actualizar un registro en una tabla.\n\nUn ejemplo de respuesta a actualizar un registro de la tabla *\"test\"* podr?a ser algo como:\n <pre>\n {\n \"StatusCode\":0,\n \"StatusMessage\":null,\n \"EntityName\":\"test\",\n \"EntityCode\":\"00000000000002abcdef0123456789\",\n \"RevisionCode\":\"00000000000029abcdef0123456789\"\n }\n </pre>", |
| 201 |
"properties": {
|
| 202 |
"StatusCode": {
|
| 203 |
"type": "integer", |
| 204 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente." |
| 205 |
}, |
| 206 |
"StatusMessage": {
|
| 207 |
"type": "string", |
| 208 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema." |
| 209 |
}, |
| 210 |
"EntityName": {
|
| 211 |
"type": "string", |
| 212 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro" |
| 213 |
}, |
| 214 |
"EntityCode": {
|
| 215 |
"type": "string", |
| 216 |
"format": "string40", |
| 217 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica." |
| 218 |
}, |
| 219 |
"RevisionCode": {
|
| 220 |
"type": "string", |
| 221 |
"format": "string40", |
| 222 |
"description": "C?digo de la revisi?n en la que se encuentran los datos en el servidor tras realizarse la operaci?n." |
| 223 |
} |
| 224 |
} |
| 225 |
}, |
| 226 |
"RowDeleteRequest": {
|
| 227 |
"required": [
|
| 228 |
"EntityName",
|
| 229 |
"LocalRevisionCode",
|
| 230 |
"RelatedFeatureCode"
|
| 231 |
], |
| 232 |
"type": "object", |
| 233 |
"description": "Este objeto representa una petici?n de eliminar un registro en una tabla.\n\nEl registro que se desea eliminar se identificara por el valor del atributo *RelatedFeatureCode*.\n\nUn ejemplo de petici?n para eliminar un registro de la tabla \"test\" podr?a ser algo como:\n <pre>\n {\n \"EntityName\":\"test\",\n \"LocalRevisionCode\":\"00000000000029abcdef0123456789\",\n \"RelatedFeatureCode\":\"00000000000022abcdef0123456789\",\n \"EfectiveDate\":\"2020-02-19 10:11:12.123\",\n \"Comment\":\"test row delete (4,dd2)\"\n }\n </pre>\n\n ", |
| 234 |
"properties": {
|
| 235 |
"EntityName": {
|
| 236 |
"type": "string", |
| 237 |
"description": "Nombre de la tabla en la que se solicita crear el nuevo registro" |
| 238 |
}, |
| 239 |
"LocalRevisionCode": {
|
| 240 |
"type": "string", |
| 241 |
"format": "string40", |
| 242 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente" |
| 243 |
}, |
| 244 |
"EfectiveDate": {
|
| 245 |
"type": "string", |
| 246 |
"format": "timestamp", |
| 247 |
"description": "Fecha de entrada en vigor de la operaci?n, en el formato yyyy-mm-dd hh:MM:ss.LLL . En caso de ser nulo se asignara la fecha actual." |
| 248 |
}, |
| 249 |
"Comment": {
|
| 250 |
"type": "string", |
| 251 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo." |
| 252 |
}, |
| 253 |
"RelatedFeatureCode": {
|
| 254 |
"type": "string", |
| 255 |
"format": "string40", |
| 256 |
"description": "C?digo del registro que se desea eliminar. Eliminara el registro que tenga como valor del atributo VCSGISCODE el valor de este campo." |
| 257 |
} |
| 258 |
} |
| 259 |
}, |
| 260 |
"RowDeleteResponse": {
|
| 261 |
"type": "object", |
| 262 |
"description": "Este objeto representa a la respuesta a una petici?n de eliminar un registro en una tabla.\n\nUn ejemplo de respuesta a eliminar un registro de la tabla \"test\" podr?a ser algo como:\n <pre>\n {\n \"StatusCode\":0,\n \"StatusMessage\":null,\n \"EntityName\":\"test\",\n \"EntityCode\":\"00000000000002abcdef0123456789\",\n \"RevisionCode\":\"00000000000034abcdef0123456789\"\n }\n </pre>", |
| 263 |
"properties": {
|
| 264 |
"StatusCode": {
|
| 265 |
"type": "integer", |
| 266 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente." |
| 267 |
}, |
| 268 |
"StatusMessage": {
|
| 269 |
"type": "string", |
| 270 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema." |
| 271 |
}, |
| 272 |
"EntityName": {
|
| 273 |
"type": "string", |
| 274 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro" |
| 275 |
}, |
| 276 |
"EntityCode": {
|
| 277 |
"type": "string", |
| 278 |
"format": "string40", |
| 279 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica." |
| 280 |
}, |
| 281 |
"RevisionCode": {
|
| 282 |
"type": "string", |
| 283 |
"format": "string40", |
| 284 |
"description": "C?digo de la revisi?n en la que se encuentran los datos en el servidor tras realizarse la operaci?n." |
| 285 |
} |
| 286 |
} |
| 287 |
} |
| 288 |
} |
| 289 |
} |
| 290 |
} |