Plumsail HelpDesk

API позволяет взаимодействовать с системой запросов в HelpDesk Plumsail. Дополнительные сведения см. в разделе https://plumsail.com/docs/help-desk-o365/v1.x/API/ms-flow.html "Дополнительные сведения".

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

Услуга 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)
Контакт
Имя Пламсайл
URL https://plumsail.com/sharepoint-helpdesk
Адрес электронной почты support@plumsail.com
Метаданные соединителя
Publisher Пламсайл Inc.
Веб-сайт https://plumsail.com
Политика конфиденциальности https://plumsail.com/privacy-policy/
Категории Сотрудничество; Управление бизнесом

Этот соединитель помогает управлять данными в HelpDesk с помощью Power Automate.

Дополнительные сведения см. в разделе https://plumsail.com/helpdesk "Дополнительные сведения".

Видео HelpDesk Plumsail HelpDesk Power Automate

Предпосылки

Чтобы начать использовать его, необходимо выполнить следующие предварительные требования:

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

Просто найдите "Plumsail HelpDesk" в потоке и добавьте соответствующее действие:

Список действий HelpDesk

При первом добавлении действия вам будет предложено Connection Name и для Access Key. Можно ввести любое имя подключения. Например: Plumsail HelpDesk.

Затем вставьте ключ API, созданный на первом шаге для Access Key ввода.

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

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True
Регион центра обработки данных струна True

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

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

Действия

Обновить организацию

Возвращает организацию по идентификатору и возвращает ее.
Обновление билета

Получает билет по идентификатору и обновляет его. Возвращает обновленный билет.
Обновление контакта

Находит контакт по идентификатору и обновляет его. Возвращает обновленный контакт.
Обновление контакта по электронной почте

Находит контакт по электронной почте и обновляет его. Возвращает обновленный контакт.
Обновление организации по названию

Получает организацию по названию и обновляет ее. Возвращает обновленную организацию.
Получение билетов

Возвращает список объектов TicketRead, каждый объект TicketRead содержит следующие поля: Category, Created, TicketID, Status, Requester и т. д. Дополнительные сведения см. в определении объекта TicketRead.
Получение всех комментариев для билета

Возвращает все комментарии для билета с указанным идентификатором.
Получение контактов

Получение списка контактов
Получение одного билета

Возвращает билет по идентификатору и возвращает его
Получение одного комментария

Возвращает комментарий по идентификатору и возвращает его.
Получение одного контакта по идентификатору

Получает контакт по идентификатору и возвращает его.
Получение одного контакта по электронной почте

Получает контакт по электронной почте и возвращает его.
Получение одной организации

Возвращает организацию по идентификатору и возвращает ее
Получение одной организации по названию

Получает организацию по названию и возвращает ее.
Получение организаций

Получение списка организаций
Скачивание вложения

Возвращает файл вложения для конкретного билета по имени или возвращает код ошибки
Создание билета

Создает новый билет и возвращает созданный билет.
Создание комментария

Создает новый комментарий для билета с указанным идентификатором и возвращает его.
Создание контакта

Создает новый контакт и возвращает его.
Создание организации

Создает новый элемент в списке "Организации" и возвращает его
Удаление билета

Удаляет билет по идентификатору.
Удаление контакта

Удаляет контакт по идентификатору
Удаление организации по названию

Удаляет организацию по названию
Удалить организацию

Удаляет организацию по идентификатору.

Обновить организацию

Идентификатор операции:
_flowV4OrganizationsByIdPut

Возвращает организацию по идентификатору и возвращает ее.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор организации
 id True integer

Идентификатор организации
Настраиваемые поля организации
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Название организации
 title True string

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

Тело
OrganizationRead

Обновление билета

Идентификатор операции:
_flowV4TicketsByIdPut

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 id True integer

Идентификатор билета
Адрес электронной почты назначаемого билета или имя группы SharePoint
 assignedToEmail string
AttachmentContent
 AttachmentContent True binary

Содержимое файла
Имя файла вложения
 Name True string
Текст билета
 body True string
Категория билета
 category string
Сообщения электронной почты "Копия билетов"
 ccEmails array of string
Настраиваемые поля билета
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Билет DueDate
 dueDate date-time
Приоритет билета
 priority string
Электронная почта запрашивающего билета
 requesterEmail True string
Состояние билета
 status string
Тема билета
 subject True string
Служба поддержки запросов
 supportChannel string
