GetDocumentsStatus interface
Методы
| get(Document |
Возвращает состояние всех документов в запросе на перевод документов пакетной службы. Если количество документов в ответе превышает ограничение разбиения на страницах, используется разбиение на стороне сервера. Ответы с разбивкой на страницы указывают на частичный результат и включают маркер продолжения в ответ. Отсутствие маркера продолжения означает, что дополнительные страницы недоступны. $top, $skip и параметры запроса $maxpagesize можно использовать для указания ряда результатов, возвращаемых и смещения для коллекции. $top указывает общее количество записей, которые пользователь хочет вернуть на всех страницах. $skip указывает количество записей для пропуска из списка состояния документа, удерживаемого сервером на основе указанного метода сортировки. По умолчанию мы сортируем по убыванию времени начала. $maxpagesize — это максимальное количество элементов, возвращаемых на странице. Если запрашиваются дополнительные элементы с помощью $top (или $top не заданы и есть дополнительные элементы, которые будут возвращены), "@nextLink" будет содержать ссылку на следующую страницу. параметр запроса $orderBy можно использовать для сортировки возвращаемого списка (например, "$orderBy=createdDateTimeUtc asc" или "$orderBy=createdDateTimeUtc desc"). Сортировка по умолчанию выполняется по убыванию, созданномуDateTimeUtc. Некоторые параметры запроса можно использовать для фильтрации возвращаемого списка (например, "status=Succeeded,Отменено") будет возвращать только успешные и отмененные документы. createdDateTimeUtcStart и createdDateTimeUtcEnd можно использовать в сочетании или отдельно, чтобы указать диапазон даты и времени для фильтрации возвращаемого списка по. Поддерживаемые параметры запроса фильтрации: (состояние, идентификаторы, созданныеDateTimeUtcStart, createdDateTimeUtcEnd). Если включены оба $top и $skip, сервер должен сначала применить $skip, а затем $top в коллекции. Примечание. Если сервер не может соблюдать $top и/или $skip, сервер должен вернуть клиенту сообщение об ошибке, информируя об этом, а не просто игнорируя параметры запроса. Это снижает риск того, что клиент делает предположения о возвращаемых данных. |
Сведения о методе
get(DocumentTranslationGetDocumentsStatusParameters)
Возвращает состояние всех документов в запросе на перевод документов пакетной службы.
Если количество документов в ответе превышает ограничение разбиения на страницах, используется разбиение на стороне сервера. Ответы с разбивкой на страницы указывают на частичный результат и включают маркер продолжения в ответ. Отсутствие маркера продолжения означает, что дополнительные страницы недоступны.
$top, $skip и параметры запроса $maxpagesize можно использовать для указания ряда результатов, возвращаемых и смещения для коллекции.
$top указывает общее количество записей, которые пользователь хочет вернуть на всех страницах. $skip указывает количество записей для пропуска из списка состояния документа, удерживаемого сервером на основе указанного метода сортировки. По умолчанию мы сортируем по убыванию времени начала. $maxpagesize — это максимальное количество элементов, возвращаемых на странице. Если запрашиваются дополнительные элементы с помощью $top (или $top не заданы и есть дополнительные элементы, которые будут возвращены), "@nextLink" будет содержать ссылку на следующую страницу.
параметр запроса $orderBy можно использовать для сортировки возвращаемого списка (например, "$orderBy=createdDateTimeUtc asc" или "$orderBy=createdDateTimeUtc desc"). Сортировка по умолчанию выполняется по убыванию, созданномуDateTimeUtc. Некоторые параметры запроса можно использовать для фильтрации возвращаемого списка (например, "status=Succeeded,Отменено") будет возвращать только успешные и отмененные документы. createdDateTimeUtcStart и createdDateTimeUtcEnd можно использовать в сочетании или отдельно, чтобы указать диапазон даты и времени для фильтрации возвращаемого списка по. Поддерживаемые параметры запроса фильтрации: (состояние, идентификаторы, созданныеDateTimeUtcStart, createdDateTimeUtcEnd).
Если включены оба $top и $skip, сервер должен сначала применить $skip, а затем $top в коллекции. Примечание. Если сервер не может соблюдать $top и/или $skip, сервер должен вернуть клиенту сообщение об ошибке, информируя об этом, а не просто игнорируя параметры запроса. Это снижает риск того, что клиент делает предположения о возвращаемых данных.
function get(options?: DocumentTranslationGetDocumentsStatusParameters): StreamableMethod<DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response>Параметры
Возвращаемое значение
StreamableMethod<DocumentTranslationGetDocumentsStatus200Response | DocumentTranslationGetDocumentsStatus400Response | DocumentTranslationGetDocumentsStatus401Response | DocumentTranslationGetDocumentsStatus404Response | DocumentTranslationGetDocumentsStatus429Response | DocumentTranslationGetDocumentsStatus500Response | DocumentTranslationGetDocumentsStatus503Response>
