Get an incident
curl --request GET \
--url https://api.lynkwell.com/incident-management/v1/incidents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.lynkwell.com/incident-management/v1/incidents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lynkwell.com/incident-management/v1/incidents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"networkId": "<string>",
"detectedAt": "2023-11-07T05:31:56Z",
"status": "NEW",
"summary": "<string>",
"description": "<string>",
"alertType": "<string>",
"affectedStationCount": 123,
"faults": [
{
"id": "<string>",
"errorCode": "<string>",
"vendorErrorCode": "<string>",
"vendorId": "<string>",
"faultCatalogEntryId": "<string>",
"mergedFromIncidentId": "<string>"
}
],
"faultInstances": [
{
"incidentFaultId": "<string>",
"stationId": "<string>",
"connectorId": 123,
"firstReportedAt": "2023-11-07T05:31:56Z",
"lastReportedAt": "2023-11-07T05:31:56Z",
"occurrenceCount": 123,
"mergedFromIncidentId": "<string>"
}
],
"slaState": "ON_TRACK",
"slaBreached": true,
"linkedIncidentIds": [
"<string>"
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"autoResolved": true,
"locationId": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"assigneeUserId": "<string>",
"slaResolutionDeadline": "2023-11-07T05:31:56Z",
"mergedIntoIncidentId": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"resolvedAt": "2023-11-07T05:31:56Z",
"location": {
"id": "<string>",
"name": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"streetDetails": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"countryCode": "<string>"
},
"network": {
"id": "<string>",
"name": "<string>"
}
}
}{
"type": "BAD_REQUEST",
"code": "<string>",
"message": "<string>"
}{
"message": "<string>"
}"<string>"{
"type": "NOT_FOUND",
"code": "<string>",
"message": "<string>"
}{
"type": "INTERNAL_ERROR",
"message": "<string>"
}Incidents
Get an incident
Returns one incident with its location and network joined in. A merged-away incident is still returned (with mergedIntoIncidentId set) so the caller can follow the redirect to the primary.
GET
/
incident-management
/
v1
/
incidents
/
{id}
Get an incident
curl --request GET \
--url https://api.lynkwell.com/incident-management/v1/incidents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.lynkwell.com/incident-management/v1/incidents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lynkwell.com/incident-management/v1/incidents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"networkId": "<string>",
"detectedAt": "2023-11-07T05:31:56Z",
"status": "NEW",
"summary": "<string>",
"description": "<string>",
"alertType": "<string>",
"affectedStationCount": 123,
"faults": [
{
"id": "<string>",
"errorCode": "<string>",
"vendorErrorCode": "<string>",
"vendorId": "<string>",
"faultCatalogEntryId": "<string>",
"mergedFromIncidentId": "<string>"
}
],
"faultInstances": [
{
"incidentFaultId": "<string>",
"stationId": "<string>",
"connectorId": 123,
"firstReportedAt": "2023-11-07T05:31:56Z",
"lastReportedAt": "2023-11-07T05:31:56Z",
"occurrenceCount": 123,
"mergedFromIncidentId": "<string>"
}
],
"slaState": "ON_TRACK",
"slaBreached": true,
"linkedIncidentIds": [
"<string>"
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"autoResolved": true,
"locationId": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"assigneeUserId": "<string>",
"slaResolutionDeadline": "2023-11-07T05:31:56Z",
"mergedIntoIncidentId": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"resolvedAt": "2023-11-07T05:31:56Z",
"location": {
"id": "<string>",
"name": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"streetDetails": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"countryCode": "<string>"
},
"network": {
"id": "<string>",
"name": "<string>"
}
}
}{
"type": "BAD_REQUEST",
"code": "<string>",
"message": "<string>"
}{
"message": "<string>"
}"<string>"{
"type": "NOT_FOUND",
"code": "<string>",
"message": "<string>"
}{
"type": "INTERNAL_ERROR",
"message": "<string>"
}Authorizations
OAuth2 Client Credentials Flow
Path Parameters
Query Parameters
Required for machine callers whose token carries no network claim.
Response
The incident, with its location and network joined in.
An incident as the detail route returns it: every Incident field, plus its location and network joined in from the platform records. location is absent when the incident has none; either join is absent when the record is not yet known to the incident service.
Show child attributes
Show child attributes