Dokumentasi DDB

# Migrasi ke V2

Panduan ini menerangkan cara berhijrah dari V1 hingga V2, untuk microservices yang terjejas.

# Perubahan di seluruh perkhidmatan

# Meminta item yang dipadam

Dapatkan titik akhir yang membolehkan pulangan item yang dipadam kini mempunyai pertanyaan berikut yang tersedia:

  • show_active - Bendera Boolean (lalai true) untuk mengembalikan item yang tidak dipadamkan (iaitu aktif) dalam badan tindak balas
  • show_deleted - Bendera Boolean (lalai false) untuk mengembalikan item yang dipadam dalam badan tindak balas.

Secara lalai, item aktif akan dikembalikan sahaja.

To return deleted items only, request with show_deleted value true and show_active value false.

Untuk mengembalikan item aktif dan dipadam, minta nilai show_deleted true.

Nota: Sesetengah titik akhir mengandungi pertanyaan show_deleted sahaja, tetapi tingkah laku adalah sama.

# Komen Perkhidmatan

Sila gunakan nota penghijrahan ini untuk membantu beralih dari V1 dari comments-service-api ke V2. Dokumen ini harus memperincikan semua perubahan di seluruh versi.

# Deprecated Endpoints

Sila ambil perhatian bahawa semua titik akhir dalam v1 API ini ditutup sehingga pengguna mesti menaik taraf ke versi yang tersedia seterusnya secepat mungkin

# Perubahan di titik akhir

Sila lihat di bawah untuk perubahan pada setiap titik akhir. Ini berstruktur dengan cara yang sama dengan Dokumentasi API (opens new window) for ease of use.

Nota: Tidak semua titik akhir mempunyai perubahan.

# Komen

# GET /comments

  • Pertanyaan comment_id kini menerima pelbagai ID dalam array, yang membolehkan pengguna menapis untuk beberapa komen sekaligus.

# POST /comments

  • Titik akhir ini kini menerima pelbagai objek komen dalam badan permintaan, yang membolehkan pengguna menyiarkan beberapa komen sekaligus:

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

# Perkhidmatan data rujukan

Sila gunakan nota penghijrahan ini untuk membantu beralih dari V1 dari reference-data-service-api ke V2. Dokumen ini harus memperincikan semua perubahan di seluruh versi.

# Titik akhir yang tidak ditetapkan

Sila ambil perhatian bahawa semua titik akhir dalam v1 API ini ditutup sehingga pengguna mesti menaik taraf ke versi yang tersedia seterusnya secepat mungkin

# Perubahan di titik akhir

Sila lihat di bawah untuk perubahan pada setiap titik akhir. Ini berstruktur dengan cara yang sama dengan Dokumentasi API (opens new window) untuk kemudahan penggunaan.

Nota: Tidak semua titik akhir mempunyai perubahan.

# Jenis sumber

# GET /source_types

  • Logik pertanyaan show_deleted telah dikemas kini. Sila lihat bahagian di atas untuk maklumat lanjut.

# Sumber

# GET /sources

  • Logik pertanyaan show_deleted telah dikemas kini. Sila lihat bahagian di atas untuk maklumat lanjut.

# Perkhidmatan QA

Sila gunakan nota penghijrahan ini untuk membantu beralih dari V1 dari qa-data-service-api ke V2. Dokumen ini harus memperincikan semua perubahan di seluruh versi.

# Titik akhir yang tidak ditetapkan

Sila ambil perhatian bahawa semua titik akhir dalam v1 API ini ditutup sehingga pengguna mesti menaik taraf ke versi yang tersedia seterusnya secepat mungkin

# Perubahan di titik akhir

Sila lihat di bawah untuk perubahan pada setiap titik akhir. Ini berstruktur dengan cara yang sama dengan Dokumentasi API (opens new window) untuk kemudahan penggunaan.

# Rekod

# POST /records

  • Titik akhir ini telah dikemas kini untuk menerima pelbagai rekod dalam badan permintaan. Ini membolehkan pengguna menyiarkan beberapa rekod baru sekaligus:

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

# Perkhidmatan konteks persekitaran

Sila gunakan nota penghijrahan ini untuk membantu beralih dari V1 dari comments-service-api ke V2. Dokumen ini harus memperincikan semua perubahan di seluruh versi.

# Titik akhir yang tidak ditetapkan

Sila ambil perhatian bahawa semua titik akhir dalam v1 API ini ditutup sehingga pengguna mesti menaik taraf ke versi yang tersedia seterusnya secepat mungkin

# Perubahan di titik akhir

Sila lihat di bawah untuk perubahan pada setiap titik akhir. Ini berstruktur dengan cara yang sama dengan Dokumentasi API (opens new window) untuk kemudahan penggunaan.

Perubahan utama datang dari suis API, kami kini menggunakan iklan (perkhidmatan data arup) dan bukannya CDS (perkhidmatan data korporat)

Nota: Tidak semua titik akhir mempunyai perubahan.

# Projek

# GET /projects & /ads/projects

  • Kekunci respons telah berubah
{
"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

  • Kekunci respons telah berubah
{
"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"
    }
}

# Negara

# GET /countries

  • Kekunci respons telah berubah
{
  "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,
      }
    }
  ]
}

# Kawasan

# GET /regions

  • Kekunci respons telah berubah
{
  "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, 3:19:15 PTG

←