DDB документация

# Миграция в V2

Это руководство объясняет, как мигрировать с V1 на V2 для затронутых микросервисов.

# Изменения в услугах

# Запрос на удаленные предметы

Получите конечные точки, которые позволяют возвращать удаленные элементы, теперь имеются следующие запросы:

  • show_active - логический флаг (по умолчанию true), чтобы вернуть не удаленные (то есть активные) элементы в корпусе ответа

  • show_deleted - логический флаг (по умолчанию false), чтобы вернуть удаленные элементы в корпусе ответа.

По умолчанию активные элементы будут возвращены только.

Чтобы вернуть только удаленные элементы, запросите с show_deleted Значение true и show_active Значение false.

Чтобы вернуть как активные, так и удаленные элементы, запросите со значением show_deleted true.

Примечание. Некоторые конечные точки содержат только запрос show_deleted, но поведение одинаково.

# Комментарии Сервис

Пожалуйста, используйте эти заметки о миграции, чтобы помочь переключиться с V1 comments-service-api на V2. Этот документ должен подробно описать все изменения в версиях.

# Устаревшие конечные точки

Обратите внимание, что все конечные точки в V1 этого API устарели, поэтому пользователи должны перейти на следующую доступную версию как можно скорее

# Изменения в конечных точках

Пожалуйста, смотрите ниже изменения в каждой конечной точке. Это структурировано аналогично Документация API (opens new window) для простоты использования.

Примечание: не все конечные точки имели изменения.

# Комментарии

# GET /comments

  • Запрос comment_id теперь принимает несколько идентификаторов в массиве, позволяя пользователям фильтровать несколько комментариев одновременно.

# POST /comments

  • Эта конечная точка теперь принимает множество объектов комментариев в органе запроса, позволяя пользователям публиковать несколько комментариев одновременно:

    
+ [

    {

        reference_id: "79b577e3-f11e-4b7e-b91d-65c501a0926d",

        reference_table: "assets",

        reference_url: "http://testapi.com/api/assets",

        content: "Test comment"

    }

+ ]

# Справочная служба данных

Пожалуйста, используйте эти миграционные заметки, чтобы помочь переключиться с V1 reference-data-service-api на V2. Этот документ должен подробно описать все изменения в версиях.

# Устаревшие конечные точки

Обратите внимание, что все конечные точки в V1 этого API устарели, поэтому пользователи должны перейти на следующую доступную версию как можно скорее

# Изменения в конечных точках

Пожалуйста, смотрите ниже изменения в каждой конечной точке. Это структурировано аналогично Документация API (opens new window) для простоты использования.

Примечание: не все конечные точки имели изменения.

# Типы источников

# GET /source_types

  • Логика запроса show_deleted была обновлена. Пожалуйста, посмотри выше раздела Чтобы получить больше информации.

# Источники

# GET /sources

  • Логика запроса show_deleted была обновлена. Пожалуйста, посмотри выше раздела Чтобы получить больше информации.

# QA Сервис

Пожалуйста, используйте эти заметки о миграции, чтобы помочь переключиться с V1 qa-data-service-api на V2. Этот документ должен подробно описать все изменения в версиях.

# Устаревшие конечные точки

Обратите внимание, что все конечные точки в V1 этого API устарели, поэтому пользователи должны перейти на следующую доступную версию как можно скорее

# Изменения в конечных точках

Пожалуйста, смотрите ниже изменения в каждой конечной точке. Это структурировано аналогично Документация 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"

    }

+ ]

# Служба контекста среды

Пожалуйста, используйте эти заметки о миграции, чтобы помочь переключиться с V1 comments-service-api на V2. Этот документ должен подробно описать все изменения в версиях.

# Устаревшие конечные точки

Обратите внимание, что все конечные точки в V1 этого API устарели, поэтому пользователи должны перейти на следующую доступную версию как можно скорее

# Изменения в конечных точках

Пожалуйста, смотрите ниже изменения в каждой конечной точке. Это структурировано аналогично Документация API (opens new window) для простоты использования.

Основные изменения исходят от переключателя API, теперь мы используем рекламу (служба данных ARUP), а не CDS (Служба корпоративных данных)

Примечание: не все конечные точки имели изменения.

# Проекты

# 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: 13.09.2023, 15:19:15

←