Создание запроса классификации файла

Статья
04/08/2023

Создает запрос на классификацию одного или нескольких файлов с помощью примененной модели осмысления документации. (Дополнительные сведения см. в примере.)

Служба REST в SharePoint Online (а также локальной среде SharePoint 2016 или более поздней версии) поддерживает объединение нескольких запросов. Запросы объединяются в один вызов службы с помощью параметра запроса $batch OData. Этот метод можно использовать для одновременной постановки в очередь рабочих элементов классификации для сотен документов.

HTTP-запрос

POST /_api/machinelearning/workItems HTTP/1.1

Параметры URI

None;

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

Заголовок	Значение
Accept	application/json;odata=verbose
Content-Type	application/json;odata=verbose;charset=utf-8
x-requestdigest	Подходящий дайджест для текущего сайта

Тело запроса

Имя	Тип	Описание
_metadata	строка	Настройте метаданные объекта в SPO. Всегда используйте значение {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"}.
TargetSiteId	guid	ИД сайта, на котором расположен файл для классификации. Его можно пропустить, если для TargetSiteUrl указано значение.
TargetSiteUrl	строка	Полный URL-адрес сайта, на котором расположен файл для классификации. Его можно пропустить, если для TargeSiteId указано значение.
TargetWebId	guid	ИД веб-сайта, на котором расположен файл для классификации. Его можно пропустить, если для TargetWebServerRelativeUrl указано значение.
TargetWebServerRelativeUrl	строка	Относительный URL-адрес сервера веб-сайта, на котором расположен файл для классификации. Его можно пропустить, если для TargetWebId указано значение.
TargetUniqueId	guid	ИД папки для классификации. Его можно пропустить, если для TargetServerRelativeUrl указано значение.
TargetServerRelativeUrl	строка	Относительный URL-адрес сервера, где расположен файл для классификации. Его можно пропустить, если для TargetUniqueId указано значение.

Ответы

Имя	Тип	Описание
201 Создано		Ответ настроен. В случае сбоя по-прежнему может возвращаться ответ "201 Создано". Вызывающая сторона должна дополнительно проверить текст ответа, чтобы определить точный результат.

Примеры

Постановка в очередь запроса на классификацию файла с ИД "e6cff8b7-c90c-4564-b5b8-033449090932"

Пример запроса

{
    "__metadata": {
        "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"
    },
    "TargetSiteId": "f686e63b-aba7-48e5-97c7-68c4c1df292f",
    "TargetWebId": "66d6b64d-6f88-4dd9-b3db-47e6f00c53e8",
    "TargetUniqueId": "e6cff8b7-c90c-4564-b5b8-033449090932"
}

Пример отклика

Код состояния: 201

{
    "ErrorMessage":  null,
    "StatusCode":  201
}

{
    "ErrorMessage":  null,
    "StatusCode":  201
}

См. также

REST API модели осмысления документации Syntex

Поделиться через