Object

The Object Model

Field

Type

Description

background

String

Object's background image.

child_ids

Array<String>

An array of object's child objects IDs.

child_link_ids

Array<String>

An array of object's child links IDs.

child_ref_ids

Array<String>

An array of object's child references IDs.

class_id

String

The ID of an object class.

client_data

String

Object's client data. See a more detailed description below.

created

Integer

A timestamp when the object was created.

discovery_id

String

Object's discovery ID. The filed can be used along with the Create Object method. If the field is specified in a request body, the method works as follows: if an object with a specified discovery ID doesn't exist, a new object with this ID will be created. If an object with a specified discovery ID already exists, the object's body will be updated. Thus, this field can be used as an external ID created by the user and utilized thereafter to work with an object.

geoposition

Array<Float>

Object's position on a map. It is specified as an array of two float numbers, where the first number is longitude, the second one is latitude.

geopositionRadius

Integer

The radius of an object's area displayed on a map.

id

String

Object's ID.

last_state_update

Integer

A timestamp when object's state was last updated.

manual_state

ManualState

Object's manual state.

name

String

required

Object's name.

operations

Array<Operation>

An array of object's operations.

owner_id

String

The ID of a user who owns the object.

parent_id

Array<String>

The IDs of an object's parents.

properties

Array<Property>

An array of object's properties.

state_id

String

The ID of an object state.

tags

Array<Tag>

An array of object's tags.

updated

Integer

A timestamp when the object was last updated.

weight

Integer

Object's weight.

Client data

Client data is a set of fields that correspond to various object's UI settings. The fields are specified in the JSON format and stored on a server as a string. The table below contains a description of all fields from the set:

Field

Type

Description

charts

Array<Array<String>>

An array of plots. Each plot is stored as an array, the first element of which is the ID of the plot, the second one is a mathematical formula for metrics to be displayed on the plot.

collapseSections

Map<String, Boolean>

A collection of object's metrics names whose plots should be collapsed. Each record of the collection is a pair, the first element of which is a metric's title, the second one is a boolean value. If the value set to true, the corresponding plot will be collapsed.

custom_style.height

Integer

Object's height (in pixels). Should be specified with the px suffix.

custom_style.left

Integer

Object's margin from the left (in pixels). Should be specified with the px suffix.

custom_style.top

Integer

Object's margin from the top (in pixels). Should be specified with the px suffix.

custom_style.width

Integer

Object's width (in pixels). Should be specified with the px suffix.

custom_style.zIndex

Integer

Object's Z-index. The index specifies how overlapping objects should be displayed in the standard view. For example, if there are two overlapping objects, an object with a greater Z-index will be shown above the other object with a smaller Z-index. In other words, objects with greater Z-index are shown above objects with smaller Z-index.

headlinePropIds

Array<String>

An array of properties' keys whose values should be displayed on an object's headline.

joinedGraphs

Array<String>

An array of plots' IDs displayed on a joined plot.

nonPinnedSections

Map<String, Boolean>

A collection of object's sections names that should be unpinned. Each record of the collection is a pair, the first element of which is a section name, the second one is a boolean value. If the value is set to true, the corresponding section will be unpinned. See a list of all possible sections' names in the paragraph below.

widgets

Array<Widget>

An array of widgets configured for the object.

Sections' names

documents, stat, entity-settings, monitoring, entity-state-conditions, entity-incident-conditions, state-triggers, stat-rules, properties, operations, state-history, audit-log.