Reitityssääntöjen API-referenssi

Kenttien mahdolliset arvot

Toiminnon tyyppi

Arvo	Kuvaus
`NOTIFY_TEAM`	Ilmoita tietylle tiimille
`NOTIFY_WORKSPACE_MEMBER`	Ilmoita tietylle työtilan jäsenelle
`NOTIFY_CURRENT_ON_CALL_USER`	Ilmoita nykyiselle päivystäjälle
`NOTIFY_NEXT_ON_CALL_USER`	Ilmoita seuraavalle päivystäjälle
`NOTIFY_ALL_ON_CALL_MEMBERS`	Ilmoita kaikille tällä hetkellä päivystäville jäsenille

Ehdon tyyppi

Arvo	Kuvaus
`IMPACT`	Tarkistaa tapahtuman vaikutuksen
`TITLE`	Tarkistaa tapahtuman otsikon
`DESCRIPTION`	Tarkistaa tapahtuman kuvauksen
`AFFECTED_COMPONENTS`	Tarkistaa tapahtuman kohteena olevat komponentit

Vertailutyypit

Arvo	Kuvaus
`EQUALS`	Tarkistaa, onko arvo yhtä suuri
`NOT_EQUALS`	Tarkistaa, onko arvo eri suuri
`IS_EMPTY`	Tarkistaa, onko arvo tyhjä
`NOT_EMPTY`	Tarkistaa, onko arvo ei-tyhjä
`GREATER_THAN`	Tarkistaa, onko arvo suurempi
`GREATER_THAN_OR_EQUALS`	Tarkistaa, onko arvo suurempi tai yhtä suuri
`LESS_THAN`	Tarkistaa, onko arvo pienempi
`LESS_THAN_OR_EQUALS`	Tarkistaa, onko arvo pienempi tai yhtä suuri
`CONTAINS`	Tarkistaa, sisältääkö arvo määritetyn merkkijonon
`NOT_CONTAINS`	Tarkistaa, ettei arvo sisällä merkkijonoa
`HAS_KEY`	Tarkistaa, onko objektilla tietty avain
`NOT_HAS_KEY`	Tarkistaa, ettei objektilla ole tiettyä avainta
`HAS_VALUE`	Tarkistaa, onko objektilla tietty arvo
`NOT_HAS_VALUE`	Tarkistaa, ettei objektilla ole tiettyä arvoa
`IS_NULL`	Tarkistaa, onko arvo null
`NOT_NULL`	Tarkistaa, ettei arvo ole null
`STARTS_WITH`	Tarkistaa, alkaako arvo tietyllä merkkijonolla
`ENDS_WITH`	Tarkistaa, päättyykö arvo tiettyyn merkkijonoon

Hae reitityssäännöt

Päätepiste:

GET /:page_id/routing-rules

Esimerkkipyyntö

GET /1/routing-rules

Esimerkkivastaus

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

Luo reitityssääntö

Päätepiste:

POST /routing-rules

Huomaa, että toiminnoissa targetId voi olla työtilan jäsenen sähköposti tai tiimin ID toiminnon tyypistä riippuen.

Esimerkkipyyntö

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

Esimerkkivastaus

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

Päivitä reitityssääntö

Päätepiste:

PUT /routing-rules/:id

Esimerkkipyyntö

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

Esimerkkivastaus

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

Poista reitityssääntö

Päätepiste:

DELETE /routing-rules/:id

Esimerkkipyyntö

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

Esimerkkivastaus

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