Compartilhar via

Plumsail HelpDesk

A API permite interagir com o sistema de tíquetes do Plumsail HelpDesk. Visite https://plumsail.com/docs/help-desk-o365/v1.x/API/ms-flow.html para obter mais informações.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Standard Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Plumsail
URL https://plumsail.com/sharepoint-helpdesk
Email support@plumsail.com
Metadados do conector
Publicador Plumsail Inc.
Site da Web https://plumsail.com
Política de privacidade https://plumsail.com/privacy-policy/
Categorias Colaboração; Gestão de empresas

Esse conector ajuda você a manipular dados em seu HelpDesk com a ajuda do Power Automate.

Visite https://plumsail.com/helpdesk para obter mais informações.

Plumsail HelpDesk Power Automate

Pré-requisitos

Para começar a usá-lo, você precisa concluir os seguintes pré-requisitos:

Em seguida, depois de criar uma chave de API, você estará pronto para criar seu primeiro Flow.

Basta procurar "Plumsail HelpDesk" em seu Flow e adicionar uma ação apropriada:

Lista de ações do HelpDesk

Quando você adicionar uma ação pela primeira vez, será solicitado Connection Name e solicitado Access Key. Você pode digitar qualquer nome para a conexão. Por exemplo, Plumsail HelpDesk.

Em seguida, cole a chave de API que você criou na primeira etapa para Access Key inserir.

Criar conexão de fluxo

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs

Nome Tipo Description Obrigatório
Chave de API secureString A chave de API para esta api Verdade
Região do data center cadeia Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar um contato

Localiza um contato por ID e o atualiza. Retorna o contato atualizado.
Atualizar um contato por email

Localiza um contato por email e o atualiza. Retorna o contato atualizado.
Atualizar um tíquete

Obtém um tíquete por ID e o atualiza. Retorna o tíquete atualizado.
Atualizar uma organização

Obtém uma organização por ID e a retorna.
Atualizar uma organização por título

Obtém uma organização por título e a atualiza. Retorna a organização atualizada.
Baixar anexo

Retorna o arquivo de anexo para um tíquete específico pelo nome ou retorna o código de erro
Criar um comentário

Cria um novo comentário para um tíquete com a ID especificada e o retorna.
Criar um contato

Cria um novo contato e o retorna.
Criar um tíquete

Cria um novo tíquete e retorna o tíquete criado.
Criar uma organização

Cria um novo item na lista Organizações e o retorna
Excluir um contato

Exclui o contato por ID
Excluir um tíquete

Exclui o tíquete por ID.
Excluir uma organização

Exclui a organização por Id.
Excluir uma organização por título

Exclui a organização por título
Obter contatos

Obter lista de contatos
Obter organizações

Obter lista de organizações
Obter todos os comentários de um tíquete

Obtém todos os comentários de um tíquete com a ID especificada.
Obter tíquetes

Retorna a lista de objetos TicketRead, cada objeto TicketRead tem os seguintes campos: Categoria, Criado, TicketID, Status, Solicitante etc. Verifique a definição do objeto TicketRead para obter mais detalhes
Obter um único comentário

Obtém um comentário por ID e o retorna.
Obter um único contato por email

Obtém um contato por email e o retorna.
Obter um único contato por ID

Obtém um contato por ID e o revira.
Obter um único tíquete

Obtém um tíquete por ID e o retorna
Obter uma única organização

Obtém a organização por Id e a retorna
Obter uma única organização por título

Obtém uma organização por título e a retorna.

Atualizar um contato

ID da operação:
_flowV4ContactsByIdPut

Localiza um contato por ID e o atualiza. Retorna o contato atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de contato
 id True integer

ID de contato
Entrar em contato com campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email de contato
 email True string
Contatar email alternativo
 emailAlternate string
Função de contato
 role string
Contatar SPUserId
 spUserId integer
Nome do contato
 title True string

Retornos

Corpo
ContactRead

Atualizar um contato por email

ID da operação:
_flowV4ContactsByEmailByEmailPut

Localiza um contato por email e o atualiza. Retorna o contato atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Email de contato
 email True string

Email de contato
Entrar em contato com campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email de contato
 email True string
Contatar email alternativo
 emailAlternate string
Função de contato
 role string
Contatar SPUserId
 spUserId integer
Nome do contato
 title True string

Retornos

Corpo
ContactRead

