アプリケーションプログラミングインターフェイスガイド> Webサービスオペレーション> オペレーションリファレンス> getIntrospectableResourceIdsResult
 
getIntrospectableResourceIdsResult
getIntrospectableResourceIdsTaskから結果を取得します。返されるリソースの数は、ページサイズと既知のリソースの総数によって制限されます。その後のこのオペレーションの呼び出しは、データソース内で使用可能なネイティブリソース識別子の完全なリストを段階的に返します。
ブロックエレメントが設定され、TRUEの場合、このオペレーションはタスクが完了するまでブロックされます。それ以外の場合、このオペレーションはブロックされません。
ページサイズは、この呼び出しから返されるリソース識別子の最大数を制御します。
ページの開始により、最初に返されるリソースが決まります。これを使用して、リソースリストを先に進めることができます。このジャンプは、現在のロケーションを基準にしています。このオペレーションを呼び出すたびにゼロ以外のページ開始を提供すると、毎回ページサイズの結果をスキップする効果があります。ページ開始を指定すると、リソースIDの受信を開始するロケーションが設定されます。このオペレーションへの後続の呼び出しは、その時点から開始されます。
このオペレーションの呼び出し中に不十分な数のリソースIDが検出された場合、このオペレーションはタイムアウトになるか、COMPLETEDがTRUEに等しい状態で返されます。いずれの場合も、識別子の空のリストが返されます。
このオペレーションは、getIntrospectableResourceIdsResultを使用して結果を取得するために使用できる、またはcancelServerTaskを使用してキャンセルできるtaskIdを返します。
このオペレーションは、totalResultsエレメント内の既知のリソース識別子の総数を返します。 totalResultsエレメントは、完全な合計がわかるまで存在しません。この数が不明であるか、部分的な結果しか利用できない場合、このエレメントは空です。
このオペレーションは、処理が完了したかどうかを示すcompletedエレメントを返します。これらは、呼び出し元が受け取る最後の結果です。 TRUEの場合、getIntrospectableResourceIdsResultへの後続の呼び出しはNotFoundフォールトを生成します。
lastUpdate returnエレメントは、このリソースIDリストに関連付けられたキャッシュが最後に更新された日時を示します。元のgetIntrospectableResourceIdsTaskが原因で結果セットが現在更新されている場合、lastUpdateはサーバータスクがいつ開始されたかを反映します。
resourceIdentifiersエレメントは、ネイティブリソースのパス、タイプ、およびサブタイプのリストを提供します。パスは、含まれているデータソースからの相対パスです。
このオペレーションは、getIntrospectableResourceIdsTaskへの元の呼び出しが呼び出されたのと同じ明示的なトランザクション内で実行する必要があります。それ以外の場合、taskIdはNotFoundとして報告されます。
ロケーション
/services/webservices/system/admin/resource/operations/
リクエストエレメント
taskId:元の呼び出しに関連付けられたサーバータスクID。
block:処理が完了するまでブロックするかどうか。デフォルトはFALSEです。
page:
size:結果で返されるリソース識別子の数。
start:データの取得を開始するページ番号。デフォルトは0です。
応答エレメント
taskId:元の呼び出しに関連付けられたサーバータスクID。
totalResults:わかっている場合は、結果セットの合計サイズ。それ以外の場合、このエレメントは存在しません。
completed:処理が完了し、結果セットが使い果たされた場合はTRUE。
lastUpdate:キャッシュされたリソースが最後に作成された日時。
resourceIdentifiers:データソース内で使用可能なネイティブリソースパスとタイプのリスト。
エラー解析
DataSourceError:データソース接続を確立できない場合、またはデータソース要求がエラーを返した場合。
IllegalArgument:taskIdまたはページの形式が正しくない場合。
IllegalState:データソースが無効になっている場合。
NotFound:taskIdが存在しないか、完了している場合。
セキュリティ:ユーザーがACCESS_TOOLS権限を持っていない場合。
セキュリティ:サーバータスクの作成に別のTDVセッションが使用された場合。