Documentación de DDB

# Migración a V2

Esta guía explica cómo migrar de V1 a V2, para los microservicios afectados.

# Cambios en todos los servicios

# Consulta para artículos eliminados

Obtenga puntos finales que permitan la devolución de los elementos eliminados ahora tiene las siguientes consultas disponibles:

  • show_active - Una bandera booleana (predeterminada true) para devolver ítems no eliminados (es decir, activo) en el cuerpo de respuesta
  • show_deleted - Una bandera booleana (predeterminada false) para devolver elementos eliminados en el cuerpo de respuesta.

Por defecto, los elementos activos solo se devolverán.

Para devolver los elementos eliminados solamente, solicite el valor show_deleted true y show_active Valor false.

Para devolver los elementos activos y eliminados, solicite el valor show_deleted true.

Nota: Algunos puntos finales contienen solo la consulta show_deleted, pero el comportamiento es el mismo.

# Servicio de comentarios

Utilice estas notas de migración para ayudar a cambiar de V1 del comments-service-api a V2. Este documento debe detallar todos los cambios en las versiones.

# Puntos finales desapercibidos

Tenga en cuenta que todos los puntos finales en V1 de esta API están en desuso, por lo que los usuarios deben actualizar a la próxima versión disponible lo antes posible.

# Cambios a través de puntos finales

Consulte a continuación los cambios en cada punto final. Esto está estructurado de manera similar al Documentación de API (opens new window) para facilitar el uso.

Nota: No todos los puntos finales han tenido cambios.

# Comentario

# GET /comments

  • La consulta comment_id ahora acepta múltiples ID en una matriz, lo que permite a los usuarios filtrar para múltiples comentarios a la vez.

# POST /comments

  • Este punto final ahora acepta una variedad de objetos de comentarios en el cuerpo de solicitud, lo que permite a los usuarios publicar múltiples comentarios a la vez:

    + [
    {
        reference_id: "79b577e3-f11e-4b7e-b91d-65c501a0926d",
        reference_table: "assets",
        reference_url: "http://testapi.com/api/assets",
        content: "Test comment"
    }
+ ]

# Servicio de datos de referencia

Utilice estas notas de migración para ayudar a cambiar de V1 del reference-data-service-api a V2. Este documento debe detallar todos los cambios en las versiones.

# Puntos finales desapercibidos

Tenga en cuenta que todos los puntos finales en V1 de esta API están en desuso, por lo que los usuarios deben actualizar a la próxima versión disponible lo antes posible.

# Cambios a través de puntos finales

Consulte a continuación los cambios en cada punto final. Esto está estructurado de manera similar al Documentación de API (opens new window) para facilitar el uso.

Nota: No todos los puntos finales han tenido cambios.

# Tipos de fuentes

# GET /source_types

  • La lógica de consulta show_deleted se ha actualizado. Por favor mira Sección de arriba para más información.

# Fuentes

# GET /sources

  • La lógica de consulta show_deleted se ha actualizado. Por favor mira Sección de arriba para más información.

# Servicio de control de calidad

Utilice estas notas de migración para ayudar a cambiar de V1 del qa-data-service-api a V2. Este documento debe detallar todos los cambios en las versiones.

# Puntos finales desapercibidos

Tenga en cuenta que todos los puntos finales en V1 de esta API están en desuso, por lo que los usuarios deben actualizar a la próxima versión disponible lo antes posible.

# Cambios a través de puntos finales

Consulte a continuación los cambios en cada punto final. Esto está estructurado de manera similar al Documentación de API (opens new window) para facilitar el uso.

# Registros

# POST /records

  • Este punto final se ha actualizado para aceptar una variedad de registros en el cuerpo de solicitud. Esto permite a los usuarios publicar múltiples registros nuevos a la vez:

    + [
    {
        "type_id": "f3f25a90-5caa-459a-ab8b-ab0a4dc20e42",
        "reference_id": "79b577e3-f11e-4b7e-b91d-65c501a0926d",
        "reference_table": "assets",
        "reference_url": "http://testapi.com/api/assets"
    }
+ ]

