Workload Schemes
Patch workload scheme
Updates only fields present in the merge-patch payload.
PATCH
/
v1
/
public
/
workload-schemes
/
{id}
Patch workload scheme
curl --request PATCH \
--url https://api.agile-tools.io/v1/public/workload-schemes/{id} \
--header 'Content-Type: application/merge-patch+json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"externalId": "<string>",
"description": "<string>",
"mondayHours": 123,
"tuesdayHours": 123,
"wednesdayHours": 123,
"thursdayHours": 123,
"fridayHours": 123,
"saturdayHours": 123,
"sundayHours": 123
}
'import requests
url = "https://api.agile-tools.io/v1/public/workload-schemes/{id}"
payload = {
"name": "<string>",
"externalId": "<string>",
"description": "<string>",
"mondayHours": 123,
"tuesdayHours": 123,
"wednesdayHours": 123,
"thursdayHours": 123,
"fridayHours": 123,
"saturdayHours": 123,
"sundayHours": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
name: '<string>',
externalId: '<string>',
description: '<string>',
mondayHours: 123,
tuesdayHours: 123,
wednesdayHours: 123,
thursdayHours: 123,
fridayHours: 123,
saturdayHours: 123,
sundayHours: 123
})
};
fetch('https://api.agile-tools.io/v1/public/workload-schemes/{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.agile-tools.io/v1/public/workload-schemes/{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>',
'externalId' => '<string>',
'description' => '<string>',
'mondayHours' => 123,
'tuesdayHours' => 123,
'wednesdayHours' => 123,
'thursdayHours' => 123,
'fridayHours' => 123,
'saturdayHours' => 123,
'sundayHours' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/merge-patch+json",
"X-API-Key: <api-key>"
],
]);
$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.agile-tools.io/v1/public/workload-schemes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+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.agile-tools.io/v1/public/workload-schemes/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agile-tools.io/v1/public/workload-schemes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"requestId": "<string>",
"timestamp": "2022-03-10T16:15:50Z",
"pagination": {
"mode": "<string>",
"totalCount": 123,
"page": 123,
"limit": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true,
"nextCursor": "<string>",
"hasMore": true
},
"library": {
"tabCounts": {}
}
}
}Authorizations
Body
application/merge-patch+json
Only supplied fields are changed; explicit null clears description or externalId.
⌘I
Patch workload scheme
curl --request PATCH \
--url https://api.agile-tools.io/v1/public/workload-schemes/{id} \
--header 'Content-Type: application/merge-patch+json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"externalId": "<string>",
"description": "<string>",
"mondayHours": 123,
"tuesdayHours": 123,
"wednesdayHours": 123,
"thursdayHours": 123,
"fridayHours": 123,
"saturdayHours": 123,
"sundayHours": 123
}
'import requests
url = "https://api.agile-tools.io/v1/public/workload-schemes/{id}"
payload = {
"name": "<string>",
"externalId": "<string>",
"description": "<string>",
"mondayHours": 123,
"tuesdayHours": 123,
"wednesdayHours": 123,
"thursdayHours": 123,
"fridayHours": 123,
"saturdayHours": 123,
"sundayHours": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
name: '<string>',
externalId: '<string>',
description: '<string>',
mondayHours: 123,
tuesdayHours: 123,
wednesdayHours: 123,
thursdayHours: 123,
fridayHours: 123,
saturdayHours: 123,
sundayHours: 123
})
};
fetch('https://api.agile-tools.io/v1/public/workload-schemes/{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.agile-tools.io/v1/public/workload-schemes/{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>',
'externalId' => '<string>',
'description' => '<string>',
'mondayHours' => 123,
'tuesdayHours' => 123,
'wednesdayHours' => 123,
'thursdayHours' => 123,
'fridayHours' => 123,
'saturdayHours' => 123,
'sundayHours' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/merge-patch+json",
"X-API-Key: <api-key>"
],
]);
$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.agile-tools.io/v1/public/workload-schemes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+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.agile-tools.io/v1/public/workload-schemes/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agile-tools.io/v1/public/workload-schemes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"mondayHours\": 123,\n \"tuesdayHours\": 123,\n \"wednesdayHours\": 123,\n \"thursdayHours\": 123,\n \"fridayHours\": 123,\n \"saturdayHours\": 123,\n \"sundayHours\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"requestId": "<string>",
"timestamp": "2022-03-10T16:15:50Z",
"pagination": {
"mode": "<string>",
"totalCount": 123,
"page": 123,
"limit": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true,
"nextCursor": "<string>",
"hasMore": true
},
"library": {
"tabCounts": {}
}
}
}
