Skip to content

site-post-documentprocessingjobs.md

Latest commit

 

History

History
134 lines (99 loc) · 4.93 KB

site-post-documentprocessingjobs.md

File metadata and controls

134 lines (99 loc) · 4.93 KB
title Create documentProcessingJob
description Create a new document processing job object.
author travislius
ms.localizationpriority medium
ms.subservice sharepoint
doc_type apiPageType
ms.date 08/06/2024

Create documentProcessingJob

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new documentProcessingJob object. The document processing job queues a document, or all documents in a folder, for processing by the applied content models.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /sites/{sitesId}/documentProcessingJobs

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the documentProcessingJob object.

You can specify the following properties when you create a documentProcessingJob.

Property Type Description
jobType documentProcessingJobType The document processing job type. The possible values are: File, Folder. Optional.
status documentProcessingJobStatus The document processing job status. The possible values are: inProgress, completed, failed, notStarted. Typically when a job is created, its initial status is notStarted. Optional.
createdDateTime DateTimeOffset Date and time of item creation. Read-only. Optional.
listItemUniqueId String The unique ID of the file or folder to process. To get the unique ID, use the GET driveItem method and read the sharepointIds property.

Response

If successful, this method returns a 201 Created response code and a documentProcessingJob object in the response body.

Examples

Request

The following example shows a request.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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