Referință API pentru regulile de rutare

Valori posibile pentru câmpuri

Tipul acțiunii

Valoare	Descriere
`NOTIFY_TEAM`	Anunță o anumită echipă
`NOTIFY_WORKSPACE_MEMBER`	Anunță un anumit membru al spațiului de lucru
`NOTIFY_CURRENT_ON_CALL_USER`	Anunță utilizatorul de gardă curent
`NOTIFY_NEXT_ON_CALL_USER`	Anunță următorul utilizator de gardă
`NOTIFY_ALL_ON_CALL_MEMBERS`	Anunță toți membrii aflați de gardă

Tipul verificării

Valoare	Descriere
`IMPACT`	Verifică impactul unui eveniment
`TITLE`	Verifică titlul unui eveniment
`DESCRIPTION`	Verifică descrierea unui eveniment
`AFFECTED_COMPONENTS`	Verifică componentele afectate de un eveniment

Tipuri de comparație

Valoare	Descriere
`EQUALS`	Verifică dacă valoarea este egală
`NOT_EQUALS`	Verifică dacă valoarea nu este egală
`IS_EMPTY`	Verifică dacă valoarea este goală
`NOT_EMPTY`	Verifică dacă valoarea nu este goală
`GREATER_THAN`	Verifică dacă valoarea este mai mare
`GREATER_THAN_OR_EQUALS`	Verifică dacă valoarea este mai mare sau egală
`LESS_THAN`	Verifică dacă valoarea este mai mică
`LESS_THAN_OR_EQUALS`	Verifică dacă valoarea este mai mică sau egală
`CONTAINS`	Verifică dacă valoarea conține un anumit subșir
`NOT_CONTAINS`	Verifică dacă valoarea nu conține un subșir
`HAS_KEY`	Verifică dacă un obiect are o anumită cheie
`NOT_HAS_KEY`	Verifică dacă un obiect nu are o anumită cheie
`HAS_VALUE`	Verifică dacă un obiect are o anumită valoare
`NOT_HAS_VALUE`	Verifică dacă un obiect nu are o anumită valoare
`IS_NULL`	Verifică dacă valoarea este null
`NOT_NULL`	Verifică dacă valoarea nu este null
`STARTS_WITH`	Verifică dacă valoarea începe cu un anumit subșir
`ENDS_WITH`	Verifică dacă valoarea se termină cu un anumit subșir

Obține regulile de rutare

Endpoint:

GET /:page_id/routing-rules

Exemplu de cerere

GET /1/routing-rules

Exemplu de răspuns

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

Creează o regulă de rutare

Endpoint:

POST /routing-rules

Reține că, în acțiuni, targetId poate fi e-mailul unui membru al spațiului de lucru sau ID-ul unei echipe, în funcție de tipul acțiunii.

Exemplu de cerere

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

Exemplu de răspuns

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

Actualizează o regulă de rutare

Endpoint:

PUT /routing-rules/:id

Exemplu de cerere

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

Exemplu de răspuns

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

Șterge o regulă de rutare

Endpoint:

DELETE /routing-rules/:id

Exemplu de cerere

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

Exemplu de răspuns

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