DocumentProcessingJob erstellen

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues documentProcessingJob-Objekt . Der Dokumentverarbeitungsauftrag stellt ein Dokument oder alle Dokumente in einem Ordner für die Verarbeitung durch die angewendeten Inhaltsmodelle in die Warteschlange.

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigung mit den geringsten Rechten	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Site.Manage.All	Site.Manage.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	Site.Manage.All	Site.Manage.All

HTTP-Anforderung

POST /sites/{sitesId}/documentProcessingJobs

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des documentProcessingJob-Objekts an.

Sie können die folgenden Eigenschaften angeben, wenn Sie einen documentProcessingJob erstellen.

Eigenschaft	Typ	Beschreibung
jobType	documentProcessingJobType	Der Auftragstyp der Dokumentverarbeitung. Die möglichen Werte sind: File, Folder. Optional.
status	documentProcessingJobStatus	Der Status des Dokumentverarbeitungsauftrags. Mögliche Werte sind: inProgress, completed, failed, notStarted. Wenn ein Auftrag erstellt wird, lautet notStartedder anfangse Status in der Regel . Optional.
createdDateTime	DateTimeOffset	Datum und Uhrzeit der Elementerstellung. Schreibgeschützt. Optional.
listItemUniqueId	String	Die eindeutige ID der zu verarbeitenden Datei oder des Zu verarbeitenden Ordners. Verwenden Sie zum Abrufen der eindeutigen ID die GET driveItem-Methode , und lesen Sie die sharepointIds-Eigenschaft .

Antwort

Wenn die Methode erfolgreich verläuft, werden der 201 Created Antwortcode und ein documentProcessingJob-Objekt im Antworttext zurückgegeben.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/documentProcessingJobs
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.documentProcessingJob",
  "jobType": "File",
  "listItemUniqueId": "5955b119-99c1-4af9-97ed-3449e02de6f1",
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "11f99394-e5eb-45e9-b478-7c83eaeda224",
  "jobType": "File",
  "status": "notStarted",
  "createdDateTime": "2023-06-23T22:03:47",
  "listItemUniqueId": "5955b119-99c1-4af9-97ed-3449e02de6f1",
}