Partager via


Créer un documentProcessingJob

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet documentProcessingJob . Le travail de traitement de document met en file d’attente un document, ou tous les documents d’un dossier, pour le traitement par les modèles de contenu appliqués.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Sites.Manage.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Sites.Manage.All Non disponible.

Requête HTTP

POST /sites/{sitesId}/documentProcessingJobs

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet documentProcessingJob .

Vous pouvez spécifier les propriétés suivantes lorsque vous créez un documentProcessingJob.

Propriété Type Description
jobType documentProcessingJobType Type de travail de traitement de document. Les valeurs possibles sont : File, Folder. Optional.
status documentProcessingJobStatus État du travail de traitement de document. Les valeurs possibles sont : inProgress, completed, failed, notStarted. En règle générale, lorsqu’un travail est créé, son état initial est notStarted. Optional.
createdDateTime DateTimeOffset Date et heure de création de l’élément. En lecture seule. Optional.
listItemUniqueId Chaîne ID unique du fichier ou du dossier à traiter. Pour obtenir l’ID unique, utilisez la méthode GET driveItem et lisez la propriété sharepointIds .

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet documentProcessingJob dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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