DDB dokumentation

# Migration til V1

Denne vejledning forklarer, hvordan man migrerer fra V0 til V1, 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.

# Pagination

Pagination er føjet til flere ruter på tværs af tjenesterne. Dette er så store svar kan styres rimeligt.

Pagination tilføjer nye forespørgsler til eventuelle paginerede slutpunkter:

+ ?page_limit=int
+ ?before=base64
+ ?after=base64

Hvor ikke er til stede før, vil nye forespørgsler på show_deleted og order også være til stede på paginerede slutpunkter:

+ ?sort_by=name
+ ?order=desc

Se dokumentationen for mere information om disse forespørgsler.

Responsorganerne for paginerede slutpunkter er også blevet opdateret med nye nøgler:

+ 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
+  }

# Fejlmeddelelser

Klientfejlresponser inkluderer ikke længere sort_by -nøglen:

  {
    details: "id \"632f6133-c5c4-4232-bdb6-c1a227a48b8e\" could not be found",
    msg: "Route Not Found",
-   source: "body"
  }

# Parametertjeneste

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

# Udskrivede slutpunkter

Følgende endepunkter er blevet fjernet fra V1:

# parameter-service-api

Erstattet af nyt slutpunkt **GET /parameters/:parameter_id/revision** (se nedenfor)

# GET /entries/:entry_id/revisions

Erstattet af nyt slutpunkt **POST /parameters/:parameter_id/revision** (se nedenfor)

# PUT /entries

Erstattet af nyt slutpunkt **PATCH /parameters/:parameter_id/revision** (se nedenfor)

# Æ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.

# Aktiver

# PATCH /revisions

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.

  • Responseorganet inkluderer nu GET /assets egenskab i asset_type_id -nøglen:

    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"
    }

  • asset_sub_type forespørgsel er blevet udskiftet. Se venligst Ovenstående afsnit for mere information

    - GET /assets?show_deleted_assets=true
+ GET /assets?show_deleted=true

# show_deleted_assets

  • Dette slutpunkt accepterer nu en af POST /assets eller asset_type_id i anmodningsorganet:

  • Hvis du leverer asset_sub_type_id, er feltet asset_sub_type_id valgfrit, og hvis det ikke er tomt, vil det udfyldes automatisk for at matche name -navnet.

  • Hvis du kun leverer en asset_sub_type for et aktiv, der har asset_type_id egenskab på asset_sub_type, vil du modtage en fejl, hvis du poster med en true egenskab, der ikke matcher et af de gyldige undertypenavne.

  • Responseorganet inkluderer nu name egenskab i asset_type_id -nøglen:

    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"
    }

# asset_sub_type

  • Responskroppen inkluderer nu GET /assets/{asset_id} egenskab i asset_type_id -nøglen:

    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"
    }

  • asset_sub_type forespørgsel er blevet udskiftet. Se venligst Ovenstående afsnit for mere information

    - GET /assets?show_deleted_assets=true
+ GET /assets?show_deleted=true

# show_deleted_assets

  • Hvert GET /assets/{asset_ids}/hierarchy -objekt i responsorganet inkluderer nu en hierarchy -nøgle:

    {
  hierarchies: [
    [
      {
        id: "a3d5c386-9451-495e-9d3c-8ed152b1300f",
        name: "Wellington Place",
+       asset_type_id: "a3d5c386-9451-495e-9d3c-8ed152b1300f"
      }
    ]
  ]
}

# Poster

En post repræsenterer en værdi for en parameter. Indlæg kan revideres. I øjeblikket er parametre begrænset til maksimalt en post. I fremtidige versioner vil parametre have kapacitet til at have flere poster. Se venligst dokumentation (opens new window) for mere information.

Der er fire nye ruter, der vedrører poster:

# asset_type_id

  • Dette slutpunkt returnerer alle poster, dette kan forespørgsler med en række GET /entries 's.

# parameter_id

  • Dette slutpunkt erstatter PUT /entries og giver dig mulighed for at oprette eller opdatere en eller flere poster.
  • Dette slutpunkt accepterer en række POST /parameters/:parameter_id/revision. Påkrævede felter er entries, entry_id, parameter_id, source_id. I øjeblikket har values en maksimal længde på en. Valgfrie tilføjelser er values og comment.

# location_in_source

  • Dette slutpunkt erstatter GET /entries/:entry_id/revisions og returnerer alle revisioner for en specificeret GET /parameters/:parameter_id/revision.

# entry_id

  • Dette slutpunkt erstatter PATCH /revisions slutpunktet og giver brugerne mulighed for at opdatere PATCH /parameters/:parameter_id/revisions af flere revisioner relateret til flere forskellige poster på én gang.
  • Brugere skal kun opdateresenesteRevision af en post
  • Brugere skal specificere status af revisionen for at opdatere
  • Hvis brugere opdaterer revisionen revision_id til QA -tilstand status En rejected ejendom er påkrævet.