Заголовки тегов билетов
 tagTitles array of string

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

Тело
TicketRead

Обновление контакта

Идентификатор операции:
_flowV4ContactsByIdPut

Находит контакт по идентификатору и обновляет его. Возвращает обновленный контакт.

Параметры

Имя Ключ Обязательно Тип Описание
Контактный номер
 id True integer

Контактный номер
Связаться с настраиваемыми полями
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Контактный адрес электронной почты
 email True string
Альтернативный адрес электронной почты
 emailAlternate string
Роль контакта
 role string
Контакт с SPUserId
 spUserId integer
Имя контактного лица
 title True string

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

Тело
ContactRead

Обновление контакта по электронной почте

Идентификатор операции:
_flowV4ContactsByEmailByEmailPut

Находит контакт по электронной почте и обновляет его. Возвращает обновленный контакт.

Параметры

Имя Ключ Обязательно Тип Описание
Контактный адрес электронной почты
 email True string

Контактный адрес электронной почты
Связаться с настраиваемыми полями
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Контактный адрес электронной почты
 email True string
Альтернативный адрес электронной почты
 emailAlternate string
Роль контакта
 role string
Контакт с SPUserId
 spUserId integer
Имя контактного лица
 title True string

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

Тело
ContactRead

Обновление организации по названию

Идентификатор операции:
_flowV4OrganizationsByTitleByTitlePut

Получает организацию по названию и обновляет ее. Возвращает обновленную организацию.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
 title True string

Название организации
Настраиваемые поля организации
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Название организации
 title True string

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

Тело
OrganizationRead

Получение билетов

Идентификатор операции:
_flowV4TicketsGet

Возвращает список объектов TicketRead, каждый объект TicketRead содержит следующие поля: Category, Created, TicketID, Status, Requester и т. д. Дополнительные сведения см. в определении объекта TicketRead.

Параметры

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

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.
$фильтр
 $filter string

Параметр запроса $filter ODATA. Например, используйте $filter=Status/Title eq STATUS или $filter=Status/Title ne STATUS (STATUS может быть "Ожидание", "New", "In Progress", "Solved" и т. д.), чтобы получить билеты по определенному состоянию или $filter=Status/Title ne Solved, чтобы получить активные билеты, или $filter=Created gt '2023-08-18', чтобы получить билеты, созданные после определенной даты. Используйте поле "Категория", чтобы отфильтровать по категориям, AssignedTo/Email, чтобы фильтровать по назначению электронной почты, AssignedTo/Title для фильтрации по имени назначаемого пользователя. Используйте $filter=substringof('@DOMAIN', Requester/Email), чтобы найти пользователя с электронной почтой из домена (DOMAIN). Просроченные билеты являются только активными билетами, где DueDate меньше, чем сегодня.
$orderBy
 $orderBy string

Параметр запроса ODATA $orderBy для указания порядка записей.
$top
 $top integer

Параметр запроса ODATA $top для выбора первых n элементов возвращаемого набора для возврата (по умолчанию = 50, максимум = 100).
$skiptoken
 $skiptoken string

Параметр запроса ODATA $skiptoken пропускать элементы до достижения указанного элемента и возвращать остальные элементы.

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

response
array of TicketRead

Получение всех комментариев для билета

Идентификатор операции:
_flowV4TicketsByTicketIdCommentsGet

Возвращает все комментарии для билета с указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 ticketId True integer

Идентификатор билета
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.
$фильтр
 $filter string

Параметр запроса ODATA $filter для ограничения возвращаемых записей
$orderBy
 $orderBy string

Параметр запроса ODATA $orderBy для указания порядка записей.

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

response
array of CommentRead

Получение контактов

Идентификатор операции:
_flowV4ContactsGet

Получение списка контактов

Параметры

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

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей. Используйте $select=PhoneNumber,Title,Email,ID, чтобы включить номер телефона.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.
$фильтр
 $filter string

Используйте параметр $filter ODATA, чтобы найти необходимый контакт. Например, используйте $filter=Title eq "Билл Гейтс" для поиска пользователя по полному имени. Используйте $filter=substringof('@DOMAIN', email) для поиска пользователя с электронной почтой из домена (ДОМЕН)
$orderBy
 $orderBy string

Параметр запроса ODATA $orderBy для указания порядка записей.
$top
 $top integer

