Training
Patch apiv2organizations trainingcases
PATCH
/
api
/
v2
/
organizations
/
{orgId}
/
training
/
cases
/
{id}
cURL
curl --request PATCH \
--url https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"label": "<string>",
"id": "<string>"
}
],
"archived": true
}
'import requests
url = "https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"label": "<string>",
"id": "<string>"
}
],
"archived": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
situation: '<string>',
objective: '<string>',
successCriteria: '<string>',
dos: [{label: '<string>', id: '<string>'}],
archived: true
})
};
fetch('https://api.example.com/api/v2/organizations/{orgId}/training/cases/{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.example.com/api/v2/organizations/{orgId}/training/cases/{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>',
'situation' => '<string>',
'objective' => '<string>',
'successCriteria' => '<string>',
'dos' => [
[
'label' => '<string>',
'id' => '<string>'
]
],
'archived' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v2/organizations/{orgId}/training/cases/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/v2/organizations/{orgId}/training/cases/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"id": "<string>",
"label": "<string>"
}
],
"archivedAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Body
application/json
Required string length:
1 - 80Required string length:
1 - 200Required string length:
1 - 1000Required string length:
1 - 500Required string length:
1 - 500Available options:
easy, medium, hard Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
The updated training case
⌘I
cURL
curl --request PATCH \
--url https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"label": "<string>",
"id": "<string>"
}
],
"archived": true
}
'import requests
url = "https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"label": "<string>",
"id": "<string>"
}
],
"archived": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
situation: '<string>',
objective: '<string>',
successCriteria: '<string>',
dos: [{label: '<string>', id: '<string>'}],
archived: true
})
};
fetch('https://api.example.com/api/v2/organizations/{orgId}/training/cases/{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.example.com/api/v2/organizations/{orgId}/training/cases/{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>',
'situation' => '<string>',
'objective' => '<string>',
'successCriteria' => '<string>',
'dos' => [
[
'label' => '<string>',
'id' => '<string>'
]
],
'archived' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v2/organizations/{orgId}/training/cases/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/v2/organizations/{orgId}/training/cases/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/organizations/{orgId}/training/cases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"situation\": \"<string>\",\n \"objective\": \"<string>\",\n \"successCriteria\": \"<string>\",\n \"dos\": [\n {\n \"label\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"archived\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"situation": "<string>",
"objective": "<string>",
"successCriteria": "<string>",
"dos": [
{
"id": "<string>",
"label": "<string>"
}
],
"archivedAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}