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


Действия Plumsail

Действия Plumsail предоставляют расширенные действия для управления SharePoint, включая расширенные операции между сайтами. Он охватывает все возможные разрешения, позволяет управлять документами, элементами списка и папками, создавать сайты SharePoint, списки или библиотеки и управлять их свойствами. Дополнительные сведения см. в https://plumsail.com/actions/этой записи.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Стандарт Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Support
URL https://plumsail.com
Адрес электронной почты support@plumsail.com
Метаданные соединителя
Publisher Пламсайл
Веб-сайт https://plumsail.com
Политика конфиденциальности https://plumsail.com/privacy-policy/
Категории Продуктивность; Содержимое и файлы

Соединитель SharePoint на стероидах стандартный соединитель SharePoint для Power Automate и Logic Apps предоставляет базовые средства для управления SharePoint. К сожалению, он не охватывает много реальных сценариев, включая некоторые из межсайтовых операций. Вот где наш соединитель дает вам гораздо больше энергии.

Регистрация учетной записи

Прежде всего, необходимо зарегистрировать учетную запись Plumsail. Эта учетная запись используется для управления продуктами Plumsail Actions и Plumsail Forms.

Лучше использовать активный адрес электронной почты. Подписка будет связана с этим адресом.

Если у вас уже есть учетная запись, просто войдите в account.plumsail.com.

Создание ключа API

Перейдите к разделу "Ключи API" и нажмите кнопку "Добавить новую". Затем выберите тип ключа API в соответствии с вашими потребностями.

Ключи API

SharePoint — разрешения администратора

Действия Plumsail будут подключаться к SharePoint с помощью разрешений администратора клиента. Заполните указанный ниже адрес SharePoint Online и предоставьте их, выполнив вход с помощью пользователя администратора клиента SharePoint.

Ключ разрешений администратора Plumsail SharePoint

Обратите внимание, что этот тип ключа API не расделяется на уровне разрешений пользователей и включена многофакторная проверка подлинности для них, его нельзя использовать с действием создания современного сайта SharePoint .

SharePoint — пользовательские учетные данные

Этот тип ключа позволяет действиям SharePoint работать под учетной записью конкретного пользователя. Вам нужно заполнить имя учетной записи и пароль для пользователя:

Ключ учетных данных Plumsail Custom SharePoint

Примечание. Чтобы использовать этот тип ключа API, необходимо отключить многофакторную проверку подлинности (MFA) для пользователя, под учетной записью которой создается ключ. Действия, использующие ключ, будут иметь тот же уровень разрешений, что и пользователь.

Базовый

Он позволяет выполнять действия Plumsail, которые не требуют доступа к SharePoint. Используйте его с синтаксический анализ CSV, сопоставление регулярных выражений и другие аналогичные действия.

Базовый ключ API Plumsail

Копирование и использование ключа API

После создания ключа API вы увидите ключ прямо в столбце "Секрет". Вы также можете изменить имя ключа, щелкнув его в столбце "Имя":

Ключи API

Теперь вы можете скопировать и использовать его в:

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Доступный для общего пользования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Ключ API securestring Создание ключа API в account.plumsail.com True
Расположение центра обработки данных струна

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Активация компонента SharePoint

Активация функции с определенным идентификатором

Анализ CSV

Он работает так же, как Анализ JSON, но для CSV-файла

Деактивация компонента SharePoint

Отключение функции с определенным идентификатором

Добавление пользователя в группу SharePoint

Добавляет пользователя в определенную группу SharePoint

Добавление типа контента в список SharePoint

Добавляет указанный тип контента в список SharePoint

Добавление узла навигации сайта SharePoint

Добавляет пункт меню в быструю или верхнюю навигацию

Замена регулярных выражений

В указанной входной строке заменяются все строки, соответствующие шаблону регулярного выражения с указанной строкой замены. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Запуск рабочего процесса сайта SharePoint (2013)

Запускает рабочий процесс уровня сайта SharePoint и передает входные параметры, если они были указаны. Действие может выполнять только рабочие процессы 2013

Запуск рабочего процесса списка SharePoint (2013)

Запускает рабочий процесс уровня списка SharePoint и передает входные параметры, если они были указаны. Действие может выполнять только рабочие процессы 2013

Изменение разрешений SharePoint

Предоставление, удаление и восстановление разрешений для сайта, списка и элемента

