DDBドキュメント

# V2 への移行

このガイドでは、影響を受けるマイクロサービスのために、V1 から V2 に移動する方法について説明します。

# サービス全体の変更

# 削除されたアイテムのクエリ

削除されたアイテムを返すことを可能にするエンドポイントを取得すると、次のクエリが利用可能になりました。

  • show_active-応答ボディの非削除（アクティブ）アイテムを返すためのブールフラグ（デフォルトtrue）
  • show_deleted-応答ボディの削除されたアイテムを返すブールフラグ（デフォルトfalse）。

デフォルトでは、アクティブアイテムは返品のみに返されます。

削除されたアイテムのみを返すには、show_deleted値trueおよびshow_active値falseでリクエストします。

アクティブアイテムと削除されたアイテムの両方を返すには、show_deleted値trueでリクエストします。

注：一部のエンドポイントにはshow_deletedクエリのみが含まれていますが、動作は同じです。

# コメントサービス

これらの移行ノートを使用して、comments-service-apiの V1 から V2 に切り替えるのに役立ちます。 このドキュメントは、バージョン全体のすべての変更を詳述する必要があります。

# 非推奨エンドポイント

この API の V1 のすべてのエンドポイントは非推奨であるため、ユーザーはできるだけ早く次の利用可能なバージョンにアップグレードする必要があることに注意してください

# エンドポイント全体で変更されます

各エンドポイントの変更については、以下をご覧ください。 これは、と同様の方法で構成されています API ドキュメント (opens new window) 使いやすさ。

注：すべてのエンドポイントに変更があったわけではありません。

# コメント

# GET /comments

  • comment_idクエリは、アレイ内の複数の ID を受け入れるようになり、ユーザーが一度に複数のコメントをフィルタリングできるようになりました。

# POST /comments

  • このエンドポイントは、リクエスト本文のコメントオブジェクトの配列を受け入れ、ユーザーが一度に複数のコメントを投稿できるようにします。

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

# 参照データサービス

これらの移行メモを使用して、reference-data-service-apiの V1 から V2 に切り替えるのに役立ちます。 このドキュメントは、バージョン全体のすべての変更を詳述する必要があります。

# 非推奨エンドポイント

この API の V1 のすべてのエンドポイントは非推奨であるため、ユーザーはできるだけ早く次の利用可能なバージョンにアップグレードする必要があることに注意してください

# エンドポイント全体で変更されます

各エンドポイントの変更については、以下をご覧ください。 これは、と同様の方法で構成されています API ドキュメント (opens new window) 使いやすさ。

注：すべてのエンドポイントに変更があったわけではありません。

# ソースタイプ

# GET /source_types

  • show_deletedクエリロジックが更新されました。 参照してください 上のセクション 詳細については。

# ソース

# GET /sources

  • show_deletedクエリロジックが更新されました。 参照してください 上のセクション 詳細については。

# QA サービス

これらの移行ノートを使用して、qa-data-service-apiの V1 から V2 に切り替えるのに役立ちます。 このドキュメントは、バージョン全体のすべての変更を詳述する必要があります。

# 非推奨エンドポイント

この API の V1 のすべてのエンドポイントは非推奨であるため、ユーザーはできるだけ早く次の利用可能なバージョンにアップグレードする必要があることに注意してください

# エンドポイント全体で変更されます

各エンドポイントの変更については、以下をご覧ください。 これは、と同様の方法で構成されています API ドキュメント (opens new window) 使いやすさ。

# 記録

# POST /records

  • このエンドポイントは、リクエスト本体の一連のレコードを受け入れるために更新されました。 これにより、ユーザーは一度に複数の新しいレコードを投稿できます。

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

# 環境コンテキストサービス

これらの移行ノートを使用して、comments-service-apiの V1 から V2 に切り替えるのに役立ちます。 このドキュメントは、バージョン全体のすべての変更を詳述する必要があります。

# 非推奨エンドポイント

この API の V1 のすべてのエンドポイントは非推奨であるため、ユーザーはできるだけ早く次の利用可能なバージョンにアップグレードする必要があることに注意してください

# エンドポイント全体で変更されます

各エンドポイントの変更については、以下をご覧ください。 これは、と同様の方法で構成されています API ドキュメント (opens new window) 使いやすさ。

主な変更は API スイッチから生じます。現在、CDS（企業データサービス）ではなく広告（ARUP データサービス）を使用しています。

注：すべてのエンドポイントに変更があったわけではありません。

# プロジェクト

# GET /projects & /ads/projects

  • 応答キーが変更されました
{
"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

  • 応答キーが変更されました
{
"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"
    }
}

# 国

# GET /countries

  • 応答キーが変更されました
{
  "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,
      }
    }
  ]
}

# 地域

# GET /regions

  • 応答キーが変更されました
{
  "regions": [
    {
      "region_code": "B04",
      "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
      "region_name": "UKIMEA Region",
-     "arup_region_level": 1,
-     "company_code": C01,
    }
  ]
}
Last Updated: 2023/9/13 15:19:15

←