Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Related Items

Create entity relation

Create a relation between two entities

post/v2/related-items/entity/{entityType}/{entityId}/relation

Path parameters

entityType'ORGANIZATION' | 'DOCUMENT' | 'LOCATION' | 'NODE' | 'CHECKLIST' | 'KB_DOCUMENT' | 'END_USER' | 'SOFTWARE_LICENSE' required
entityIdinteger required

Request body

relEntityType'ORGANIZATION' | 'DOCUMENT' | 'LOCATION' | 'NODE' | 'ATTACHMENT' | 'TECHNICIAN' | 'CREDENTIAL' | 'CHECKLIST' | 'END_USER' | 'CONTACT' | 'KB_DOCUMENT' | 'SOFTWARE_LICENSE'

Related Entity Type

relEntityIdinteger

Related Entity Identifier

Response

Returns the relation created for an entity

idinteger

Identifier

type'VALUE' | 'ENTITY'

Type of Relation

entityobject

Entity

entityIdinteger

Entity Identifier

entityType'ORGANIZATION' | 'DOCUMENT' | 'LOCATION' | 'NODE' | 'CHECKLIST' | 'KB_DOCUMENT' | 'END_USER' | 'SOFTWARE_LICENSE'

Entity Type

relEntityobject

Related Entity

relEntityIdinteger

Related Entity Identifier

relEntityType'ORGANIZATION' | 'DOCUMENT' | 'LOCATION' | 'NODE' | 'ATTACHMENT' | 'TECHNICIAN' | 'CREDENTIAL' | 'CHECKLIST' | 'END_USER' | 'CONTACT' | 'KB_DOCUMENT' | 'SOFTWARE_LICENSE' | 'SECURE'

Related Entity Type

valueobject

Related item value (Attachment meta data / Secure information)

createTimenumber double

Creation time

updateTimenumber double

Last update time

createdByAppUserIdinteger

The identifier of the user who created the related item

updatedByAppUserIdinteger

The identifier of the last user to update the related item