Копирование вложений элементов SharePoint в URL-адрес

Копирует вложения из элемента списка SharePoint в библиотеку с помощью указанного URL-адреса папки.

Копирование документа SharePoint из библиотеки

Копирует документ из библиотеки документов в указанный URL-адрес. Вы можете скопировать документ в другую библиотеку документов между сайтами или в другую папку.

Копирование набора документов SharePoint

Копирует набор документов из библиотеки документов в указанный URL-адрес. Наборы документов можно скопировать в другую библиотеку документов между сайтами или в другую папку.

Копирование папки SharePoint из библиотеки

Копирует папку из библиотеки документов в указанный URL-адрес. Вы можете скопировать папку в другую библиотеку документов между сайтами или в другую папку.

Копирование элемента списка в список SharePoint

Копирует указанный элемент списка в другой список SharePoint

Обновление свойств группы SharePoint

Обновляет свойства группы SharePoint, такие как AutoAcceptRequestToJoinLeave, AllowMembersEditMembership или другие параметры, описанные в MSDN

Обновление свойств сайта SharePoint

Обновляет веб-свойства, такие как Title, Description или другие строковые параметры, описанные в MSDN

Обновление элемента SharePoint

Обновление элемента в списке или библиотеке SharePoint

Объявление документа SharePoint в качестве записи

Объявляет документ в библиотеке SharePoint как запись

Ознакомьтесь с документом SharePoint

Извлечение документа по указанному URL-адресу

Отмена удаления документа SharePoint в качестве записи

Необъявленный документ в библиотеке SharePoint как запись

Перемещение вложений элементов SharePoint в URL-адрес

Перемещение вложений из элемента списка SharePoint в библиотеку с помощью указанного URL-адреса папки

Перемещение документа SharePoint из библиотеки

Перемещает документ из библиотеки документов в указанный URL-адрес. Вы можете скопировать документ в другую библиотеку документов между сайтами или в другую папку.

Перемещение набора документов SharePoint

Перемещает набор документов из библиотеки документов в указанный URL-адрес. Наборы документов можно скопировать в другую библиотеку документов между сайтами или в другую папку.

Перемещение папки SharePoint из библиотеки

Перемещает папку из библиотеки документов в указанный URL-адрес. Вы можете переместить папку в другую библиотеку документов между сайтами или в другую папку.

Перемещение элемента списка в список SharePoint

Перемещение указанного элемента списка в другой список SharePoint

Подготовка шаблона PnP в SharePoint

Применение шаблона PnP к сайту SharePoint

Подготовка шаблона клиента PnP в SharePoint

Применение шаблона клиента PnP к SharePoint

Получение журнала версий элементов SharePoint

Возвращает журнал изменений для определенного поля из элемента списка SharePoint

Получение значения параметра сайта SharePoint

Считывает значение из параметров сайта SharePoint (контейнер свойств)

Получение членов группы SharePoint

Возвращает члены определенной группы SharePoint

Получение элементов SharePoint по запросу CAML

Выполняет запрос CAML в списке или библиотеке документов и возвращает коллекцию элементов.

Приглашение внешнего пользователя в SharePoint

Приглашает внешних пользователей с определенным разрешением на сайт SharePoint, определенную группу SharePoint или элемент в списке SharePoint

Применение дизайна сайта SharePoint

Применяет дизайн к целевому сайту SharePoint

Проверка документа SharePoint

Регистрация документа по указанному URL-адресу с указанным комментарием

Проверка регулярных выражений

Указывает, находит ли регулярное выражение, указанное в конструкторе Regex, совпадение в указанной входной строке. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Проверьте, существует ли группа SharePoint

Проверяет, существует ли определенная группа SharePoint

Совпадение регулярных выражений

Выполняет поиск входной строки для всех вхождения регулярного выражения и возвращает все совпадения. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Создание группы SharePoint

Создает группу SharePoint с указанным именем

Создание дочернего сайта SharePoint из шаблона

Создание сайта SharePoint на основе определенного шаблона

Создание набора документов SharePoint

Создает новый набор документов в библиотеке документов по указанному URL-адресу.

Создание папки SharePoint в списке

Создает новую папку в библиотеке документов или списке с помощью указанного пути

Создание папки SharePoint по URL-адресу

Создает новую папку в библиотеке документов по указанному URL-адресу

Создание современного сайта SharePoint

Создание современного сайта группы SharePoint или коммуникации