# Servicio de contexto de medio ambiente

Utilice estas notas de migración para ayudar a cambiar de V1 del comments-service-api a V2. Este documento debe detallar todos los cambios en las versiones.

# Puntos finales desapercibidos

Tenga en cuenta que todos los puntos finales en V1 de esta API están en desuso, por lo que los usuarios deben actualizar a la próxima versión disponible lo antes posible.

# Cambios a través de puntos finales

Consulte a continuación los cambios en cada punto final. Esto está estructurado de manera similar al Documentación de API (opens new window) para facilitar el uso.

Los principales cambios provienen del conmutador API, ahora estamos utilizando anuncios (servicio de datos ARUP) en lugar de CD (servicio de datos corporativos)

Nota: No todos los puntos finales han tenido cambios.

# Proyectos

# GET /projects & /ads/projects

  • Las claves de respuesta han cambiado
{
"projects": [
    {
    "centre_code": "509",
    "confidential": false,
-   "job_name_short": "V & A MUSEUM, DUNDEE",
+   "short_title": "V & A MUSEUM, DUNDEE",
-   "job_number": "216899",
-   "job_suffix": "00",
-   "project_code": "21689900",
+   "project_number": "21689900",
-   "organisation_name": "KENGO KUMA & ASSOCIATES",
+   "client_organisation_name": "KENGO KUMA & ASSOCIATES",
    "number": "21689900",
    "project_director_email": "[email protected]",
    "project_director_name": "User Name",
    "project_id": "ca1e89a5-780d-4dc9-96e9-41f3c7aaa810",
    "project_manager_email": "[email protected]",
    "project_manager_name": "User Name",
    "project_url": "http://projects.intranet.arup.com/?layout=projects.proj.view&jp=OA&jn=26190800",
    "scope_of_works": "A new waterfront museum for Dundee City Council"
    }
]
}

# GET, PATCH /projects/{id} & POST /projects

  • Las claves de respuesta han cambiado
{
"project": {
    "centre_code": "509",
    "confidential": false,
-   "job_name_short": "V & A MUSEUM, DUNDEE",
+   "short_title": "V & A MUSEUM, DUNDEE",
-   "job_number": "216899",
-   "job_suffix": "00",
-   "project_code": "21689900",
+   "project_number": "21689900",
-   "organisation_name": "KENGO KUMA & ASSOCIATES",
+   "client_organisation_name": "KENGO KUMA & ASSOCIATES",
    "project_director_email": "[email protected]",
    "project_director_name": "User Name",
    "project_id": "ca1e89a5-780d-4dc9-96e9-41f3c7aaa810",
    "project_manager_email": "[email protected]",
    "project_manager_name": "User Name",
    "project_url": "http://projects.intranet.arup.com/?layout=projects.proj.view&jp=OA&jn=26190800",
    "scope_of_works": "A new waterfront museum for Dundee City Council."
    "created_at": "2019-05-10T13:45:08.000Z",
    "updated_at": "2019-05-10T13:45:08.000Z",
    "deleted_at": "2019-05-10T13:45:08.000Z"
    }
}

# Países

# GET /countries

  • Las claves de respuesta han cambiado
{
  "countries": [
    {
      "country_class": "A",
      "country_code": "C163",
      "country_id": "64fde841-4950-e711-8104-005056b57459",
      "country_name": "Northern Ireland",
      "iso_code": "GB",
      "iso_country_name": "United Kingdom",
-     "iso_formal_country_name": "United Kingdom of Great Britain and Northern Ireland",
+     "iso_formal_name": "United Kingdom of Great Britain and Northern Ireland",
      "region": {
        "region_code": "B04",
        "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
        "region_name": "UKIMEA Region",
-       "arup_region_level": 1,
-       "company_code": C01,
      }
    }
  ]
}

# Regiones

# GET /regions

  • Las claves de respuesta han cambiado
{
  "regions": [
    {
      "region_code": "B04",
      "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
      "region_name": "UKIMEA Region",
-     "arup_region_level": 1,
-     "company_code": C01,
    }
  ]
}
Last Updated: 24/9/2024, 16:41:45

←