Atualizar um tíquete

ID da operação:
_flowV4TicketsByIdPut

Obtém um tíquete por ID e o atualiza. Retorna o tíquete atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 id True integer

ID do tíquete
Email do Destinatário do Tíquete ou Nome do Grupo do SharePoint
 assignedToEmail string
AttachmentContent
 AttachmentContent True binary

Conteúdo do arquivo
Nome do arquivo de anexo
 Name True string
Corpo do tíquete
 body True string
Categoria de tíquete
 category string
Tíquete Cc Emails
 ccEmails array of string
Campos personalizados de tíquete
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
DueDate de Tíquete
 dueDate date-time
Prioridade de tíquete
 priority string
Email do Solicitante de Tíquete
 requesterEmail True string
Status do tíquete
 status string
Assunto do tíquete
 subject True string
Tíquete SupportChannel
 supportChannel string
Títulos de marcas de tíquete
 tagTitles array of string

Retornos

Corpo
TicketRead

Atualizar uma organização

ID da operação:
_flowV4OrganizationsByIdPut

Obtém uma organização por ID e a retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id da Organização
 id True integer

Id da Organização
Campos Personalizados da Organização
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Título da organização
 title True string

Retornos

Corpo
OrganizationRead

Atualizar uma organização por título

ID da operação:
_flowV4OrganizationsByTitleByTitlePut

Obtém uma organização por título e a atualiza. Retorna a organização atualizada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da organização
 title True string

Título da organização
Campos Personalizados da Organização
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Título da organização
 title True string

Retornos

Corpo
OrganizationRead

Baixar anexo

ID da operação:
_flowV4TicketsByIdAttachmentsByFilenameGet

Retorna o arquivo de anexo para um tíquete específico pelo nome ou retorna o código de erro

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 id True integer

ID do tíquete
Nome do arquivo de anexo
 filename True string

Nome do arquivo de anexo

Retornos

Arquivo de resultado
binary

Criar um comentário

ID da operação:
_flowV4TicketsByTicketIdCommentsPost

Cria um novo comentário para um tíquete com a ID especificada e o retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
AttachmentContent
 AttachmentContent True binary

Conteúdo do arquivo
Nome do arquivo de anexo
 Name True string
Corpo do Comentário
 body True string
Comentar campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email do autor do comentário
 fromEmail True string
Comment MessageId
 messageId string
ID do tíquete
 ticketId True integer

ID do tíquete

Retornos

Corpo
CommentRead

Criar um contato

ID da operação:
_flowV4ContactsPost

Cria um novo contato e o retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
Entrar em contato com campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email de contato
 email True string
Contatar email alternativo
 emailAlternate string
Função de contato
 role string
Contatar SPUserId
 spUserId integer
Nome do contato
 title True string
Atualizar Contato se existir
 updateIfExists boolean

Atualizar o contato se ele já existir

Retornos

Corpo
ContactRead

Criar um tíquete

ID da operação:
_flowV4TicketsPost

Cria um novo tíquete e retorna o tíquete criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Email do Destinatário do Tíquete ou Nome do Grupo do SharePoint
 assignedToEmail string
AttachmentContent
 AttachmentContent True binary

Conteúdo do arquivo
Nome do arquivo de anexo
 Name True string
Corpo do tíquete
 body True string
Categoria de tíquete
 category string
Tíquete Cc Emails
 ccEmails array of string
Campos personalizados de tíquete
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
DueDate de Tíquete
 dueDate date-time
Prioridade de tíquete
 priority string
Email do Solicitante de Tíquete
 requesterEmail True string
Status do tíquete
 status string
Assunto do tíquete
 subject True string
Tíquete SupportChannel
 supportChannel string
Títulos de marcas de tíquete
 tagTitles array of string

Retornos

Corpo
TicketRead

Criar uma organização

ID da operação:
_flowV4OrganizationsPost

Cria um novo item na lista Organizações e o retorna

Parâmetros

Nome Chave Obrigatório Tipo Description
Campos Personalizados da Organização
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Título da organização
 title True string

Retornos

Corpo
OrganizationRead

Excluir um contato

ID da operação:
_flowV4ContactsByIdDelete

Exclui o contato por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de contato
 id True integer

ID de contato

Excluir um tíquete

ID da operação:
_flowV4TicketsByIdDelete

