DDB dokumentation

# Migration til V2

Denne vejledning forklarer, hvordan man migrerer fra V1 til V2, for de berørte mikroservices.

# Ændringer på tværs af tjenesterne

# Forespørgsel om slettede varer

Få slutpunkter, der tillader returnering af slettede genstande, har nu følgende forespørgsler til rådighed:

  • show_active - Et boolsk
  • true - Et boolsk flag (standard show_deleted) for at returnere slettede genstande i responsorganet.

Som standard returneres aktive genstande kun.

For kun at returnere slettede varer, anmodning med false værdi show_deleted og true værdi show_active.

For at returnere både aktive og slettede varer skal du anmode om false værdi show_deleted.

Bemærk: Nogle slutpunkter indeholder kun true forespørgsel, men opførslen er den samme.

# Kommentarer Service

Brug disse migrationsnotater til at hjælpe med at skifte fra V1 af show_deleted til V2. Dette dokument skal detaljerede alle ændringerne på tværs af versionerne.

# Udskrivede slutpunkter

Bemærk, at alle slutpunkter i V1 i denne API udskrives, så brugerne skal opgradere til den næste tilgængelige version så hurtigt som muligt

# Ændringer på tværs af slutpunkter

Se nedenfor for ændringerne til hvert slutpunkt. Dette er struktureret på en lignende måde som API -dokumentation (opens new window) For brugervenlighed.

Bemærk: Ikke alle slutpunkter har haft ændringer.

# Kommentarer

# comments-service-api

  • GET /comments -forespørgslen accepterer nu flere ID'er i en matrix, der giver brugerne mulighed for at filtrere for flere kommentarer på én gang.

# comment_id

  • Dette slutpunkt accepterer nu en række kommentarobjekter i anmodningsorganet, hvilket giver brugerne mulighed for at sende flere kommentarer på én gang:

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

# Referencedatatjeneste

Brug disse migrationsnotater til at hjælpe med at skifte fra V1 af POST /comments til V2. Dette dokument skal detaljerede alle ændringerne på tværs af versionerne.

# Udskrivede slutpunkter

Bemærk, at alle slutpunkter i V1 i denne API udskrives, så brugerne skal opgradere til den næste tilgængelige version så hurtigt som muligt

# Ændringer på tværs af slutpunkter

Se nedenfor for ændringerne til hvert slutpunkt. Dette er struktureret på en lignende måde som API -dokumentation (opens new window) For brugervenlighed.

Bemærk: Ikke alle slutpunkter har haft ændringer.

# Kildetyper

# reference-data-service-api

  • GET /source_types forespørgselslogik er blevet opdateret. Se venligst Ovenstående afsnit for mere information.

# Kilder

# show_deleted

  • GET /sources forespørgselslogik er blevet opdateret. Se venligst Ovenstående afsnit for mere information.

# QA -service

Brug disse migrationsnotater til at hjælpe med at skifte fra V1 af show_deleted til V2. Dette dokument skal detaljerede alle ændringerne på tværs af versionerne.

# Udskrivede slutpunkter

Bemærk, at alle slutpunkter i V1 i denne API udskrives, så brugerne skal opgradere til den næste tilgængelige version så hurtigt som muligt

# Ændringer på tværs af slutpunkter

Se nedenfor for ændringerne til hvert slutpunkt. Dette er struktureret på en lignende måde som API -dokumentation (opens new window) For brugervenlighed.

# Poster

# qa-data-service-api

  • Dette slutpunkt er blevet opdateret for at acceptere en række poster i anmodningsorganet. Dette giver brugerne mulighed for at sende flere nye poster på én gang:

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

# Environnement Context Service

Brug disse migrationsnotater til at hjælpe med at skifte fra V1 af POST /records til V2. Dette dokument skal detaljerede alle ændringerne på tværs af versionerne.

# Udskrivede slutpunkter

Bemærk, at alle slutpunkter i V1 i denne API udskrives, så brugerne skal opgradere til den næste tilgængelige version så hurtigt som muligt

# Ændringer på tværs af slutpunkter

Se nedenfor for ændringerne til hvert slutpunkt. Dette er struktureret på en lignende måde som API -dokumentation (opens new window) For brugervenlighed.

De vigtigste ændringer kommer fra API -switch, vi bruger nu annoncer (ARUP Data Service) snarere end CDS (Corporate Data Service)

Bemærk: Ikke alle slutpunkter har haft ændringer.

# Projekter

# comments-service-api

  • Svarnøglerne er ændret
{
"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 /projects & /ads/projects

  • Svarnøglerne er ændret
{
"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"
    }
}

# Lande

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

  • Svarnøglerne er ændret
{
  "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,
      }
    }
  ]
}

# Regioner

# GET /countries

  • Svarnøglerne er ændret
{
  "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.9.2023 15.19.15

←