Documentazione DDB

# Migrazione a v2

Questa guida spiega come migrare da V1 a V2, per i microservizi interessati.

# Cambiamenti tra i servizi

# Interrogazione per articoli eliminati

Ottieni endpoint che consentono il ritorno degli articoli eliminati ora hanno le seguenti domande disponibili:

  • show_active - Una bandiera booleana (impostazione predefinita true) per restituire elementi non cancellati (cioè attivo) nel corpo di risposta
  • show_deleted - Una bandiera booleana (impostazione predefinita false) per restituire oggetti cancellati nel corpo della risposta.

Per impostazione predefinita, gli elementi attivi verranno restituiti solo.

Per restituire solo gli elementi eliminati, richiedere con show_deleted valore true e show_active Valore false.

Per restituire elementi sia attivi che eliminati, richiedere con show_deleted valore true.

Nota: alcuni endpoint contengono solo la query show_deleted, ma il comportamento è lo stesso.

# Servizio di commenti

Si prega di utilizzare queste note di migrazione per aiutare a passare da V1 di comments-service-api a V2. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.

# Endpoint deprecati

Si prega di notare che tutti gli endpoint in V1 di questa API sono deprecati in modo che gli utenti devono passare alla versione disponibile successiva il più presto possibile

# Cambiamenti tra gli endpoint

Vedi sotto per le modifiche a ciascun endpoint. Questo è strutturato in modo simile a Documentazione API (opens new window) per facilità d'uso.

Nota: non tutti gli endpoint hanno avuto modifiche.

# Commenti

# GET /comments

  • La query comment_id ora accetta più ID in un array, consentendo agli utenti di filtrare più commenti contemporaneamente.

# POST /comments

  • Questo endpoint ora accetta una serie di oggetti di commento nel corpo di richiesta, consentendo agli utenti di pubblicare più commenti contemporaneamente:

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

# Servizio dati di riferimento

Si prega di utilizzare queste note di migrazione per aiutare a passare da V1 di reference-data-service-api a V2. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.

# Deprecated Endpoints

Si prega di notare che tutti gli endpoint in V1 di questa API sono deprecati in modo che gli utenti devono passare alla versione disponibile successiva il più presto possibile

# Cambiamenti tra gli endpoint

Vedi sotto per le modifiche a ciascun endpoint. Questo è strutturato in modo simile a Documentazione API (opens new window) per facilità d'uso.

Nota: non tutti gli endpoint hanno avuto modifiche.

# Source Types

# GET /source_types

  • La logica di query show_deleted è stata aggiornata. Perfavore guarda Sopra la sezione for more information.

# Fonti

# GET /sources

  • La logica di query show_deleted è stata aggiornata. Perfavore guarda Sopra la sezione per maggiori informazioni.

# Servizio QA

Si prega di utilizzare queste note di migrazione per aiutare a passare da V1 di qa-data-service-api a V2. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.

# Endpoint deprecati

Si prega di notare che tutti gli endpoint in V1 di questa API sono deprecati in modo che gli utenti devono passare alla versione disponibile successiva il più presto possibile

# Cambiamenti tra gli endpoint

Vedi sotto per le modifiche a ciascun endpoint. Questo è strutturato in modo simile a Documentazione API (opens new window) per facilità d'uso.

# Record

# POST /records

  • Questo endpoint è stato aggiornato per accettare una serie di record nell'organismo di richiesta. Ciò consente agli utenti di pubblicare più nuovi record contemporaneamente:

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

# Servizio contesto ambientale

Si prega di utilizzare queste note di migrazione per aiutare a passare da V1 di comments-service-api a V2. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.

# Endpoint deprecati

Si prega di notare che tutti gli endpoint in V1 di questa API sono deprecati in modo che gli utenti devono passare alla versione disponibile successiva il più presto possibile

# Cambiamenti tra gli endpoint

Vedi sotto per le modifiche a ciascun endpoint. Questo è strutturato in modo simile a Documentazione API (opens new window) per facilità d'uso.

Le principali modifiche provengono dallo switch API, ora stiamo utilizzando ADS (AUP Data Service) piuttosto che CDS (servizio di dati aziendali)

Nota: non tutti gli endpoint hanno avuto modifiche.

# Progetti

# GET /projects & /ads/projects

  • Le chiavi di risposta sono cambiate
{
"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

  • Le chiavi di risposta sono cambiate
{
"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"
    }
}

# Paesi

# GET /countries

  • Le chiavi di risposta sono cambiate
{
  "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,
      }
    }
  ]
}

# Regioni

# GET /regions

  • Le chiavi di risposta sono cambiate
{
  "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

←