You can add custom parameters to the platform objects. For example, item numbers, extended warranty information, additional specifications, etc.

Custom parameters can be used in global search and filtering of information in tables.

In the current version, it is possible to add parameters to the following objects:

  • servers;
  • switches;
  • PDUs;
  • UPS.

Fields for custom parameters can be of the following types:

  • single-line text;
  • multi-line text;
  • selection field with the possibility of entering a custom value;
  • date;
  • number;
  • logical parameter (yes/no);
  • link.

Configuring custom parameters


Custom parameters can only be configured through the platform API. For example, you can configure via the Swagger interactive shell.

Creating parameters

To create custom parameters for a certain type of equipment, run a POST request:

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

domain.com — domain name or IP address of the server with the platform

entity_name — equipment type. Possible values:

  • server
  • switch
  • pdu
  • ups

In the body of the request, specify a description of the parameters:

Example of description

{
	"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 — internal name of the parameter. Must be unique within the selected object type

is_required — whether the parameter is mandatory when creating or changing an object. Possible options: true — mandatory parameter, false — optional

priority — the order in which the parameters are displayed in the interface. The minimum value is 1. The lower the priority value, the higher the parameter will be located on the form. In the table columns the parameters are displayed from left to right in ascending order of priority

readable_name — the name to be displayed in the English interface

readable_name_ru — the name to be displayed in the Russian interface. Optional parameter

type — type of field for the parameter. Possible values:

  • string — single-line text;
  • text — multi-line text;
  • select — a selection field with the possibility to enter a custom value;
  • date — date;
  • numeric — number;
  • bool — logical parameter (yes/no);
  • url — link

Note

This POST request does not add new parameters, but recreates all parameters for the selected equipment type. All previously created parameters for this type of equipment will be deleted.

Deleting parameters

To delete custom parameters for a certain type of equipment, run a DELETE request: 

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

domain.com — domain name or IP address of the server with the platform

entity_name — equipment type. Possible values:

  • server
  • switch
  • pdu
  • ups

Managing custom parameters


Adding an object

When adding an object to the platform, fields for entering custom parameters are displayed on the form under Additional parameters.

Editing an object

Open the object card and enter Additional parameters to change the value of the object's custom parameters.

Displaying parameters in tables

Press the symbol in the upper right corner and select the required parameters from the list to enable the display of custom parameters in the table.