Miscellaneous - List Operations

Dienst:

Azure AI Services

API-Version:

2022-08-31

Listen alle Vorgänge.

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
api-version	query	True	ApiVersion	Angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

GetOperations

Beispielanforderung

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Beispiel für eine Antwort

Statuscode:

200

{
  "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}"
}

Definitionen

Name	Beschreibung
ApiVersion	API-Version.
Error	Fehlerinformationen.
ErrorResponse	Fehlerantwortobjekt.
GetOperationsResponse	List Operations-Antwortobjekt.
InnerError	Detaillierter Fehler.
OperationKind	Typ des Vorgangs.
OperationStatus	Vorgangsstatus
OperationSummary	Vorgangsinformationen.

ApiVersion

API-Version.

Name	Typ	Beschreibung
2022-08-31	string

Error

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	Error[]	Liste der detaillierten Fehler.
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

GetOperationsResponse

List Operations-Antwortobjekt.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite der Vorgänge.
value	OperationSummary[]	Liste der Vorgänge.

InnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.

OperationKind

Typ des Vorgangs.

Name	Typ	Beschreibung
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Vorgangsstatus

Name	Typ	Beschreibung
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

Vorgangsinformationen.

Name	Typ	Beschreibung
apiVersion	string	Api-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string	Datum und Uhrzeit (UTC), zu dem der Vorgang erstellt wurde.
kind	OperationKind	Typ des Vorgangs.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer	Vorgangsfortschritt (0-100).
resourceLocation	string	URL der Ressource, auf die dieser Vorgang abzielt.
status	OperationStatus	Vorgangsstatus
tags	object	Liste der Schlüssel-Wert-Tag-Attribute, die dem Dokumentmodell zugeordnet sind.