logo
logo

Related paths properties

Related paths provide quick access to related parent path–enabled entities. You can only use the related paths property on the parent relations with the Is path relation parameter enabled when connected to parent entities with path.

Note

Related paths show you where you are in the relation path and return simple labels. For data aggregation, use aggregations.

Template

The query URL parameter is defined as follows:

relatedPathProperties=<RelationName>|<DefinitionNames...>|<PropertyNames...>

You can use one or several definition names and property names in the request.

You can use the relatedPathProperties parameter multiple times for multiple relations.

All requested properties are combined and fetched in one call from the database.

http://localhost:8080/api/entities/1000?relatedPathProperties=AssetTypeToAsset|M.AssetType|Label,TriggersVision

Example

The following example shows you a single path entity returned, which means that the entity for which you made the request only has one related path. However, a payload can have several path entities if the entity has more than one related path.

{
   "related_paths":{
      "AssetTypeToAsset":[
         [
            {
               "values":{
                  "en-US":"asset type name"
               },
               "properties":{
                  "Label":"asset type label",
                  "TriggersVision":true
               },
               "entity":"http://localhost:8080/api/entities/1005",
               "definition":"http://localhost:8080/api/entitydefinitions/M.AssetType"
            }
         ]
      ]
   }
}

Performance and storage impact

There is no significant performance difference between using the relatedPathProperties one or several times on an entity. However, when an entity has many related paths, it requires loading a lot of entities, which might slightly impact performance.

Related paths are computed on the fly, thus their impact on the storage is minimal. Paths however, are computed and stored in the main meta–data storage for all the path–enabled entities. The computation of the paths happens during the search indexing process of the entities.

Paths themselves have a non trivial, though small, memory footprint. This does not normally cause issues. However, paths (not related paths) should not be enabled and are not intended for entity definitions with significant amounts of entities (for example, M.Asset or M.File). You can consider the paths as a form of data classification which sorts large groups of data rather than classifying every single piece of data.

Computation of the paths for large pools of entities has an impact on system performance and uses a large portion of the main metadata storage.

Can we improve this article ? Provide feedback