Home
Attribution
FAQ
How do I gather Entities in Python?
How do I get an Entity ontology in Python?
API Reference
OpenAPI documentation
Authentication
Entities
Entity Types
Entity Type: Data Schema
Data Schema: Data Mapping
Entity Styles
Pending Actions (Server Jobs)
Client and temp files
Entity Attachments
Entity Links
Entity Tags
Entity LODs (representations)
Entity Type LODs
Import Assemblies
Import CSV
Import GeoJSON
Import JSON
Import KML / KMZ
Export BRZ
DataLab queries
DataLab actions
DataLab secondary queries
Entity historic data
Entity Scenarios
Project Views and Bookmarks
Project View Menu Items
Project View Data
Custom Forms
Relationship Types
Relationships
Libraries: Web
Getting started
Setup: No framework
Setup: Typescript + React
Setup: Typescript + Angular
Setup: React Native + Expo
Authentication
Default widgets
Drawing tools
Entity interaction
Render Project Views
Render Entities
Render Cesium Tilesets
Render terrain and basemaps
Styling Entities
Styling Tilesets
Request Entity records
File uploads
Libraries: Python
Getting started
Authentication
Entities
Entity Types
Web Navigator
Plugins
Plugins - Developer environment
Loading in an iFrame
Operator
Annotated documents
Other apps
IBM Maximo
Unreal Engine 5
Omniverse

Entity Relationship Types


A Relationship Type is a classification of a Relationship between two Entity records. It gives a human-readable way to describe how your Entities relate to each-other.


The most simple Relationship Type is "Parent" and "Child" where you provide the name and reverse-name of "parent of" and "child of". This allows us to create human-readable sentences that describe your records.

Entity A is parent of Entity B. Entity B is child of Entity A.


Some Relationship Types are generated automatically and serve an internal purpose. For example the ID COMMENTS_REPLY is reserved for relating Comment records to their replies. BruceRsrvContains is reserved for our Assembly imports for parent/child relationships that have relative positioning. BruceRsrvInstanceOf is a legacy Assembly Relationship Type.

Relationship Type requests

Below are the basic requests for managing Relationship Types.

Get Relationship Types

Response
interface IResponse {
    Items: {
        // Unique ID for the Relationship Type.
        "ID": string;
        // Human readable name.
        "Name": string;
        // Forward name to use in a sentence.
        "ForwardName": string;
        // Reverse name to use in a sentence.
        "ReverseName": String;

        // Default Style ID.
        // This guides rendering the lines/parabolas between records in 3D.
        "EntityDisplaySettingsID"?: number;
        // Default Entity Type ID.
        // This is used as the default Entity Type when creating Entity data records for Relationships.
        "Relation.EntityType.ID"?: string;
    }[];
}
Javascript example

Create / Update Relationship Type

Request body
interface IBody {
    // Human readable name.
    "Name": string;
    // Forward name to use in a sentence.
    "ForwardName": string;
    // Reverse name to use in a sentence.
    "ReverseName": String;
}
Response
// Body is a JSON object with the same properties as a single item from the list above.
// It returns a single Relationship Type record directly.

Delete Relationship Type

Javascript example