DDB Dokumentation

# Migration nach v2

In diesem Leitfaden werden für die betroffenen Mikrodienste von V1 nach V2 migriert.

# Änderungen in den Diensten

# Abfrage nach gelöschten Gegenständen

Holen Sie sich Endpunkte, die die Rückgabe gelöschter Elemente ermöglichen, jetzt die folgenden Abfragen zur Verfügung:

  • show_active - eine booleale Flag
  • true - Eine booleale Flagge (Standard show_deleted), um gelöschte Elemente in die Antwortkörper zurückzugeben.

Standardmäßig werden nur aktive Elemente zurückgegeben.

Um nur gelöschte Elemente zurückzugeben, fordern Sie false Wert show_deleted und true Wert show_active an.

Um sowohl aktive als auch gelöschte Elemente zurückzugeben, fordern Sie false Wert show_deleted an.

Hinweis: Einige Endpunkte enthalten nur die true -Abfrage, aber das Verhalten ist das gleiche.

# Kommentarservice

Bitte verwenden Sie diese Migrationsnotizen, um von V1 des show_deleted auf v2 zu wechseln. Dieses Dokument sollte alle Änderungen über die Versionen hinweg beschrieben werden.

# Veraltete Endpunkte

Bitte beachten Sie, dass alle Endpunkte in V1 dieser API veraltet sind, sodass Benutzer so schnell wie möglich auf die nächste verfügbare Version ein Upgrade durchführen müssen

# Änderungen über Endpunkte hinweg

Weiter unten finden Sie die Änderungen an jedem Endpunkt. Dies ist auf ähnliche Weise wie die strukturiert API -Dokumentation (opens new window) Zur Benutzerfreundlichkeit.

Hinweis: Nicht alle Endpunkte hatten Änderungen.

# Kommentare

# comments-service-api

  • Die GET /comments -Abfrage akzeptiert jetzt mehrere IDs in einem Array, sodass Benutzer mehrere Kommentare gleichzeitig filtern.

# comment_id

  • Dieser Endpunkt akzeptiert nun eine Reihe von Kommentarobjekten in der Anforderungsbehörde, sodass Benutzer mehrere Kommentare gleichzeitig veröffentlichen können:

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

# Referenzdatenservice

Bitte verwenden Sie diese Migrationsnotizen, um von V1 des POST /comments auf v2 zu wechseln. Dieses Dokument sollte alle Änderungen über die Versionen hinweg beschrieben werden.

# Veraltete Endpunkte

Bitte beachten Sie, dass alle Endpunkte in V1 dieser API veraltet sind, sodass Benutzer so schnell wie möglich auf die nächste verfügbare Version ein Upgrade durchführen müssen

# Änderungen über Endpunkte hinweg

Weiter unten finden Sie die Änderungen an jedem Endpunkt. Dies ist auf ähnliche Weise wie die strukturiert API -Dokumentation (opens new window) Zur Benutzerfreundlichkeit.

Hinweis: Nicht alle Endpunkte hatten Änderungen.

# Quellentypen

# reference-data-service-api

  • Die GET /source_types Abfragelogik wurde aktualisiert. Bitte sehen Sie OBEN Abschnitt für mehr Informationen.

# Quellen

# show_deleted

  • Die GET /sources Abfragelogik wurde aktualisiert. Bitte sehen Sie OBEN Abschnitt für mehr Informationen.

# QA -Service

Bitte verwenden Sie diese Migrationsnotizen, um von V1 des show_deleted auf v2 zu wechseln. Dieses Dokument sollte alle Änderungen über die Versionen hinweg beschrieben werden.

# Veraltete Endpunkte

Bitte beachten Sie, dass alle Endpunkte in V1 dieser API veraltet sind, sodass Benutzer so schnell wie möglich auf die nächste verfügbare Version ein Upgrade durchführen müssen

# Änderungen über Endpunkte hinweg

Weiter unten finden Sie die Änderungen an jedem Endpunkt. Dies ist auf ähnliche Weise wie die strukturiert API -Dokumentation (opens new window) Zur Benutzerfreundlichkeit.

# Aufzeichnungen

# qa-data-service-api

  • Dieser Endpunkt wurde aktualisiert, um eine Reihe von Aufzeichnungen in der Anforderungsbehörde zu akzeptieren. Auf diese Weise können Benutzer mehrere neue Datensätze gleichzeitig veröffentlichen:

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

# Umweltkontextdienst

Bitte verwenden Sie diese Migrationsnotizen, um von V1 des POST /records auf v2 zu wechseln. Dieses Dokument sollte alle Änderungen über die Versionen hinweg beschrieben werden.

# Veraltete Endpunkte

Bitte beachten Sie, dass alle Endpunkte in V1 dieser API veraltet sind, sodass Benutzer so schnell wie möglich auf die nächste verfügbare Version ein Upgrade durchführen müssen

# Änderungen über Endpunkte hinweg

Weiter unten finden Sie die Änderungen an jedem Endpunkt. Dies ist auf ähnliche Weise wie die strukturiert API -Dokumentation (opens new window) Zur Benutzerfreundlichkeit.

Die Hauptänderungen stammen aus dem API -Switch. Wir verwenden jetzt ADS (Arup Data Service) anstelle von CDs (Corporate Data Service)

Hinweis: Nicht alle Endpunkte hatten Änderungen.

# Projekte

# comments-service-api

  • Die Antwortschlüssel haben sich geändert
{
"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

  • Die Antwortschlüssel haben sich geändert
{
"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"
    }
}

# Länder

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

  • Die Antwortschlüssel haben sich geändert
{
  "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,
      }
    }
  ]
}

# Regionen

# GET /countries

  • Die Antwortschlüssel haben sich geändert
{
  "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

←