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

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

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

  • серверы;
  • коммутаторы;
  • PDU;
  • ИБП.

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

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

Настройка собственных параметров

Настройка собственных параметров возможна только через API платформы. Например, вы можете выполнить настройку в интерактивной оболочке Swagger.

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

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

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

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

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

  • server — сервер
  • switch — коммутатор
  • pdu — PDU
  • 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 — тип оборудования. Возможные варианты:

  • server — сервер
  • switch — коммутатор
  • pdu — PDU
  • ups — ИБП

Управление собственными параметрами

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

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

Редактирование объекта

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

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

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