GetDocumentsStatus interface
メソッド
| get(Get |
バッチ ドキュメント翻訳要求内のすべてのドキュメントの状態を返します。 応答内のドキュメントの数がページングの制限を超えた場合は、サーバー側のページングが使用されます。 ページ分割された応答は、部分的な結果を示し、応答に継続トークンを含めます。 継続トークンが存在しない場合は、追加のページが使用できなくなることを意味します。 top、skip、maxpagesize のクエリ パラメーターを使用して、返される結果の数とコレクションのオフセットを指定できます。 top は、ユーザーがすべてのページにわたって返すレコードの合計数を示します。 skip は、指定された並べ替え方法に基づいて、サーバーが保持するドキュメントの状態の一覧からスキップするレコードの数を示します。 既定では、開始時刻を降順に並べ替えます。 maxpagesize は、ページで返される最大アイテムです。 top を使用して要求される項目が増えた場合 (または top が指定されておらず、返される項目が他にある場合) |
メソッドの詳細
get(GetDocumentsStatusParameters)
バッチ ドキュメント翻訳要求内のすべてのドキュメントの状態を返します。
応答内のドキュメントの数がページングの制限を超えた場合は、サーバー側のページングが使用されます。 ページ分割された応答は、部分的な結果を示し、応答に継続トークンを含めます。 継続トークンが存在しない場合は、追加のページが使用できなくなることを意味します。
top、skip、maxpagesize のクエリ パラメーターを使用して、返される結果の数とコレクションのオフセットを指定できます。
top は、ユーザーがすべてのページにわたって返すレコードの合計数を示します。 skip は、指定された並べ替え方法に基づいて、サーバーが保持するドキュメントの状態の一覧からスキップするレコードの数を示します。 既定では、開始時刻を降順に並べ替えます。 maxpagesize は、ページで返される最大アイテムです。 top を使用して要求される項目が増えた場合 (または top が指定されておらず、返される項目が他にある場合)
function get(options?: GetDocumentsStatusParameters): StreamableMethod<GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse>パラメーター
- options
- GetDocumentsStatusParameters