API-referens för dirigeringsregler

Möjliga värden för fält

Åtgärdstyp

Värde	Beskrivning
`NOTIFY_TEAM`	Meddela ett specifikt team
`NOTIFY_WORKSPACE_MEMBER`	Meddela en specifik arbetsytemedlem
`NOTIFY_CURRENT_ON_CALL_USER`	Meddela nuvarande jourhavande
`NOTIFY_NEXT_ON_CALL_USER`	Meddela nästa jourhavande
`NOTIFY_ALL_ON_CALL_MEMBERS`	Meddela alla som har jour just nu

Villkorstyp

Värde	Beskrivning
`IMPACT`	Kontrollerar en händelses påverkan
`TITLE`	Kontrollerar en händelses titel
`DESCRIPTION`	Kontrollerar en händelses beskrivning
`AFFECTED_COMPONENTS`	Kontrollerar en händelses påverkade komponenter

Jämförelsetyper

Värde	Beskrivning
`EQUALS`	Kontrollerar om värdet är lika
`NOT_EQUALS`	Kontrollerar om värdet inte är lika
`IS_EMPTY`	Kontrollerar om värdet är tomt
`NOT_EMPTY`	Kontrollerar om värdet inte är tomt
`GREATER_THAN`	Kontrollerar om värdet är större än
`GREATER_THAN_OR_EQUALS`	Kontrollerar om värdet är större än eller lika med
`LESS_THAN`	Kontrollerar om värdet är mindre än
`LESS_THAN_OR_EQUALS`	Kontrollerar om värdet är mindre än eller lika med
`CONTAINS`	Kontrollerar om värdet innehåller en viss delsträng
`NOT_CONTAINS`	Kontrollerar om värdet saknar en viss delsträng
`HAS_KEY`	Kontrollerar om ett objekt har en viss nyckel
`NOT_HAS_KEY`	Kontrollerar om ett objekt saknar en viss nyckel
`HAS_VALUE`	Kontrollerar om ett objekt har ett visst värde
`NOT_HAS_VALUE`	Kontrollerar om ett objekt saknar ett visst värde
`IS_NULL`	Kontrollerar om värdet är null
`NOT_NULL`	Kontrollerar om värdet inte är null
`STARTS_WITH`	Kontrollerar om värdet börjar med en viss delsträng
`ENDS_WITH`	Kontrollerar om värdet slutar med en viss delsträng

Hämta dirigeringsregler

Endpoint:

GET /:page_id/routing-rules

Exempelanrop

GET /1/routing-rules

Exempelsvar

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

Skapa dirigeringsregel

Endpoint:

POST /routing-rules

Kom ihåg att targetId i åtgärder kan vara en arbetsytemedlems e-postadress eller ett team-ID, beroende på åtgärdens typ.

Exempelanrop

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

Exempelsvar

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

Uppdatera dirigeringsregel

Endpoint:

PUT /routing-rules/:id

Exempelanrop

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

Exempelsvar

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

Radera dirigeringsregel

Endpoint:

DELETE /routing-rules/:id

Exempelanrop

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

Exempelsvar

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