Параметр запроса ODATA $top для выбора первых n элементов возвращаемого набора для возврата (по умолчанию = 50, максимум = 100).
$skiptoken
 $skiptoken string

Параметр запроса ODATA $skiptoken пропускать элементы до достижения указанного элемента и возвращать остальные элементы.

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

response
array of ContactRead

Получение одного билета

Идентификатор операции:
_flowV4TicketsByIdGet

Возвращает билет по идентификатору и возвращает его

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 id True integer

Идентификатор билета
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
TicketRead

Получение одного комментария

Идентификатор операции:
_flowV4TicketsByTicketIdCommentsByIdGet

Возвращает комментарий по идентификатору и возвращает его.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 ticketId True integer

Идентификатор билета
Идентификатор комментария
 id True integer

Идентификатор комментария
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
CommentRead

Получение одного контакта по идентификатору

Идентификатор операции:
_flowV4ContactsByIdGet

Получает контакт по идентификатору и возвращает его.

Параметры

Имя Ключ Обязательно Тип Описание
Контактный номер
 id True integer

Контактный номер
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
ContactRead

Получение одного контакта по электронной почте

Идентификатор операции:
_flowV4ContactsByEmailByEmailGet

Получает контакт по электронной почте и возвращает его.

Параметры

Имя Ключ Обязательно Тип Описание
Контактный адрес электронной почты
 email True string

Контактный адрес электронной почты
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
ContactRead

Получение одной организации

Идентификатор операции:
_flowV4OrganizationsByIdGet

Возвращает организацию по идентификатору и возвращает ее

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор организации
 id True integer

Идентификатор организации
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
OrganizationRead

Получение одной организации по названию

Идентификатор операции:
_flowV4OrganizationsByTitleByTitleGet

Получает организацию по названию и возвращает ее.

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
 title True string

Название организации
$select
 $select string

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.

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

Тело
OrganizationRead

Получение организаций

Идентификатор операции:
_flowV4OrganizationsGet

Получение списка организаций

Параметры

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

Параметр запроса ODATA $select, чтобы указать поля, возвращаемые для элемента списка. Можно использовать * для возврата всех доступных полей.
$expand
 $expand string

Параметр запроса ODATA $expand, чтобы указать, что запрос возвращает значения подстановок.
$фильтр
 $filter string

Параметр запроса ODATA $filter для ограничения возвращаемых записей
$orderBy
 $orderBy string

Параметр запроса ODATA $orderBy для указания порядка записей.
$top
 $top integer

Параметр запроса ODATA $top для выбора первых n элементов возвращаемого набора для возврата (по умолчанию = 50, максимум = 100).
$skiptoken
 $skiptoken string

Параметр запроса ODATA $skiptoken пропускать элементы до достижения указанного элемента и возвращать остальные элементы.

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

response
array of OrganizationRead

Скачивание вложения

Идентификатор операции:
_flowV4TicketsByIdAttachmentsByFilenameGet

Возвращает файл вложения для конкретного билета по имени или возвращает код ошибки

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 id True integer

Идентификатор билета
Имя файла вложения
 filename True string

Имя файла вложения

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

Файл результатов
binary

Создание билета

Идентификатор операции:
_flowV4TicketsPost

Создает новый билет и возвращает созданный билет.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес электронной почты назначаемого билета или имя группы SharePoint
 assignedToEmail string
AttachmentContent
 AttachmentContent True binary

Содержимое файла
Имя файла вложения
 Name True string
Текст билета
 body True string
Категория билета
 category string
Сообщения электронной почты "Копия билетов"
 ccEmails array of string
Настраиваемые поля билета
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Билет DueDate
 dueDate date-time
Приоритет билета
 priority string
Электронная почта запрашивающего билета
 requesterEmail True string
Состояние билета
 status string
Тема билета
 subject True string
Служба поддержки запросов
 supportChannel string
Заголовки тегов билетов
 tagTitles array of string

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

Тело
TicketRead

Создание комментария

Идентификатор операции:
_flowV4TicketsByTicketIdCommentsPost

Создает новый комментарий для билета с указанным идентификатором и возвращает его.

Параметры

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

Содержимое файла
Имя файла вложения
 Name True string
Текст комментария
 body True string
Настраиваемые поля примечания
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Сообщение электронной почты автора комментариев
 fromEmail True string
Комментарий MessageId
 messageId string
Идентификатор билета
 ticketId True integer

Идентификатор билета

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

