curl --request PATCH \
--url https://api.lynkwell.com/incident-management/v1/incidents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changedByUserId": "<string>",
"assigneeUserId": "<string>",
"summary": "<string>",
"description": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"reason": "<string>",
"networkId": "<string>"
}
'import requests
url = "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
payload = {
"changedByUserId": "<string>",
"assigneeUserId": "<string>",
"summary": "<string>",
"description": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"reason": "<string>",
"networkId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changedByUserId: '<string>',
assigneeUserId: '<string>',
summary: '<string>',
description: '<string>',
rootCause: '<string>',
resolutionNotes: '<string>',
reason: '<string>',
networkId: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'changedByUserId' => '<string>',
'assigneeUserId' => '<string>',
'summary' => '<string>',
'description' => '<string>',
'rootCause' => '<string>',
'resolutionNotes' => '<string>',
'reason' => '<string>',
'networkId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
payload := strings.NewReader("{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}"
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"
}
}{
"type": "BAD_REQUEST",
"code": "<string>",
"message": "<string>"
}{
"message": "<string>"
}"<string>"{
"type": "NOT_FOUND",
"code": "<string>",
"message": "<string>"
}{
"type": "CONFLICT",
"code": "<string>",
"message": "<string>"
}{
"type": "INTERNAL_ERROR",
"message": "<string>"
}Update an incident
Transition status, assign or unassign, or edit summary, description, rootCause, and resolutionNotes. status must be a valid transition, and resolutionNotes is required when resolving.
curl --request PATCH \
--url https://api.lynkwell.com/incident-management/v1/incidents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changedByUserId": "<string>",
"assigneeUserId": "<string>",
"summary": "<string>",
"description": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"reason": "<string>",
"networkId": "<string>"
}
'import requests
url = "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
payload = {
"changedByUserId": "<string>",
"assigneeUserId": "<string>",
"summary": "<string>",
"description": "<string>",
"rootCause": "<string>",
"resolutionNotes": "<string>",
"reason": "<string>",
"networkId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changedByUserId: '<string>',
assigneeUserId: '<string>',
summary: '<string>',
description: '<string>',
rootCause: '<string>',
resolutionNotes: '<string>',
reason: '<string>',
networkId: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'changedByUserId' => '<string>',
'assigneeUserId' => '<string>',
'summary' => '<string>',
'description' => '<string>',
'rootCause' => '<string>',
'resolutionNotes' => '<string>',
'reason' => '<string>',
'networkId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lynkwell.com/incident-management/v1/incidents/{id}"
payload := strings.NewReader("{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.lynkwell.com/incident-management/v1/incidents/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changedByUserId\": \"<string>\",\n \"assigneeUserId\": \"<string>\",\n \"summary\": \"<string>\",\n \"description\": \"<string>\",\n \"rootCause\": \"<string>\",\n \"resolutionNotes\": \"<string>\",\n \"reason\": \"<string>\",\n \"networkId\": \"<string>\"\n}"
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"
}
}{
"type": "BAD_REQUEST",
"code": "<string>",
"message": "<string>"
}{
"message": "<string>"
}"<string>"{
"type": "NOT_FOUND",
"code": "<string>",
"message": "<string>"
}{
"type": "CONFLICT",
"code": "<string>",
"message": "<string>"
}{
"type": "INTERNAL_ERROR",
"message": "<string>"
}Authorizations
OAuth2 Client Credentials Flow
Path Parameters
Body
Update an incident. Provide at least one field. status must be a valid transition from the current status.
NetworkUser id of the acting Support Operator. Required on every write; attributes the change.
Lifecycle state. NEW, INVESTIGATING, MITIGATING, WAITING_ON_OEM, POST_MORTEM, RESOLVED, MERGED. RESOLVED and MERGED are terminal; MERGED is set only by a merge, never by a status update.
NEW, INVESTIGATING, MITIGATING, WAITING_ON_OEM, POST_MORTEM, RESOLVED, MERGED NetworkUser id to assign, or null to unassign.
5001000010000Required when transitioning to RESOLVED (unless already set).
10000An optional note recorded on the status transition. Only valid with a status change.
10000Network id. Required for machine (M2M) callers whose token carries no network claim; ignored when the token has one.
Response
The updated incident.
An incident: a period of degraded or lost service on one or more stations. The roster of affected stations lives on the affected-stations sub-resource; the incident carries only the cached affectedStationCount.
Show child attributes
Show child attributes