مرجع واجهة قواعد التوجيه البرمجية

القيم الممكنة للحقول

نوع الإجراء

القيمة	الوصف
NOTIFY_TEAM	إشعار فريق محدد
NOTIFY_WORKSPACE_MEMBER	إشعار عضو محدد في مساحة العمل
NOTIFY_CURRENT_ON_CALL_USER	إشعار المناوب الحالي
NOTIFY_NEXT_ON_CALL_USER	إشعار المناوب التالي
NOTIFY_ALL_ON_CALL_MEMBERS	إشعار جميع الأعضاء المناوبين حاليًا

نوع الشرط

القيمة	الوصف
IMPACT	يتحقق من أثر الحدث
TITLE	يتحقق من عنوان الحدث
DESCRIPTION	يتحقق من وصف الحدث
AFFECTED_COMPONENTS	يتحقق من المكوّنات المتأثرة بالحدث

أنواع المقارنة

القيمة	الوصف
EQUALS	يتحقق من تساوي القيمة
NOT_EQUALS	يتحقق من عدم تساوي القيمة
IS_EMPTY	يتحقق من كون القيمة فارغة
NOT_EMPTY	يتحقق من كون القيمة غير فارغة
GREATER_THAN	يتحقق من كون القيمة أكبر من
GREATER_THAN_OR_EQUALS	يتحقق من كون القيمة أكبر من أو تساوي
LESS_THAN	يتحقق من كون القيمة أصغر من
LESS_THAN_OR_EQUALS	يتحقق من كون القيمة أصغر من أو تساوي
CONTAINS	يتحقق من احتواء القيمة على نص فرعي محدد
NOT_CONTAINS	يتحقق من عدم احتواء القيمة على نص فرعي
HAS_KEY	يتحقق من وجود مفتاح محدد في كائن
NOT_HAS_KEY	يتحقق من عدم وجود مفتاح محدد في كائن
HAS_VALUE	يتحقق من وجود قيمة محددة في كائن
NOT_HAS_VALUE	يتحقق من عدم وجود قيمة محددة في كائن
IS_NULL	يتحقق من كون القيمة null
NOT_NULL	يتحقق من كون القيمة ليست null
STARTS_WITH	يتحقق من بدء القيمة بنص فرعي محدد
ENDS_WITH	يتحقق من انتهاء القيمة بنص فرعي محدد

احصل على قواعد التوجيه

نقطة النهاية:

GET /:page_id/routing-rules

مثال على الطلب

GET /1/routing-rules

مثال على الاستجابة

{
  "routingRules": [
    {
      "id": "1",
      "siteId": "pageId",
      "assertions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value2"
        }
      ],
      "actions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "member@platform.com"
        }
      ],
      "createdAt": "2021-09-29T00:00:00.000Z",
      "updatedAt": "2021-09-29T00:00:00.000Z",
      "order": 1
    }
  ]
}

أنشئ قاعدة توجيه

نقطة النهاية:

POST /routing-rules

انتبه إلى أن targetId في الإجراءات قد يكون بريد عضو في مساحة العمل أو معرّف فريق، بحسب نوع الإجراء.

مثال على الطلب

{
  "routingRule": {
    "assertions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value1"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value2"
      }
    ],
    "actions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member2@platform.com"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member@platform.com"
      }
    ],
    "order": 1,
    "siteId": "site-id-1"
  },
  "message": "Routing rule updated successfully"
}

مثال على الاستجابة

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "order": 1,
    "siteId": "site123",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-09-01T12:00:00Z"
  },
  "message": "Routing rule created successfully."
}

حدّث قاعدة توجيه

نقطة النهاية:

PUT /routing-rules/:id

مثال على الطلب

PUT /routing-rules/routing-rule-id-1

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

مثال على الاستجابة

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2024-08-09T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

احذف قاعدة توجيه

نقطة النهاية:

DELETE /routing-rules/:id

مثال على الطلب

DELETE /routing-rules/routing-rule-id-1

مثال على الاستجابة

{
  "message": "Routing rule deleted successfully."
}