Versions Compared

Old Version 19

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.
Info

Integration API is available at slaapp.almarise.com

Find out how to identify the Jira Issue ID in Cloud

This API is dedicated to integration between Jira and third-party systems and allows for the extraction of data such as SLA metic state, history, etc.

Basic authentication is used to authenticate calls (email address + security token). Read how to set up a personal access token as described here.

Request headers to be set:

  • Source-System - JIRA

  • Jira-Host - address of Jira Cloud instance

Endpoints

SLA Metric State

...

Panel
bgColor#DEEBFF
GET/integration/V1/metrics-state/{ticketId}

          This endpoint allows viewing the states of all SLA metrics in the given issue.

...

Expand
titleResponse example

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039?showUiMetaData=false

Response body:

Code Block
[
    {
        "slaMetricId": "6729eb08a66f5026ea86fbd1",
        "ticketId": "10039",
        "slaMetricState": "ACTIVE",
        "deadline": "2024-12-05T11:32:19.893+01:00",
        "timeSpent": {
            "millis": 30758956,
            "shortText": "8h 32m 38s"
        },
        "timeRemaining": {
            "millis": -19958956,
            "shortText": "-5h 32m 38s"
        },
        "totalTime": {
            "millis": 10800000,
            "shortText": "3h"
        },
        "isBreached": true,
        "flowingDeadline": false,
        "wasRestarted": false,
        "metricName": "SLA metric 1.0",
        "visible": true
    },
    {
        "slaMetricId": "6751a9af00835a31fb1c27ac",
        "ticketId": "10039",
        "slaMetricState": "ACTIVE",
        "deadline": "2024-12-05T11:32:19.893+01:00",
        "timeSpent": {
            "millis": 30758956,
            "shortText": "8h 32m 38s"
        },
        "timeRemaining": {
            "millis": -19958956,
            "shortText": "-5h 32m 38s"
        },
        "totalTime": {
            "millis": 10800000,
            "shortText": "3h"
        },
        "isBreached": true,
        "flowingDeadline": false,
        "wasRestarted": false,
        "metricName": "Time To Resolution",
        "visible": true
    }
]


Panel
bgColor#DEEBFF

GET/integration/V1/metrics-state/{ticketId}/metrics

This endpoint returns metrics related to the given issue.

Expand
titleParameters
ParameterTypeDefault valueRequired
ticketIdstring
     check mark 
showHiddenbooleanfalse
Expand
titleResponse example

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039/metrics?showHidden=true

Response body:

Code Block
[
  {
    "name": "SLA metric 1.0",
    "id": "6729eb08a66f5026ea86fbd1",
    "visible": true
  },
  {
    "name": "Time To Resolution",
    "id": "6751a9af00835a31fb1c27ac",
    "visible": true
  }
]


Panel
bgColor#DEEBFF
GET/integration/V1/metrics-state/{ticketId}/{slaMetricId}

Returns the state of the requested SLA metric in the given issue.

Expand
titleParameters
ParameterTypeDefault valueRequired
ticketIdstring
     check mark 
slaMetricIdstring
check mark 
showUiMetaDatabooleanfalse
Expand
titleResponse example

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039/6751a9af00835a31fb1c27ac?showUiMetaData=false

Response body:

Code Block
{
  "slaMetricId": "6751a9af00835a31fb1c27ac",
  "ticketId": "10039",
  "slaMetricState": "ACTIVE",
  "deadline": "2024-12-05T11:32:19.893+01:00",
  "timeSpent": {
    "millis": 32581835,
    "shortText": "9h 3m 1s"
  },
  "timeRemaining": {
    "millis": -21781835,
    "shortText": "-6h 3m 1s"
  },
  "totalTime": {
    "millis": 10800000,
    "shortText": "3h"
  },
  "isBreached": true,
  "flowingDeadline": false,
  "wasRestarted": false,
  "metricName": "Time To Resolution",
  "visible": true
}


Responses

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

Status
colourYellow
title401
- Unauthorized.

Status
colourYellow
title403
- Forbidden. Returned if the user does not have permission to complete this request.

Status
colourYellow
title404
- Not Found. 

Status
colourRed
title500
- Server Error.