Создание списка или библиотеки SharePoint

Создание списка или библиотеки по шаблону

Удаление группы SharePoint

Удаляет группу SharePoint по указанному имени

Удаление документа SharePoint по URL-адресу

Удаление документа по определенному URL-адресу

Удаление папки SharePoint по URL-адресу

Удаляет папку из библиотеки документов или списка по указанному URL-адресу.

Удаление пользователя из группы SharePoint

Удаляет пользователя из определенной группы SharePoint

Удаление сайта SharePoint

Удаляет сайт SharePoint по определенному URL-адресу

Удаление узла навигации сайта SharePoint

Удаляет пункт меню из быстрого запуска или верхней навигации

Установка группы сайтов SharePoint по умолчанию

Настройте группы по умолчанию для сайта с помощью Microsoft Flow. Это альтернатива <странице URL-адреса> сайта/_layouts/15/permsetup.aspx в пользовательском интерфейсе SharePoint.

Участник группы SharePoint

Проверяет, является ли пользователь членом определенной группы SharePoint

Активация компонента SharePoint

Активация функции с определенным идентификатором

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Идентификатор функции
featureId True uuid

Guid функции

Сила
force boolean

значение true для принудительного действия компонента, даже если возникают ошибки; в противном случае значение false

Анализ CSV

Он работает так же, как Анализ JSON, но для CSV-файла

Параметры

Имя Ключ Обязательно Тип Описание
Содержимое CSV-документа
content True byte

Содержимое CSV-документа

Разделитель
delimiter string

Разделитель столбцов (по умолчанию это просто запятая)

Региональные настройки
locale string

Языковой стандарт, который будет применен к документу

Лимит
limit integer

Возвращает первые строки n

Headers
headers True string

Разделенный запятыми список заголовков в том же порядке, что и столбцы CSV

Пропустить первую строку
skipFirstLine boolean

Выберите "Да", если в CSV-файле есть заголовки в качестве первой строки.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Деактивация компонента SharePoint

Отключение функции с определенным идентификатором

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Идентификатор функции
featureId True uuid

Guid функции

Сила
force boolean

значение true для принудительного действия компонента, даже если возникают ошибки; в противном случае значение false

Добавление пользователя в группу SharePoint

Добавляет пользователя в определенную группу SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

User
userLogin True string

Вход или электронная почта пользователя, который будет добавлен в определенную группу. Кроме того, можно указать несколько элементов с запятой ";" с разделителями

Отправить сообщение электронной почты
sendEmail boolean

Отключение уведомления по электронной почте

Добавление типа контента в список SharePoint

Добавляет указанный тип контента в список SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Имя типа контента
contentTypeName True string

Имя типа контента

Сделать его по умолчанию
makeItDefault boolean

Создание типа контента по умолчанию для списка

Добавление узла навигации сайта SharePoint

Добавляет пункт меню в быструю или верхнюю навигацию

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Местоположение
location True string

Расположение добавляемого узла

Название
title True string

Название узла навигации

Parent
parent string

Это название родительского элемента навигации. Если есть несколько элементов верхнего уровня с одинаковым заголовком, мы выберем только первый.

URL-адрес
url string

Целевой URL-адрес. Если URL-адрес пуст, будет создан элемент навигации верхнего уровня.

Prepend
prepend boolean

Да или нет. Значение по умолчанию — No

Замена регулярных выражений

В указанной входной строке заменяются все строки, соответствующие шаблону регулярного выражения с указанной строкой замены. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Параметры

Имя Ключ Обязательно Тип Описание
Рисунок
pattern True string

Шаблон регулярного выражения

Текст
text True string

Строка для поиска совпадений

Replacement
replacement string

Строка замены

Возвращаемое значение

Запуск рабочего процесса сайта SharePoint (2013)

Запускает рабочий процесс уровня сайта SharePoint и передает входные параметры, если они были указаны. Действие может выполнять только рабочие процессы 2013

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя рабочего процесса
workflowName True string

Имя рабочего процесса, который будет запущен

Входные параметры
inputParameters object

Строка JSON, содержащая входные параметры для рабочего процесса

Возвращаемое значение

Запуск рабочего процесса списка SharePoint (2013)

Запускает рабочий процесс уровня списка SharePoint и передает входные параметры, если они были указаны. Действие может выполнять только рабочие процессы 2013

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя рабочего процесса
workflowName True string

