Link
The Link Model
| Field | Type | Description |
|---|---|---|
| class_id | String | Link's class ID. |
| client_data | String | Link's client data. See a more detailed description below. |
| created | Integer | A timestamp when the link was created. |
| id | String | Link's ID. |
| last_state_update | Integer | A timestamp when link's state was last updated. |
| manual_state | ManualState | Link's manual state. |
| operations | Array<Operation> | An array of link's operations. |
| owner_id | String | The ID of a user who owns the link. |
| properties | Array<Property> | An array of link's properties. |
| source | String
|
The ID of a link's source object. |
| state_id | String | Link's state ID. |
| tags | Array<Tag> | An array of link's tags. |
| target | String
|
The ID of a link's target object. |
| updated | Integer | A timestamp when the link was last updated. |
| weight | Integer | Link's weight. |
Client data
Client data is a set of fields that correspond to various link'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. |
| connectorStyle | String | The style of a link shape. Available options: Bezier, Flowchart, Straight. |
| headlinePropIds | Array<String> | An array of properties' keys whose values should be displayed on a link's headline. |
| joinedGraphs | Array<String> | An array of plots' IDs displayed on a joined plot. |
| nonPinnedSections | Map<String, Boolean> | A collection of link'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. |
| showArrow | Boolean | Whether to show a link's arrow. |
| widgets | Array<Widget> | An array of widgets configured for the object. |
Sections' names
The sections' names are as follows: - documents - stat - entity-settings - monitoring - entity-state-conditions - entity-incident-conditions - state-triggers - stat-rules - properties - operations - state-history - audit-log