命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 documentProcessingJob 对象。 文档处理作业将文档或文件夹中的所有文档排队,以便由应用的内容模型进行处理。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
Sites.Manage.All |
不可用。 |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
Sites.Manage.All |
不可用。 |
HTTP 请求
POST /sites/{sitesId}/documentProcessingJobs
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供 documentProcessingJob 对象的 JSON 表示形式。
创建 documentProcessingJob 时,可以指定以下属性。
| 属性 |
类型 |
说明 |
| jobType |
documentProcessingJobType |
文档处理作业类型。 可能的值为: File、 Folder。 可选。 |
| status |
documentProcessingJobStatus |
文档处理作业状态。 可能的值包括 inProgress、completed、failed、notStarted。 通常,创建作业时,其初始状态为 notStarted。 可选。 |
| createdDateTime |
DateTimeOffset |
创建项的日期和时间。 只读。 可选。 |
| listItemUniqueId |
String |
要处理的文件或文件夹的唯一 ID。 若要获取唯一 ID,请使用 GET driveItem 方法并读取 sharepointIds 属性。 |
响应
如果成功,此方法在响应正文中返回响应 201 Created 代码和 documentProcessingJob 对象。
示例
请求
以下示例显示了一个请求。
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);
// 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)
// 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);
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);
<?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();
# 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)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
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",
}