Получить класс по ID

Получить класс по ID

Получить класс по ID ​

Возвращает класс с указанным ID.

Запрос ​

HTTP Запрос ​

text
GET /node/api/classes/:id

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

ПараметрТипОписание
idString

обязательный | ID класса. |

Тело запроса ​

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

Ответ ​

Возвращает следующие поля из модели Класс.

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

обязательный | Идентификатор класса. | | name | String

обязательный | Имя класса. | | description | String | Описание класса. | | category_id | String | Идентификатор категории класса. Подробную информацию о категории можно найти в разделе Идентификатор категории. | | operations | Array<Операция> | Массив операций класса. |

Остальные поля класса можно получить запросом Получить все классы, который возвращает все заполненные поля всех классов в системе. Также некоторые поля можно получить специальными запросами. Например, запрос Получить свойства класса возвращает информацию о свойствах класса, а запрос Получить условия перехода состояний класса возвращает условия перехода состояний класса.

Пример ​

Запрос ​

  • Bash
  • JavaScript
  • NodeJS
  • Python
bash
login=<...>
password=<...>
saymon_hostname=<...>
class_id=<...>
url=https://$saymon_hostname/node/api/classes/$class_id

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

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

let requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch(saymonHostname + path, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
javascript
let http = require('follow-redirects').http;
let fs = require('fs');

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

let options = {
  'method': 'GET',
  'hostname': '192.168.1.101',
  'path': '/node/api/classes/4',
  'headers': {
    'Authorization': auth
  },
  'maxRedirects': 20
};

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();
python
import requests

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

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

Ответ ​

json
{
    "id": 4,
    "name": "CPU",
    "category_id": 1,
    "description": "Central Processor Unit",
    "operations": []
}

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