{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Document Translation API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Document Translation", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Returns A List Of Batch Requests Submitted And The Status For Each Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches", "params": [ { "name": "$top", "value": "", "type": "query", "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options." }, { "name": "$skip", "value": "", "type": "query", "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options." }, { "name": "$maxpagesize", "value": "", "type": "query", "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size." }, { "name": "ids", "value": "", "type": "query", "description": "Ids to use in filtering" }, { "name": "statuses", "value": "", "type": "query", "description": "Statuses to use in filtering" }, { "name": "createdDateTimeUtcStart", "value": "", "type": "query", "description": "the start datetime to get items after" }, { "name": "createdDateTimeUtcEnd", "value": "", "type": "query", "description": "the end datetime to get items before" }, { "name": "$orderBy", "value": "", "type": "query", "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')" } ] }, "docs": "Returns a list of batch requests submitted and the status for each request.
This list only contains batch requests submitted by the user (based on the resource).

If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
The absence of a continuation token means that no additional pages are available.

$top, $skip and $maxpagesize query p" }, { "info": { "name": "Microsoft Azure Submit A Document Translation Request To The Document Translation Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/batches" }, "docs": "Use this API to submit a bulk (batch) translation request to the Document Translation service.
Each request can contain multiple documents and must contain a source and destination container for each document.

The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.

Glossaries / Translation memory can be included in the request and are applied by the service when the document is " }, { "info": { "name": "Microsoft Azure Returns The Status For A Specific Document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches/:id/documents/:documentId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Format - uuid. The batch id" }, { "name": "documentId", "value": "", "type": "path", "description": "Format - uuid. The document id" } ] }, "docs": "Returns the translation status for a specific document based on the request Id and document Id." }, { "info": { "name": "Microsoft Azure Returns The Status For A Document Translation Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Format - uuid. The operation id" } ] }, "docs": "Returns the status for a document translation request.
The status includes the overall request status, as well as the status for documents that are being translated as part of that request." }, { "info": { "name": "Microsoft Azure Cancel A Currently Processing Or Queued Translation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/batches/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Format - uuid. The operation-id" } ] }, "docs": "Cancel a currently processing or queued translation.
A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
All documents that have completed translation will not be cancelled and will be charged.
All pending documents will be cancelled if possible." }, { "info": { "name": "Microsoft Azure Returns The Status For All Documents In A Batch Document Translation Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches/:id/documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Format - uuid. The operation id" }, { "name": "$top", "value": "", "type": "query", "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options." }, { "name": "$skip", "value": "", "type": "query", "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options." }, { "name": "$maxpagesize", "value": "", "type": "query", "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size." }, { "name": "ids", "value": "", "type": "query", "description": "Ids to use in filtering" }, { "name": "statuses", "value": "", "type": "query", "description": "Statuses to use in filtering" }, { "name": "createdDateTimeUtcStart", "value": "", "type": "query", "description": "the start datetime to get items after" }, { "name": "createdDateTimeUtcEnd", "value": "", "type": "query", "description": "the end datetime to get items before" }, { "name": "$orderBy", "value": "", "type": "query", "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')" } ] }, "docs": "Returns the status for all documents in a batch document translation request.

If the number of documents in the response exceeds our paging limit, server-side paging is used.
Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.

$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an " }, { "info": { "name": "Microsoft Azure Returns A List Of Supported Document Formats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/documents/formats" }, "docs": "The list of supported document formats supported by the Document Translation service.
The list includes the common file extension, as well as the content-type if using the upload API." }, { "info": { "name": "Microsoft Azure Returns The List Of Supported Glossary Formats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/glossaries/formats" }, "docs": "The list of supported glossary formats supported by the Document Translation service.
The list includes the common file extension used." }, { "info": { "name": "Microsoft Azure Returns A List Of Supported Storage Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/storagesources" }, "docs": "Returns a list of storage sources/options supported by the Document Translation service." } ] } ], "bundled": true }