API v2 - Esquema

Esquema OpenAPI 3.0

GET /api/v2/

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

GET /api/v2/categories/

Endpoint de API que lista las categorías.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/categories/{id}/

Endpoint de API que lista las categorías.

Parámetros

• id (integer) – Un valor entero único que identifica esta categoría de tema.

Códigos de estado

• 200 OK –

GET /api/v2/datasets/

Punto de acceso API que permite ver o editar capas.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

PATCH /api/v2/datasets/

Punto de acceso API que permite ver o editar capas.

Códigos de estado

• 200 OK –

GET /api/v2/datasets/{id}/

Punto de acceso API que permite ver o editar capas.

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Códigos de estado

• 200 OK –

PUT /api/v2/datasets/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Códigos de estado

• 200 OK –

PATCH /api/v2/datasets/{id}/

Punto de acceso API que permite ver o editar capas.

Ejemplo:

Actualizar los metadatos (por ejemplo, “títle”, “abstract”, …) de un conjunto de datos:

PATCH /dataset/{id}/ {

“{metadata_1_name}”: “{metadata_1_value}”, “{metadata_n_name}”: “{metadata_n_value”

}

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Códigos de estado

• 200 OK –

GET /api/v2/datasets/{id}/{field_name}/

Obtener objeto(s) relacionado(s), como si estuvieran cargados lateralmente (usado para soportar objetos enlazados).

Este método se asigna a /<resource>/<pk>/<field_name>/ por DynamicRouter para todos los campos DynamicRelationField. En general, este método probablemente no debería ser sobrescrito.

Una implementación alternativa sería generar consultas inversas. Para una exploración de ese enfoque, ver:

https://gist.github.com/ryochiji/54687d675978c7d96503

Parámetros

• field_name (string) –

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Códigos de estado

• 200 OK –

GET /api/v2/datasets/{id}/maplayers/

Punto de acceso de la API que permite recuperar la lista de capas del mapa.

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/datasets/{id}/maps/

Punto de acceso de la API que permite recuperar mapas utilizando el conjunto de datos.

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

PUT /api/v2/datasets/{id}/metadata/

Punto de acceso de la API que permite subir metadatos en formato XML compatibles con ISO-19115 para el conjunto de datos.

Parámetros

• id (integer) – Un valor entero único que identifica este conjunto de datos.

Códigos de estado

• 200 OK –

GET /api/v2/documents/

Punto de acceso de la API que permite ver o editar documentos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

PATCH /api/v2/documents/

Punto de acceso de la API que permite ver o editar documentos.

Códigos de estado

• 200 OK –

GET /api/v2/documents/{id}/

Punto de acceso de la API que permite ver o editar documentos.

Parámetros

• id (integer) – Un valor entero único que identifica este documento.

Códigos de estado

• 200 OK –

PUT /api/v2/documents/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica este documento.

Códigos de estado

• 200 OK –

PATCH /api/v2/documents/{id}/

Punto de acceso de la API que permite ver o editar documentos.

Parámetros

• id (integer) – Un valor entero único que identifica este documento.

Códigos de estado

• 200 OK –

GET /api/v2/documents/{id}/linked_resources/

Punto de acceso de la API que permite recuperar el(los) enlace(s) del recurso de documentos.

Parámetros

• id (integer) – Un valor entero único que identifica este documento.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/geoapps/

Punto de acceso de la API que permite ver o editar aplicaciones geográficas (geoapps).

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/geoapps/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

PATCH /api/v2/geoapps/

Punto de acceso de la API que permite ver o editar aplicaciones geográficas (geoapps).

Códigos de estado

• 200 OK –

GET /api/v2/geoapps/{id}/

Punto de acceso de la API que permite ver o editar aplicaciones geográficas (geoapps).

Parámetros

• id (integer) – Un valor entero único que identifica esta aplicación geográfica.

Códigos de estado

• 200 OK –

PUT /api/v2/geoapps/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica esta aplicación geográfica.

Códigos de estado

• 200 OK –

PATCH /api/v2/geoapps/{id}/

Punto de acceso de la API que permite ver o editar aplicaciones geográficas (geoapps).

Parámetros

• id (integer) – Un valor entero único que identifica esta aplicación geográfica.

Códigos de estado

• 200 OK –

GET /api/v2/geoapps/{id}/{field_name}/

Obtener objeto(s) relacionado(s), como si estuvieran cargados lateralmente (usado para soportar objetos enlazados).

Este método se asigna a /<resource>/<pk>/<field_name>/ por DynamicRouter para todos los campos DynamicRelationField. En general, este método probablemente no debería ser sobrescrito.

Una implementación alternativa sería generar consultas inversas. Para una exploración de ese enfoque, ver:

https://gist.github.com/ryochiji/54687d675978c7d96503

Parámetros

• field_name (string) –

• id (integer) – Un valor entero único que identifica esta aplicación geográfica.

Códigos de estado

• 200 OK –

GET /api/v2/groups/

Punto de acceso de la API que permite visualizar o editar grupos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/groups/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

PATCH /api/v2/groups/

Punto de acceso de la API que permite visualizar o editar grupos.

Códigos de estado

• 200 OK –

DELETE /api/v2/groups/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/groups/{id}/

Punto de acceso de la API que permite visualizar o editar grupos.

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Códigos de estado

• 200 OK –

PUT /api/v2/groups/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Códigos de estado

• 200 OK –

PATCH /api/v2/groups/{id}/

Punto de acceso de la API que permite visualizar o editar grupos.

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Códigos de estado

• 200 OK –

DELETE /api/v2/groups/{id}/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/groups/{id}/managers/

Punto de acceso de la API que permite recuperar los administradores del grupo.

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/groups/{id}/members/

Punto de acceso de la API que permite recuperar los miembros del grupo.

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/groups/{id}/resources/

Punto de acceso de la API que permite recuperar los recursos específicos del grupo.

Parámetros

• id (integer) – Un valor entero único que identifica este perfil de grupo.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/harvesters/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

Códigos de estado

• 200 OK –

POST /api/v2/harvesters/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

GET /api/v2/harvesters/{harvester_id}/harvestable-resources/

Agrega el método update_list a un conjunto de vistas

update_list es utilizado por api.routers.ListPatchRouter para permitir la ejecución de solicitudes PATCH contra el punto de acceso list de un conjunto de vistas

Parámetros

• harvester_id (integer) –

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

PATCH /api/v2/harvesters/{harvester_id}/harvestable-resources/

Agrega el método update_list a un conjunto de vistas

update_list es utilizado por api.routers.ListPatchRouter para permitir la ejecución de solicitudes PATCH contra el punto de acceso list de un conjunto de vistas

Parámetros

• harvester_id (integer) –

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

GET /api/v2/harvesters/{id}/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros

• id (integer) – Un valor entero único que identifica esta cosechadora.

Códigos de estado

• 200 OK –

PUT /api/v2/harvesters/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica esta cosechadora.

Códigos de estado

• 200 OK –

PATCH /api/v2/harvesters/{id}/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros

• id (integer) – Un valor entero único que identifica esta cosechadora.

Códigos de estado

• 200 OK –

DELETE /api/v2/harvesters/{id}/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Parámetros

• id (integer) – Un valor entero único que identifica esta cosechadora.

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/harvesting-sessions/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

Códigos de estado

• 200 OK –

GET /api/v2/harvesting-sessions/{id}/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros

• id (integer) – Un valor entero único que identifica esta sesión de recolección asincrónica.

Códigos de estado

• 200 OK –

GET /api/v2/keywords/

Punto de acceso de la API que enumera palabras clave jerárquicas.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/keywords/{id}/

Punto de acceso de la API que enumera palabras clave jerárquicas.

Parámetros

• id (integer) – Un valor entero único que identifica esta palabra clave jerárquica.

Códigos de estado

• 200 OK –

GET /api/v2/management/commands/

Manejar el uso de los comandos de gestión expuestos:

• GET: Lista de comandos expuestos

• GET detail: Ayuda para un comando específico

• POST: Crea un trabajo (y ejecuciones automáticas) para un comando específico.

Códigos de estado

• 200 OK –

POST /api/v2/management/commands/

Crea y ejecuta un trabajo de comando de administración. Espera un tipo de contenido application/json con la siguiente forma: {

«args»: [<arg1>, <arg2>], «kwargs: {<key1>: <val1>, <key2>: <val2>}, «autostart»: bool

} De forma predeterminada, el inicio automático está configurado como true.

Códigos de estado

• 200 OK –

GET /api/v2/management/commands/{cmd_name}/

Manejar el uso de los comandos de gestión expuestos:

• GET: Lista de comandos expuestos

• GET detail: Ayuda para un comando específico

• POST: Crea un trabajo (y ejecuciones automáticas) para un comando específico.

Parámetros

• cmd_name (string) –

Códigos de estado

• 200 OK –

POST /api/v2/management/commands/{cmd_name}/

Crea y ejecuta un trabajo de comando de administración. Espera un tipo de contenido application/json con la siguiente forma: {

«args»: [<arg1>, <arg2>], «kwargs: {<key1>: <val1>, <key2>: <val2>}, «autostart»: bool

} De forma predeterminada, el inicio automático está configurado como true.

Parámetros

• cmd_name (string) –

Códigos de estado

• 200 OK –

GET /api/v2/management/commands/{cmd_name}/jobs/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

Parámetros de consulta

• app_name (string) –

• celery_result_id (string) –

• command (string) –

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• status (string) –

• user (integer) –

• user__username (string) –

Códigos de estado

• 200 OK –

POST /api/v2/management/commands/{cmd_name}/jobs/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

Códigos de estado

• 201 Created –

GET /api/v2/management/commands/{cmd_name}/jobs/{id}/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

PATCH /api/v2/management/commands/{cmd_name}/jobs/{id}/start/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

GET /api/v2/management/commands/{cmd_name}/jobs/{id}/status/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

PATCH /api/v2/management/commands/{cmd_name}/jobs/{id}/stop/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• cmd_name (string) –

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

GET /api/v2/management/jobs/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros de consulta

• app_name (string) –

• celery_result_id (string) –

• command (string) –

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• status (string) –

• user (integer) –

• user__username (string) –

Códigos de estado

• 200 OK –

POST /api/v2/management/jobs/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Códigos de estado

• 201 Created –

GET /api/v2/management/jobs/{id}/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

PATCH /api/v2/management/jobs/{id}/start/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

GET /api/v2/management/jobs/{id}/status/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

PATCH /api/v2/management/jobs/{id}/stop/

Crear, enumerar, recuperar, iniciar, detener y obtener el estado de un trabajo de comando de administración.

Parámetros

• id (integer) – Un valor entero único que identifica este trabajo de comando de administración.

Códigos de estado

• 200 OK –

GET /api/v2/maps/

Punto de acceso de la API que permite ver o editar mapas.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/maps/

Los cambios en los maplayers de m2m se confirman antes de que se modifiquen los objetos. Para proteger la base de datos, esta acción se realiza dentro de una transacción atómica.

Códigos de estado

• 201 Created –

PATCH /api/v2/maps/

Punto de acceso de la API que permite ver o editar mapas.

Códigos de estado

• 200 OK –

GET /api/v2/maps/{id}/

Punto de acceso de la API que permite ver o editar mapas.

Parámetros

• id (integer) – Un valor entero único que identifica este mapa.

Códigos de estado

• 200 OK –

PUT /api/v2/maps/{id}/

Los cambios en los maplayers de m2m se confirman antes de que se modifiquen los objetos. Para proteger la base de datos, esta acción se realiza dentro de una transacción atómica.

Parámetros

• id (integer) – Un valor entero único que identifica este mapa.

Códigos de estado

• 200 OK –

PATCH /api/v2/maps/{id}/

Punto de acceso de la API que permite ver o editar mapas.

Parámetros

• id (integer) – Un valor entero único que identifica este mapa.

Códigos de estado

• 200 OK –

GET /api/v2/maps/{id}/{field_name}/

Obtener objeto(s) relacionado(s), como si estuvieran cargados lateralmente (usado para soportar objetos enlazados).

Este método se asigna a /<resource>/<pk>/<field_name>/ por DynamicRouter para todos los campos DynamicRelationField. En general, este método probablemente no debería ser sobrescrito.

Una implementación alternativa sería generar consultas inversas. Para una exploración de ese enfoque, ver:

https://gist.github.com/ryochiji/54687d675978c7d96503

Parámetros

• field_name (string) –

• id (integer) – Un valor entero único que identifica este mapa.

Códigos de estado

• 200 OK –

GET /api/v2/maps/{id}/datasets/

Punto de acceso de la API que permite recuperar los MapLayers locales.

Parámetros

• id (integer) – Un valor entero único que identifica este mapa.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/maps/{id}/maplayers/

Punto de acceso de la API que permite recuperar la lista de capas del mapa.

Parámetros

• id (integer) – Un valor entero único que identifica este mapa.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/owners/

Punto de acceso de la API que enumera todos los posibles propietarios.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/owners/{id}/

Punto de acceso de la API que enumera todos los posibles propietarios.

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Códigos de estado

• 200 OK –

GET /api/v2/regions/

Punto de acceso de la API que enumera regiones.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/regions/{id}/

Punto de acceso de la API que enumera regiones.

Parámetros

• id (integer) – Un valor entero único que identifica esta región.

Códigos de estado

• 200 OK –

GET /api/v2/resource-service/execution-status/{execution_id}

Punto de acceso del despachador principal para seguir el progreso del estado de una solicitud de API

• GET entrada: <str: execution id>

• salida: <ExecutionRequest>

Parámetros

• execution_id (string) –

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

GET /api/v2/resources/

Punto de acceso de la API que permite visualizar o editar recursos base.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/resources/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

PATCH /api/v2/resources/

Punto de acceso de la API que permite visualizar o editar recursos base.

Códigos de estado

• 200 OK –

DELETE /api/v2/resources/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/resources/{id}/

Punto de acceso de la API que permite visualizar o editar recursos base.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PUT /api/v2/resources/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PATCH /api/v2/resources/{id}/

Punto de acceso de la API que permite visualizar o editar recursos base.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

DELETE /api/v2/resources/{id}/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/resources/{id}/{field_name}/

Obtener objeto(s) relacionado(s), como si estuvieran cargados lateralmente (usado para soportar objetos enlazados).

Este método se asigna a /<resource>/<pk>/<field_name>/ por DynamicRouter para todos los campos DynamicRelationField. En general, este método probablemente no debería ser sobrescrito.

Una implementación alternativa sería generar consultas inversas. Para una exploración de ese enfoque, ver:

https://gist.github.com/ryochiji/54687d675978c7d96503

Parámetros

• field_name (string) –

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PUT /api/v2/resources/{id}/copy/

Indica al despachador Async que ejecute una operación “COPY” sobre un “uuid” válido.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

DELETE /api/v2/resources/{id}/delete/

Indica al despachador Async que ejecute una operación “DELETE” sobre un “uuid” válido.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

GET /api/v2/resources/{id}/extra_metadata/

Obtener/Actualizar/Eliminar/Agregar metadatos adicionales para el recurso

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

POST /api/v2/resources/{id}/extra_metadata/

Obtener/Actualizar/Eliminar/Agregar metadatos adicionales para el recurso

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PUT /api/v2/resources/{id}/extra_metadata/

Obtener/Actualizar/Eliminar/Agregar metadatos adicionales para el recurso

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

DELETE /api/v2/resources/{id}/extra_metadata/

Obtener/Actualizar/Eliminar/Agregar metadatos adicionales para el recurso

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

POST /api/v2/resources/{id}/favorite/

Punto de acceso de la API que permite recuperar los recursos favoritos.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

DELETE /api/v2/resources/{id}/favorite/

Punto de acceso de la API que permite recuperar los recursos favoritos.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/resources/{id}/permissions/

Establece los niveles de permiso de un objeto según el JSON perm_spec.

el mapeo se ve así: ``` {

“users”: {

“AnonymousUser”: [“view”], <username>: [“perm1”,”perm2”,”perm3”], <username2>: [“perm1”,”perm2”,”perm3”] …

}, “groups”: {

<groupname>: [“perm1”,”perm2”,”perm3”], <groupname2>: [“perm1”,”perm2”,”perm3”], …

}

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

PUT /api/v2/resources/{id}/permissions/

Establece los niveles de permiso de un objeto según el JSON perm_spec.

el mapeo se ve así: ``` {

“users”: {

“AnonymousUser”: [“view”], <username>: [“perm1”,”perm2”,”perm3”], <username2>: [“perm1”,”perm2”,”perm3”] …

}, “groups”: {

<groupname>: [“perm1”,”perm2”,”perm3”], <groupname2>: [“perm1”,”perm2”,”perm3”], …

}

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

PATCH /api/v2/resources/{id}/permissions/

Establece los niveles de permiso de un objeto según el JSON perm_spec.

el mapeo se ve así: ``` {

“users”: {

“AnonymousUser”: [“view”], <username>: [“perm1”,”perm2”,”perm3”], <username2>: [“perm1”,”perm2”,”perm3”] …

}, “groups”: {

<groupname>: [“perm1”,”perm2”,”perm3”], <groupname2>: [“perm1”,”perm2”,”perm3”], …

}

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

DELETE /api/v2/resources/{id}/permissions/

Establece los niveles de permiso de un objeto según el JSON perm_spec.

el mapeo se ve así: ``` {

“users”: {

“AnonymousUser”: [“view”], <username>: [“perm1”,”perm2”,”perm3”], <username2>: [“perm1”,”perm2”,”perm3”] …

}, “groups”: {

<groupname>: [“perm1”,”perm2”,”perm3”], <groupname2>: [“perm1”,”perm2”,”perm3”], …

}

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK – Sin cuerpo de respuesta

GET /api/v2/resources/{id}/ratings/

Punto de acceso de la API que permite calificar y obtener la calificación general del recurso.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

POST /api/v2/resources/{id}/ratings/

Punto de acceso de la API que permite calificar y obtener la calificación general del recurso.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PUT /api/v2/resources/{id}/set_thumbnail/

Punto de acceso de la API que permite establecer la miniatura del recurso.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

PUT /api/v2/resources/{id}/update/

Indica al despachador Async que ejecute una operación “UPDATE” sobre un “uuid” válido.

Parámetros

• id (integer) – Un valor entero único que identifica esta base de recursos.

Códigos de estado

• 200 OK –

POST /api/v2/resources/{resource_id}/set_thumbnail_from_bbox/

Punto de acceso de la API que permite establecer la URL de miniatura para un conjunto de datos existente.

Parámetros

• resource_id (string) –

Códigos de estado

• 200 OK –

GET /api/v2/resources/approved/

Punto de acceso de la API que permite recuperar los recursos aprobados.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/resources/create/{resource_type}/

Indica al despachador Async que ejecute una operación “CREATE”.

Parámetros

• resource_type (string) –

Códigos de estado

• 200 OK –

GET /api/v2/resources/favorites/

Punto de acceso de la API que permite recuperar los recursos favoritos.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/resources/featured/

Punto de acceso de la API que permite recuperar los recursos destacados.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/resources/ingest/{resource_type}/

Indica al despachador Async que ejecute una operación “INGEST”.

Parámetros

• resource_type (string) –

Códigos de estado

• 200 OK –

GET /api/v2/resources/published/

Punto de acceso de la API que permite recuperar los recursos publicados.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/resources/resource_types/

Devuelve la lista de polymorphic_ctypes de ResourceBase disponibles.

el mapeo se ve así: ``` {

«resource_types»:[

{

«name»: «layer», «count»: <number of layers>

}, {

«name»: «map», «count»: <number of maps>

}, {

«name»: «document», «count»: <number of documents>

}, {

«name»: «geostory», «count»: <number of geostories>

}

]

Códigos de estado

• 200 OK –

GET /api/v2/schema/

Esquema OpenApi3 para esta API. El formato se puede seleccionar mediante la negociación de contenido.

• YAML: application/vnd.oai.openapi

• JSON: application/vnd.oai.openapi+json

Parámetros de consulta

• format (string) –

• lang (string) –

Códigos de estado

• 200 OK –

GET /api/v2/tkeywords/

Punto de acceso de la API que enumera las palabras clave del tesauro.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/tkeywords/{id}/

Punto de acceso de la API que enumera las palabras clave del tesauro.

Parámetros

• id (integer) – Un valor entero único que identifica esta palabra clave del tesauro.

Códigos de estado

• 200 OK –

GET /api/v2/upload-parallelism-limits/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

Códigos de estado

• 200 OK –

POST /api/v2/upload-parallelism-limits/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

GET /api/v2/upload-parallelism-limits/{slug}/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros

• slug (string) – Un valor único que identifica este límite de paralelismo de carga.

Códigos de estado

• 200 OK –

GET /api/v2/upload-size-limits/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

Códigos de estado

• 200 OK –

POST /api/v2/upload-size-limits/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

GET /api/v2/upload-size-limits/{slug}/

Un conjunto de vistas que puede admitir funciones de API dinámicas.

Atributos:

características: una lista de características admitidas por el conjunto de vistas. meta: datos adicionales que DynamicRenderer agrega a la respuesta.

Parámetros

• slug (string) – Un valor único que identifica este límite de tamaño de carga.

Códigos de estado

• 200 OK –

GET /api/v2/uploads/

Punto de acceso de la API que permite ver o editar las cargas.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/uploads/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

GET /api/v2/uploads/{id}/

Punto de acceso de la API que permite ver o editar las cargas.

Parámetros

• id (integer) – Un valor entero único que identifica esta carga.

Códigos de estado

• 200 OK –

POST /api/v2/uploads/upload/

Inicia una sesión de carga basada en el formulario de carga del conjunto de datos.

los parámetros del formulario se ven así: ```

“csrfmiddlewaretoken”: self.csrf_token, “permissions”: “{ «users»: {«AnonymousUser»: [«view_resourcebase»]} , «groups»:{}}”, “time”: “false”, “charset”: “UTF-8”, “base_file”: base_file, “dbf_file”: dbf_file, “shx_file”: shx_file, “prj_file”: prj_file, “tif_file”: tif_file

```

Códigos de estado

• 201 Created – Sin cuerpo de respuesta

GET /api/v2/users/

Punto de acceso de la API que permite ver o editar usuarios.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

POST /api/v2/users/

Crea una o varias instancias de modelo en forma masiva utilizando la capacidad many=True del Serializador de Django REST >= 2.2.5.

Los datos se pueden representar mediante el nombre del serializador (forma simple o plural), diccionario o lista.

Ejemplos:

POST /dogs/ {

«name»: «Fido», «age»: 2

}

POST /dogs/ {

«dog»: {

«name»: «Lucky», «age»: 3

}

}

POST /dogs/ {

«dogs»: [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

}

POST /dogs/ [

{«name»: «Fido», «age»: 2}, {«name»: «Lucky», «age»: 3}

]

Códigos de estado

• 201 Created –

PATCH /api/v2/users/

Punto de acceso de la API que permite ver o editar usuarios.

Códigos de estado

• 200 OK –

DELETE /api/v2/users/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/users/{id}/

Punto de acceso de la API que permite ver o editar usuarios.

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Códigos de estado

• 200 OK –

PUT /api/v2/users/{id}/

Actualiza una o más instancias del modelo.

Si ENABLE_BULK_UPDATE está activado, múltiples registros previamente obtenidos pueden ser actualizados en una sola llamada, siempre que se proporcionen sus IDs.

Si ENABLE_PATCH_ALL está activado, múltiples registros pueden ser actualizados en una sola llamada PATCH, incluso sin conocer sus IDs.

ADVERTENCIA: ENABLE_PATCH_ALL debe considerarse una función avanzada y usarse con precaución. Esta función debe activarse a nivel de viewset y también debe ser solicitada explícitamente por el cliente mediante el parámetro de consulta «patch-all».

Este parámetro puede tener uno de los siguientes valores:

true (o 1): los registros serán obtenidos y luego actualizados en un bucle de transacción

• Se llamará al método Model.save y se ejecutarán las señales del modelo

• Esto puede ser lento si hay demasiadas señales o muchos registros en la consulta

• Este se considera el comportamiento más seguro y predeterminado

query: los registros se actualizarán en una sola consulta

• Se llamará al método QuerySet.update y no se ejecutarán las señales del modelo

• Esto será rápido, pero puede romper las restricciones de datos que son controladas por señales

• Esto se considera inseguro, pero útil en ciertas situaciones

La respuesta exitosa del servidor a una solicitud patch-all NO incluirá ningún registro individual. En su lugar, el contenido de la respuesta contendrá un objeto «meta» con un recuento «updated» de los registros actualizados.

Ejemplos:

Actualizar un perro:

PATCH /dogs/1/ {

“fur”: “white”

}

Actualizar muchos perros por ID:

PATCH /dogs/ [

{“id”: 1, “fur”: “white”}, {“id”: 2, “fur”: “black”}, {“id”: 3, “fur”: “yellow”}

]

Actualizar todos los perros en una consulta:

PATCH /dogs/?filter{fur.contains}=brown&patch-all=true {

“fur”: “gold”

}

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Códigos de estado

• 200 OK –

PATCH /api/v2/users/{id}/

Punto de acceso de la API que permite ver o editar usuarios.

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Códigos de estado

• 200 OK –

DELETE /api/v2/users/{id}/

Eliminar una o varias instancias de modelo en masa

DELETE /dogs/ {

«dogs»: [

{«id»: 1}, {«id»: 2}

]

}

DELETE /dogs/ [

{«id»: 1}, {«id»: 2}

]

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Códigos de estado

• 204 No Content – Sin cuerpo de respuesta

GET /api/v2/users/{id}/groups/

Punto de acceso de la API que permite recuperar los grupos de los que es miembro el usuario.

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –

GET /api/v2/users/{id}/resources/

Punto de acceso de la API que permite recuperar los recursos visibles para el usuario.

Parámetros

• id (integer) – Un valor entero único que identifica a este usuario.

Parámetros de consulta

• ordering (string) – Qué campo usar al ordenar los resultados.

• page (integer) – Un número de página dentro del conjunto de resultados paginado.

• page_size (integer) – Número de resultados a devolver por página.

• search (string) – Un término de búsqueda.

Códigos de estado

• 200 OK –