getIntrospectableResourceIdsTask
特定のデータソースで使用可能なすべてのリソース識別子をフェッチするサーバータスクを作成します。
これが最初に呼び出されると、基になるデータソースは、データソース内で使用可能なリソースの完全なリストについて照会されます。この情報はキャッシュされるため、同じデータソースを使用してこれを呼び出すと、データソースにクエリを実行するのではなく、キャッシュの内容が返されます。このキャッシュをクリアするには、
clearIntrospectableResourceIdCacheを使用します。結果には、リソースIDキャッシュをクリアする必要があるかどうかを判断するために使用できるlastUpdateフィールドが含まれます。
データソース内で使用可能なリソースのリストは、データソース内のユーザーのアクセス権によって異なります。
dsContainerIdが指定されている場合、イントロスペクト可能なリソースの検索はその場所から開始されます。設定されていない場合、検索はデータソースルートから開始されます。
recurseがTRUEまたは設定されていない場合、イントロスペクタブルリソースの検索は、指定されたdsContainerIdから始まるデータソース全体で再帰的に実行されます。dsContainerIdが設定されていない場合はデータソースルートで実行されます。 recurseがFALSEの場合、dsContainerIdまたはデータソースルートの直接の子のみが検出されます。
キャッシュの作成に関連付けられたユーザー名もキャッシュに配置されます。データソースが動的でない場合、ユーザー名はデータソース接続パラメーターから取得されます。データソースが動的である場合、TDVユーザー名とドメインから取得されます。
各データソースには、1つのプライマリリソース識別子キャッシュがあります。この呼び出しに関連付けられているユーザー名がプライマリキャッシュと異なる場合、プライマリキャッシュには有効期限のマークが付けられます。有効期限が過ぎると、キャッシュはクリアされます。この期間は、TDVサーバー属性を使用して変更できます。呼び出しに関連付けられているユーザー名が、現在有効期限のマークが付けられているキャッシュと一致する場合、有効期限はキャンセルされ、プライマリキャッシュになります。一致するユーザー名のキャッシュが存在しない場合は、データソースにクエリを実行して新しいキャッシュが作成されます。
このオペレーションは、
getIntrospectableResourceIdsResultを使用して結果を取得するために使用できるtaskIdを返すか、
cancelServerTaskを使用してキャンセルします。
このオペレーションは、totalResultsエレメント内の既知のリソース識別子の総数を返します。 totalResultsエレメントは、完全な合計がわかるまで存在しません。この数が不明であるか、部分的な結果しか利用できない場合、このエレメントは空です。
タスクが完了する前にこのオペレーションを呼び出すTDVセッションが閉じると、タスクは終了します。
このオペレーションは、タスクIDをgetIntrospectableResourceIdsResultの連続呼び出しで使用できるように、明示的なトランザクション内で実行する必要があります。
ロケーション
/services/webservices/system/admin/resource/operations/
リクエストエレメント
path：データソースのパス。
attributes（オプション）：データソースタイプ固有の属性のリスト。サポートされる属性の具体的なリストは、データソースの種類によって異なります。 （
getDataSourceAttributeDefsを参照してください。）指定された属性を設定しますが、指定されていない属性の値は変更しません。
属性エレメントを参照してください。
dsContainerId（オプション）：イントロスペクト可能なリソースを検索するためのデータソース内のコンテナー。設定されていない場合、データソースのルートパスが使用されます。
•path：コンテナへのパス。
recurse（オプション）：TRUEまたは設定されていない場合、イントロスペクト可能なリソースの検索は、指定されたdsContainerIdから始まるデータソース全体で再帰的に実行されます。dsContainerIdが設定されていない場合はデータソースルートで実行されます。 recurseがFALSEの場合、dsContainerIdまたはデータソースルートの直接の子のみが検出されます。
応答エレメント
taskId：作業を実行するサーバータスクのID。
totalResults（オプション）：わかっている場合は、結果セットの合計サイズ。それ以外の場合、このエレメントは存在しません。
エラー解析
DataSourceError：データソース接続を確立できない場合、またはデータソース要求がエラーを返した場合。
IllegalArgument：パスまたはdsPathの形式が正しくない場合。
IllegalState：データソースが無効になっている場合。
NotFound：データソースまたはデータソースへのパスの一部が存在しない場合。
NotFound：dsPathがデータソース内に存在しない場合。
セキュリティ：ユーザーがパス内の最後のアイテム以外のすべてのアイテムに対する読み取りアクセス権を持っていない場合。
セキュリティ：ユーザーがパスの最後の項目への読み取りアクセス権を持っていない場合。
セキュリティ：ユーザーがACCESS_TOOLS権限を持っていない場合。