Documentación del endpoint Metadata

El endpoint Metadata está diseñado para proporcionar los metadatos y las notas asociados con la última actualización de un conjunto de datos específico en la plataforma Datafaro.

Endpoint

GET /api/v1/metadata/

Este endpoint se utiliza para obtener los metadatos y las notas de la última actualización de un conjunto de datos identificado por su ID único.

Autenticación

El acceso a este endpoint requiere autenticación a través de Token Authentication. Los usuarios deben incluir su token de acceso en el encabezado de la solicitud HTTP:

Authorization: Token YOUR_ACCESS_TOKEN

Parámetros de solicitud

• id: El identificador único del conjunto de datos (DataSet) del cual se requieren los metadatos.

Respuesta

La respuesta incluirá los metadatos y notas de la última actualización del conjunto de datos solicitado. Los metadatos incluyen información sobre la descripción de los campos de datos, el formato de los datos, entre otros. Las notas proporcionan información adicional sobre la actualización del conjunto de datos.

Ejemplo de solicitud

Para obtener metadatos de un DataSet específico:

curl -X GET "http://datafaro.adatar.do/api/v1/metadata/?id=specific_dataset_id" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Ejemplo de respuesta

La API devolverá una estructura de respuesta que contiene los metadatos y las notas:

{
    "metadata": {
        "campo_1": {
            "name": "Campo 1",
            "dtype": "f2",
        },
        "campo_2": {
            "name": "Campo 2",
            "dtype": "mdate",
        },
    },
    "notes": [
        "Nota 1",
        "Nota 2",
    ]
}

Códigos de estado HTTP

• 200 OK: La solicitud se completó con éxito y los metadatos se devuelven en la respuesta.
• 401 Unauthorized: Falta token de acceso o es inválido.
• 404 Not Found: No se encontró el conjunto de datos con el ID proporcionado.

Manejo de errores

Si ocurre un error, como un ID de conjunto de datos inexistente, la API proporcionará un mensaje de error descriptivo y un código de estado HTTP correspondiente.

Ejemplo de respuesta de error

{
    "error": "No existe un dataset con el id 'specific_dataset_id'"
}