DDB documentatie

# Migratie naar V2

Deze gids legt uit hoe je van V1 naar V2 kunt migreren voor de getroffen microservices.

# Veranderingen in de diensten

# Onderzoek naar verwijderde items

Ontvang eindpunten waarmee het retourneren van verwijderde items nu de volgende vragen beschikbaar hebben:

  • show_active - Een Booleaanse vlag (standaard true) om niet -verwijderde (d.w.z. actieve) items in de responslichaam te retourneren
  • show_deleted - Een Booleaanse vlag (standaard false) om verwijderde items in de responslichaam te retourneren.

Standaard worden actieve items alleen geretourneerd.

Om alleen verwijderde items te retourneren, vraagt u met show_deleted waarde true en show_active waarde false.

Om zowel actieve als verwijderde items te retourneren, vraagt u met show_deletedwaarde true.

Opmerking: sommige eindpunten bevatten alleen de show_deleted -query, maar het gedrag is hetzelfde.

# Opmerkingen Service

Gebruik deze migratienotities om over te schakelen van V1 van de comments-service-api naar v2. Dit document moet alle wijzigingen in de versies beschrijven.

# Verouderde eindpunten

Houd er rekening mee dat alle eindpunten in V1 van deze API zijn verouderd, zodat gebruikers zo snel mogelijk moeten upgraden naar de volgende beschikbare versie

# Veranderingen over eindpunten

Zie hieronder voor de wijzigingen in elk eindpunt. Dit is op dezelfde manier gestructureerd als de API -documentatie (opens new window) voor gebruiksgemak.

Opmerking: niet alle eindpunten hebben wijzigingen aangebracht.

# Opmerkingen

# GET /comments

  • De comment_id -query accepteert nu meerdere ID's in een array, zodat gebruikers in één keer voor meerdere opmerkingen kunnen filteren.

# POST /comments

  • Dit eindpunt accepteert nu een reeks commentaarobjecten in de aanvraaglichaam, waardoor gebruikers meerdere opmerkingen tegelijk kunnen posten:

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

# Referentiegegevensservice

Gebruik deze migratienotities om over te schakelen van V1 van de reference-data-service-api naar v2. Dit document moet alle wijzigingen in de versies beschrijven.

# Verouderde eindpunten

Houd er rekening mee dat alle eindpunten in V1 van deze API zijn verouderd, zodat gebruikers zo snel mogelijk moeten upgraden naar de volgende beschikbare versie

# Veranderingen over eindpunten

Zie hieronder voor de wijzigingen in elk eindpunt. Dit is op dezelfde manier gestructureerd als de API -documentatie (opens new window) voor gebruiksgemak.

Opmerking: niet alle eindpunten hebben wijzigingen aangebracht.

# Brontypen

# GET /source_types

  • De show_deleted -querylogica is bijgewerkt. Alsjeblieft zie boven sectie voor meer informatie.

# Bronnen

# GET /sources

  • De show_deleted -querylogica is bijgewerkt. Alsjeblieft zie boven sectie voor meer informatie.

# QA -service

Gebruik deze migratienotities om over te schakelen van V1 van de qa-data-service-api naar v2. Dit document moet alle wijzigingen in de versies beschrijven.

# Verouderde eindpunten

Houd er rekening mee dat alle eindpunten in V1 van deze API zijn verouderd, zodat gebruikers zo snel mogelijk moeten upgraden naar de volgende beschikbare versie

# Veranderingen over eindpunten

Zie hieronder voor de wijzigingen in elk eindpunt. Dit is op dezelfde manier gestructureerd als de API -documentatie (opens new window) voor gebruiksgemak.

# Records

# POST /records

  • Dit eindpunt is bijgewerkt om een reeks records in de aanvraaglichaam te accepteren. Hierdoor kunnen gebruikers meerdere nieuwe records tegelijk plaatsen:

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

# Environment context service

Gebruik deze migratienotities om over te schakelen van V1 van de comments-service-api naar v2. Dit document moet alle wijzigingen in de versies beschrijven.

# Verouderde eindpunten

Houd er rekening mee dat alle eindpunten in V1 van deze API zijn verouderd, zodat gebruikers zo snel mogelijk moeten upgraden naar de volgende beschikbare versie

# Veranderingen over eindpunten

Zie hieronder voor de wijzigingen in elk eindpunt. Dit is op dezelfde manier gestructureerd als de API -documentatie (opens new window) voor gebruiksgemak.

De belangrijkste wijzigingen komen van de API -schakelaar, we gebruiken nu advertenties (Arup Data Service) in plaats van CD's (Corporate Data Service)

Opmerking: niet alle eindpunten hebben wijzigingen aangebracht.

# Projecten

# GET /projects & /ads/projects

  • De responstoetsen zijn veranderd
{
"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

  • De responstoetsen zijn veranderd
{
"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"
    }
}

# Landen

# GET /countries

  • De responstoetsen zijn veranderd
{
  "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,
      }
    }
  ]
}

# Regio's

# GET /regions

  • De responstoetsen zijn veranderd
{
  "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

←