Dogfennaeth DDB

# Ymfudo i V2

Mae'r canllaw hwn yn esbonio sut i fudo o V1 i V2, ar gyfer y microservices yr effeithir arnynt.

# Newidiadau ar draws y Gwasanaethau

# Ymholiad am eitemau wedi'u dileu

Sicrhewch fod gan bwyntiau terfyn sy'n caniatáu dychwelyd eitemau wedi'u dileu bellach yr ymholiadau canlynol ar gael:

  • show_active - Baner Boole (diofyn true) i ddychwelyd eitemau heb eu dileu (h.y. gweithredol) yn y corff ymateb
  • show_deleted - Baner Boole (diofyn false) i ddychwelyd eitemau wedi'u dileu yn y corff ymateb.

Yn ddiofyn, bydd eitemau gweithredol yn cael eu dychwelyd yn unig.

I ddychwelyd eitemau wedi'u dileu yn unig, ceisiwch gyda gwerth show_deleted true a show_active gwerth false.

I ddychwelyd eitemau gweithredol a dileu, ceisiwch gyda gwerth show_deleted true.

Nodyn: Mae rhai pwyntiau terfyn yn cynnwys yr ymholiad show_deleted yn unig, ond mae'r ymddygiad yr un peth.

# Gwasanaeth Sylwadau

Defnyddiwch y nodiadau mudo hyn i helpu i newid o V1 y comments-service-api i V2. Dylai'r ddogfen hon fanylu ar yr holl newidiadau ar draws y fersiynau.

# Pwyntiau terfyn di -flewyn -ar -dafod

Sylwch fod yr holl bwyntiau terfyn yn V1 o'r API hwn yn cael eu dibrisio felly mae'n rhaid i ddefnyddwyr uwchraddio i'r fersiwn nesaf sydd ar gael cyn gynted â phosibl

# Newidiadau ar draws pwyntiau terfyn

Gweler isod am y newidiadau i bob pwynt terfyn. Mae hyn wedi'i strwythuro mewn ffordd debyg i'r Dogfennaeth API (opens new window) er hwylustod i'w ddefnyddio.

Nodyn: Nid yw pob pwynt terfyn wedi cael newidiadau.

# Sylwadau

# GET /comments

  • Mae'r ymholiad comment_id bellach yn derbyn IDau lluosog mewn arae, gan ganiatáu i ddefnyddwyr hidlo am sylwadau lluosog ar unwaith.

# POST /comments

  • Mae'r pwynt terfyn hwn bellach yn derbyn amrywiaeth o wrthrychau sylwadau yn y corff cais, gan ganiatáu i ddefnyddwyr bostio sawl sylwadau ar unwaith:
 + [
     {
         reference_id: "79b577e3-f11e-4b7e-b91d-65c501a0926d",
         reference_table: "assets",
         reference_url: "http://testapi.com/api/assets",
         content: "Test comment"
     }
 + ]

# Gwasanaeth Data Cyfeirio

Defnyddiwch y nodiadau mudo hyn i helpu i newid o V1 y reference-data-service-api i V2. Dylai'r ddogfen hon fanylu ar yr holl newidiadau ar draws y fersiynau.

# Pwyntiau terfyn di -flewyn -ar -dafod

Sylwch fod yr holl bwyntiau terfyn yn V1 o'r API hwn yn cael eu dibrisio felly mae'n rhaid i ddefnyddwyr uwchraddio i'r fersiwn nesaf sydd ar gael cyn gynted â phosibl

# Newidiadau ar draws pwyntiau terfyn

Gweler isod am y newidiadau i bob pwynt terfyn. Mae hyn wedi'i strwythuro mewn ffordd debyg i'r Dogfennaeth API (opens new window) er hwylustod i'w ddefnyddio.

Nodyn: Nid yw pob pwynt terfyn wedi cael newidiadau.

# Mathau o Ffynhonnell

# GET /source_types

  • Mae'r rhesymeg ymholiad show_deleted wedi'i diweddaru. Gweld os gwelwch yn dda Uchod yr adran am fwy o wybodaeth.

# Ffynonellau

# GET /sources

  • Mae'r rhesymeg ymholiad show_deleted wedi'i diweddaru. Gweld os gwelwch yn dda Uchod yr adran am fwy o wybodaeth.

# Gwasanaeth QA

Defnyddiwch y nodiadau mudo hyn i helpu i newid o V1 y qa-data-service-api i V2. Dylai'r ddogfen hon fanylu ar yr holl newidiadau ar draws y fersiynau.

# Pwyntiau terfyn di -flewyn -ar -dafod

Sylwch fod yr holl bwyntiau terfyn yn V1 o'r API hwn yn cael eu dibrisio felly mae'n rhaid i ddefnyddwyr uwchraddio i'r fersiwn nesaf sydd ar gael cyn gynted â phosibl

# Newidiadau ar draws pwyntiau terfyn

Gweler isod am y newidiadau i bob pwynt terfyn. Mae hyn wedi'i strwythuro mewn ffordd debyg i'r Dogfennaeth API (opens new window) er hwylustod i'w ddefnyddio.

# Chofnodion

# POST /records

  • Mae'r pwynt terfyn hwn wedi'i ddiweddaru i dderbyn amrywiaeth o gofnodion yn y corff cais. Mae hyn yn caniatáu i ddefnyddwyr bostio sawl cofnod newydd ar unwaith:
 + [
     {
         "type_id": "f3f25a90-5caa-459a-ab8b-ab0a4dc20e42",
         "reference_id": "79b577e3-f11e-4b7e-b91d-65c501a0926d",
         "reference_table": "assets",
         "reference_url": "http://testapi.com/api/assets"
     }
 + ]

# Gwasanaeth cyd -destun amgylchedd

Defnyddiwch y nodiadau mudo hyn i helpu i newid o V1 y comments-service-api i V2. Dylai'r ddogfen hon fanylu ar yr holl newidiadau ar draws y fersiynau.

# Pwyntiau terfyn di -flewyn -ar -dafod

Sylwch fod yr holl bwyntiau terfyn yn V1 o'r API hwn yn cael eu dibrisio felly mae'n rhaid i ddefnyddwyr uwchraddio i'r fersiwn nesaf sydd ar gael cyn gynted â phosibl

# Newidiadau ar draws pwyntiau terfyn

Gweler isod am y newidiadau i bob pwynt terfyn. Mae hyn wedi'i strwythuro mewn ffordd debyg i'r Dogfennaeth API (opens new window) er hwylustod i'w ddefnyddio.

Daw'r prif newidiadau o'r switsh API, rydym bellach yn defnyddio ADS (Gwasanaeth Data ARUP) yn hytrach na CDs (Gwasanaeth Data Corfforaethol)

Nodyn: Nid yw pob pwynt terfyn wedi cael newidiadau.

# Prosiectau

# GET /projects & /ads/projects

  • Mae'r allweddi ymateb wedi newid
{
"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

  • Mae'r allweddi ymateb wedi newid
{
"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"
    }
}

# Gwledydd

# GET /countries

  • Mae'r allweddi ymateb wedi newid
{
  "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,
      }
    }
  ]
}

# Rhanbarthau

# GET /regions

  • Mae'r allweddi ymateb wedi newid
{
  "regions": [
    {
      "region_code": "B04",
      "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
      "region_name": "UKIMEA Region",
-     "arup_region_level": 1,
-     "company_code": C01,
    }
  ]
}
Last Updated: 3/8/2023 15:20:28

←