Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleExample of usage

Request URL: https://slaapp.almarise.com/integration/V1/sla-custom-event/add/multiple

Request body:

{
  "ticketId": "10039",
  "metricId": "6751a9af00835a31fb1c27ac",
  "events": [
    {
      "triggerName": "metricResume",
      "slaEventAction": "RESUME",
      "actionDate": "2024-12-09T09:51:33.963Z"
    },
    {
      "triggerName": "metricFinish",
      "slaEventAction": "FINISH",
      "actionDate": "2024-12-09T09:55:33.963Z"
    }
  ]
}


Panel
bgColor#DEEBFF
GET/integration/V1/sla-custom-event/list/full

Returns a full detailed list of SLA events for the given metric.

...

Expand
titleResponse example

Request URL: https://slaapp.almarise.com/integration/V1/sla-custom-event/list/full?ticketId=10039&metricId=6751a9af00835a31fb1c27ac

Response body:

Code Block
[
    {
        "id": "6752df8607cc8c581fa2ad7f",
        "ticketId": "10039",
        "metricId": "6751a9af00835a31fb1c27ac",
        "triggerName": "Pause",
        "slaEvent": "PAUSE",
        "eventDate": "2024-12-06T11:24:14.807Z",
        "evaluationTimestamp": "2024-12-06T11:27:02.43819Z",
        "origin": "API",
        "originEnum": "API"
    },
    {
        "id": "6752e37907cc8c581fa2ad8f",
        "ticketId": "10039",
        "metricId": "6751a9af00835a31fb1c27ac",
        "triggerName": "Start",
        "slaEvent": "START",
        "eventDate": "2024-12-06T11:42:42.75Z",
        "evaluationTimestamp": "2024-12-06T11:43:53.993078Z",
        "origin": "API",
        "originEnum": "API"
    }
]


Panel
bgColor#DEEBFF
GET/integration/V1/sla-custom-event/list

Returns a list of SLA events for the given metric.

Expand
titleParameters
ParameterTypeDefault valueRequired
ticketIdstring
     check mark 
metricIdstring
check mark 
Expand
titleResponse example

Request URL: https://slaapp.almarise.com/integration/V1/sla-custom-event/list?ticketId=10039&metricId=6751a9af00835a31fb1c27ac

Response body:

Code Block
{
    "ticketId": "10039",
    "metricId": "6751a9af00835a31fb1c27ac",
    "events": [
        {
            "triggerName": "Pause",
            "slaEventAction": "PAUSE",
            "actionDate": "2024-12-06T11:24:14.807Z"
        },
        {
            "triggerName": "string",
            "slaEventAction": "START",
            "actionDate": "2024-12-06T11:42:42.75Z"
        },
        {
            "triggerName": "metricStart",
            "slaEventAction": "START",
            "actionDate": "2024-12-06T12:20:42.75Z"
        },
        {
            "triggerName": "metricStart",
            "slaEventAction": "START",
            "actionDate": "2024-12-06T12:32:42.75Z"
        },
        {
            "triggerName": "metricPause",
            "slaEventAction": "PAUSE",
            "actionDate": "2024-12-06T12:34:42.75Z"
        }
    ]
  }


Panel
bgColor#FFCCCB
DELETE/integration/V1/sla-custom-event/list

Allows to delete SLA events of the given metric. This means that the SLA metric will switch to Not Started state.

Expand
titleParameters
ParameterTypeDefault valueRequired
ticketIdstring
     check mark 
metricIdstring
check mark 
Expand
titleExample of usage

Request URL: https://slaapp.almarise.com/integration/V1/sla-custom-event/list?ticketId=10039&metricId=6751a9af00835a31fb1c27ac


Responses

Status
colourGreen
title200
- OK. Returned if the request is successful.

Status
colourYellow
title400
- Bad request.

Status
colourYellow
title401
- Unauthorized.

Status
colourYellow
title403
- Forbidden.

Status
colourYellow
title404
- Not Found. Metric ID does not exist.

Status
colourRed
title500
- Server Error.