# Migrazione a v1
Questa guida spiega come migrare da V0 a V1, 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 predefinitatrue
) per restituire elementi non definiti (cioè attivi) nel corpo di rispostashow_deleted
- Una bandiera booleana (impostazione predefinitafalse
) per restituire oggetti cancellati nel corpo di 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.
# Impaginazione
La paginazione è stata aggiunta a diverse rotte attraverso i servizi. Questa è che le risposte così grandi possono essere gestite ragionevolmente.
La paginazione aggiunge nuove query a eventuali endpoint paginati:
+ ?page_limit=int
+ ?before=base64
+ ?after=base64
Laddove non presente prima, saranno presenti anche nuove query di order
e sort_by
sugli endpoint paginati:
+ ?sort_by=name
+ ?order=desc
Si prega di consultare la documentazione per ulteriori informazioni su queste domande.
Anche i corpi di risposta per gli endpoint paginati sono stati aggiornati con nuove chiavi:
+ paging: {
+ cursors: {
+ before: "MjUxYjYzNzAtNDk1MC1lNzExLTgxMDQtMDA1MDU2YjU3NDU5",
+ after: "OGExMTcxNzAtNDk1MC1lNzExLTgxMDQtMDA1MDU2YjU3NDU5"
+ },
+ previous: "http://ddb.arup.com/api/projects?before=MjUxYjYzNzAtNDk1MC1lNzExLTgxMDQtMDA1MDU2YjU3NDU5",
+ next: "http://ddb.arup.com/api/projects?after=MjUxYjYzNzAtNDk1MC1lNzExLTgxMDQtMDA1MDU2YjU3NDU5"
+ },
+ summary: {
+ estimate_count: 44
+ }
# Messaggio di errore
Le risposte all'errore del client non includono più la chiave source
:
{
details: "id \"632f6133-c5c4-4232-bdb6-c1a227a48b8e\" could not be found",
msg: "Route Not Found",
- source: "body"
}
# Servizio di parametri
Si prega di utilizzare queste note di migrazione per aiutare a passare da V0 di parameter-service-api
a V1. Questa sezione dovrebbe descrivere in dettaglio tutte le modifiche tra le versioni.
# Endpoint deprecati
I seguenti endpoint sono stati rimossi da V1:
# **GET /parameters/:parameter_id/revision**
Sostituito dal nuovo endpoint GET /entries/:entry_id/revisions
(vedi sotto)
# **POST /parameters/:parameter_id/revision**
Sostituito dal nuovo endpoint PUT /entries
(vedi sotto)
# **PATCH /parameters/:parameter_id/revision**
Sostituito dal nuovo endpoint PATCH /revisions
(vedi sotto)
# 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.
# Risorse
# GET /assets
Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
Il corpo di risposta ora include la proprietà
asset_type_id
nella chiaveasset_sub_type
:asset_sub_type: { id: "a7154e9a-9dd4-4983-a900-c172a3366544", name: "Domestic Hot Water", + asset_type_id: "577cfd8d-8da0-4d78-b4a4-c81ab728d4bf", parent_asset_sub_type_id: "f2ac4d11-6854-4763-b26e-2b2c664390cb" }
La query
show_deleted_assets
è stata sostituita. Perfavore guarda Sopra la sezione per maggiori informazioni- GET /assets?show_deleted_assets=true + GET /assets?show_deleted=true
# POST /assets
Questo endpoint ora accetta uno di
asset_type_id
oasset_sub_type_id
nell'organismo di richiesta:Se stai fornendo
asset_sub_type_id
, il camponame
è facoltativo e se lasciato vuoto verrà popolato automaticamente per abbinare il nomeasset_sub_type
.Se si fornisce un
asset_type_id
solo per una risorsa che haasset_sub_type
proprietà ditrue
, riceverai un errore se la pubblicazione con una proprietàname
non corrisponde a uno dei nomi dei tipi secondari validi.Il corpo di risposta ora include la proprietà
asset_type_id
nella chiaveasset_sub_type
:asset_sub_type: { id: "a7154e9a-9dd4-4983-a900-c172a3366544", name: "Domestic Hot Water", + asset_type_id: "577cfd8d-8da0-4d78-b4a4-c81ab728d4bf", parent_asset_sub_type_id: "f2ac4d11-6854-4763-b26e-2b2c664390cb" }
# GET /assets/{asset_id}
Il corpo di risposta ora include la proprietà
asset_type_id
nella chiaveasset_sub_type
:asset_sub_type: { id: "a7154e9a-9dd4-4983-a900-c172a3366544", name: "Domestic Hot Water", + asset_type_id: "577cfd8d-8da0-4d78-b4a4-c81ab728d4bf", parent_asset_sub_type_id: "f2ac4d11-6854-4763-b26e-2b2c664390cb" }
La query
show_deleted_assets
è stata sostituita. Si prega di consultare il Sopra la sezione per maggiori informazioni- GET /assets?show_deleted_assets=true + GET /assets?show_deleted=true
# GET /assets/{asset_ids}/hierarchy
Ogni oggetto
hierarchy
nel corpo di risposta ora include un tastoasset_type_id
:{ hierarchies: [ [ { id: "a3d5c386-9451-495e-9d3c-8ed152b1300f", name: "Wellington Place", + asset_type_id: "a3d5c386-9451-495e-9d3c-8ed152b1300f" } ] ] }
# Inserimenti
Una voce rappresenta un valore per un parametro. Le voci possono essere riviste. Attualmente, i parametri sono limitati al massimo di una voce. Nelle versioni future, i parametri avranno la capacità di avere più voci. Si prega di consultare il documentazione (opens new window) per maggiori informazioni.
Ci sono quattro nuove rotte relative alle voci:
# GET /entries
- Questo endpoint restituisce tutte le voci, questo è query da una serie di
parameter_id
.
# PUT /entries
- Questo endpoint sostituisce
POST /parameters/:parameter_id/revision
e ti consente di creare o aggiornare una o più voci. - Questo endpoint accetta un array di
entries
. I campi richiesti sonoentry_id
,parameter_id
,source_id
,values
. Attualmente,values
ha una lunghezza massima di uno. Le aggiunte opzionali sonocomment
elocation_in_source
.
# GET /entries/:entry_id/revisions
- Questo endpoint sostituisce
GET /parameters/:parameter_id/revision
e restituisce tutte le revisioni per un specificatoentry_id
.
# PATCH /revisions
- Questo endpoint sostituisce l'endpoint
PATCH /parameters/:parameter_id/revisions
e consente agli utenti di aggiornarestatus
di più revisioni relative a più voci diverse contemporaneamente. - Gli utenti dovrebbero solo aggiornare ilultima ultimoRevisione di una voce
- Gli utenti sono tenuti a specificare
revision_id
della revisione da aggiornare - Se gli utenti stanno aggiornando la revisione
status
allo stato QArejected
Acomment
La proprietà è richiesta.
# Set di parametri
Nota: i set di parametri sono in rilascio di alfa per i test. Non è consigliabile utilizzare questi percorsi in produzione.
Le convenzioni di denominazione per set di parametri sono state modificate da V0 a V1. Le modifiche sono le seguenti:
V0 Convenzione di denominazione | V1 Convenzione di denominazione |
---|---|
parameter_set_type | parameter_set_category |
parameter_set | parameter_set_type |
parameter_set_instance | parameter_set |
Ciò ha comportato l'aggiornamento delle rotte nel modo seguente:
V0 Route | V1 Route |
---|---|
GET /parameter_set_types | GET /parameter_set_categories |
GET /parameter_sets | GET /parameter_set_types |
POST /parameter_sets | POST /parameter_set_types |
DELETE /parameter_sets/:parameter_set_id | DELETE /parameter_set_types/:parameter_set_type_id |
POST /parameter_sets/:parameter_set_id/items | POST /parameter_set_types/:parameter_set_type_id/items |
DELETE //parameter_sets/:parameter_set_id/items/:item_type_id | DELETE /parameter_set_types/:parameter_set_type_id/items/:item_type_id |
GET /parameter_sets/:parameter_set_id/instances | GET /parameter_sets |
GET /parameter_sets/:parameter_set_id/instances/:instance_id | GET /parameter_sets/:parameter_set_id |
GET /parameter_sets/:parameter_set_id/instances/:instance_id/parameters | GET /parameter_sets/:parameter_set_id/parameters |
Le chiavi sui corpi di risposta sono state aggiornate nel modo pertinente. Ad esempio, una richiesta a GET /parameter_set_categories
(precedentemente noto come GET /parameter_set_types
) restituirà una risposta con:
{
- parameter_set_types: [ ... ]
+ parameter_set_categories: [ ... ]
}
Tutti gli endpoint dovrebbero comportarsi in modo simile (esclusi gli endpoint dettagliati di seguito).
# GET /parameter_sets
Questo endpoint sostituisce l'endpoint V0 GET /parameter_sets/:parameter_set_id/instances
. Per filtrare i parametri set di parameter_set_type_id
pertinenti, questo viene passato attraverso una query sull'endpoint:
+ GET /parameter_sets?parameter_set_type_id=uuid
Questo restituirà tutto parameter_sets
della specifica parameter_set_type_id
.
# GET /parameter_sets/:parameter_set_id/parameters
Questo endpoint contiene una risposta ridotta rispetto alla versione V0 (GET /parameter_sets/:parameter_set_id/instances/:instance_id/parameters
):
{
- parameter_set_instance_parameters: [
+ parameter_set_parameters: [
{
...parameter,
parameter_type: {
id,
name,
data_type,
global_parameter,
- unit_type_id,
- created_at,
- deleted_at,
- updated_at
},
parents: [
{
id,
asset_sub_type,
children,
name,
parent,
asset_type: {
id,
name,
parent_id,
- asset_sub_type,
- asset_type_group,
- created_at,
- deleted_at,
},
- project_id,
- deleted_at,
}
]
}
],
... rest
}
# Parametri
# GET /parameters
Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
La query
show_deleted_parameters
è stata sostituita. Si prega di consultare il Sopra la sezione per maggiori informazioni- GET /parameters?show_deleted_parameters=true + GET /assets?show_deleted=true
La query
offset
è stata rimossa:- GET /parameters?offset=
La chiave
revision
nel corpo di risposta è stata rinominata aselected_entry
:{ parameters: [ { ... parameter, - revision: { ... } + selected_entry: { ... } }, ... ] }
La chiave
selected_entry.source
contiene una risposta ridottasource: { id: "286a550e-00bc-4b1e-8e20-71f96b43e9c6", created_at: "2022-07-18T16:00:53.182Z", - updated_at: "2022-07-18T16:00:53.182Z", - deleted_at: null, - time: null, date_day: "15", date_month: "1", date_year: "2021", reference: "Assumption", - reference_id: "90803033-268a-ea11-8129-005056b50c57", - reference_table: "project", - reference_url: "dev.ddb.arup.com/api/project", - scope: "90803033-268a-ea11-8129-005056b50c57", title: "Assumption", url: "TBA", source_type: { id: "6a1292c7-a245-41cf-8872-46feb9a7fd11", name: "Assumption", - visible: true, - deleted_at: null } }
La chiave
selected_entry.created_by
contiene una risposta ridottacreated_by: { - staff_id: 12345, staff_name: "Arup Employee Name", email: "[email protected]", - company_centre_arup_unit: "01-462 NOR Digital Services", - location_name: "Edinburgh Office", - grade_level: 3, - my_people_page_url: "https://arup-my.sharepoint.com/PersonImmersive.aspx?accountname=i:0%83.f%7cmembership%[email protected]" },
The
selected_entry
key does not have anupdated_at
,comment
orlocation_in_source
property.
# POST /parameters
- La chiave
revision
nel corpo di richiesta è stata sostituita conentries
, che accetta un array. - C'è una chiave
entry_id
opzionale nel corpo post corpoentries
: - Se stai aggiungendo una nuova voce a unsenza rispostaParametro, questo può essere lasciato vuoto e popolerà automaticamente con un nuovo UUID.
- Se vuoi revisionare unRispostaParametro, è necessario fornire la revisione dell'esistente
entry_id
.
Questo è attualmente limitato a un elemento nella proprietà entries
.
La chiave
revision
nel corpo post risposta è ora rinominata aselected_entry
- revision: { ... } + selected_entry: { ... }
# GET /parameters/{parameter_id}
La query
show_deleted_parameters
è stata sostituita. Si prega di consultare il Sopra la sezione per maggiori informazioni- GET /parameters/:parameter_id?show_deleted_parameters=true + GET /parameters/:parameter_id?show_deleted=true
La chiave
revision
nel corpo della risposta è stata rinominata aselected_entry
- revision: { ... } + selected_entry: { ... }
La chiave
selected_entry.source
contiene una risposta ridottasource: { id: "286a550e-00bc-4b1e-8e20-71f96b43e9c6", created_at: "2022-07-18T16:00:53.182Z", - updated_at: "2022-07-18T16:00:53.182Z", - deleted_at: null, - time: null, date_day: "15", date_month: "1", date_year: "2021", reference: "Assumption", - reference_id: "90803033-268a-ea11-8129-005056b50c57", - reference_table: "project", - reference_url: "dev.ddb.arup.com/api/project", - scope: "90803033-268a-ea11-8129-005056b50c57", title: "Assumption", url: "TBA", source_type: { id: "6a1292c7-a245-41cf-8872-46feb9a7fd11", name: "Assumption", - visible: true, - deleted_at: null } }
La chiave
selected_entry.created_by
contiene una risposta ridottacreated_by: { - staff_id: 12345, staff_name: "Arup Employee Name", email: "[email protected]", - company_centre_arup_unit: "01-462 NOR Digital Services", - location_name: "Edinburgh Office", - grade_level: 3, - my_people_page_url: "https://arup-my.sharepoint.com/PersonImmersive.aspx?accountname=i:0%83.f%7cmembership%[email protected]" },
La chiave
selected_entry
non ha una proprietàupdated_at
,comment
olocation_in_source
.
# Albero
Esistono diversi nuovi endpoint per restituire le gerarchie degli alberi. Si prega di consultare il documentazione (opens new window) Per ulteriori informazioni su questi endpoint.
# GET /asset_tree
- Nuovo endpoint che restituisce un albero di attività di
asset_id
.
# GET /asset_type_tree
- Nuovo endpoint che restituisce un albero di tipo patrimoniale di
asset_type_id
.
# Tipi
# GET /asset_type_groups
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
# GET /asset_types
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
# GET /asset_types/{asset_type_id}/asset_sub_types
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
# GET /parameter_types
Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
La chiave
name
sulla proprietàdefault_unit
nel corpo di risposta è stata rinominata asymbol
:default_unit: { id: "b39e5bcf-cda6-49ed-8c0c-174d8daf8bc1", - name: "°C", + symbol: "°C", unit_type_id: "5391cd71-08f0-44f8-9dd2-6379a511dd29", unit_system_id: "50115948-140f-48fc-b5f2-c56e96869734" }
# GET /item_types
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
- La query
offset
è stata rimossa.
# GET /unit_types
Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
Ogni oggetto
unit_type
ha una nuova chiaveunit_systems
, contenente i sistemi e le unità unità disponibili per quel particolare tipounit_types: [ { id: "e8c3da00-5c20-45f1-a24c-0d657bcae032", name: "Geotechnics analysis material type", created_at: "2022-06-24T12:26:00.263Z", updated_at: "2022-06-24T12:26:00.263Z", deleted_at: null, + unit_systems: [ + { + id: "5508a780-9f9f-4e6d-bc9c-a84607a5ba87", + name: "Drop-down list", + short_name: "Drop-down", + units: [ + { + id: "892c32c1-808a-440a-8290-e05fdf5457ba", + symbol: "Mohr-coulomb, linear-elastic" + } + ] + } + ] } ]
# POST /unit_types
- Il corpo di risposta
unit_types
per il metodo post è stato aggiornato allo stesso modo delGET /unit_types
- Fare riferimento a questa sezione per i dettagli.
# GET /unit_types/:unit_type_id
- Il corpo di risposta dell'oggetto
unit_type
ora includecreated_at
,updated_at
edeleted_at
tasti:
unit_type: {
id: "38f045f3-ce7a-4a38-9fe7-f9d72d07a129",
name: "Area",
+ created_at: "2021-12-22T13:07:17.214Z",
+ updated_at: "2021-12-22T13:07:17.214Z",
+ deleted_at: null,
unit_systems: [ ... ]
}
# Unità
# GET /units
Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
La chiave
name
nel corpo di risposta è stata rinominata asymbol
:{ id: "a3d5c386-9451-495e-9d3c-8ed152b1300f", created_at: "2019-05-10T13:45:08.000Z", deleted_at: "2020-06-18T11:25:21.000Z", - name: "m", + symbol: "m", updated_at: "2020-06-12T13:39:41.000Z", unit_type_id: "7a857f03-a222-405c-bc03-90d6dcaa8e0e", unit_system_id: "50115948-140f-48fc-b5f2-c56e96869734" }
# POST /units
L'organismo di richiesta non accetta più un campo
name
. Questo dovrebbe ora esseresymbol
:{ id: "cdbcb4d1-b6c1-436c-8126-737c29c9b2f4", - name: "°F", + symbol: "°F", unit_type_id: "b68caf97-e537-4ce4-b3bd-7131f0e72e93", unit_system_id: "50115948-140f-48fc-b5f2-c56e96869734" }
# GET /unit_systems
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
# Servizio di metadati dei parametri
Si prega di utilizzare queste note di migrazione per aiutare a passare da V0 del parameter-metadata-service-api
a V1. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.
# Endpoint deprecati
Si prega di notare che tutti gli endpoint in V0 dell'API vengono deprecati, quindi gli utenti devono essere aggiornati alla versione disponibile successiva
# 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.
# Allow Custom
allow_custom
è una nuova chiave nel corpo di risposta per tutti gli oggettitag_type
restituiti endpoint. Questa proprietà significa se untag_type
accetta tag personalizzati o non utilizza un valore booleano ditrue
ofalse
.tag_type: { id: "1e08965a-f116-4a6d-8bba-74290edc8c0a", created_at: "2019-05-10T13:45:08.000Z", deleted_at: "2019-05-10T13:45:08.000Z", name: "Calculation", updated_at: "2019-05-10T13:45:08.000Z", + allow_custom: false }
# Etichetta
# GET /tags
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
- Nuove query aggiunte per il recupero di tag cancellati. Perfavore guarda Sopra la sezione per maggiori informazioni.
- La query
item_limit
è stata sostituita dalla querypage_limit
come parte della paginazione. - È disponibile una nuova query per
tag_scope
, questa può essere una o piùproject_id
e restituirà tutti i tag con il datotag_scope
. Un filtro a stringa di query vuoto (null
) per tutti i tag senza portata, ovvero tag globali. - È disponibile una nuova query per
omit_global
(bool). Se vero, questo omette tutti i tag globali (quelli contag_scope = null
) dal risultato. Il valore predefinito per questa query èfalse
. - L'oggetto
tag_type
nel corpo di risposta per untag
ora include una nuova chiave diallow_custom
. Perfavore guarda questa sezione per maggiori informazioni.
# POST /tags
- Questo è un nuovo endpoint che consente agli utenti di aggiungere un nuovo tag.
- Qualsiasi utente può pubblicare un tag personalizzato che viene espulso a un progetto (ovvero un tag che ha
tag_type
con la proprietàallow_custom: true
etag_scope: your-project-uuid
). La pubblicazione di tag globali richiede privilegi di amministrazione.
# GET /tags/:tag_id
- L'oggetto
tag_type
nel corpo di risposta ora include una nuova chiave diallow_custom
. Perfavore guarda questa sezione per maggiori informazioni.
# PATCH /tags/:tag_id
- Questo è un nuovo endpoint che consente di aggiornare una proprietà tag
name
. - Questo endpoint richiede privilegi di amministrazione.
# DELETE /tags/:tag_id
- Questo è un nuovo endpoint che ti consente di eliminare un tag di
tag_id
. - Questo endpoint richiede privilegi di amministrazione.
# Collegamenti tag
# GET /tags/:tag_id/links
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
- Nuove query aggiunte per il recupero di collegamenti a tag cancellati. Perfavore guarda Sopra la sezione per maggiori informazioni.
# GET /tags/:tag_id/links/:reference_id
- Questo è un nuovo endpoint per gli utenti per ottenere un collegamento di tag esistente tra le risorse.
# PATCH /tags/{tag_id}/links/{reference_id}
- Questo è un nuovo endpoint per aggiornare un collegamento
reference_table
e/oreference_url
tra un tag e un riferimento.
# PUT /tag_links
- Questo è un nuovo endpoint che consente agli utenti di mettere nuovi e/o aggiornare
tag_link
esistenti.
# Tipo di tag
# GET /tag_types
- Paginazione aggiunta. Si prega di consultare il Sezione iniziale per maggiori informazioni.
- Nuove query aggiunte per il recupero dei tipi di tag cancellati. Perfavore guarda Sopra la sezione per maggiori informazioni.
- Gli oggetti
tag_type
nel corpo di risposta ora includono una nuova chiave diallow_custom
. Perfavore guarda questa sezione per maggiori informazioni.
# POST /tag_types
- Questo è un nuovo endpoint che ti consente di aggiungere un nuovo
tag_type
. - Questo endpoint richiede privilegi di amministrazione.
# GET /tag_types/:tag_type_id
- L'oggetto
tag_type
nel corpo di risposta ora include una nuova chiave diallow_custom
. Perfavore guarda questa sezione per maggiori informazioni.
# PATCH /tag_types/{tag_type_id}
- Questo è un nuovo endpoint che consente agli utenti di aggiornare un singolo
tag_type
.
*Nota: questo endpoint richiede privilegi di amministrazione. *
# DELETE /tag_types/{tag_type_id}
- Nuovo endpoint che elimina un singolo tipo di tag utilizzando
tag_type_id
come query richiesta - Questo endpoint richiede privilegi di amministrazione.
# Servizio di contesto dell'ambiente
Si prega di utilizzare queste note di migrazione per aiutare a passare da V0 di Environmental-Context-Service-api
a V1. Questo documento dovrebbe descrivere in dettaglio tutte le modifiche nelle versioni.
# Endpoint deprecati
Si prega di notare che tutti gli endpoint in V0 di questa API vengono deprecati, quindi gli utenti devono essere aggiornati alla versione disponibile successiva