documentProcessingJob を作成する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい documentProcessingJob オブジェクトを 作成します。 ドキュメント処理ジョブは、適用されたコンテンツ モデルによる処理のために、ドキュメントまたはフォルダー内のすべてのドキュメントをキューに入れます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Site.Manage.All Site.Manage.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Site.Manage.All Site.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",
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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