1. 関連パス プロパティ

関連パス プロパティ

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

関連パスを使用すると、関連エンティティにすばやくアクセスできます。関連パス プロパティは、パス リレーション パラメーターが有効になっているリレーション エンティティでのみ使用できます。

注意

関連パスは、リレーション パスのどこにいるかを示し、単純なラベルを返します。データ集計には、集計を使用します。

テンプレート

クエリ URL パラメーターは次のように定義されます。

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

要求では、1 つまたは複数の定義名とプロパティ名を使用できます。

relatedPathProperties パラメーターは、複数のリレーションに複数回使用できます。

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

次の例は、返された単一のパス エンティティを示しています。これは、要求を行った対象のエンティティの関連パスが 1 つのみであることを意味します。ただし、エンティティに複数の関連パスがある場合、ペイロードには複数のパス エンティティがある可能性があります。

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

パフォーマンスへの影響

この機能によるパフォーマンスへの影響は極めて小さなものです。これは、要求されたすべてのプロパティが組み合わされ、1 回の呼び出しでデータベースからフェッチされるためです。

エンティティに対して relatedPathProperties を 1 回または複数回使用しても、パフォーマンスに大きな違いはありません。

ただし、エンティティに関連パスが多数ある場合は、多数のエンティティを読み込む必要があり、パフォーマンスにわずかな影響を与える可能性があります。

この記事を改善するための提案がある場合は、 お知らせください!