# Referensi API Aturan Perutean

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

## Nilai yang mungkin untuk kolom

**Jenis Tindakan**

| Nilai                         | Deskripsi                            |
| ----------------------------- | ------------------------------------ |
| `NOTIFY_TEAM`                 | Beri tahu tim tertentu               |
| `NOTIFY_WORKSPACE_MEMBER`     | Beri tahu anggota workspace tertentu |
| `NOTIFY_CURRENT_ON_CALL_USER` | Beri tahu petugas siaga saat ini     |
| `NOTIFY_NEXT_ON_CALL_USER`    | Beri tahu petugas siaga berikutnya   |
| `NOTIFY_ALL_ON_CALL_MEMBERS`  | Beri tahu semua anggota yang sedang siaga |

**Jenis Pernyataan**

| Nilai                 | Deskripsi                                   |
| --------------------- | ------------------------------------------- |
| `IMPACT`              | Memeriksa dampak sebuah peristiwa           |
| `TITLE`               | Memeriksa judul sebuah peristiwa            |
| `DESCRIPTION`         | Memeriksa deskripsi sebuah peristiwa        |
| `AFFECTED_COMPONENTS` | Memeriksa komponen terdampak sebuah peristiwa |

**Jenis Perbandingan**

| Nilai                    | Deskripsi                                            |
| ------------------------ | ---------------------------------------------------- |
| `EQUALS`                 | Memeriksa apakah nilainya sama                       |
| `NOT_EQUALS`             | Memeriksa apakah nilainya tidak sama                 |
| `IS_EMPTY`               | Memeriksa apakah nilainya kosong                     |
| `NOT_EMPTY`              | Memeriksa apakah nilainya tidak kosong               |
| `GREATER_THAN`           | Memeriksa apakah nilainya lebih besar                |
| `GREATER_THAN_OR_EQUALS` | Memeriksa apakah nilainya lebih besar atau sama      |
| `LESS_THAN`              | Memeriksa apakah nilainya lebih kecil                |
| `LESS_THAN_OR_EQUALS`    | Memeriksa apakah nilainya lebih kecil atau sama      |
| `CONTAINS`               | Memeriksa apakah nilainya memuat substring tertentu  |
| `NOT_CONTAINS`           | Memeriksa apakah nilainya tidak memuat substring     |
| `HAS_KEY`                | Memeriksa apakah objek punya kunci tertentu          |
| `NOT_HAS_KEY`            | Memeriksa apakah objek tidak punya kunci tertentu    |
| `HAS_VALUE`              | Memeriksa apakah objek punya nilai tertentu          |
| `NOT_HAS_VALUE`          | Memeriksa apakah objek tidak punya nilai tertentu    |
| `IS_NULL`                | Memeriksa apakah nilainya null                       |
| `NOT_NULL`               | Memeriksa apakah nilainya bukan null                 |
| `STARTS_WITH`            | Memeriksa apakah nilainya diawali substring tertentu |
| `ENDS_WITH`              | Memeriksa apakah nilainya diakhiri substring tertentu |

## Mendapatkan Aturan Perutean

**Endpoint:**

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

**Contoh permintaan**

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

**Contoh respons**

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

## Membuat Aturan Perutean

**Endpoint:**

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

Perlu diingat bahwa pada tindakan, `targetId` bisa berupa email anggota workspace atau id tim, tergantung jenis tindakannya.

**Contoh permintaan**

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

**Contoh respons**

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

## Memperbarui Aturan Perutean

**Endpoint:**

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

**Contoh permintaan**

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

**Contoh respons**

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

## Menghapus Aturan Perutean

**Endpoint:**

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

**Contoh permintaan**

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

**Contoh respons**

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