Miscellaneous - List Operations
Listas todas las operaciones.
GET {endpoint}/formrecognizer/operations?api-version=2022-08-31
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
Versión de API solicitada. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar. |
|
Other Status Codes |
Error encontrado. |
Seguridad
Ocp-Apim-Subscription-Key
Tipo:
apiKey
En:
header
Ejemplos
GetOperations
Solicitud de ejemplo
GET {endpoint}/formrecognizer/operations?api-version=2022-08-31
Respuesta de muestra
{
"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}"
}
Definiciones
Nombre | Description |
---|---|
Api |
Versión de la API. |
Error |
Información de error. |
Error |
Objeto de respuesta de error. |
Get |
Objeto de respuesta List Operations. |
Inner |
Error detallado. |
Operation |
Tipo de operación. |
Operation |
Estado de la operación. |
Operation |
Información de la operación. |
ApiVersion
Versión de la API.
Nombre | Tipo | Description |
---|---|---|
2022-08-31 |
string |
Error
Información de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
details |
Error[] |
Lista de errores detallados. |
innererror |
Error detallado. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Objeto de respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Información de error. |
GetOperationsResponse
Objeto de respuesta List Operations.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Vínculo a la página siguiente de operaciones. |
value |
Lista de operaciones. |
InnerError
Error detallado.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
innererror |
Error detallado. |
|
message |
string |
Mensaje de error. |
OperationKind
Tipo de operación.
Nombre | Tipo | Description |
---|---|---|
documentModelBuild |
string |
|
documentModelCompose |
string |
|
documentModelCopyTo |
string |
OperationStatus
Estado de la operación.
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
notStarted |
string |
|
running |
string |
|
succeeded |
string |
OperationSummary
Información de la operación.
Nombre | Tipo | Description |
---|---|---|
apiVersion |
string |
Versión de API usada para crear esta operación. |
createdDateTime |
string |
Fecha y hora (UTC) cuando se creó la operación. |
kind |
Tipo de operación. |
|
lastUpdatedDateTime |
string |
Fecha y hora (UTC) cuando se actualizó por última vez el estado. |
operationId |
string |
Id. de operación |
percentCompleted |
integer |
Progreso de la operación (0-100). |
resourceLocation |
string |
Dirección URL del recurso de destino de esta operación. |
status |
Estado de la operación. |
|
tags |
object |
Lista de atributos de etiqueta clave-valor asociados al modelo de documento. |