Имя рабочего процесса, который будет запущен

Входные параметры
inputParameters object

Строка JSON, содержащая входные параметры для рабочего процесса

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True integer

Идентификатор элемента, для которого нужно запустить рабочий процесс списка

Возвращаемое значение

Изменение разрешений SharePoint

Предоставление, удаление и восстановление разрешений для сайта, списка и элемента

Параметры

Имя Ключ Обязательно Тип Описание
Тип действия
actionType True string

Тип операции

Цель
target True string

Цель операции

request
request True dynamic

Копирование вложений элементов SharePoint в URL-адрес

Копирует вложения из элемента списка SharePoint в библиотеку с помощью указанного URL-адреса папки.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True integer

Идентификатор исходного элемента

URL-адрес целевой папки
destinationUrl True string

URL-адрес папки, в которой будут скопированы вложения.

Перезаписать
overwrite boolean

Перезапись, если файл с тем же именем уже существует

Возвращаемое значение

Копирование документа SharePoint из библиотеки

Копирует документ из библиотеки документов в указанный URL-адрес. Вы можете скопировать документ в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес скопированного документа. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет скопирован исходный документ. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Возвращаемое значение

Копирование набора документов SharePoint

Копирует набор документов из библиотеки документов в указанный URL-адрес. Наборы документов можно скопировать в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес набора документов, который необходимо скопировать. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет скопирован исходный набор документов. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена. Если URL-адрес заканчивается косой чертой "/", наборы документов будут помещены в эту папку без изменений имени. В противном случае набор документов будет переименован

Возвращаемое значение

Копирование папки SharePoint из библиотеки

Копирует папку из библиотеки документов в указанный URL-адрес. Вы можете скопировать папку в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес папки, скопированной. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет скопирована исходная папка. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Возвращаемое значение

Копирование элемента списка в список SharePoint

Копирует указанный элемент списка в другой список SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True string

Идентификатор исходного элемента

URL-адрес списка назначения
destinationListUrl True string

URL-адрес целевого списка. Этот список должен содержать те же поля, что и в исходном списке.

Копирование вложений
copyAttachments boolean

Копирование элемента с вложенными файлами или нет

Возвращаемое значение

Обновление свойств группы SharePoint

Обновляет свойства группы SharePoint, такие как AutoAcceptRequestToJoinLeave, AllowMembersEditMembership или другие параметры, описанные в MSDN

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

Название
title string

Заголовок группы

Description
description string

Описание группы

Владелец
owner string

Владелец группы, которая может быть пользователем или другой группой.

Разрешить членам изменять членство
allowMembersEditMembership boolean

Значение, указывающее, могут ли члены группы изменять членство в группе.

Разрешить запрос на присоединение к выходу
allowRequestToJoinLeave boolean

Значение, указывающее, разрешать ли пользователям запрашивать членство в группе и разрешать пользователям запрашивать выход из группы.

Автоматическое принятие запроса на присоединение к выходу
autoAcceptRequestToJoinLeave boolean

Значение, указывающее, добавляются ли пользователи автоматически или удаляются при выполнении запроса.

Разрешить только членства в представлении членов
onlyAllowMembersViewMembership boolean

Значение, указывающее, разрешены ли только члены группы просматривать список участников в группе.

Запрос на присоединение к параметру электронной почты
requestToJoinLeaveEmailSetting string

Адрес электронной почты, на который отправляются запросы на членство

Обновление свойств сайта SharePoint

Обновляет веб-свойства, такие как Title, Description или другие строковые параметры, описанные в MSDN

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Название
title string

Название веб-сайта

Description
description string

Описание сайта

Быстрый запуск включен
quickLaunchEnabled boolean

Значение, указывающее, включена ли область быстрого запуска на веб-сайте.

Представление дерева включено
treeViewEnabled boolean

Значение, указывающее, включена ли Функция TreeView SharePoint Foundation в области навигации слева страниц веб-сайта.

URL-адрес логотипа сайта
siteLogoUrl string

Абсолютный URL-адрес логотипа веб-сайта

Альтернативный URL-адрес CSS
alternateCssUrl string

URL-адрес альтернативной каскадной таблицы стилей (CSS) для использования на веб-сайте

Связанная группа участников
associatedMemberGroup string

Пользователи, которым предоставлено разрешение на участие на веб-сайте

