Partilhar via


GetDocumentsStatusQueryParamProperties interface

Propriedades

createdDateTimeUtcEnd

A data/hora final para obter itens antes

createdDateTimeUtcStart

A data/hora de início para obter itens após

ids

Ids a utilizar na filtragem

maxpagesize

maxpagesize é o máximo de itens retornados em uma página. Se mais itens forem solicitados via top (ou top não for especificado e houver mais itens a serem devolvidos),

orderby

a consulta de classificação para a coleção (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')

skip

Ignorar indica o número de registros a serem ignorados da lista de registros mantidos pelo servidor com base no método de classificação especificado. Por padrão, classificamos por hora de início decrescente.

Os clientes PODEM usar parâmetros de consulta superior e ignorar para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando o topo e o pulo são fornecidos por um cliente, o servidor DEVE primeiro aplicar skip e, em seguida, top na coleção.

Nota: Se o servidor não puder honrar o topo e/ou ignorar, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de simplesmente ignorar as opções de consulta.

statuses

Status a ser usado na filtragem

top

TOP indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas.

Os clientes PODEM usar parâmetros de consulta superior e ignorar para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando o topo e o pulo são fornecidos por um cliente, o servidor DEVE primeiro aplicar skip e, em seguida, top na coleção.

Nota: Se o servidor não puder honrar o topo e/ou ignorar, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de simplesmente ignorar as opções de consulta.

Detalhes de Propriedade

createdDateTimeUtcEnd

A data/hora final para obter itens antes

createdDateTimeUtcEnd?: string | Date

Valor de Propriedade

string | Date

createdDateTimeUtcStart

A data/hora de início para obter itens após

createdDateTimeUtcStart?: string | Date

Valor de Propriedade

string | Date

ids

Ids a utilizar na filtragem

ids?: string[]

Valor de Propriedade

string[]

maxpagesize

maxpagesize é o máximo de itens retornados em uma página. Se mais itens forem solicitados via top (ou top não for especificado e houver mais itens a serem devolvidos),

maxpagesize?: number

Valor de Propriedade

number

orderby

a consulta de classificação para a coleção (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')

orderby?: string[]

Valor de Propriedade

string[]

skip

Ignorar indica o número de registros a serem ignorados da lista de registros mantidos pelo servidor com base no método de classificação especificado. Por padrão, classificamos por hora de início decrescente.

Os clientes PODEM usar parâmetros de consulta superior e ignorar para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando o topo e o pulo são fornecidos por um cliente, o servidor DEVE primeiro aplicar skip e, em seguida, top na coleção.

Nota: Se o servidor não puder honrar o topo e/ou ignorar, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de simplesmente ignorar as opções de consulta.

skip?: number

Valor de Propriedade

number

statuses

Status a ser usado na filtragem

statuses?: string[]

Valor de Propriedade

string[]

top

TOP indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas.

Os clientes PODEM usar parâmetros de consulta superior e ignorar para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando o topo e o pulo são fornecidos por um cliente, o servidor DEVE primeiro aplicar skip e, em seguida, top na coleção.

Nota: Se o servidor não puder honrar o topo e/ou ignorar, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de simplesmente ignorar as opções de consulta.

top?: number

Valor de Propriedade

number