Create dictionary group

Creates new dictionary group.

Request

HTTP Request

POST /node/api/dictionary-groups

Permissions

manage-dictionaries

Path parameters

No parameters required.

Body parameters

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 added via REST API"
}

Response

Returns created 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=<...>
url=https://$saymon_hostname/node/api/dictionary-groups

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "REST API",
    "description": "Group added via REST API"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/dictionary-groups";
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 added via REST API"
});

let requestOptions = {
    method: "POST",
    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 path = "/node/api/dictionary-groups";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "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 added via REST API"
});

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

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

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

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

Response

{
    "id": "6835b26cd04437002f0e62cd",
    "name": "REST API",
    "description": "Group added via REST API"
}

See also