# Dokumentacja API reguł kierowania

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

## Możliwe wartości pól

**Typ akcji**

| Wartość | Opis |
| ----------------------------- | ------------------------------------ |
| `NOTIFY_TEAM`                 | Powiadom określony zespół |
| `NOTIFY_WORKSPACE_MEMBER`     | Powiadom określonego członka workspace’u |
| `NOTIFY_CURRENT_ON_CALL_USER` | Powiadom obecną osobę na dyżurze |
| `NOTIFY_NEXT_ON_CALL_USER`    | Powiadom kolejną osobę na dyżurze |
| `NOTIFY_ALL_ON_CALL_MEMBERS`  | Powiadom wszystkie osoby aktualnie na dyżurze |

**Typ asercji**

| Wartość | Opis |
| --------------------- | ------------------------------------------- |
| `IMPACT`              | Sprawdza uderzenie zdarzenia |
| `TITLE`               | Sprawdza tytuł zdarzenia |
| `DESCRIPTION`         | Sprawdza opis zdarzenia |
| `AFFECTED_COMPONENTS` | Sprawdza komponenty, których dotyczy zdarzenie |

**Typy porównań**

| Wartość | Opis |
| ------------------------ | ---------------------------------------------------- |
| `EQUALS`                 | Sprawdza, czy wartość jest równa |
| `NOT_EQUALS`             | Sprawdza, czy wartość nie jest równa |
| `IS_EMPTY`               | Sprawdza, czy wartość jest pusta |
| `NOT_EMPTY`              | Sprawdza, czy wartość nie jest pusta |
| `GREATER_THAN`           | Sprawdza, czy wartość jest większa |
| `GREATER_THAN_OR_EQUALS` | Sprawdza, czy wartość jest większa lub równa |
| `LESS_THAN`              | Sprawdza, czy wartość jest mniejsza |
| `LESS_THAN_OR_EQUALS`    | Sprawdza, czy wartość jest mniejsza lub równa |
| `CONTAINS`               | Sprawdza, czy wartość zawiera wskazany podciąg |
| `NOT_CONTAINS`           | Sprawdza, czy wartość nie zawiera podciągu |
| `HAS_KEY`                | Sprawdza, czy obiekt ma określony klucz |
| `NOT_HAS_KEY`            | Sprawdza, czy obiekt nie ma określonego klucza |
| `HAS_VALUE`              | Sprawdza, czy obiekt ma określoną wartość |
| `NOT_HAS_VALUE`          | Sprawdza, czy obiekt nie ma określonej wartości |
| `IS_NULL`                | Sprawdza, czy wartość jest null |
| `NOT_NULL`               | Sprawdza, czy wartość nie jest null |
| `STARTS_WITH`            | Sprawdza, czy wartość zaczyna się wskazanym podciągiem |
| `ENDS_WITH`              | Sprawdza, czy wartość kończy się wskazanym podciągiem |

## Pobierz reguły kierowania

**Endpoint:**

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

**Przykładowe żądanie**

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

**Przykładowa odpowiedź**

```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
    }
  ]
}
```

## Utwórz regułę kierowania

**Endpoint:**

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

Pamiętaj, że w akcjach `targetId` może być adresem e-mail członka workspace’u lub identyfikatorem zespołu, w zależności od typu akcji.

**Przykładowe żądanie**

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

**Przykładowa odpowiedź**

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

## Zaktualizuj regułę kierowania

**Endpoint:**

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

**Przykładowe żądanie**

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

**Przykładowa odpowiedź**

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

## Usuń regułę kierowania

**Endpoint:**

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

**Przykładowe żądanie**

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

**Przykładowa odpowiedź**

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