การโยกย้ายไปยัง 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 รับ 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,

 }

 ]

}