Получить все классы

Получить список всех классов в системе.

Этот запрос не возвращает все поля класса. Список возвращаемых полей указан в разделе Ответ.

Запрос

HTTP Запрос

GET /node/api/classes

Параметры пути

Параметры не требуются.

Тело запроса

Тело запроса пустое.

Ответ

Возвращает массив всех классов в системе. Использует модель Класс.

Этот запрос не возвращает все поля классов. Он возвращает только те поля, которым было ранее присвоено значение.

Для нового класса возвращаются следующие поля:

Поле Тип Описание

id

String

ID класса.

name

String

Имя класса.

operations

Array<Operation>

Массив операций класса.

client_data

String

Данные клиента класса.

Все остальные поля возвращаются только если им было присвоено значение. Например, если добавить свойство к классу, то списко свойств будет включён в ответ.

Эти поля будут включены даже если вручную сбросить это поле в стандартное значение (например, удалить все свойства (properties) или присвоить описанию (description) пустую строку).

  • Новый класс

  • Добавлено новое свойство

  • Удалено свойство, добавлено описание

{
    "name": "New class",
    "client_data": "{}",
    "operations": [],
    "id": "62fa271e18baa649c1d26338"
}
{
    "name": "New class",
    "client_data": "{}",
    "operations": [],
    "properties": [
        {
            "type_id": 1,
            "name": "New Property",
            "value": "Value",
            "id": "62fa26c0ad05cf4924c35569"
        }
    ],
    "id": "62fa1e20ad05cf4924c35550"
}
{
    "name": "New class",
    "client_data": "{}",
    "operations": [],
    "description": "Description",
    "properties": [],
    "id": "62fa1e20ad05cf4924c35550"
}

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/classes

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/classes";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

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/classes";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "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);
    });
});

req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/classes"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Ответ

[
    {
        "name": "Root",
        "operations": [],
        "properties": [],
        "description": "Root object",
        "default_agent_task_definition": "",
        "category_id": null,
        "id": 1
    },
    {
        "name": "Saymon Agent",
        "operations": [],
        "properties": [],
        "description": "Saymon Agent",
        "default_agent_task_definition": "",
        "id": 2
    },
    {
        "name": "Node",
        "operations": [],
        "default_agent_task_definition": "",
        "category_id": 3,
        "id": 13
    },
    ...
]

Смотрите также