DDB 문서

# V2로의 마이그레이션

이 안내서는 영향을받는 마이크로 서비스에 대해 V1에서 V2로 마이그레이션하는 방법을 설명합니다.

# 서비스 전체의 변경

# 삭제 된 항목에 대한 쿼리

삭제 된 항목의 리턴을 허용하는 엔드 포인트를 얻을 수 있습니다. 이제 다음 쿼리를 사용할 수 있습니다.

  • show_active- 응답 본문에서 삭제되지 않은 (즉, 활성) 항목을 반환하려면 부울 플래그 (기본 true)
  • show_deleted- 응답 본문에서 삭제 된 항목을 반환하려면 부울 플래그 (기본 false).

기본적으로 활성 항목은 반환됩니다.

삭제 된 항목 만 반환하려면 show_deleted 값 true 및 show_active value 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 대신 ADS (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"
    }
}

# Countries

# 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. 오후 3:19:15

←