Revision 2738
| 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 | ||
|---|---|---|
| 1 | 1 |
{
|
| 2 | 2 |
"openapi": "3.0.1", |
| 3 | 3 |
"info": {
|
| 4 |
"title": "VCSGis simple API",
|
|
| 5 |
"description": "Simple API para acceder a los servicios de VCSGis",
|
|
| 4 |
"title": "VCSGis Simple API",
|
|
| 5 |
"description": "Simple API to access VCSGis services",
|
|
| 6 | 6 |
"version": "1.0.0" |
| 7 | 7 |
}, |
| 8 | 8 |
"paths": {
|
| 9 | 9 |
"/rowcreate": {
|
| 10 | 10 |
"post": {
|
| 11 |
"summary": "Crea un nuevo registro en una tabla/entidad",
|
|
| 11 |
"summary": "Create a new record in a table/entity",
|
|
| 12 | 12 |
"operationId": "RowCreate", |
| 13 | 13 |
"requestBody": {
|
| 14 |
"description": "Datos para la creaci?n del nuevo registro",
|
|
| 14 |
"description": "Data for creating the new record",
|
|
| 15 | 15 |
"content": {
|
| 16 | 16 |
"application/json": {
|
| 17 | 17 |
"schema": {
|
| 18 |
"$ref": "#/components/schemas/RowCreationRequest"
|
|
| 18 |
"$ref": "#/components/schemas/RowCreateRequest"
|
|
| 19 | 19 |
} |
| 20 | 20 |
} |
| 21 | 21 |
}, |
| ... | ... | |
| 27 | 27 |
"content": {
|
| 28 | 28 |
"application/json": {
|
| 29 | 29 |
"schema": {
|
| 30 |
"$ref": "#/components/schemas/RowCreationResponse"
|
|
| 30 |
"$ref": "#/components/schemas/RowCreateResponse"
|
|
| 31 | 31 |
} |
| 32 | 32 |
} |
| 33 | 33 |
} |
| ... | ... | |
| 37 | 37 |
}, |
| 38 | 38 |
"/rowupdate": {
|
| 39 | 39 |
"post": {
|
| 40 |
"summary": "Actualiza un registro en una tabla/entidad",
|
|
| 40 |
"summary": "Update a record in a table/entity",
|
|
| 41 | 41 |
"operationId": "RowUpdate", |
| 42 | 42 |
"requestBody": {
|
| 43 |
"description": "Datos para la actualizaci?n de un registro",
|
|
| 43 |
"description": "Data for updating a record",
|
|
| 44 | 44 |
"content": {
|
| 45 | 45 |
"application/json": {
|
| 46 | 46 |
"schema": {
|
| ... | ... | |
| 66 | 66 |
}, |
| 67 | 67 |
"/rowdelete": {
|
| 68 | 68 |
"post": {
|
| 69 |
"summary": "Elimina un registro en una tabla/entidad",
|
|
| 69 |
"summary": "Delete a record in a table/entity",
|
|
| 70 | 70 |
"operationId": "RowDelete", |
| 71 | 71 |
"requestBody": {
|
| 72 |
"description": "Datos para la eliminaci?n de un registro",
|
|
| 72 |
"description": "Data for deletion of a record",
|
|
| 73 | 73 |
"content": {
|
| 74 | 74 |
"application/json": {
|
| 75 | 75 |
"schema": {
|
| ... | ... | |
| 92 | 92 |
} |
| 93 | 93 |
} |
| 94 | 94 |
} |
| 95 |
}, |
|
| 96 |
"/update": {
|
|
| 97 |
"post": {
|
|
| 98 |
"summary": "Brings changes from the repository to your working copy.", |
|
| 99 |
"operationId": "Update", |
|
| 100 |
"requestBody": {
|
|
| 101 |
"description": "It contains the information to determine what data should be sent to the client.", |
|
| 102 |
"content": {
|
|
| 103 |
"application/json": {
|
|
| 104 |
"schema": {
|
|
| 105 |
"$ref": "#/components/schemas/UpdateRequest" |
|
| 106 |
} |
|
| 107 |
} |
|
| 108 |
}, |
|
| 109 |
"required": true |
|
| 110 |
}, |
|
| 111 |
"responses": {
|
|
| 112 |
"200": {
|
|
| 113 |
"description": "successful operation", |
|
| 114 |
"content": {
|
|
| 115 |
"application/json": {
|
|
| 116 |
"schema": {
|
|
| 117 |
"$ref": "#/components/schemas/UpdateResponse" |
|
| 118 |
} |
|
| 119 |
} |
|
| 120 |
} |
|
| 121 |
} |
|
| 122 |
} |
|
| 123 |
} |
|
| 95 | 124 |
} |
| 96 | 125 |
}, |
| 97 | 126 |
"components": {
|
| 127 |
"examples": {
|
|
| 128 |
"ObjectEntity": {
|
|
| 129 |
"summary": "Entity example", |
|
| 130 |
"value": {
|
|
| 131 |
"EntityCode": "00000000000002abcdef0123456789", |
|
| 132 |
"EntityName": "test", |
|
| 133 |
"DatatableName": "VCSGIS_DATA", |
|
| 134 |
"Description": "", |
|
| 135 |
"FeatureIdFieldName": "VCSGISCODE", |
|
| 136 |
"FeatureTypeAsJson": "...", |
|
| 137 |
"FieldForLabel": "text", |
|
| 138 |
"GeometryFieldName": "", |
|
| 139 |
"RevisionCode": "00000000000034abcdef0123456789", |
|
| 140 |
"TopologyPlanCode": "", |
|
| 141 |
"UserCode": "00000000000001abcdef0123456789" |
|
| 142 |
} |
|
| 143 |
}, |
|
| 144 |
"ObjectUpdateEntry": {
|
|
| 145 |
"summary": "UpdateEntry example", |
|
| 146 |
"value": {
|
|
| 147 |
"DataCode": "00000000000100abcdef0123456789", |
|
| 148 |
"EntityCode": "00000000000002abcdef0123456789", |
|
| 149 |
"RevisionCode": "00000000000034abcdef0123456789", |
|
| 150 |
"Operation": 1, |
|
| 151 |
"RevisionNumber": 4, |
|
| 152 |
"EfectiveDate": "2020-02-19 10:11:12.123", |
|
| 153 |
"FeatureRelatedCode": "00000000000022abcdef0123456789", |
|
| 154 |
"Data": "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"
|
|
| 155 |
} |
|
| 156 |
} |
|
| 157 |
}, |
|
| 98 | 158 |
"schemas": {
|
| 99 |
"RowCreationRequest": {
|
|
| 159 |
"RowCreateRequest": {
|
|
| 100 | 160 |
"required": [ |
| 101 | 161 |
"EntityName", |
| 102 | 162 |
"LocalRevisionCode", |
| 103 | 163 |
"Data" |
| 104 | 164 |
], |
| 105 | 165 |
"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 ",
|
|
| 166 |
"description": "This object represents a request to create a new record in a table.\n\nWhen the record is created, a unique code will be assigned with the VCS, overwriting the value of the VCSGISCODE attribute with the new value.", |
|
| 167 |
"example": {
|
|
| 168 |
"EntityName": "test", |
|
| 169 |
"LocalRevisionCode": "00000000000014abcdef0123456789", |
|
| 170 |
"EfectiveDate": "2020-02-18 10:11:12.123", |
|
| 171 |
"Comment": "test row create (4, ddd)", |
|
| 172 |
"Data": "{ \"id\": 4, \"text\": \"DDD\", \"VCSGISCODE\": \"\"}"
|
|
| 173 |
}, |
|
| 107 | 174 |
"properties": {
|
| 108 | 175 |
"EntityName": {
|
| 109 | 176 |
"type": "string", |
| 110 |
"description": "Nombre de la tabla en la que se solicita crear el nuevo registro"
|
|
| 177 |
"description": "Name of the table in which to create the new record"
|
|
| 111 | 178 |
}, |
| 112 | 179 |
"LocalRevisionCode": {
|
| 113 | 180 |
"type": "string", |
| 114 | 181 |
"format": "string40", |
| 115 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente"
|
|
| 182 |
"description": "Code of the revision in which the client data is found"
|
|
| 116 | 183 |
}, |
| 117 | 184 |
"EfectiveDate": {
|
| 118 | 185 |
"type": "string", |
| 119 | 186 |
"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."
|
|
| 187 |
"description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."
|
|
| 121 | 188 |
}, |
| 122 | 189 |
"Comment": {
|
| 123 | 190 |
"type": "string", |
| 124 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo."
|
|
| 191 |
"description": "Comment associated with the operation to be performed. It can be null."
|
|
| 125 | 192 |
}, |
| 126 | 193 |
"Data": {
|
| 127 | 194 |
"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."
|
|
| 195 |
"description": "The feature data to create in the table coded as a string json. If the feature has the VCSGISCODE field it will be overwritten, assigning a new code to it."
|
|
| 129 | 196 |
} |
| 130 | 197 |
} |
| 131 | 198 |
}, |
| 132 |
"RowCreationResponse": {
|
|
| 199 |
"RowCreateResponse": {
|
|
| 133 | 200 |
"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>",
|
|
| 201 |
"description": "This object represents the response to a request to create a new record in a table.\n\nYou will inform us of the status of the request, as well as:\n - The code of the new record created.\n - The code of the revision in which the\n table on the server.", |
|
| 202 |
"example": {
|
|
| 203 |
"StatusCode": 0, |
|
| 204 |
"StatusMessage": "", |
|
| 205 |
"RelatedFeatureCode": "00000000000022abcdef0123456789", |
|
| 206 |
"EntityName": "test", |
|
| 207 |
"EntityCode": "00000000000002abcdef0123456789", |
|
| 208 |
"RevisionCode": "00000000000024abcdef0123456789" |
|
| 209 |
}, |
|
| 135 | 210 |
"properties": {
|
| 136 | 211 |
"StatusCode": {
|
| 137 | 212 |
"type": "integer", |
| 138 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente."
|
|
| 213 |
"description": "Status code of the operation. Zero when the operation has been done correctly."
|
|
| 139 | 214 |
}, |
| 140 | 215 |
"StatusMessage": {
|
| 141 | 216 |
"type": "string", |
| 142 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema."
|
|
| 217 |
"description": "In case the operation did not go well, a message describing the problem."
|
|
| 143 | 218 |
}, |
| 144 | 219 |
"RelatedFeatureCode": {
|
| 145 | 220 |
"type": "string", |
| 146 | 221 |
"format": "string40", |
| 147 |
"description": "C?digo asignado al campo VCSGISCODE del nuevo registro, que representa al identificador de este en el VCS."
|
|
| 222 |
"description": "Code assigned to the VCSGISCODE field of the new record, which represents the identifier of this in the VCS."
|
|
| 148 | 223 |
}, |
| 149 | 224 |
"EntityName": {
|
| 150 | 225 |
"type": "string", |
| 151 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro"
|
|
| 226 |
"description": "Name of the table in which the new one was requested to be created registry"
|
|
| 152 | 227 |
}, |
| 153 | 228 |
"EntityCode": {
|
| 154 | 229 |
"type": "string", |
| 155 | 230 |
"format": "string40", |
| 156 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica."
|
|
| 231 |
"description": "Internal code associated with the table to identify it in a way Unique."
|
|
| 157 | 232 |
}, |
| 158 | 233 |
"RevisionCode": {
|
| 159 | 234 |
"type": "string", |
| 160 | 235 |
"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."
|
|
| 236 |
"description": "Code of the revision in which the data is found in the server after the operation is performed."
|
|
| 162 | 237 |
} |
| 163 | 238 |
} |
| 164 | 239 |
}, |
| ... | ... | |
| 169 | 244 |
"Data" |
| 170 | 245 |
], |
| 171 | 246 |
"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 ",
|
|
| 247 |
"description": "This object represents a request to update a record in a table.\nIt is essential that the value of the VCSGISCODE attribute of the data of the record that we want to update has the correct code, since it is used to identify the record we want to update.", |
|
| 248 |
"example": {
|
|
| 249 |
"EntityName": "test", |
|
| 250 |
"LocalRevisionCode": "00000000000024abcdef0123456789", |
|
| 251 |
"EfectiveDate": null, |
|
| 252 |
"Comment": "test row update (4, dd2)", |
|
| 253 |
"Data": "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"
|
|
| 254 |
}, |
|
| 173 | 255 |
"properties": {
|
| 174 | 256 |
"EntityName": {
|
| 175 | 257 |
"type": "string", |
| 176 |
"description": "Nombre de la tabla en la que se solicita actualizar el registro"
|
|
| 258 |
"description": "Name of the table in which the record is requested to be updated"
|
|
| 177 | 259 |
}, |
| 178 | 260 |
"LocalRevisionCode": {
|
| 179 | 261 |
"type": "string", |
| 180 | 262 |
"format": "string40", |
| 181 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente"
|
|
| 263 |
"description": "Code of the revision in which the client data is located"
|
|
| 182 | 264 |
}, |
| 183 | 265 |
"EfectiveDate": {
|
| 184 | 266 |
"type": "string", |
| 185 | 267 |
"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."
|
|
| 268 |
"description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."
|
|
| 187 | 269 |
}, |
| 188 | 270 |
"Comment": {
|
| 189 | 271 |
"type": "string", |
| 190 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo."
|
|
| 272 |
"description": "Comment associated with the operation to be performed. It can be null."
|
|
| 191 | 273 |
}, |
| 192 | 274 |
"Data": {
|
| 193 | 275 |
"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."
|
|
| 276 |
"description": "The feature data to create in the table coded as a string json. The VCSGISCODE attribute must have a valid code and It will identify the record that is being updated."
|
|
| 195 | 277 |
} |
| 196 | 278 |
} |
| 197 | 279 |
}, |
| 198 | 280 |
"RowUpdateResponse": {
|
| 199 | 281 |
"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>",
|
|
| 282 |
"description": "This object represents the response to a request to update a record in a table.", |
|
| 283 |
"example": {
|
|
| 284 |
"StatusCode": 0, |
|
| 285 |
"StatusMessage": "", |
|
| 286 |
"EntityName": "test", |
|
| 287 |
"EntityCode": "00000000000002abcdef0123456789", |
|
| 288 |
"RevisionCode": "00000000000029abcdef0123456789" |
|
| 289 |
}, |
|
| 201 | 290 |
"properties": {
|
| 202 | 291 |
"StatusCode": {
|
| 203 | 292 |
"type": "integer", |
| 204 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente."
|
|
| 293 |
"description": "Operation status code. Zero when the operation has done correctly."
|
|
| 205 | 294 |
}, |
| 206 | 295 |
"StatusMessage": {
|
| 207 | 296 |
"type": "string", |
| 208 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema."
|
|
| 297 |
"description": "In case the operation did not go well, a message describing the problem."
|
|
| 209 | 298 |
}, |
| 210 | 299 |
"EntityName": {
|
| 211 | 300 |
"type": "string", |
| 212 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro"
|
|
| 301 |
"description": "Name of the table in which the requested was create the new record"
|
|
| 213 | 302 |
}, |
| 214 | 303 |
"EntityCode": {
|
| 215 | 304 |
"type": "string", |
| 216 | 305 |
"format": "string40", |
| 217 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica."
|
|
| 306 |
"description": "Internal code associated with the table to identify."
|
|
| 218 | 307 |
}, |
| 219 | 308 |
"RevisionCode": {
|
| 220 | 309 |
"type": "string", |
| 221 | 310 |
"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."
|
|
| 311 |
"description": "Code of the revision in which the data is found in the server after the operation is performed."
|
|
| 223 | 312 |
} |
| 224 | 313 |
} |
| 225 | 314 |
}, |
| ... | ... | |
| 230 | 319 |
"RelatedFeatureCode" |
| 231 | 320 |
], |
| 232 | 321 |
"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 ",
|
|
| 322 |
"description": "This object represents a request to delete a record in a table.\n\nThe record to be deleted will be identified by the value of the *RelatedFeatureCode* attribute.", |
|
| 323 |
"example": {
|
|
| 324 |
"EntityName": "test", |
|
| 325 |
"LocalRevisionCode": "00000000000029abcdef0123456789", |
|
| 326 |
"RelatedFeatureCode": "00000000000022abcdef0123456789", |
|
| 327 |
"EfectiveDate": "2020-02-19 10:11:12.123", |
|
| 328 |
"Comment": "test row delete (4, dd2)" |
|
| 329 |
}, |
|
| 234 | 330 |
"properties": {
|
| 235 | 331 |
"EntityName": {
|
| 236 | 332 |
"type": "string", |
| 237 |
"description": "Nombre de la tabla en la que se solicita crear el nuevo registro"
|
|
| 333 |
"description": "Name of the table in which to delete the record"
|
|
| 238 | 334 |
}, |
| 239 | 335 |
"LocalRevisionCode": {
|
| 240 | 336 |
"type": "string", |
| 241 | 337 |
"format": "string40", |
| 242 |
"description": "C?digo de la revisi?n en la que se encuentran los datos del cliente"
|
|
| 338 |
"description": "Code of the revision in which the client data is located"
|
|
| 243 | 339 |
}, |
| 244 | 340 |
"EfectiveDate": {
|
| 245 | 341 |
"type": "string", |
| 246 | 342 |
"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."
|
|
| 343 |
"description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."
|
|
| 248 | 344 |
}, |
| 249 | 345 |
"Comment": {
|
| 250 | 346 |
"type": "string", |
| 251 |
"description": "Comentario asociado a la operaci?n a realizar. Puede ser nulo."
|
|
| 347 |
"description": "Comment associated with the operation to be performed. It can be null."
|
|
| 252 | 348 |
}, |
| 253 | 349 |
"RelatedFeatureCode": {
|
| 254 | 350 |
"type": "string", |
| 255 | 351 |
"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."
|
|
| 352 |
"description": "Code of the record to be deleted. Delete the record that have the value of the VCSGISCODE attribute as the value of this field."
|
|
| 257 | 353 |
} |
| 258 | 354 |
} |
| 259 | 355 |
}, |
| 260 | 356 |
"RowDeleteResponse": {
|
| 261 | 357 |
"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>",
|
|
| 358 |
"description": "This object represents the response to a request to delete a record in a table.", |
|
| 359 |
"example": {
|
|
| 360 |
"StatusCode": 0, |
|
| 361 |
"StatusMessage": "", |
|
| 362 |
"EntityName": "test", |
|
| 363 |
"EntityCode": "00000000000002abcdef0123456789", |
|
| 364 |
"RevisionCode": "00000000000034abcdef0123456789" |
|
| 365 |
}, |
|
| 263 | 366 |
"properties": {
|
| 264 | 367 |
"StatusCode": {
|
| 265 | 368 |
"type": "integer", |
| 266 |
"description": "C?digo de estado de la operaci?n. Cero cuando la operaci?n se ha realizado correctamente."
|
|
| 369 |
"description": "Operation status code. Zero when the operation has done correctly."
|
|
| 267 | 370 |
}, |
| 268 | 371 |
"StatusMessage": {
|
| 269 | 372 |
"type": "string", |
| 270 |
"description": "En caso de que no haya ido bien la operaci?n, mensaje describiendo el problema."
|
|
| 373 |
"description": "In case the operation did not go well, a message describing the problem."
|
|
| 271 | 374 |
}, |
| 272 | 375 |
"EntityName": {
|
| 273 | 376 |
"type": "string", |
| 274 |
"description": "Nombre de la tabla en la que se ha solicitado crear el nuevo registro"
|
|
| 377 |
"description": "Name of the table in which the new one was requested to be created registry"
|
|
| 275 | 378 |
}, |
| 276 | 379 |
"EntityCode": {
|
| 277 | 380 |
"type": "string", |
| 278 | 381 |
"format": "string40", |
| 279 |
"description": "C?digo interno asociado a la tabla para identificarla de forma ?nica."
|
|
| 382 |
"description": "Internal code associated with the table to identify."
|
|
| 280 | 383 |
}, |
| 281 | 384 |
"RevisionCode": {
|
| 282 | 385 |
"type": "string", |
| 283 | 386 |
"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."
|
|
| 387 |
"description": "Code of the revision in which the data is found in the server after the operation is performed."
|
|
| 285 | 388 |
} |
| 286 | 389 |
} |
| 390 |
}, |
|
| 391 |
"Entity": {
|
|
| 392 |
"type": "object", |
|
| 393 |
"description": "This object represents an entity or table on the server. It contains the metadata of this, such as its name, code, code of the last revision, user who created it ...", |
|
| 394 |
"properties": {
|
|
| 395 |
"EntityCode": {
|
|
| 396 |
"type": "string", |
|
| 397 |
"format": "string40", |
|
| 398 |
"description": "Code of this entity" |
|
| 399 |
}, |
|
| 400 |
"EntityName": {
|
|
| 401 |
"type": "string", |
|
| 402 |
"description": "Name of this entity" |
|
| 403 |
}, |
|
| 404 |
"DatatableName": {
|
|
| 405 |
"type": "string", |
|
| 406 |
"description": "Name of the table in which the entity's data is stored" |
|
| 407 |
}, |
|
| 408 |
"Description": {
|
|
| 409 |
"type": "string" |
|
| 410 |
}, |
|
| 411 |
"FeatureIdFieldName": {
|
|
| 412 |
"type": "string" |
|
| 413 |
}, |
|
| 414 |
"FeatureTypeAsJson": {
|
|
| 415 |
"type": "string" |
|
| 416 |
}, |
|
| 417 |
"FieldForLabel": {
|
|
| 418 |
"type": "string" |
|
| 419 |
}, |
|
| 420 |
"GeometryFieldName": {
|
|
| 421 |
"type": "string" |
|
| 422 |
}, |
|
| 423 |
"RevisionCode": {
|
|
| 424 |
"type": "string" |
|
| 425 |
}, |
|
| 426 |
"TopologyPlanCode": {
|
|
| 427 |
"type": "string" |
|
| 428 |
}, |
|
| 429 |
"UserCode": {
|
|
| 430 |
"type": "string" |
|
| 431 |
} |
|
| 432 |
} |
|
| 433 |
}, |
|
| 434 |
"UpdateEntry": {
|
|
| 435 |
"type": "object", |
|
| 436 |
"description": "This object defines the data associated with a record that has changed in a table. It tells us if we should delete our record from the working copy, update it or insert a new one, as well as the data associated with the records.", |
|
| 437 |
"properties": {
|
|
| 438 |
"DataCode": {
|
|
| 439 |
"type": "string", |
|
| 440 |
"description": "Unique identifier asociated to this entry." |
|
| 441 |
}, |
|
| 442 |
"EntityCode": {
|
|
| 443 |
"type": "string", |
|
| 444 |
"description": "The entity code, table, asociated to this entry." |
|
| 445 |
}, |
|
| 446 |
"RevisionCode": {
|
|
| 447 |
"type": "string", |
|
| 448 |
"description": "The revision code asociated to this entry." |
|
| 449 |
}, |
|
| 450 |
"Operation": {
|
|
| 451 |
"type": "integer", |
|
| 452 |
"description": "The operation asociated to this entry:\n - 0 for delete\n - 1 for update\n - 2 for insert", |
|
| 453 |
"enum": [ |
|
| 454 |
0, |
|
| 455 |
1, |
|
| 456 |
2 |
|
| 457 |
] |
|
| 458 |
}, |
|
| 459 |
"RevisionNumber": {
|
|
| 460 |
"type": "string", |
|
| 461 |
"description": "The revision number asociated to this entry" |
|
| 462 |
}, |
|
| 463 |
"EfectiveDate": {
|
|
| 464 |
"type": "string", |
|
| 465 |
"format": "timestamp", |
|
| 466 |
"description": "The efective date asociated to this entry" |
|
| 467 |
}, |
|
| 468 |
"FeatureRelatedCode": {
|
|
| 469 |
"type": "string", |
|
| 470 |
"description": "The code that identify the feature in the VCS." |
|
| 471 |
}, |
|
| 472 |
"Data": {
|
|
| 473 |
"type": "string", |
|
| 474 |
"description": "The feature data coded as a json string." |
|
| 475 |
} |
|
| 476 |
} |
|
| 477 |
}, |
|
| 478 |
"UpdateRequest": {
|
|
| 479 |
"required": [ |
|
| 480 |
"EntityName", |
|
| 481 |
"LocalRevisionCode" |
|
| 482 |
], |
|
| 483 |
"type": "object", |
|
| 484 |
"description": "This object contains the information necessary to determine what data should be sent to the client so that the data of a table is updated with the last revision of this one.", |
|
| 485 |
"example": {
|
|
| 486 |
"EntityName": "test", |
|
| 487 |
"LocalRevisionCode": "00000000000024abcdef0123456789" |
|
| 488 |
}, |
|
| 489 |
"properties": {
|
|
| 490 |
"EntityName": {
|
|
| 491 |
"type": "string", |
|
| 492 |
"description": "Name of the table we want to update" |
|
| 493 |
}, |
|
| 494 |
"LocalRevisionCode": {
|
|
| 495 |
"type": "string", |
|
| 496 |
"format": "string40", |
|
| 497 |
"description": "Code of the revision in which the client data is located" |
|
| 498 |
} |
|
| 499 |
} |
|
| 500 |
}, |
|
| 501 |
"UpdateResponse": {
|
|
| 502 |
"type": "object", |
|
| 503 |
"description": "It contains the necessary data to update the local table and to go from being in the revision in which it is to the last revision that the server contains.", |
|
| 504 |
"example": {
|
|
| 505 |
"StatusCode": 0, |
|
| 506 |
"StatusMessage": "", |
|
| 507 |
"Entity": {
|
|
| 508 |
"$ref": "#/components/examples/ObjectEntity/value" |
|
| 509 |
}, |
|
| 510 |
"Data": [ |
|
| 511 |
{
|
|
| 512 |
"$ref": "#/components/examples/ObjectUpdateEntry/value" |
|
| 513 |
} |
|
| 514 |
] |
|
| 515 |
}, |
|
| 516 |
"properties": {
|
|
| 517 |
"StatusCode": {
|
|
| 518 |
"type": "integer", |
|
| 519 |
"description": "Operation status code. Zero when the operation has done correctly." |
|
| 520 |
}, |
|
| 521 |
"StatusMessage": {
|
|
| 522 |
"type": "string", |
|
| 523 |
"description": "In case the operation did not go well, a message describing the problem." |
|
| 524 |
}, |
|
| 525 |
"Entity": {
|
|
| 526 |
"$ref": "#/components/schemas/Entity" |
|
| 527 |
}, |
|
| 528 |
"Data": {
|
|
| 529 |
"type": "array", |
|
| 530 |
"items": {
|
|
| 531 |
"$ref": "#/components/schemas/UpdateEntry" |
|
| 532 |
} |
|
| 533 |
} |
|
| 534 |
} |
|
| 287 | 535 |
} |
| 288 | 536 |
} |
| 289 | 537 |
} |
| 290 |
} |
|
| 538 |
} |
|
Also available in: Unified diff