Documentation DDB

# Migration vers V2

Ce guide explique comment migrer de V1 à V2, pour les microservices affectés.

# Modifications entre les services

# Interroger les articles supprimés

Obtenez des points de terminaison qui permettent le retour des articles supprimés, disposent désormais des requêtes suivantes:

  • show_active - un drapeau booléen (par défaut true) pour retourner des éléments non supprimés (c'est-à-dire actifs) dans l'organisme de réponse
  • show_deleted - Un drapeau booléen (par défaut false) pour retourner les éléments supprimés dans le corps de réponse.

Par défaut, les éléments actifs seront retournés uniquement.

Pour retourner les éléments supprimés uniquement, demandez avec show_deleted valeur true et show_active valeur false.

Pour retourner les éléments actifs et supprimés, demandez avec show_deleted valeur true.

Remarque: Certains points de terminaison contiennent uniquement la requête show_deleted, mais le comportement est le même.

# Service de commentaires

Veuillez utiliser ces notes de migration pour aider à passer de la V1 du comments-service-api à V2. Ce document devrait détailler tous les changements entre les versions.

# Points de terminaison obsolètes

Veuillez noter que tous les points de terminaison de la V1 de cette API sont obsolètes afin que les utilisateurs soient passés à la prochaine version disponible dès que possible

# Modifications entre les points de terminaison

Veuillez consulter ci-dessous pour les modifications de chaque point final. Ceci est structuré de la même manière que Documentation API (opens new window) pour faciliter l'utilisation.

Remarque: tous les points de terminaison n'ont pas eu de changements.

# commentaires

# GET /comments

  • La requête comment_id accepte désormais plusieurs ID dans un tableau, permettant aux utilisateurs de filtrer plusieurs commentaires à la fois.

# POST /comments

  • Ce point de terminaison accepte désormais un tableau d'objets de commentaire dans le corps de la demande, permettant aux utilisateurs de publier plusieurs commentaires à la fois:

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

# Service de données de référence

Veuillez utiliser ces notes de migration pour aider à passer de la V1 du reference-data-service-api à V2. Ce document devrait détailler tous les changements entre les versions.

# Points de terminaison obsolètes

Veuillez noter que tous les points de terminaison de la V1 de cette API sont obsolètes afin que les utilisateurs soient passés à la prochaine version disponible dès que possible

# Modifications entre les points de terminaison

Veuillez consulter ci-dessous pour les modifications de chaque point final. Ceci est structuré de la même manière que Documentation API (opens new window) pour faciliter l'utilisation.

Remarque: tous les points de terminaison n'ont pas eu de changements.

# Types de source

# GET /source_types

  • La logique de requête show_deleted a été mise à jour. S'il te plait regarde section ci-dessus pour plus d'informations.

# Sources

# GET /sources

  • La logique de requête show_deleted a été mise à jour. S'il te plait regarde section ci-dessus pour plus d'informations.

# Service d'AQ

Veuillez utiliser ces notes de migration pour aider à passer de la V1 du qa-data-service-api à V2. Ce document devrait détailler tous les changements entre les versions.

# Points de terminaison obsolètes

Veuillez noter que tous les points de terminaison de la V1 de cette API sont obsolètes afin que les utilisateurs soient passés à la prochaine version disponible dès que possible

# Modifications entre les points de terminaison

Veuillez consulter ci-dessous pour les modifications de chaque point final. Ceci est structuré de la même manière que Documentation API (opens new window) pour faciliter l'utilisation.

# Enregistrements

# POST /records

  • Ce point de terminaison a été mis à jour pour accepter un tableau d'enregistrements dans le corps de la demande. Cela permet aux utilisateurs de publier plusieurs nouveaux enregistrements à la fois:

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

# Service de contexte environnemental

Veuillez utiliser ces notes de migration pour aider à passer de la V1 du comments-service-api à la V2. Ce document devrait détailler tous les changements entre les versions.

# Points de terminaison obsolètes

Veuillez noter que tous les points de terminaison de la V1 de cette API sont obsolètes afin que les utilisateurs soient passés à la prochaine version disponible dès que possible

# Modifications entre les points de terminaison

Veuillez consulter ci-dessous pour les modifications de chaque point final. Ceci est structuré de la même manière que Documentation API (opens new window) pour faciliter l'utilisation.

Les principaux modifications proviennent du commutateur API, nous utilisons maintenant des annonces (service de données ARUP) plutôt que des CD (service de données d'entreprise)

Remarque: tous les points de terminaison n'ont pas eu de changements.

# Projets

# GET /projects & /ads/projects

  • Les clés de réponse ont changé
{
"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

  • Les clés de réponse ont changé
{
"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"
    }
}

# Des pays

# GET /countries

  • Les clés de réponse ont changé
{
  "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,
      }
    }
  ]
}

# Régions

# GET /regions

  • Les clés de réponse ont changé
{
  "regions": [
    {
      "region_code": "B04",
      "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
      "region_name": "UKIMEA Region",
-     "arup_region_level": 1,
-     "company_code": C01,
    }
  ]
}
Last Updated: 13/09/2023 15:19:15

←