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

class_id

String

Link’s class ID.

created

Integer

A timestamp when the link was created.

client_data

String

Link’s client data. See a more detailed description below.

entityType

Integer

Entity Type. For a link, entity type is 2.

id

String
required

Link’s ID.

last_state_update

Integer

A timestamp when link’s state was last updated.

manual_state

ManualState

Link’s manual state.

name

String

Name of the link entity in the following format <source_name>-<target_name>

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
required

The ID of a link’s source object.

source_name

String

Name of the source object.

state_id

String

Link’s state ID.

tags

Array<__Tag>

An array of link’s tags.

target

String
required

The ID of a link’s target object.

target_name

String

Name of the target object.

updated

Integer

A timestamp when the link was last updated.

_version

Integer

Version of the link. Version increases by 1 every time any field changes in a link.

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

class_id

String

Link’s class ID.

created

Integer

A timestamp when the link was created.

client_data

String

Link’s client data. See a more detailed description below.

entityType

Integer

Entity Type. For a link, entity type is 2.

id

String
required

Link’s ID.

last_state_update

Integer

A timestamp when link’s state was last updated.

manual_state

ManualState

Link’s manual state.

name

String

Name of the link entity in the following format <source_name>-<target_name>

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
required

The ID of a link’s source object.

source_name

String

Name of the source object.

state_id

String

Link’s state ID.

tags

Array<__Tag>

An array of link’s tags.

target

String
required

The ID of a link’s target object.

target_name

String

Name of the target object.

updated

Integer

A timestamp when the link was last updated.

_version

Integer

Version of the link. Version increases by 1 every time any field changes in a link.

weight

Integer

Link’s weight.

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"
  }