Связанная группа владельцев
associatedOwnerGroup string

Связанные группы владельцев веб-сайта

Связанная группа посетителей
associatedVisitorGroup string

Связанная группа посетителей веб-сайта

Содержит конфиденциальные сведения
containsConfidentialInfo boolean

Значение, указывающее, содержит ли сайт SharePoint конфиденциальную информацию.

Пользовательский главный URL-адрес
customMasterUrl string

URL-адрес настраиваемого главного файла страницы для применения к веб-сайту

Включение минимальной загрузки
enableMinimalDownload boolean

Значение, указывающее, должен ли веб-сайт использовать минимальную стратегию загрузки

Многоязычный
isMultilingual boolean

Значение, указывающее, включен ли многоязычный пользовательский интерфейс для веб-сайта.

Главный URL-адрес
masterUrl string

URL-адрес главной страницы, используемой для веб-сайта

Участники могут предоставить общий доступ
membersCanShare boolean

Разрешить участникам предоставлять общий доступ к сайту и приглашать других пользователей

Обход без обхода
noCrawl boolean

Значение, указывающее, включен ли поиск для веб-сайта.

Перезапись переводов при изменении
overwriteTranslationsOnChange boolean

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

Запрос электронной почты для доступа
requestAccessEmail string

Адрес электронной почты, на который отправляются запросы на доступ

Сохранение сайта в качестве шаблона включено
saveSiteAsTemplateEnabled boolean

Значение, указывающее, можно ли сохранить веб-сайт в качестве шаблона сайта.

Относительный URL-адрес сервера
serverRelativeUrl string

URL-адрес относительно сервера для веб-сайта

Включена синдикация
syndicationEnabled boolean

Значение, указывающее, включена ли функция "Действительно простая синдикация" (RSS) на веб-сайте.

Версия пользовательского интерфейса
uiVersion integer

Текущий номер версии пользовательского интерфейса

Обновление элемента SharePoint

Обновление элемента в списке или библиотеке SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя списка
listName True string

Название списка или библиотеки

Идентификатор элемента или URL-адрес
itemId True string

Идентификатор элемента или URL-адрес документа или папки

Значения полей
data True object

Объект JSON, например { "InternalFieldName": "FieldValue" }

Объявление документа SharePoint в качестве записи

Объявляет документ в библиотеке SharePoint как запись

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя списка
listName True string

Название списка или библиотеки

Идентификатор элемента или URL-адрес
itemId True string

Идентификатор элемента или URL-адрес документа

Ознакомьтесь с документом SharePoint

Извлечение документа по указанному URL-адресу

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес документа
documentUrl True string

URL-адрес документа для регистрации

Возвращаемое значение

Отмена удаления документа SharePoint в качестве записи

Необъявленный документ в библиотеке SharePoint как запись

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя списка
listName True string

Название списка или библиотеки

Идентификатор элемента или URL-адрес
itemId True string

Идентификатор элемента или URL-адрес документа

Перемещение вложений элементов SharePoint в URL-адрес

Перемещение вложений из элемента списка SharePoint в библиотеку с помощью указанного URL-адреса папки

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True integer

Идентификатор исходного элемента

URL-адрес целевой папки
destinationUrl True string

URL-адрес папки, в которой будут перемещаться вложения.

Перезаписать
overwrite boolean

Перезапись, если файл с тем же именем уже существует

Возвращаемое значение

Перемещение документа SharePoint из библиотеки

Перемещает документ из библиотеки документов в указанный URL-адрес. Вы можете скопировать документ в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес перемещаемого документа. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет перемещен исходный документ. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Возвращаемое значение

Перемещение набора документов SharePoint

Перемещает набор документов из библиотеки документов в указанный URL-адрес. Наборы документов можно скопировать в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес перемещаемого набора документов. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет перемещен исходный набор документов. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена. Если URL-адрес заканчивается косой чертой "/", наборы документов будут помещены в эту папку без изменений имени. В противном случае набор документов будет переименован

Возвращаемое значение

Перемещение папки SharePoint из библиотеки

Перемещает папку из библиотеки документов в указанный URL-адрес. Вы можете переместить папку в другую библиотеку документов между сайтами или в другую папку.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес источника
sourceUrl True string

URL-адрес перемещаемой папки. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

URL-адрес назначения
destinationUrl True string

URL-адрес, в котором будет перемещена исходная папка. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Возвращаемое значение

