Вы можете добавить собственные (кастомные) параметры к объектам платформы. Например, номенклатурные номера, данные расширенной гарантии, дополнительные технические характеристики и т.д.

Собственные параметры могут быть использованы в глобальном поиске и фильтрации информации в таблицах.

В текущей реализации доступно добавление параметров к следующим объектам:

  • серверы;
  • шасси;
  • коммутаторы;
  • PDU;
  • ИБП;
  • оборудование на складе;
  • стойки.

Собственные параметры применяются для всех объектов платформы выбранного типа.

Поля для собственных параметров могут быть следующих типов:

  • Строка — поле для ввода однострочного текста;
  • Многострочный текст — поле для ввода многострочного текста;
  • Селект — поле выбора с возможностью ввода собственного значения;
  • Дата — поле выбора даты в календаре;
  • Число — поле для ввода числовых значений;
  • Чекбокс — логический параметр (да/нет);
  • Ссылка.

Управление параметрами через интерфейс

Для управления параметрами перейдите в раздел Оборудование → вкладка Доп. параметры.

Интерфейс раздела

Чтобы добавить параметр:

  1. Выберите тип оборудования → нажмите кнопку Создать параметр.
  2. Задайте настройки параметра:
    1. Выберите Тип поля:
      • Строка;
      • Многострочный текст;
      • Селект;
      • Дата;
      • Число;
      • Чекбокс;
      • Ссылка.
    2. Укажите Внутреннее имя для API — имя, которое будет использоваться в API-запросах. Должно быть уникальным в рамках выбранного типа объектов.

    3. Укажите Название поля RU –- для отображения в русском интерфейсе.

    4. Укажите Название поля EN –- для отображения в английском интерфейсе.

    5. Если это поле должно быть обязательным при создании и изменении объекта, включите опцию Обязательный параметр.
  3. Нажмите кнопку Создать.

Чем выше параметр отображается в списке, тем выше он будет находиться на формах создания и настройки оборудования. Чтобы изменить положение параметра, нажмите значок и перетяните строку в нужное место. 

Чтобы изменить параметр, нажмите значок .

Чтобы удалить параметр, нажмите значок .

Добавление объекта

При добавлении объекта в платформу поля для ввода собственных параметров отображаются на форме в разделе Дополнительные параметры. 

Изменение объекта

Чтобы изменить значение собственных параметров объекта, откройте карточку объекта и перейдите в раздел Дополнительные параметры.

Отображение параметров в таблицах

Чтобы включить отображение собственных параметров в таблице, нажмите значок в правом верхнем углу и выберите нужные параметры в списке.

Управление параметрами через API

Создание параметров

Чтобы создать собственные параметры для определённого типа оборудования, выполните POST-запрос:

POST https://domain.com/dci/v3/custom_field/entity_name
CODE

domain.com — доменное имя или IP-адрес сервера с платформой

entity_name — тип оборудования. Возможные варианты:

  • chassis — шасси
  • cpu — процессор
  • cpu_type — модель CPU
  • other_spare_part — оборудование из раздела "Другое"
  • other_spare_type — модель оборудования из раздела "Другое"
  • pci — PCI-e устройство
  • pci_type — модель PCI-e устройства
  • pdu — PDU
  • rack — стойка
  • ram — оперативная память
  • ram_type — модель оперативной памяти
  • server — сервер
  • storage — накопитель
  • storage_type — модель накопителя
  • switch — коммутатор
  • ups — UPS

В теле запроса укажите описание параметров:

Пример описания

{
	"fields": [{
			"field_name": "param1",
			"is_required": true,
			"priority": 1,
			"readable_name": "Parameter 1",
			"readable_name_ru": "Параметр 1",
			"type": "string"
		},
		{
			"field_name": "param2",
			"is_required": false,
			"priority": 2,
			"readable_name": "Parameter 2",
			"readable_name_ru": "Параметр 2",
			"type": "text"
		},
		{
			"field_name": "param3",
			"is_required": false,
			"priority": 3,
			"readable_name": "Parameter 3",
			"readable_name_ru": "Параметр 3",
			"type": "select"
		}
	]
}
CODE

field_name — внутреннее имя параметра. Должно быть уникальным в рамках выбранного типа объектов

is_required — является ли параметр обязательным при создании или изменении объекта. Возможные варианты: true — обязательный параметр, false — необязательный

priority — порядок отображения параметров в интерфейсе. Минимальное значение — 1. Чем меньше значение priority, тем выше параметр будет расположен на форме. В столбцах таблицы параметры отображаются слева направо по возрастанию значения priority.

readable_name –- название для отображения в английском интерфейсе

readable_name_ru –- название для отображения в русском интерфейсе

type — тип поля для параметра. Возможные варианты:

  • string — Строка;
  • text — Многострочный текст;
  • select — Селект;
  • date — Дата;
  • numeric — Число;
  • bool — Чекбокс;
  • url — Ссылка

Этот POST-запрос не добавляет новые параметры, а заново создаёт все параметры для выбранного типа оборудования. Все ранее созданные параметры для этого типа оборудования будут удалены.

Удаление параметров

Чтобы удалить собственные параметры для определённого типа оборудования, выполните DELETE-запрос: 

DELETE https://domain.com/dci/v3/custom_field/entity_name
CODE

domain.com — доменное имя или IP-адрес сервера с платформой

entity_name — тип оборудования. Возможные варианты:

  • chassis — шасси
  • cpu — процессор
  • cpu_type — модель CPU
  • other_spare_part — оборудование из раздела "Другое"
  • other_spare_type — модель оборудования из раздела "Другое"
  • pci — PCI-e устройство
  • pci_type — модель PCI-e устройства
  • pdu — PDU
  • rack — стойка
  • ram — оперативная память
  • ram_type — модель оперативной памяти
  • server — сервер
  • storage — накопитель
  • storage_type — модель накопителя
  • switch — коммутатор
  • ups — UPS