GetDocumentsStatus interface
Métodos
| get(Document |
Retorna o status de todos os documentos em uma solicitação de tradução de documentos em lote. Se o número de documentos na resposta exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis. $top, $skip e $maxpagesize parâmetros de consulta podem ser usados para especificar um número de resultados a serem retornados e um deslocamento para a coleção. $top indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas. $skip indica o número de registros a serem ignorados da lista de status do documento mantida pelo servidor com base no método de classificação especificado. Por padrão, classificamos por hora de início decrescente. $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), '@nextLink' conterá o link para a próxima página. $orderBy parâmetro de consulta pode ser usado para classificar a lista retornada (ex "$orderBy=createdDateTimeUtc asc" ou "$orderBy=createdDateTimeUtc desc"). A classificação padrão é decrescente por createdDateTimeUtc. Alguns parâmetros de consulta podem ser usados para filtrar a lista retornada (por exemplo: "status=Succeeded,Cancelled") só retornará documentos bem-sucedidos e cancelados. createdDateTimeUtcStart e createdDateTimeUtcEnd podem ser usados combinados ou separadamente para especificar um intervalo de datetime pelo qual filtrar a lista retornada. Os parâmetros de consulta de filtragem suportados são (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd). Quando $top e $skip são incluídos, o servidor deve primeiro aplicar $skip e, em seguida, $top na coleção. Nota: Se o servidor não puder honrar $top e/ou $skip, o servidor deve retornar um erro para o cliente informando sobre isso em vez de apenas ignorar as opções de consulta. Isso reduz o risco de o cliente fazer suposições sobre os dados retornados. |
Detalhes de Método
get(DocumentTranslationGetDocumentsStatusParameters)
Retorna o status de todos os documentos em uma solicitação de tradução de documentos em lote.
Se o número de documentos na resposta exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis.
$top, $skip e $maxpagesize parâmetros de consulta podem ser usados para especificar um número de resultados a serem retornados e um deslocamento para a coleção.
$top indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas. $skip indica o número de registros a serem ignorados da lista de status do documento mantida pelo servidor com base no método de classificação especificado. Por padrão, classificamos por hora de início decrescente. $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), '@nextLink' conterá o link para a próxima página.
$orderBy parâmetro de consulta pode ser usado para classificar a lista retornada (ex "$orderBy=createdDateTimeUtc asc" ou "$orderBy=createdDateTimeUtc desc"). A classificação padrão é decrescente por createdDateTimeUtc. Alguns parâmetros de consulta podem ser usados para filtrar a lista retornada (por exemplo: "status=Succeeded,Cancelled") só retornará documentos bem-sucedidos e cancelados. createdDateTimeUtcStart e createdDateTimeUtcEnd podem ser usados combinados ou separadamente para especificar um intervalo de datetime pelo qual filtrar a lista retornada. Os parâmetros de consulta de filtragem suportados são (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
Quando $top e $skip são incluídos, o servidor deve primeiro aplicar $skip e, em seguida, $top na coleção. Nota: Se o servidor não puder honrar $top e/ou $skip, o servidor deve retornar um erro para o cliente informando sobre isso em vez de apenas ignorar as opções de consulta. Isso reduz o risco de o cliente fazer suposições sobre os dados retornados.
function get(options?: DocumentTranslationGetDocumentsStatusParameters): StreamableMethod<DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response>Parâmetros
Devoluções
StreamableMethod<DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response>