# Parametersæt

Bemærk: Parametersæt er i alfa -frigivelse til test. Det anbefales ikke at bruge disse ruter i produktionen.

Navnekonventioner for parametersæt er blevet ændret fra V0 til V1. Ændringer er som følger:

V0 navnekonvention V1 navnekonvention
comment parameter_set_type
parameter_set_category parameter_set
parameter_set_type parameter_set_instance

Dette har resulteret i opdateringen af ruter på følgende måde:

v0 rute v1 rute
parameter_set 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

Tasterne på svarlegemerne er blevet opdateret på den relevante måde. For eksempel vil en anmodning til GET /parameter_sets/:parameter_set_id/parameters (tidligere kendt som GET /parameter_set_categories) returnere et svar med:

{
- parameter_set_types: [ ... ]
+ parameter_set_categories: [ ... ]
}

Alle slutpunkter skal opføre sig på en lignende måde (eksklusive slutpunkter beskrevet nedenfor).

# GET /parameter_set_types

Dette slutpunkt erstatter V0 -slutpunktet GET /parameter_sets. For at filtrere parametersæt med de relevante GET /parameter_sets/:parameter_set_id/instances dette overføres gennem en forespørgsel på slutpunktet:

+ GET /parameter_sets?parameter_set_type_id=uuid

Dette returnerer alle parameter_set_type_id af den specificerede parameter_sets.

# parameter_set_type_id

Dette slutpunkt indeholder en reduceret respons sammenlignet med V0 -versionen (GET /parameter_sets/:parameter_set_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
}

# Parametre

# GET /parameter_sets/:parameter_set_id/instances/:instance_id/parameters

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.

  • GET /parameters forespørgsel er blevet udskiftet. Se venligst Ovenstående afsnit for mere information

    - GET /parameters?show_deleted_parameters=true
+ GET /assets?show_deleted=true

  • show_deleted_parameters forespørgsel er fjernet:

    - GET /parameters?offset=

  • offset -nøglen i responslegemet er blevet omdøbt til revision:

    {
  parameters: [
    {
      ... parameter,
-    revision: { ... }
+     selected_entry: { ... }
    },
    ...
  ]
}

  • Tasten selected_entry indeholder et reduceret svar

    source: {
          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
          }
        }

  • Tasten selected_entry.source indeholder et reduceret svar

    created_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]"
},

  • Tasten selected_entry.created_by har ikke en selected_entry, updated_at eller comment ejendom.

# location_in_source

  • POST /parameters -nøglen i anmodningsorganet er blevet erstattet med revision, der accepterer en matrix.
  • Der er en valgfri entries -nøgle i entry_id postkroppen:
  • Hvis du tilføjer en ny post til enubesvaretParameter, dette kan efterlades tomt og udfyldes automatisk med en ny UUID.
  • Hvis du ønsker at revidere ensvaredeParameter, skal du give de eksisterende entries for at revidere.

Dette er i øjeblikket kun begrænset til et element i entry_id egenskaben.

  • entries -tasten i post -svaret omdøbes nu til revision

    - revision: { ... }
+ selected_entry: { ... }

# selected_entry

  • GET /parameters/{parameter_id} forespørgsel er blevet udskiftet. Se venligst Ovenstående afsnit for mere information

    - GET /parameters/:parameter_id?show_deleted_parameters=true
+ GET /parameters/:parameter_id?show_deleted=true

  • show_deleted_parameters -nøglen i svarkroppen er omdøbt til revision

    - revision: { ... }
+ selected_entry: { ... }

  • Tasten selected_entry indeholder et reduceret svar

    source: {
          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
          }
        }

  • Tasten selected_entry.source indeholder et reduceret svar

    created_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]"
},

  • Tasten selected_entry.created_by har ikke en selected_entry, updated_at eller comment ejendom.

# Træ

Der er flere nye slutpunkt for at returnere træhierarkier. Se venligst dokumentation (opens new window) For mere information om disse slutpunkter.

# location_in_source

  • Nyt slutpunkt, der returnerer et aktivtræ med GET /asset_tree.

# asset_id

  • Nyt slutpunkt, der returnerer et aktivtype -træ med GET /asset_type_tree.

# Typer

# asset_type_id

# GET /asset_type_groups

# GET /asset_types

# GET /asset_types/{asset_type_id}/asset_sub_types

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.

  • GET /parameter_types -nøglen på name egenskaben i responsorganet er omdøbt til default_unit:

    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"
      }

# symbol

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.
  • GET /item_types forespørgsel er fjernet.

# offset

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.

  • Hvert GET /unit_types -objekt har en ny unit_type -nøgle, der indeholder de enhedssystemer og enheder, der er tilgængelige for den bestemte type

    unit_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"
+      }
+    ]
+  }
+ ]
}
]

