Versions Compared

Old Version 2

changes.mady.by.user Nadiia Lisovska

Saved on

compared with

New Version Current

changes.mady.by.user Nadiia Lisovska

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
bgColor#c8f7c8
POST/integration/V1/sla-custom-event/add

 Allows users to manually add an event that will trigger SLA state change.

Expand
titleRequest body
Code Block
{
  "ticketId": "string",
  "metricId": "string",
  "triggerName": "string",
  "slaEventAction": "START",
  "actionDate": "2024-12-06T11:19:22.270Z"
}


Expand
titleExample of usage

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

Request body:

{
  "ticketId": "10039",
  "metricId": "6751a9af00835a31fb1c27ac",
  "triggerName": "metricPause",
  "slaEventAction": "PAUSE",
  "actionDate": "2024-12-06T12:34:42.750Z"
}


Panel
bgColor#c8f7c8#90ee90
POST/integration/V1/sla-custom-event/add/multiple

 Allows adding multiple SLA events at once.

Expand
titleRequest body
Code Block
{
  "ticketId": "string",
  "metricId": "string",
  "events": [
    {
      "triggerName": "string",
      "slaEventAction": "START",
      "actionDate": "2024-12-06T12:37:34.340Z"
    }
  ]
}


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 metricThis endpoint allows viewing the states of all SLA metrics in the given issue.

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

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

Response body:

Code Block
[
    {
        "slaMetricIdid": "6729eb08a66f5026ea86fbd16752df8607cc8c581fa2ad7f",
        "ticketId": "10039",
        "slaMetricStatemetricId": "ACTIVE6751a9af00835a31fb1c27ac",
        "deadlinetriggerName": "2024-12-05T11:32:19.893+01:00Pause",
        "timeSpentslaEvent": {
    "PAUSE",
        "milliseventDate": 30758956"2024-12-06T11:24:14.807Z",
            "shortTextevaluationTimestamp": "8h 32m 38s"
2024-12-06T11:27:02.43819Z",
         }"origin": "API",
        "timeRemainingoriginEnum": {"API"
    },
    {
        "millisid": -19958956"6752e37907cc8c581fa2ad8f",
            "shortTextticketId": "-5h 32m 38s"10039",
        } "metricId": "6751a9af00835a31fb1c27ac",
        "totalTimetriggerName": {"Start",
            "millisslaEvent": 10800000"START",
            "shortTexteventDate": "3h"2024-12-06T11:42:42.75Z",
        }"evaluationTimestamp": "2024-12-06T11:43:53.993078Z",
        "isBreachedorigin": true"API",
        "flowingDeadlineoriginEnum": false,"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
{
    "wasRestartedticketId": false"10039",
        "metricNamemetricId": "SLA metric 1.06751a9af00835a31fb1c27ac",
        "visibleevents": true[
    },
    {
            "slaMetricIdtriggerName": "6751a9af00835a31fb1c27acPause",
            "ticketIdslaEventAction": "10039PAUSE",
        "slaMetricState": "ACTIVE",
        "deadlineactionDate": "2024-12-05T1106T11:3224:19.893+01:00",
14.807Z"
        },
        {
            "timeSpenttriggerName": {"string",
            "millisslaEventAction": 30758956"START",
            "shortTextactionDate": "8h 32m 38s2024-12-06T11:42:42.75Z"
        },
        "timeRemaining{
            "triggerName": {"metricStart",
            "millisslaEventAction": -19958956"START",
            "shortTextactionDate": "-5h 32m 38s2024-12-06T12:20:42.75Z"
        },
        {
            "totalTimetriggerName": {"metricStart",
            "millisslaEventAction": 10800000"START",
            "shortTextactionDate": "3h2024-12-06T12:32:42.75Z"
        },
        "isBreached": true,
{
            "flowingDeadlinetriggerName": false"metricPause",
            "wasRestartedslaEventAction": false"PAUSE",
            "metricNameactionDate": "Time To Resolution",2024-12-06T12:34:42.75Z"
        "visible": true}
    }
]]
}


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.