Перемещение элемента списка в список SharePoint

Перемещение указанного элемента списка в другой список SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True string

Идентификатор исходного элемента

URL-адрес списка назначения
destinationListUrl True string

URL-адрес целевого списка. Этот список должен содержать те же поля, что и в исходном списке.

Перемещение вложений
copyAttachments boolean

Перемещение элемента с вложенными файлами или нет

Возвращаемое значение

Подготовка шаблона PnP в SharePoint

Применение шаблона PnP к сайту SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Содержимое шаблона
xmlTemplateContent True byte

Содержимое шаблона XML или PnP

Перезапись значений System PropertyBag
overwriteSystemPropertyBagValues boolean

Укажите этот параметр, если вы хотите перезаписать или создать свойства, которые известны как системные записи (начиная с vti_, dlc_ и т. д.)

Игнорировать ошибки повторяющихся строк данных
ignoreDuplicateDataRowErrors boolean

Игнорируйте ошибки повторяющихся строк данных, если строка данных в шаблоне уже существует.

Очистка навигации
clearNavigation boolean

Если указать это значение, узлы навигации всегда будут удалены перед добавлением узлов в шаблон

Подготовка типов контента для вложенных веб-объектов
provisionContentTypesToSubWebs boolean

Если задать типы контента, будет подготовлено, если целевой веб-сайт является подсетью.

Подготовка полей в вложенных веб-приложениях
provisionFieldsToSubWebs boolean

Если поля набора будут подготовлены, если целевой веб-сайт является подсетью.

Обработчики
handlers string

Позволяет обрабатывать только определенную часть шаблона. Обратите внимание, что это может завершиться ошибкой, так как для некоторых обработчиков требуются другие артефакты, если они не являются частью вашего применения. Посетите https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers возможные значения.

Исключение обработчиков
excludeHandlers string

Позволяет запускать все обработчики, за исключением указанных.

Параметры
parameters string

Позволяет указать параметры, к которым можно ссылаться в шаблоне с помощью маркера <Key>=<Value>;

Подготовка шаблона клиента PnP в SharePoint

Применение шаблона клиента PnP к SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Содержимое шаблона
xmlTemplateContent True byte

Содержимое шаблона XML или PnP

Перезапись значений System PropertyBag
overwriteSystemPropertyBagValues boolean

Укажите этот параметр, если вы хотите перезаписать или создать свойства, которые известны как системные записи (начиная с vti_, dlc_ и т. д.)

Игнорировать ошибки повторяющихся строк данных
ignoreDuplicateDataRowErrors boolean

Игнорируйте ошибки повторяющихся строк данных, если строка данных в шаблоне уже существует.

Очистка навигации
clearNavigation boolean

Если указать это значение, узлы навигации всегда будут удалены перед добавлением узлов в шаблон

Подготовка типов контента для вложенных веб-объектов
provisionContentTypesToSubWebs boolean

Если задать типы контента, будет подготовлено, если целевой веб-сайт является подсетью.

Подготовка полей в вложенных веб-приложениях
provisionFieldsToSubWebs boolean

Если поля набора будут подготовлены, если целевой веб-сайт является подсетью.

Обработчики
handlers string

Позволяет обрабатывать только определенную часть шаблона. Обратите внимание, что это может завершиться ошибкой, так как для некоторых обработчиков требуются другие артефакты, если они не являются частью вашего применения. Посетите https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers возможные значения.

Исключение обработчиков
excludeHandlers string

Позволяет запускать все обработчики, за исключением указанных.

Параметры
parameters string

Позволяет указать параметры, к которым можно ссылаться в шаблоне с помощью маркера <Key>=<Value>;

Получение журнала версий элементов SharePoint

Возвращает журнал изменений для определенного поля из элемента списка SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

Идентификатор элемента
itemId True integer

Идентификатор элемента, для которого требуется получить журнал версий

Имя поля
fieldName True string

Имя поля, для которого требуется получить журнал версий

Возвращаемое значение

Получение значения параметра сайта SharePoint

Считывает значение из параметров сайта SharePoint (контейнер свойств)

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя параметра
optionName True string

Имя параметра

Возвращаемое значение

Получение членов группы SharePoint

Возвращает члены определенной группы SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

Возвращаемое значение

Получение элементов SharePoint по запросу CAML

Выполняет запрос CAML в списке или библиотеке документов и возвращает коллекцию элементов.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес списка
listUrl True string

