GetDocumentsStatusQueryParamProperties interface

パッケージ:

@azure-rest/ai-translation-document

プロパティ

createdDateTimeUtcEnd	前にアイテムを取得する終了日時
createdDateTimeUtcStart	後にアイテムを取得する開始日時
ids	フィルター処理で使用する ID
maxpagesize	maxpagesize は、ページで返される最大アイテムです。 top を使用して要求される項目が増えた場合 (または top が指定されておらず、返される項目が他にある場合)
orderby	コレクションの並べ替えクエリ (例: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')
skip	skip は、指定された並べ替え方法に基づいて、サーバーが保持するレコードの一覧からスキップするレコードの数を示します。 既定では、開始時刻を降順に並べ替えます。 クライアントは、top パラメーターと skip クエリ パラメーターを使用して、返される結果の数とコレクションへのオフセットを指定できます (MAY)。 top と skip の両方がクライアントによって指定された場合、サーバーは最初に skip を適用し、次にコレクションの上に適用する必要があります (SHOULD)。 注: サーバーが上位またはスキップを優先できない場合、サーバーはクエリ オプションを無視するのではなく、そのことを通知するエラーをクライアントに返す必要があります(MUST)。
statuses	フィルター処理で使用する状態
top	top は、ユーザーがすべてのページにわたって返すレコードの合計数を示します。 クライアントは、top パラメーターと skip クエリ パラメーターを使用して、返される結果の数とコレクションへのオフセットを指定できます (MAY)。 top と skip の両方がクライアントによって指定された場合、サーバーは最初に skip を適用し、次にコレクションの上に適用する必要があります (SHOULD)。 注: サーバーが上位またはスキップを優先できない場合、サーバーはクエリ オプションを無視するのではなく、そのことを通知するエラーをクライアントに返す必要があります(MUST)。

プロパティの詳細

createdDateTimeUtcEnd

前にアイテムを取得する終了日時

createdDateTimeUtcEnd?: string | Date

プロパティ値

string | Date

createdDateTimeUtcStart

後にアイテムを取得する開始日時

createdDateTimeUtcStart?: string | Date

プロパティ値

string | Date

ids

フィルター処理で使用する ID

ids?: string[]

プロパティ値

string[]

maxpagesize

maxpagesize は、ページで返される最大アイテムです。 top を使用して要求される項目が増えた場合 (または top が指定されておらず、返される項目が他にある場合)

maxpagesize?: number

プロパティ値

number

orderby

コレクションの並べ替えクエリ (例: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')

orderby?: string[]

プロパティ値

string[]

skip

skip は、指定された並べ替え方法に基づいて、サーバーが保持するレコードの一覧からスキップするレコードの数を示します。 既定では、開始時刻を降順に並べ替えます。

クライアントは、top パラメーターと skip クエリ パラメーターを使用して、返される結果の数とコレクションへのオフセットを指定できます (MAY)。 top と skip の両方がクライアントによって指定された場合、サーバーは最初に skip を適用し、次にコレクションの上に適用する必要があります (SHOULD)。

注: サーバーが上位またはスキップを優先できない場合、サーバーはクエリ オプションを無視するのではなく、そのことを通知するエラーをクライアントに返す必要があります(MUST)。

skip?: number

プロパティ値

number

statuses

フィルター処理で使用する状態

statuses?: string[]

プロパティ値

string[]

top

top は、ユーザーがすべてのページにわたって返すレコードの合計数を示します。

クライアントは、top パラメーターと skip クエリ パラメーターを使用して、返される結果の数とコレクションへのオフセットを指定できます (MAY)。 top と skip の両方がクライアントによって指定された場合、サーバーは最初に skip を適用し、次にコレクションの上に適用する必要があります (SHOULD)。

注: サーバーが上位またはスキップを優先できない場合、サーバーはクエリ オプションを無視するのではなく、そのことを通知するエラーをクライアントに返す必要があります(MUST)。

top?: number

プロパティ値

number