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-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 开关，我们现在使用广告（ARUP 数据服务），而不是 CD（公司数据服务）

注意：并非所有端点都有更改。

# 项目

# 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: 2024/6/21 11:34:44

←