Имя списка, URL-адрес или guid

URL-адрес папки
folderUrl string

Относительный URL-адрес сервера папки списка, из которой будут возвращены результаты.

ЗАПРОС CAML
camlQuery True string

Запрос CAML, который будет выполняться

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Приглашение внешнего пользователя в SharePoint

Приглашает внешних пользователей с определенным разрешением на сайт SharePoint, определенную группу SharePoint или элемент в списке SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
Цель
target True string

Цель операции

request
request True dynamic

Применение дизайна сайта SharePoint

Применяет дизайн к целевому сайту SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
url True string

Полный URL-адрес (например, https://yourtenant.sharepoint.com/sites/team-site)

Проектирование сайта
siteDesign True string

Имя или идентификатор макета сайта SharePoint

Возвращаемое значение

Тело
WebUrlResponse

Проверка документа SharePoint

Регистрация документа по указанному URL-адресу с указанным комментарием

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес документа
documentUrl True string

URL-адрес документа для регистрации

Комментарий
comment string

Комментарий для сопроводительный возврат документа

Возвращаемое значение

Проверка регулярных выражений

Указывает, находит ли регулярное выражение, указанное в конструкторе Regex, совпадение в указанной входной строке. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Параметры

Имя Ключ Обязательно Тип Описание
Рисунок
pattern True string

Шаблон регулярного выражения

Текст
text True string

Строка для поиска совпадений

Возвращаемое значение

Проверьте, существует ли группа SharePoint

Проверяет, существует ли определенная группа SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

Возвращаемое значение

Совпадение регулярных выражений

Выполняет поиск входной строки для всех вхождения регулярного выражения и возвращает все совпадения. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия

Параметры

Имя Ключ Обязательно Тип Описание
Рисунок
pattern True string

Шаблон регулярного выражения

Текст
text True string

Строка для поиска совпадений

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание группы SharePoint

Создает группу SharePoint с указанным именем

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

Описание группы
groupDescription string

Описание группы

Владелец группы
userLogin string

Владелец группы может быть адресом электронной почты или именем входа пользователя.

Создание дочернего сайта SharePoint из шаблона

Создание сайта SharePoint на основе определенного шаблона

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Название
title True string

Название нового сайта

Template
template True string

Заголовок шаблона сайта, который будет использоваться для нового сайта

Конечный URL-адрес
leafUrl True string

Строка, представляющая имя конечного URL-адреса

Description
description string

Описание веб-сайта

Lcid
lcid integer

LCID нового веб-сайта

Наследование разрешений
inheritPermissions boolean

Указывает, будет ли новый сайт наследовать разрешения от родительского сайта.

Наследование навигации
inheritNavigation boolean

Указывает, наследует ли сайт навигацию

Навигация сверху
onTopNav boolean

Отображение этого сайта на верхней панели ссылок родительского сайта. Значение по умолчанию — "Да"

При быстром запуске
onQuickLaunch boolean

Отобразите этот сайт на панели быстрого запуска родительского сайта. Значение по умолчанию — No

Возвращаемое значение

Тело
WebUrlResponse

Создание набора документов SharePoint

Создает новый набор документов в библиотеке документов по указанному URL-адресу.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя набора документов
documentSetName True string

Имя набора документов

Целевой список
targetListUrl True string

Имя или URL-адрес библиотеки или списка, в котором будет создан набор документов. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Тип контента
contentType string

Указание типа контента по имени или идентификатору

Возвращаемое значение

Создание папки SharePoint в списке

Создает новую папку в библиотеке документов или списке с помощью указанного пути

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Целевой список
targetListUrl True string

Имя или URL-адрес библиотеки или списка, в котором будет создана папка. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Путь к папке
folderPath True string

Путь, по которому будет создана папка. Действие создаст все папки, включенные в путь

Возвращаемое значение

Создание папки SharePoint по URL-адресу

Создает новую папку в библиотеке документов по указанному URL-адресу

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес папки
folderUrl True string

URL-адрес папки. Если указать полный путь, можно создать несколько папок.

Возвращаемое значение

Создание современного сайта SharePoint

Создание современного сайта группы SharePoint или коммуникации

Параметры

Имя Ключ Обязательно Тип Описание
Тип сайта
siteType True string

Тип сайта для создания

request
request True dynamic

Возвращаемое значение

Тело
WebUrlResponse

Создание списка или библиотеки SharePoint

Создание списка или библиотеки по шаблону

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Название
title True string

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

Template
template True string

Заголовок шаблона, который будет использоваться для этого списка

Частичный URL-адрес
partialUrl string

Частичный URL-адрес списка

Description
description string

Описание списка

При быстром запуске
onQuickLaunch boolean

Отображение этого списка на панели быстрого запуска

Удаление группы SharePoint

Удаляет группу SharePoint по указанному имени

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

Удаление документа SharePoint по URL-адресу

Удаление документа по определенному URL-адресу

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес документа
sourceUrl True string

URL-адрес документа, который нужно удалить. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Удаление папки SharePoint по URL-адресу

Удаляет папку из библиотеки документов или списка по указанному URL-адресу.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

URL-адрес папки
sourceUrl True string

URL-адрес библиотеки, в которой будет удалена исходная папка. Вы можете использовать полный URL-адрес, а также относительный URL-адрес домена

Удаление пользователя из группы SharePoint

Удаляет пользователя из определенной группы SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

User
userLogin True string

Имя входа или сообщение электронной почты пользователя, которое будет удалено из определенной группы. Кроме того, можно указать несколько элементов с запятой ";" с разделителями

Удаление сайта SharePoint

Удаляет сайт SharePoint по определенному URL-адресу

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Удаление узла навигации сайта SharePoint

Удаляет пункт меню из быстрого запуска или верхней навигации

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Местоположение
location True string

Расположение добавляемого узла

Название
title True string

Название узла навигации

Parent
parent string

Это название родительского элемента навигации. Если есть несколько элементов верхнего уровня с одинаковым заголовком, мы выберем только первый.

Установка группы сайтов SharePoint по умолчанию

Настройте группы по умолчанию для сайта с помощью Microsoft Flow. Это альтернатива <странице URL-адреса> сайта/_layouts/15/permsetup.aspx в пользовательском интерфейсе SharePoint.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Тип группы
groupType True string

Тип группы

Имя группы
groupName True string

Имя группы

Участник группы SharePoint

Проверяет, является ли пользователь членом определенной группы SharePoint

Параметры

Имя Ключ Обязательно Тип Описание
URL-адрес сайта SharePoint
spUrl True string

Действие будет выполнено на указанном сайте SharePoint

Имя группы
groupName True string

Имя группы

User
userLogin True string

Вход или электронная почта пользователя для проверки того, является ли он членом указанной группы.

Возвращаемое значение

Определения

BooleanResultResponse

Имя Путь Тип Описание
IsSuccess
isSuccess boolean

DocumentInfoResponse

Имя Путь Тип Описание
Идентификатор документа
id integer
URL-адрес документа
url string

DocumentSetInfoResponse

Имя Путь Тип Описание
Идентификатор набора документов
id integer
URL-адрес набора документов
url string

FolderInfoResponse

Имя Путь Тип Описание
Идентификатор папки
id integer
URL-адрес папки
url string

GetSPGroupMembersResponse

Имя Путь Тип Описание
Users
users array of SharePointUserResponse

GroupExistResponse

Имя Путь Тип Описание
Группа существует
groupExists boolean

ListFileUrlsResponse

Имя Путь Тип Описание
URL-адреса файлов
fileUrls array of string

ListItemIdResponse

Имя Путь Тип Описание
Идентификатор элемента результата
resultItemId integer

SPSiteOptionValueResponse

Имя Путь Тип Описание
Значение параметра
optionValue string

SharePointUserResponse

Имя Путь Тип Описание
Идентификатор пользователя
id integer
Имя пользователя
loginName string
Электронная почта пользователя
email string
Утверждения пользователей
claims string

SharePointVersionResponse

Имя Путь Тип Описание
редактор
editor SharePointUserResponse
Изменено
modified date-time
Ценность
value string

StringResultResponse

Имя Путь Тип Описание
Result
result string

UserExistsResponse

Имя Путь Тип Описание
Пользователь существует
userExists boolean

VersionsHistoryResponse

Имя Путь Тип Описание
Подсчет версий
countVersions integer
Versions
versions array of SharePointVersionResponse

WebUrlResponse

Имя Путь Тип Описание
URL-адрес
url string

WorkflowGuidResponse

Имя Путь Тип Описание
GUID рабочего процесса
workflowGuid string