Создание documentProcessingJob

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Создайте новый объект documentProcessingJob . Задание обработки документов помещает в очередь документ или все документы в папке для обработки с помощью примененных моделей содержимого.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Sites.Manage.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	Sites.Manage.All	Недоступно.

HTTP-запрос

POST /sites/{sitesId}/documentProcessingJobs

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта documentProcessingJob в формате JSON.

При создании documentProcessingJob можно указать следующие свойства.

Свойство	Тип	Описание
jobType	DocumentProcessingJobType	Тип задания обработки документа. Возможные значения: File, Folder. Необязательный параметр.
status	documentProcessingJobStatus	Состояние задания обработки документа. Допустимые значения: inProgress, completed, failed, notStarted. Как правило, при создании задания его начальным состоянием является notStarted. Необязательный параметр.
createdDateTime	DateTimeOffset	Дата и время создания элемента. Только для чтения. Необязательный параметр.
listItemUniqueId	String	Уникальный идентификатор файла или папки для обработки. Чтобы получить уникальный идентификатор, используйте метод 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",
}