# מדריך ה‑API של כללי ניתוב

Source: https://instatus.com/help/he/api/routing-rules

## ערכים אפשריים לשדות

**סוג הפעולה**

| ערך                         | תיאור                          |
| ----------------------------- | ------------------------------------ |
| `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`              | בודק אם הערך מסתיים במחרוזת משנה מסוימת   |

## קבלת כללי ניתוב

**נקודת קצה:**

```bash
GET /:page_id/routing-rules
```

**דוגמת בקשה**

```bash
GET /1/routing-rules
```

**דוגמת תשובה**

```json
{
  "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
    }
  ]
}
```

## יצירת כלל ניתוב

**נקודת קצה:**

```bash
POST /routing-rules
```

שימו לב שבתוך actions הערך `targetId` יכול להיות אימייל של חבר בסביבת העבודה או מזהה צוות, בהתאם לסוג הפעולה.

**דוגמת בקשה**

```json
{
  "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"
}
```

**דוגמת תשובה**

```json
{
  "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."
}
```

## עדכון כלל ניתוב

**נקודת קצה:**

```bash
PUT /routing-rules/:id
```

**דוגמת בקשה**

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

```json
{
  "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"
}
```

**דוגמת תשובה**

```json
{
  "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"
}
```

## מחיקת כלל ניתוב

**נקודת קצה:**

```bash
DELETE /routing-rules/:id
```

**דוגמת בקשה**

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

**דוגמת תשובה**

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