1. REST API

関連パスのプロパティ

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

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

関連パスを使用すると、関連する親パス対応エンティティにすばやくアクセスできます。親リレーションのrelated pathsプロパティは、Is path relationパラメータが有効になっている場合にのみ、pathで親エンティティに接続されているときにのみ使用できます。

メモ

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

テンプレート

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

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

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

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

要求されたすべてのプロパティは、データベースから1回の呼び出しで結合され、フェッチされます。

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

次の例は、返された1つのパス エンティティを示しています。これは、要求を行ったエンティティに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"
      }
     ]
   ]
  }
}

パフォーマンスとストレージへの影響

エンティティでrelatedPathPropertiesを1回使用するか、数回使用するかの間に、パフォーマンスに大きな違いはありません。ただし、エンティティに多数の関連パスがある場合は、多くのエンティティをロードする必要があり、パフォーマンスに若干の影響を与える可能性があります。

関連するパスはオンザフライで計算されるため、ストレージへの影響は最小限に抑えられます。ただし、パスは計算され、すべてのパス対応エンティティのメインメタデータストレージに格納されます。パスの計算は、エンティティの検索インデックス作成プロセス中に行われます。

パス自体には、小さいながらも重要なメモリフットプリントがあります。通常、これは問題を引き起こしません。ただし、パス (関連パスではない) は有効にすべきではなく、大量のエンティティ ( M.AssetM.Fileなど) を含むエンティティ定義を対象としていません。パスは、すべてのデータを分類するのではなく、大規模なデータ グループを並べ替えるデータ分類の形式と考えることができます。

エンティティの大規模なプールのパスの計算は、システムのパフォーマンスに影響を与え、メインメタデータストレージの大部分を使用します。

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