Exclui o tíquete por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 id True integer

ID do tíquete

Excluir uma organização

ID da operação:
_flowV4OrganizationsByIdDelete

Exclui a organização por Id.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id da Organização
 id True integer

Id da Organização

Excluir uma organização por título

ID da operação:
_flowV4OrganizationsByTitleByTitleDelete

Exclui a organização por título

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da organização
 title True string

Título da organização

Obter contatos

ID da operação:
_flowV4ContactsGet

Obter lista de contatos

Parâmetros

Nome Chave Obrigatório Tipo Description
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis. Use $select=PhoneNumber, Title, Email, ID para incluir o número de telefone.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.
$filtro
 $filter string

Use a opção $filter ODATA para localizar o contato necessário. Por exemplo, use $filter=Título eq 'Bill Gates' para localizar a pessoa pelo nome completo. Use $filter=substringof('@DOMAIN', Email) para encontrar uma pessoa com email do domínio (DOMÍNIO)
$orderBy
 $orderBy string

Uma opção de consulta $orderBy ODATA para especificar a ordem das entradas.
$top
 $top integer

Um ODATA $top opção de consulta para selecionar os primeiros n itens do conjunto de retorno para retorno (padrão = 50, máximo = 100).
$skiptoken
 $skiptoken string

Um ODATA $skiptoken opção de consulta para ignorar itens até que o item especificado seja atingido e retornar o restante.

Retornos

response
array of ContactRead

Obter organizações

ID da operação:
_flowV4OrganizationsGet

Obter lista de organizações

Parâmetros

Nome Chave Obrigatório Tipo Description
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.
$filtro
 $filter string

Uma opção de consulta $filter ODATA para restringir as entradas retornadas
$orderBy
 $orderBy string

Uma opção de consulta $orderBy ODATA para especificar a ordem das entradas.
$top
 $top integer

Um ODATA $top opção de consulta para selecionar os primeiros n itens do conjunto de retorno para retorno (padrão = 50, máximo = 100).
$skiptoken
 $skiptoken string

Um ODATA $skiptoken opção de consulta para ignorar itens até que o item especificado seja atingido e retornar o restante.

Retornos

response
array of OrganizationRead

Obter todos os comentários de um tíquete

ID da operação:
_flowV4TicketsByTicketIdCommentsGet

Obtém todos os comentários de um tíquete com a ID especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 ticketId True integer

ID do tíquete
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.
$filtro
 $filter string

Uma opção de consulta $filter ODATA para restringir as entradas retornadas
$orderBy
 $orderBy string

Uma opção de consulta $orderBy ODATA para especificar a ordem das entradas.

Retornos

response
array of CommentRead

Obter tíquetes

ID da operação:
_flowV4TicketsGet

Retorna a lista de objetos TicketRead, cada objeto TicketRead tem os seguintes campos: Categoria, Criado, TicketID, Status, Solicitante etc. Verifique a definição do objeto TicketRead para obter mais detalhes

Parâmetros

Nome Chave Obrigatório Tipo Description
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.
$filtro
 $filter string

Uma opção de consulta $filter ODATA. Por exemplo, use $filter=Status/Status/Status eq STATUS ou $filter=Status/Título ne STATUS (STATUS pode ser 'Pendente', 'Novo', 'Em Andamento', 'Resolvido' etc) para obter tíquetes com status específico ou $filter=Status/Título ne Resolvido para obter tíquetes ativos ou $filter=Created gt '2023-08-18' para obter tíquetes criados após uma data específica. Use o campo Categoria para filtrar por categoria, AssignedTo/Email para filtrar por email atribuído, AssignedTo/Title para filtrar pelo nome do destinatário. Use $filter=substringof('@DOMAIN', Solicitante/Email) para localizar uma pessoa com email de domínio (DOMÍNIO). Os tíquetes vencidos são apenas tíquetes ativos onde DueDate é menor do que hoje.
$orderBy
 $orderBy string

Uma opção de consulta $orderBy ODATA para especificar a ordem das entradas.
$top
 $top integer

Um ODATA $top opção de consulta para selecionar os primeiros n itens do conjunto de retorno para retorno (padrão = 50, máximo = 100).
$skiptoken
 $skiptoken string

Um ODATA $skiptoken opção de consulta para ignorar itens até que o item especificado seja atingido e retornar o restante.

Retornos

