Update SLA Definition
Update an SLA definition. All fields are optional; only provided fields are updated.
curl --request PATCH \
--url https://public.api.serval.com/v2/sla-definitions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": true,
"scheduleId": "<string>",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
}
],
"clearAttachmentCriteria": true
}
'import requests
url = "https://public.api.serval.com/v2/sla-definitions/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": True,
"scheduleId": "<string>",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": ["<string>"],
"logicOp": "<string>"
}
],
"clearAttachmentCriteria": True
}
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({
name: '<string>',
description: '<string>',
targetDurationSeconds: 123,
useCalendarTime: true,
scheduleId: '<string>',
attachmentCriteria: [
{
type: '<string>',
field: '<string>',
op: '<string>',
value: '<string>',
values: ['<string>'],
logicOp: '<string>'
}
],
clearAttachmentCriteria: true
})
};
fetch('https://public.api.serval.com/v2/sla-definitions/{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://public.api.serval.com/v2/sla-definitions/{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([
'name' => '<string>',
'description' => '<string>',
'targetDurationSeconds' => 123,
'useCalendarTime' => true,
'scheduleId' => '<string>',
'attachmentCriteria' => [
[
'type' => '<string>',
'field' => '<string>',
'op' => '<string>',
'value' => '<string>',
'values' => [
'<string>'
],
'logicOp' => '<string>'
]
],
'clearAttachmentCriteria' => true
]),
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://public.api.serval.com/v2/sla-definitions/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\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://public.api.serval.com/v2/sla-definitions/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/sla-definitions/{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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": true,
"scheduleId": "<string>",
"conditions": [
{
"id": "<string>",
"slaDefinitionId": "<string>",
"conditionRule": {
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
},
"resumePolicy": "<string>",
"priority": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
}
],
"actionDefinitions": [
{
"id": "<string>",
"slaDefinitionId": "<string>",
"offsetSeconds": 123,
"workflowId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"archivedAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Show child attributes
Show child attributes
SlaStartingPoint controls when the SLA clock starts counting for
auto-attached SLAs. Milestone-dependent starting points (e.g. "after
escalation") are intentionally not modeled here — express them via
attachment criteria (e.g. ticket.escalation_level = human) combined
with FROM_ATTACHMENT.
SLA_STARTING_POINT_UNSPECIFIED, SLA_STARTING_POINT_FROM_ATTACHMENT, SLA_STARTING_POINT_FROM_CREATION SlaMetric identifies what an SLA measures (i.e., what stops the clock). New metrics are added by extending this enum and registering a metric handler in backend/services/svhelp/src/internal/state/ticket/rule/sla/metric.
SLA_METRIC_UNSPECIFIED, SLA_METRIC_RESOLUTION, SLA_METRIC_FIRST_RESPONSE Response
Success
SlaDefinition represents a reusable SLA policy.
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://public.api.serval.com/v2/sla-definitions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": true,
"scheduleId": "<string>",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
}
],
"clearAttachmentCriteria": true
}
'import requests
url = "https://public.api.serval.com/v2/sla-definitions/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": True,
"scheduleId": "<string>",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": ["<string>"],
"logicOp": "<string>"
}
],
"clearAttachmentCriteria": True
}
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({
name: '<string>',
description: '<string>',
targetDurationSeconds: 123,
useCalendarTime: true,
scheduleId: '<string>',
attachmentCriteria: [
{
type: '<string>',
field: '<string>',
op: '<string>',
value: '<string>',
values: ['<string>'],
logicOp: '<string>'
}
],
clearAttachmentCriteria: true
})
};
fetch('https://public.api.serval.com/v2/sla-definitions/{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://public.api.serval.com/v2/sla-definitions/{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([
'name' => '<string>',
'description' => '<string>',
'targetDurationSeconds' => 123,
'useCalendarTime' => true,
'scheduleId' => '<string>',
'attachmentCriteria' => [
[
'type' => '<string>',
'field' => '<string>',
'op' => '<string>',
'value' => '<string>',
'values' => [
'<string>'
],
'logicOp' => '<string>'
]
],
'clearAttachmentCriteria' => true
]),
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://public.api.serval.com/v2/sla-definitions/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\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://public.api.serval.com/v2/sla-definitions/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/sla-definitions/{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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"targetDurationSeconds\": 123,\n \"useCalendarTime\": true,\n \"scheduleId\": \"<string>\",\n \"attachmentCriteria\": [\n {\n \"type\": \"<string>\",\n \"field\": \"<string>\",\n \"op\": \"<string>\",\n \"value\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"logicOp\": \"<string>\"\n }\n ],\n \"clearAttachmentCriteria\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"targetDurationSeconds": 123,
"useCalendarTime": true,
"scheduleId": "<string>",
"conditions": [
{
"id": "<string>",
"slaDefinitionId": "<string>",
"conditionRule": {
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
},
"resumePolicy": "<string>",
"priority": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attachmentCriteria": [
{
"type": "<string>",
"field": "<string>",
"op": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"logicOp": "<string>"
}
],
"actionDefinitions": [
{
"id": "<string>",
"slaDefinitionId": "<string>",
"offsetSeconds": 123,
"workflowId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"archivedAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}
