# Довідник API: правила маршрутизації

Source: https://instatus.com/help/uk/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
```

Памʼятайте, що в діях `targetId` може бути email учасника робочого простору або ID команди — залежно від типу дії.

**Приклад запиту**

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