SmartDCIM REST API

В этом разделе описаны REST-методы и модели данных, которые они используют, а также общая информация о системе SmartDCIM, которую необходимо знать для работы с системой через REST API.

Методы разделены на группы, например Аутентификация, Объекты и т. д. В каждой группе есть описание вариантов использования ее методов. Статья, посвященная конкретному методу API, состоит из:

• метод (GET, POST, и т.д.);
• URL запроса (например node/api/users/session);
• описание запроса;
• права, которые требуются от пользователя;
• парметры запроса;
• описание ответа.

Также каждая статья содержит примеры запросов на Bash, JavaScript, NodeJS и Python. Для выполнения запросов сценарии Bash используют cURL, а примеры в JavaScript, NodeJS и Python используют библиотеки http, fetch и request соответственно.

Примеры кода реализованы таким образом, чтобы быть максимально самодостаточными. Единственные параметры, которые вам необходимо предоставить для работы — это ваши учетные данные для входа и имя хоста системы SmartDCIM. В некоторых примерах требуется указать дополнительные параметры (например, идентификатор объекта или пользователя).