Тело
CommentRead

Создание контакта

Идентификатор операции:
_flowV4ContactsPost

Создает новый контакт и возвращает его.

Параметры

Имя Ключ Обязательно Тип Описание
Связаться с настраиваемыми полями
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Контактный адрес электронной почты
 email True string
Альтернативный адрес электронной почты
 emailAlternate string
Роль контакта
 role string
Контакт с SPUserId
 spUserId integer
Имя контактного лица
 title True string
Обновление контакта, если существует
 updateIfExists boolean

Обновите контакт, если он уже существует

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

Тело
ContactRead

Создание организации

Идентификатор операции:
_flowV4OrganizationsPost

Создает новый элемент в списке "Организации" и возвращает его

Параметры

Имя Ключ Обязательно Тип Описание
Настраиваемые поля организации
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Название организации
 title True string

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

Тело
OrganizationRead

Удаление билета

Идентификатор операции:
_flowV4TicketsByIdDelete

Удаляет билет по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор билета
 id True integer

Идентификатор билета

Удаление контакта

Идентификатор операции:
_flowV4ContactsByIdDelete

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

Параметры

Имя Ключ Обязательно Тип Описание
Контактный номер
 id True integer

Контактный номер

Удаление организации по названию

Идентификатор операции:
_flowV4OrganizationsByTitleByTitleDelete

Удаляет организацию по названию

Параметры

Имя Ключ Обязательно Тип Описание
Название организации
 title True string

Название организации

Удалить организацию

Идентификатор операции:
_flowV4OrganizationsByIdDelete

Удаляет организацию по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор организации
 id True integer

Идентификатор организации

Определения

Назначенное лицо

Имя Путь Тип Описание
Assignee CustomFields
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Назначение электронной почты
 email string
Назначение альтернативного сообщения электронной почты
 emailAlternate string
Идентификатор назначаемого получателя
 id integer
Роль Назначаемого
 role string
Assignee SPUserId
 spUserId integer
Полное имя назначаемого получателя
 title string

Копия (Cc)

Имя Путь Тип Описание
Cc CustomFields
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Копия электронной почты
 email string
Альтернативный адрес электронной почты
 emailAlternate string
Идентификатор cc
 id integer
Роль cc
 role string
Cc SPUserId
 spUserId integer
Полное имя cc
 title string

CommentRead

Имя Путь Тип Описание
Текст комментария
 body string
Дата создания комментариев
 created date-time
Настраиваемые поля примечания
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Сообщение электронной почты автора комментариев
 fromEmail string
Имя автора комментариев
 fromName string
Идентификатор комментария
 id integer
Комментарий MessageId
 messageId string

ContactRead

Имя Путь Тип Описание
Связаться с настраиваемыми полями
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Контактный адрес электронной почты
 email string
Альтернативный адрес электронной почты
 emailAlternate string
Код контактного лица
 id integer
Роль контакта
 role string
Контакт с SPUserId
 spUserId integer
Полное имя контакта
 title string

OrganizationRead

Имя Путь Тип Описание
Настраиваемые поля организации
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Идентификатор организации
 id integer
Название организации
 title string

Инициатора

Имя Путь Тип Описание
Requester CustomFields
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Электронная почта запрашивающего средства
 email string
Альтернативный адрес электронной почты запрашивающего
 emailAlternate string
Идентификатор запрашивающего пользователя
 id integer
Роль запрашивающего объекта
 role string
Requester SPUserId
 spUserId integer
Полное имя запрашивающего пользователя
 title string

TagRead

Имя Путь Тип Описание
Тег настраиваемых полей
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Идентификатор тега
 id integer
Заголовок тега
 title string

TicketRead

Имя Путь Тип Описание
Назначаемый билет
 assignedTo Assignee
Вложения билетов
 attachments array of string
Категория билета
 category string
Копия билета
 cc array of Cc
Дата создания билета
 created date-time
Настраиваемые поля билета
 customFields object

Строка JSON, содержащая настраиваемые значения полей
Дата выполнения билета
 dueDate date-time
Идентификатор билета
 id integer
Приоритет билета
 priority string
Запрашиватель билетов
 requester Requester
Дата разрешения билета
 resolutionDate date-time
Состояние билета
 status string
Тема билета
 subject string
Теги билетов
 tags array of TagRead
Пользовательский идентификатор билета
 ticketID string

бинарный

Это базовый тип данных binary.