DocumentProcessingJob erstellen

Artikel
08/01/2024

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.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	❌	❌	❌

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	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Sites.Manage.All	Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	Sites.Manage.All	Nicht verfügbar.

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 `notStarted`der anfangse Status in der Regel . Optional.
createdDateTime	DateTimeOffset	Datum und Uhrzeit der Elementerstellung. Schreibgeschützt. Optional.
listItemUniqueId	Zeichenfolge	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",
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new DocumentProcessingJob
{
	OdataType = "#microsoft.graph.documentProcessingJob",
	JobType = DocumentProcessingJobType.File,
	ListItemUniqueId = "5955b119-99c1-4af9-97ed-3449e02de6f1",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites["{site-id}"].DocumentProcessingJobs.PostAsync(requestBody);

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta sites document-processing-jobs create --site-id {site-id} --body '{\
  "@odata.type": "#microsoft.graph.documentProcessingJob",\
  "jobType": "File",\
  "listItemUniqueId": "5955b119-99c1-4af9-97ed-3449e02de6f1",\
}\
'

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewDocumentProcessingJob()
jobType := graphmodels.FILE_DOCUMENTPROCESSINGJOBTYPE 
requestBody.SetJobType(&jobType) 
listItemUniqueId := "5955b119-99c1-4af9-97ed-3449e02de6f1"
requestBody.SetListItemUniqueId(&listItemUniqueId) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
documentProcessingJobs, err := graphClient.Sites().BySiteId("site-id").DocumentProcessingJobs().Post(context.Background(), requestBody, nil)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DocumentProcessingJob documentProcessingJob = new DocumentProcessingJob();
documentProcessingJob.setOdataType("#microsoft.graph.documentProcessingJob");
documentProcessingJob.setJobType(DocumentProcessingJobType.File);
documentProcessingJob.setListItemUniqueId("5955b119-99c1-4af9-97ed-3449e02de6f1");
DocumentProcessingJob result = graphClient.sites().bySiteId("{site-id}").documentProcessingJobs().post(documentProcessingJob);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

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

await client.api('/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/documentProcessingJobs')
	.version('beta')
	.post(documentProcessingJob);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\DocumentProcessingJob;
use Microsoft\Graph\Beta\Generated\Models\DocumentProcessingJobType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new DocumentProcessingJob();
$requestBody->setOdataType('#microsoft.graph.documentProcessingJob');
$requestBody->setJobType(new DocumentProcessingJobType('file'));
$requestBody->setListItemUniqueId('5955b119-99c1-4af9-97ed-3449e02de6f1');

$result = $graphServiceClient->sites()->bySiteId('site-id')->documentProcessingJobs()->post($requestBody)->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.document_processing_job import DocumentProcessingJob
from msgraph_beta.generated.models.document_processing_job_type import DocumentProcessingJobType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DocumentProcessingJob(
	odata_type = "#microsoft.graph.documentProcessingJob",
	job_type = DocumentProcessingJobType.File,
	list_item_unique_id = "5955b119-99c1-4af9-97ed-3449e02de6f1",
)

result = await graph_client.sites.by_site_id('site-id').document_processing_jobs.post(request_body)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

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

Freigeben über

DocumentProcessingJob erstellen

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Antwort

Beispiele

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen