Miscellaneous - List Operations
Lists all operations.
GET {endpoint}/formrecognizer/operations?api-version=2022-08-31
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
Requested API version. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Error encountered. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
GetOperations
Sample request
GET {endpoint}/formrecognizer/operations?api-version=2022-08-31
Sample response
{
"value": [
{
"operationId": "{operationId}",
"status": "running",
"percentCompleted": 0,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:12:58Z",
"kind": "documentModelBuild",
"resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
"apiVersion": "2022-08-31"
}
],
"nextLink": "{nextLinkUrl}"
}
Definitions
Name | Description |
---|---|
Api |
API version. |
Error |
Error info. |
Error |
Error response object. |
Get |
List Operations response object. |
Inner |
Detailed error. |
Operation |
Type of operation. |
Operation |
Operation status. |
Operation |
Operation info. |
ApiVersion
API version.
Name | Type | Description |
---|---|---|
2022-08-31 |
string |
Error
Error info.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
details |
Error[] |
List of detailed errors. |
innererror |
Detailed error. |
|
message |
string |
Error message. |
target |
string |
Target of the error. |
ErrorResponse
Error response object.
Name | Type | Description |
---|---|---|
error |
Error info. |
GetOperationsResponse
List Operations response object.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to the next page of operations. |
value |
List of operations. |
InnerError
Detailed error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
innererror |
Detailed error. |
|
message |
string |
Error message. |
OperationKind
Type of operation.
Name | Type | Description |
---|---|---|
documentModelBuild |
string |
|
documentModelCompose |
string |
|
documentModelCopyTo |
string |
OperationStatus
Operation status.
Name | Type | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
notStarted |
string |
|
running |
string |
|
succeeded |
string |
OperationSummary
Operation info.
Name | Type | Description |
---|---|---|
apiVersion |
string |
API version used to create this operation. |
createdDateTime |
string |
Date and time (UTC) when the operation was created. |
kind |
Type of operation. |
|
lastUpdatedDateTime |
string |
Date and time (UTC) when the status was last updated. |
operationId |
string |
Operation ID |
percentCompleted |
integer |
Operation progress (0-100). |
resourceLocation |
string |
URL of the resource targeted by this operation. |
status |
Operation status. |
|
tags |
object |
List of key-value tag attributes associated with the document model. |