Miscellaneous - List Operations
Lists all operations.
GET {endpoint}/formrecognizer/operations?api-version=2023-07-31
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
string |
Requested API version. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
The secret key for your Azure Cognitive Services subscription. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Error encountered. |
Security
Ocp-Apim-Subscription-Key
The secret key for your Azure Cognitive Services subscription.
Type:
apiKey
In:
header
Examples
Get Operations
Sample request
GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31
Sample response
{
"value": [
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "running",
"percentCompleted": 0,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:12:58Z",
"kind": "documentModelBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
"apiVersion": "2023-07-31"
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData"
}
Definitions
Name | Description |
---|---|
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. |
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 |
---|---|---|
documentClassifierBuild |
string |
Build a new custom classifier model. |
documentModelBuild |
string |
Build a new custom document model. |
documentModelCompose |
string |
Compose a new custom document model from existing models. |
documentModelCopyTo |
string |
Copy an existing document model to potentially a different resource, region, or subscription. |
OperationStatus
Operation status.
Name | Type | Description |
---|---|---|
canceled |
string |
The operation has been canceled. |
failed |
string |
The operation has failed. |
notStarted |
string |
The operation has not started yet. |
running |
string |
The operation is in progress. |
succeeded |
string |
The operation has succeeded. |
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. |