وثائق 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: ٢١‏/٦‏/٢٠٢٤, ١١:٣٤:٤٤ ص

←