Update dictionary group

Updates dictionary group with data provided in the request body.

Request

HTTP Request

PATCH /node/api/dictionary-groups/:id

Path parameters

Parameter Type Description

id

String
required

ID of the updated group.

Body parameters

This request uses the Dictionary group model.

Field Type Description

id

String

ID of the dictionary group.

name

String

Name of the dictionary group.

description

String

Description of the dictionary group.

Request body

{
    "name": "REST API",
    "description": "Group updated via REST API"
}

Response

Returns updated dictionary group. You can find more information about the model on the Dictionary group page.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
dictionary_id=<...>
url=https://$saymon_hostname/node/api/dictionary-groups/$dictionary_id

curl -X PATCH $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "REST API",
    "description": "Group updated via REST API"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let dictionaryId = <...>
let path = "/node/api/dictionary-groups/" + dictionaryId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    "name": "REST API",
    "description": "Group updated via REST API"
});

let requestOptions = {
    method: "PATCH",
    headers: headers,
    body: data
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));
const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let dictionaryId = <...>
let path = "/node/api/dictionary-groups/" + dictionaryId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "PATCH",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

let data = JSON.stringify({
    "name": "REST API",
    "description": "Group updated via REST API"
});

req.write(data);
req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
dictionary_id = <...>
url = "https://" + saymon_hostname + "/node/api/dictionary-groups/" + dictionary_id

body = {
    "name": "REST API",
    "description": "Group updated via REST API"
}

response = requests.request("PATCH", url, json=body, auth=(login, password))
print(response.text)

Response

{
    "id": "5e9eb1bf10b1f754077f3f03",
    "name": "REST API",
    "description": "Group updated via REST API"
}