RelatedItem

A RelatedItem is the most basic unit of data on the platform. It is an item, which is a schema-less JSON object that can represent a single item, such as building model element.

Why are they called RelatedItems?

These basic data objects are called RelatedItems because they have the potential to form part of a relationship with one or more other RelatedItems, either in the same collection or another.

At their simplest, RelatedItems are schema-less JSON objects with an ID:

{  "_id": "1e7433c4-a3de-4c15-b8fb-657c1d9b814c"}

You can add your own properties to a RelatedItem:

{  "_id": "1e7433c4-a3de-4c15-b8fb-657c1d9b814c",  "name": "building_element_1" // Custom property}

Collections

Group RelatedItems in a NamedUserCollection. When your RelatedItems are in a collection, you can create relationships between them and items in the same or other collections.

RelatedItem sub-types

There are two RelatedItem sub-types:

• FileItem: Represents a file in the ItemService and points to the source file in the FileService.
• Telemetry item: Represents a telemetry item, such as a sensor.

Schema

For more information on the RelatedItem type and its properties, see the RelatedItem schema.

API

You can create and manage RelatedItems with the IafItemSvc JavaScript Platform API or the Item Service REST API.

Note: In Platform version 4.5, access controls were introduced which allow for fine-grained control of permissions on Related Items which match specific criteria. For more information on using this feature, refer to the Item Service Rest API Permissions page.