Link
Link connects two Objects. You can use it to describe and check connection between hosts or services.
Unlike Objects, Links don't have names or any parents/children, but have direction defined by source from
and target to
Objects. Otherwise, Links are similar to Objects - they have Data Ingestion, State, Properties, Operations, Tags, etc.
Link Model
Field | Type | Description |
---|---|---|
id | Stringrequired |
Link's ID. |
source | Stringrequired |
The ID of a link's source object. |
source_name | String | Name of the source object. |
target_name | String | Name of the target object. |
target | Stringrequired |
The ID of a link's target object. |
class_id | String | Link's class ID. |
owner_id | String | The ID of a user who owns the link. |
state_id | String | Link's state ID. |
created | Integer | A timestamp when the link was created. |
updated | Integer | A timestamp when the link was last updated. |
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. |
properties | Array<Property> | An array of link's properties. |
weight | Integer | Link's weight. |
tags | Array<Tag> | An array of link's tags. |
client_data | String | Link's client data. See a more detailed description below. |
_version | Integer | Version of the link. Version increases by 1 every time any field changes in a link. |
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. See a list of all possible sections' names in the Sections' Names article. |
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 Sections' Names article. |
showArrow | Boolean | Whether to show a link's arrow. |
widgets | Array<Widget> | An array of widgets configured for the object. |
Example
{
"source": "5de94259c98e8c0fc2435808",
"target": "5df1f59c53e27e5dfa333d0b",
"owner_id": "5abd0b3ee1add25079212607",
"weight": 1,
"tags": [ ],
"last_state_update": 1576213402710,
"updated": 1576213402709,
"created": 1576213402710,
"state_id": 1,
"class_id": 35,
"operations": [ ],
"properties": [ ],
"id": "5df31b9a53e27e5dfa33aa6f"
}