API-referanse for rutingregler

Mulige verdier for felt

Handlingstype

Verdi	Beskrivelse
`NOTIFY_TEAM`	Varsle et bestemt team
`NOTIFY_WORKSPACE_MEMBER`	Varsle et bestemt arbeidsområdemedlem
`NOTIFY_CURRENT_ON_CALL_USER`	Varsle den som har vakt nå
`NOTIFY_NEXT_ON_CALL_USER`	Varsle neste vakthavende
`NOTIFY_ALL_ON_CALL_MEMBERS`	Varsle alle medlemmer som har vakt nå

Påstandstype

Verdi	Beskrivelse
`IMPACT`	Sjekker innvirkningen av en hendelse
`TITLE`	Sjekker tittelen på en hendelse
`DESCRIPTION`	Sjekker beskrivelsen av en hendelse
`AFFECTED_COMPONENTS`	Sjekker de berørte komponentene i en hendelse

Sammenligningstyper

Verdi	Beskrivelse
`EQUALS`	Sjekker om verdien er lik
`NOT_EQUALS`	Sjekker om verdien ikke er lik
`IS_EMPTY`	Sjekker om verdien er tom
`NOT_EMPTY`	Sjekker om verdien ikke er tom
`GREATER_THAN`	Sjekker om verdien er større enn
`GREATER_THAN_OR_EQUALS`	Sjekker om verdien er større enn eller lik
`LESS_THAN`	Sjekker om verdien er mindre enn
`LESS_THAN_OR_EQUALS`	Sjekker om verdien er mindre enn eller lik
`CONTAINS`	Sjekker om verdien inneholder en bestemt delstreng
`NOT_CONTAINS`	Sjekker om verdien ikke inneholder en delstreng
`HAS_KEY`	Sjekker om et objekt har en bestemt nøkkel
`NOT_HAS_KEY`	Sjekker om et objekt ikke har en bestemt nøkkel
`HAS_VALUE`	Sjekker om et objekt har en bestemt verdi
`NOT_HAS_VALUE`	Sjekker om et objekt ikke har en bestemt verdi
`IS_NULL`	Sjekker om verdien er null
`NOT_NULL`	Sjekker om verdien ikke er null
`STARTS_WITH`	Sjekker om verdien starter med en bestemt delstreng
`ENDS_WITH`	Sjekker om verdien slutter med en bestemt delstreng

Hent rutingregler

Endepunkt:

GET /:page_id/routing-rules

Eksempelforespørsel

GET /1/routing-rules

Eksempelsvar

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

Opprett rutingregel

Endepunkt:

POST /routing-rules

Husk at targetId i handlinger kan være e-postadressen til et arbeidsområdemedlem eller en team-ID, avhengig av handlingstypen.

Eksempelforespørsel

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

Eksempelsvar

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

Oppdater rutingregel

Endepunkt:

PUT /routing-rules/:id

Eksempelforespørsel

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

Eksempelsvar

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

Slett rutingregel

Endepunkt:

DELETE /routing-rules/:id

Eksempelforespørsel

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

Eksempelsvar

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