Создать объект

Создаёт новый объект с данными, переданными в теле запроса. Возвращает объект в формате JSON.

Запрос

HTTP Запрос

POST /node/api/objects

Права

create-objects | manage-objects

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

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

Параметры тела запроса

Подробная информация о модели доступна в статье Объект.

Тело запроса

Чтобы создать объект нужно указать только его имя (name). Подробная информация о модели доступна в статье Объект.

{
    "name": "New Object"
}

Если поле родителя (parent_id) не указано в запросе, то по умолчанию родителем объекта становится корневой объект с ID 1.

Ответ

Ответ содержит созданный объект в формате JSON. Подробная информация о модели доступна в статье Объект.

Примеры

Создать минимальный объект

Этот пример демонстрирует как создать новый объект с именем New Object и сделать его дочерним к корневому объекту:

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "New Object",
    "parent_id": "1"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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": "New Object",
    "parent_id": "1"
});

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/objects";
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: "New Object",
    parent_id: "1"
});

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

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects"
body = {
"name": "New Object",
"parent_id": "1"
}

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

Ответ

{
    "name": "New Object",
    "owner_id": "5e21b752308c3c66d64e072c",
    "object_groups": [],
    "geoposition": [],
    "child_ref_ids": [],
    "child_link_ids": [],
    "child_ids": [],
    "parent_id": "1",
    "weight": 1,
    "tags": [],
    "last_state_update": 1585035085802,
    "updated": 1585035085800,
    "created": 1585035085802,
    "state_id": 1,
    "class_id": 13,
    "_stateConditionRefs": [],
    "operations": [],
    "properties": [],
    "id": "5e79b74d6ec5ea28e5105c58"
}

Создать объект с мультиродителем

Этот пример показывает как создать объект с несколькими родителями. Если у объекта есть несколько родителей, то он ведёт себя как один объект, но отображается в иерархии под каждым родительским объектом:

Object with multiple parents

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
"name": "Object with multiple parents",
    "parent_id": [
"62ea5dd6cd1c9856d0f55e9c",
"62e923ffb8ff53567ebda356",
"62d7e5d456d203149a080026"
]
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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": "Object with multiple parents",
    "parent_id": [
"62ea5dd6cd1c9856d0f55e9c",
"62e923ffb8ff53567ebda356",
"62d7e5d456d203149a080026"
]
});

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/objects";
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": "Object with multiple parents",
    "parent_id": [
"62ea5dd6cd1c9856d0f55e9c",
"62e923ffb8ff53567ebda356",
"62d7e5d456d203149a080026"
]
});

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

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects"
body = {
"name": "Object with multiple parents",
    "parent_id": [
"62ea5dd6cd1c9856d0f55e9c",
"62e923ffb8ff53567ebda356",
"62d7e5d456d203149a080026"
]
}

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

Ответ

{
    "name": "Object with multiple parents",
    "owner_id": "5e21b752308c3c66d64e072c",
    "object_groups": [],
    "geoposition": [],
    "child_ref_ids": [],
    "child_link_ids": [],
    "child_ids": [],
    "parent_id": [
        "62ea5dd6cd1c9856d0f55e9c",
        "62e923ffb8ff53567ebda356",
        "62d7e5d456d203149a080026"
    ],
    "weight": 1,
    "tags": [],
    "last_state_update": 1585035085802,
    "updated": 1585035085800,
    "created": 1585035085802,
    "state_id": 1,
    "class_id": 13,
    "_stateConditionRefs": [],
    "operations": [],
    "properties": [],
    "id": "5e79b74d6ec5ea28e5105c58"
}

Создать объект используя discovery ID

Если поле discoveryID указано в теле запроса, алгоритм работы системы следующий: если объект с указанным Discovery ID не существует, будет создан новый объект с этим Discovery ID. Если объект с указанным Discovery ID уже существует, тело объекта будет обновлено.

В этом примере первый запрос создает новый объект с именем "Discovery ID Test". Второй запрос вместо создания нового объекта редактирует существующий объект с тем же Discovery ID.

Первый запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "Discovery ID Test",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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": "Discovery ID Test",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
});

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/objects";
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": "Discovery ID Test",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
});

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

login = '...'
password = '...'
saymon_hostname = '...'
url = "http://" + saymon_hostname + "/node/api/objects"

body = {
    "name": "Discovery ID Test",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
}

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

Второй запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "Discovery ID Test Edited",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects";
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": "Discovery ID Test Edited",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
});

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/objects";
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": "Discovery ID Test Edited",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
});

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

login = '...'
password = '...'
saymon_hostname = '...'
url = "http://" + saymon_hostname + "/node/api/objects"

body = {
    "name": "Discovery ID Test Edited",
    "parent_id": "62e923d8cf878556dcf522b7",
    "discovery_id": "Discovery ID Test Object"
}

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

Ответ

  • Первый запрос

  • Второй запрос

{
    "id": "62ea7145b8ff53567ebda38d",
    "parent_id": [
        "62e923d8cf878556dcf522b7"
    ],
    "name": "Discovery ID Test",
    "discovery_id": "Discovery ID Test Object",
    "owner_id": "62c2f3ce80c8654892764d56",
    "updated": 1659531655003,
    "properties": [],
    "operations": [],
    "class_id": 13,
    "state_id": 1,
    "created": 1659531589533,
    "last_state_update": 1659531589533,
    "tags": [],
    "weight": 1,
    "child_ids": [],
    "child_link_ids": [],
    "child_ref_ids": [],
    "geoposition": [],
    "object_groups": []
}
{
    "id": "62ea7145b8ff53567ebda38d",
    "parent_id": [
        "62e923d8cf878556dcf522b7"
    ],
    "name": "Discovery ID Test Edited",
    "discovery_id": "Discovery ID Test Object",
    "owner_id": "62c2f3ce80c8654892764d56",
    "updated": 1659531655003,
    "properties": [],
    "operations": [],
    "class_id": 13,
    "state_id": 1,
    "created": 1659531589533,
    "last_state_update": 1659531589533,
    "tags": [],
    "weight": 1,
    "child_ids": [],
    "child_link_ids": [],
    "child_ref_ids": [],
    "geoposition": [],
    "object_groups": []
}

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