response
array of TicketRead

Obter um único comentário

ID da operação:
_flowV4TicketsByTicketIdCommentsByIdGet

Obtém um comentário por ID e o retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 ticketId True integer

ID do tíquete
ID do comentário
 id True integer

ID do comentário
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
CommentRead

Obter um único contato por email

ID da operação:
_flowV4ContactsByEmailByEmailGet

Obtém um contato por email e o retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
Email de contato
 email True string

Email de contato
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
ContactRead

Obter um único contato por ID

ID da operação:
_flowV4ContactsByIdGet

Obtém um contato por ID e o revira.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de contato
 id True integer

ID de contato
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
ContactRead

Obter um único tíquete

ID da operação:
_flowV4TicketsByIdGet

Obtém um tíquete por ID e o retorna

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tíquete
 id True integer

ID do tíquete
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
TicketRead

Obter uma única organização

ID da operação:
_flowV4OrganizationsByIdGet

Obtém a organização por Id e a retorna

Parâmetros

Nome Chave Obrigatório Tipo Description
Id da Organização
 id True integer

Id da Organização
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
OrganizationRead

Obter uma única organização por título

ID da operação:
_flowV4OrganizationsByTitleByTitleGet

Obtém uma organização por título e a retorna.

Parâmetros

Nome Chave Obrigatório Tipo Description
Título da organização
 title True string

Título da organização
$select
 $select string

Um ODATA $select opção de consulta para especificar quais campos retornar para um item de lista. Você pode usar * para retornar todos os campos disponíveis.
$expand
 $expand string

Um ODATA $expand opção de consulta para especificar que a solicitação retorna os valores das pesquisas.

Retornos

Corpo
OrganizationRead

Definições

Assignee

Nome Caminho Tipo Description
Campos Personalizados do Atribuídor
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email do Atribuídor
 email string
Email alternativo do atribuído
 emailAlternate string
ID do atribuídor
 id integer
Função de atribuídor
 role string
Assignee SPUserId
 spUserId integer
Nome Completo do Atribuídor
 title string

Cc

Nome Caminho Tipo Description
Cc CustomFields
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Cc Email
 email string
Cc Alternate Email
 emailAlternate string
Cc ID
 id integer
Função Cc
 role string
Cc SPUserId
 spUserId integer
Nome Completo cc
 title string

CommentRead

Nome Caminho Tipo Description
Corpo do Comentário
 body string
Data de criação do comentário
 created date-time
Comentar campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email do autor do comentário
 fromEmail string
Nome do autor do comentário
 fromName string
ID do comentário
 id integer
Comment MessageId
 messageId string

ContactRead

Nome Caminho Tipo Description
Entrar em contato com campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email de contato
 email string
Contatar email alternativo
 emailAlternate string
ID de contato
 id integer
Função de contato
 role string
Contatar SPUserId
 spUserId integer
Nome completo do contato
 title string

OrganizationRead

Nome Caminho Tipo Description
Campos Personalizados da Organização
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
ID da Organização
 id integer
Título da organização
 title string

Solicitante

Nome Caminho Tipo Description
Campos Personalizados do Solicitante
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Email do solicitante
 email string
Email alternativo do solicitante
 emailAlternate string
ID do solicitante
 id integer
Função do solicitante
 role string
SPUserId do solicitante
 spUserId integer
Nome completo do solicitante
 title string

TagRead

Nome Caminho Tipo Description
Marcar campos personalizados
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
ID da marca
 id integer
Título da Marca
 title string

TicketRead

Nome Caminho Tipo Description
Atribuídor de Tíquete
 assignedTo Assignee
Anexos de tíquetes
 attachments array of string
Categoria de tíquete
 category string
Tíquete Cc
 cc array of Cc
Data de criação do tíquete
 created date-time
Campos personalizados de tíquete
 customFields object

Cadeia de caracteres JSON que contém valores de campo personalizados
Data de conclusão do tíquete
 dueDate date-time
ID do tíquete
 id integer
Prioridade de tíquete
 priority string
Solicitante de tíquete
 requester Requester
Data da resolução do tíquete
 resolutionDate date-time
Status do tíquete
 status string
Assunto do tíquete
 subject string
Marcas de tíquete
 tags array of TagRead
ID do Tíquete Personalizado
 ticketID string

binário

Esse é o tipo de dados básico 'binary'.