API-reference for routingregler

Mulige værdier for felter

Handlingstype

Værdi	Beskrivelse
`NOTIFY_TEAM`	Giv et bestemt team besked
`NOTIFY_WORKSPACE_MEMBER`	Giv et bestemt workspace-medlem besked
`NOTIFY_CURRENT_ON_CALL_USER`	Giv den nuværende vagthaver besked
`NOTIFY_NEXT_ON_CALL_USER`	Giv den næste vagthaver besked
`NOTIFY_ALL_ON_CALL_MEMBERS`	Giv alle, der har vagt lige nu, besked

Betingelsestype

Værdi	Beskrivelse
`IMPACT`	Kontrollerer en begivenheds indvirkning
`TITLE`	Kontrollerer en begivenheds titel
`DESCRIPTION`	Kontrollerer en begivenheds beskrivelse
`AFFECTED_COMPONENTS`	Kontrollerer en begivenheds berørte komponenter

Sammenligningstyper

Værdi	Beskrivelse
`EQUALS`	Tjekker, om værdien er lig med
`NOT_EQUALS`	Tjekker, om værdien ikke er lig med
`IS_EMPTY`	Tjekker, om værdien er tom
`NOT_EMPTY`	Tjekker, om værdien ikke er tom
`GREATER_THAN`	Tjekker, om værdien er større end
`GREATER_THAN_OR_EQUALS`	Tjekker, om værdien er større end eller lig med
`LESS_THAN`	Tjekker, om værdien er mindre end
`LESS_THAN_OR_EQUALS`	Tjekker, om værdien er mindre end eller lig med
`CONTAINS`	Tjekker, om værdien indeholder en bestemt delstreng
`NOT_CONTAINS`	Tjekker, om værdien ikke indeholder en delstreng
`HAS_KEY`	Tjekker, om et objekt har en bestemt nøgle
`NOT_HAS_KEY`	Tjekker, om et objekt ikke har en bestemt nøgle
`HAS_VALUE`	Tjekker, om et objekt har en bestemt værdi
`NOT_HAS_VALUE`	Tjekker, om et objekt ikke har en bestemt værdi
`IS_NULL`	Tjekker, om værdien er null
`NOT_NULL`	Tjekker, om værdien ikke er null
`STARTS_WITH`	Tjekker, om værdien starter med en bestemt delstreng
`ENDS_WITH`	Tjekker, om værdien slutter med en bestemt delstreng

Hent routingregler

Endpoint:

GET /:page_id/routing-rules

Eksempel på forespørgsel

GET /1/routing-rules

Eksempel på svar

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

Opret routingregel

Endpoint:

POST /routing-rules

Husk, at targetId i handlinger kan være et workspace-medlems e-mail eller et team-id afhængigt af handlingens type.

Eksempel på forespørgsel

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

Eksempel på svar

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

Opdater routingregel

Endpoint:

PUT /routing-rules/:id

Eksempel på forespørgsel

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

Eksempel på svar

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

Slet routingregel

Endpoint:

DELETE /routing-rules/:id

Eksempel på forespørgsel

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

Eksempel på svar

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