# unit_systems

  • POST /unit_types Response Body for POST -metoden er blevet opdateret på samme måde som unit_types - Se dette afsnit for detaljer.

# GET /unit_types

  • GET /unit_types/:unit_type_id Object Response Body inkluderer nu unit_type, created_at og updated_at nøgler:
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: [ ... ]
 }

# Enheder

# deleted_at

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.

  • GET /units -nøglen i responsorganet er omdøbt til name:

    {
  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"
}

# symbol

  • Anmodningskroppen accepterer ikke længere et POST /units felt. Dette skulle nu være name:

    {
  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"
  }

# symbol

# Parametermetadatatjeneste

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

# Udskrivede slutpunkter

Bemærk, at alle slutpunkter i V0 i API udskrives, så brugerne skal opgradere til den næste tilgængelige version

# Æ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.

# parameter-metadata-service-api

  • Allow Custom er en ny nøgle i responsorganet for alle allow_custom objekter returnerede slutpunkter. Denne egenskab betyder, om en tag_type accepterer brugerdefinerede tags eller ikke bruger en boolsk værdi på tag_type eller true.

    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
      }

# Tag

# false

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.
  • Nye forespørgsler tilføjet til hentning af slettede tags. Se venligst Ovenstående afsnit for mere information.
  • GET /tags forespørgsel er blevet erstattet af item_limit forespørgsel som en del af pagination.
  • Der er en ny forespørgsel til rådighed for page_limit, dette kan være en eller flere tag_scope 's og vil returnere alle tags med de givne project_id. En tom (tag_scope) forespørgselsstrengfiltre til alle tags uden omfang, dvs. globale tags.
  • Der er en ny forespørgsel til rådighed for null (bool). Hvis det er sandt, udelader dette alle globale tags (dem med omit_global) fra resultatet. Standardværdien for denne forespørgsel er tag_scope = null.
  • false -objektet i responsorganet for en tag_type inkluderer nu en ny nøgle på tag. Se venligst Dette afsnit for mere information.

# allow_custom

  • Dette er et nyt slutpunkt, der giver brugerne mulighed for at tilføje et nyt tag.
  • Enhver bruger kan sende et brugerdefineret tag, der er scoped til et projekt (dvs. et tag, der har POST /tags med egenskab tag_type og allow_custom: true). Udstationering af globale tags kræver admin -privilegier.

# tag_scope: your-project-uuid

  • GET /tags/:tag_id -objektet i responsorganet inkluderer nu en ny nøgle på tag_type. Se venligst Dette afsnit for mere information.

# allow_custom

  • Dette er et nyt slutpunkt, der giver dig mulighed for at opdatere et tag PATCH /tags/:tag_id ejendom.
  • Dette slutpunkt kræver admin -privilegier.

# name

  • Dette er et nyt slutpunkt, der giver dig mulighed for at slette et tag af DELETE /tags/:tag_id.
  • Dette slutpunkt kræver admin -privilegier.

# tag_id

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.
  • Nye forespørgsler tilføjet til hentning af slettede tag -links. Se venligst Ovenstående afsnit for mere information.
  • Dette er et nyt slutpunkt for brugerne at få et eksisterende tag -link mellem ressourcer.
  • Dette er et nyt slutpunkt til at opdatere en links PATCH /tags/{tag_id}/links/{reference_id} og/eller reference_table mellem et tag og reference.

# reference_url

  • Dette er et nyt slutpunkt, der giver brugerne mulighed for at sætte nye og/eller opdatere eksisterende PUT /tag_links 's.

# TAG TYPE

  • Pagination tilføjede. Se venligst Begyndelsesafsnit for mere information.
  • Nye forespørgsler tilføjet til hentning af slettede tagtyper. Se venligst Ovenstående afsnit for mere information.
  • GET /tag_types -objekterne i responslegemet inkluderer nu en ny nøgle på tag_type. Se venligst Dette afsnit for mere information.

# allow_custom

  • Dette er et nyt slutpunkt, der giver dig mulighed for at tilføje en ny POST /tag_types.
  • Dette slutpunkt kræver admin -privilegier.

# tag_type

  • GET /tag_types/:tag_type_id -objektet i responskroppen inkluderer nu en ny nøgle på tag_type. Se venligst Dette afsnit for mere information.

# allow_custom

  • Dette er et nyt slutpunkt, der giver brugerne mulighed for at opdatere en enkelt PATCH /tag_types/{tag_type_id}.

*Bemærk: Dette slutpunkt kræver admin -privilegier. *

# tag_type
  • Nyt slutpunkt, der sletter en enkelt tag -type ved hjælp af DELETE /tag_types/{tag_type_id} som en påkrævet forespørgsel
  • Dette slutpunkt kræver admin -privilegier.

# Miljøkonteksttjeneste

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

# Udskrivede slutpunkter

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

Last Updated: 13.9.2023 15.19.15

← Migration til V2 →