Dynamic Signal (versão prévia)
O Dynamic Signal é uma Plataforma de Comunicação e Engajamento de Funcionários, confiável pelas organizações para se conectar, alinhar e envolver funcionários. Conecte-se ao Dynamic Signal para criar e gerenciar suas postagens e usuários.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Metadados do conector | |
|---|---|
| Publicador | Sinal Dinâmico |
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 | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Portador | secureString | O token de portador para esta api | Verdade |
| Dynamic Signal URL | cadeia | A URL em que você acessa o Dynamic Signal. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar uma imagem a uma postagem por meio do upload |
Define a imagem de postagem por meio do upload binário. |
| Adicionar uma imagem a uma postagem via URL |
Define a imagem de postagem por meio de uma URL. |
| Atualizar uma postagem |
Edita uma postagem existente. |
| Carregar imagem |
Carrega uma imagem por meio do upload binário |
| Carregar um documento em uma postagem |
Carrega um documento em uma postagem por meio do upload binário |
| Criar uma postagem |
Cria uma postagem. |
| Gerenciar postagens |
Permite que chamadas autenticadas pelo servidor atualizem propriedades para várias postagens em uma única solicitação |
| Obter categorias |
Obtém uma lista de categorias visíveis para o usuário autenticado |
| Obter destinos |
Obtém uma lista de destinos e definições de destino da comunidade |
| Obter divisões |
Obtém a lista de divisões |
| Obter marcas de postagem |
Obtém as marcas de postagem definidas no sistema |
| Obter marcas de usuário |
Obtém uma lista de marcas de usuário definidas no sistema |
| Obter um usuário por email |
Recupera um usuário por seu endereço de email |
| Obter uma postagem |
Obtém uma postagem específica por ID |
| Pré-registro de um usuário |
Cria um novo usuário no estado pré-registrado |
Adicionar uma imagem a uma postagem por meio do upload
Define a imagem de postagem por meio do upload binário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
A ID da postagem |
|
File
|
File | True | binary |
Arquivo a ser carregado |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do arquivo carregado |
Retornos
Uma resposta simples que indica que a ação foi realizada com êxito
- response
- successResponse
Adicionar uma imagem a uma postagem via URL
Define a imagem de postagem por meio de uma URL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
A ID da postagem, necessária: true |
|
URL
|
url | True | string |
A URL HTTP ou HTTPS |
Retornos
Uma resposta simples que indica que a ação foi realizada com êxito
- response
- successResponse
Atualizar uma postagem
Edita uma postagem existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
A ID da postagem |
|
Title
|
title | string |
O título da postagem |
|
|
Description
|
description | string |
A breve descrição da postagem |
|
|
Linha de Marcação
|
tagLine | string |
A linha de marcação da postagem |
|
|
Content
|
content | string |
O corpo da postagem |
|
|
Comentários do Criador
|
creatorComments | string |
Uma mensagem associada à postagem |
|
|
Perma Link
|
permaLink | string |
A URL externa referenciada pela postagem |
|
|
Discussões internas habilitadas
|
internalDiscussionsEnabled | boolean |
Se os membros têm permissão para executar como ação e adicionar comentários em postagens internamente |
Retornos
Uma postagem
- response
- postResponse
Carregar imagem
Carrega uma imagem por meio do upload binário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
File
|
File | True | binary |
Arquivo a ser carregado |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do arquivo carregado |
Retornos
- response
- uploadImageResponse
Carregar um documento em uma postagem
Carrega um documento em uma postagem por meio do upload binário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
Nome de arquivo preferencial do documento (com extensão) |
|
ID
|
id | True | uuid |
A ID da postagem |
|
File
|
File | True | binary |
Arquivo a ser carregado |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do arquivo carregado |
Retornos
Informações relevantes para um documento anexado
- response
- documentInfoResponse
Criar uma postagem
Cria uma postagem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Description
|
description | string |
A breve descrição da postagem |
|
|
Linha de Marcação
|
tagLine | string |
A linha de marcação da postagem |
|
|
Content
|
content | string |
O corpo da postagem |
|
|
Comentários do Criador
|
creatorComments | string |
Uma mensagem associada à postagem |
|
|
Perma Link
|
permaLink | string |
A URL externa referenciada pela postagem |
|
|
Discussões internas habilitadas
|
internalDiscussionsEnabled | boolean |
Se os membros têm permissão para executar como ação e adicionar comentários em postagens internamente |
|
|
Title
|
title | True | string |
O título da postagem |
|
URL de Vídeo do Membro
|
memberVideoUrl | string |
A URL do vídeo referenciada pela postagem |
|
|
Tipo de Postagem
|
postType | string |
O tipo básico da postagem |
|
|
Estado de aprovação
|
approvalState | string |
O estado de aprovação do post. O padrão é a configuração de Status de Revisão do autor. |
|
|
Modo de Exibição
|
displayMode | string |
Indica o redirecionamento de uma postagem para um local interno ou externo |
|
|
Compartilhável
|
sharable | boolean |
Se a plataforma e os widgets do VoiceStorm permitirão que a postagem seja compartilhada |
|
|
Data de Início
|
startDate | date-time |
A data após a qual a postagem está disponível para exibição |
|
|
Data de Término
|
endDate | date-time |
A data após a qual a postagem não estará mais disponível para exibição |
|
|
Texto de compartilhamento sugerido
|
suggestedShareText | string |
O texto de compartilhamento sugerido para a postagem |
|
|
Texto de compartilhamento sugerido curto
|
shortSuggestedShareText | string |
O texto de compartilhamento sugerido para a postagem para provedores de mensagens curtas |
|
|
Compartilhar pontos
|
sharePoints | integer |
O número de pontos concedidos quando um usuário compartilha a postagem |
|
|
Clique em Pontos
|
clickPoints | integer |
O número de pontos concedidos quando alguém clica em um link compartilhado para a postagem |
|
|
Compartilhar com imagens
|
shareWithImages | boolean |
Controla se as postagens compartilhadas em serviços de mensagens curtas (como o Twitter) têm imagens compartilhadas |
|
|
Compartilhar somente imagens
|
shareImagesOnly | boolean |
Controla se as postagens compartilhadas em determinados serviços são tratadas como atualizações somente de imagem/foto |
|
|
Nome
|
name | string |
O nome da marca |
|
|
Linguagem
|
language | string |
O idioma do conteúdo da postagem |
|
|
Documentos
|
documents | array of uuid |
Uma lista de IDs de documentos a serem anexadas a esta postagem |
|
|
ID do Criador
|
creatorId | integer |
O usuário que está criando a postagem; Essa propriedade só está disponível para solicitações autenticadas pelo servidor no momento. Todas as outras postagens são definidas automaticamente para o usuário autenticado. |
|
|
Exibir Criador
|
displayCreator | boolean |
Controla se as informações do criador devem ser exibidas com a postagem ou não; Essa propriedade só está disponível para solicitações autenticadas pelo servidor no momento. |
|
|
IDs de categoria
|
categoryIds | array of integer |
Uma lista de IDs de categoria que foram atribuídas à postagem |
|
|
IDs de destino
|
targetIds | array of integer |
Uma lista de IDs de destino que foram atribuídas ao post |
Retornos
Uma postagem
- response
- postResponse
Gerenciar postagens
Permite que chamadas autenticadas pelo servidor atualizem propriedades para várias postagens em uma única solicitação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de postagem
|
postIds | True | array of uuid |
As postagens que estão sendo modificadas |
|
Etiquetas
|
tags | array of string |
Uma coleção de nomes de marcas que podem ser aplicados a postagens |
|
|
IDs de divisão
|
divisionIds | array of integer |
As IDs de divisão às quais as postagens pertencem |
|
|
IDs de categoria
|
categoryIds | array of integer |
A ID da categoria à qual as postagens pertencem |
|
|
IDs de destino
|
targetIds | array of integer |
A ID de destino à qual as postagens pertencem |
|
|
Estado de aprovação
|
approvalState | string |
O estado aprovação das postagens (isso não é afetado pelas solicitações DELETE) |
Retornos
Uma resposta simples que indica que a ação foi realizada com êxito
- response
- successResponse
Obter categorias
Obtém uma lista de categorias visíveis para o usuário autenticado
Retornos
Informações detalhadas relacionadas a categorias
- response
- categoriesResponse
Obter destinos
Obtém uma lista de destinos e definições de destino da comunidade
Retornos
Uma lista de definições de destino e destinos associados para a comunidade.
- response
- targetDefinitionsInfoResponse
Obter divisões
Obter marcas de postagem
Obtém as marcas de postagem definidas no sistema
Retornos
Uma lista de marcas de postagem definidas no sistema
- response
- managePostTagsResponse
Obter marcas de usuário
Obtém uma lista de marcas de usuário definidas no sistema
Retornos
Uma lista de marcas de usuário definidas no sistema
- response
- manageUserTagsResponse
Obter um usuário por email
Recupera um usuário por seu endereço de email
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
True | string |
Email do usuário |
|
|
Incluir
|
include | array of string |
Especifica dados opcionais a serem retornados com o usuário. |
Retornos
- response
- userRequestResponse
Obter uma postagem
Obtém uma postagem específica por ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
A ID da postagem.; Esse é o identificador exclusivo da postagem. |
|
ID do Usuário
|
userId | integer |
O usuário que está exibindo a postagem. O usuário conectado será usado se nenhuma ID for especificada |
Retornos
Uma postagem
- response
- postResponse
Pré-registro de um usuário
Cria um novo usuário no estado pré-registrado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de email do usuário |
||
|
ID de usuário do Sso externo
|
externalSsoUserId | string |
A ID do usuário no sistema externo gerenciado pelo Provedor de Identidade de SSO |
|
|
Manejar
|
handle | string |
O identificador do usuário |
|
|
Primeiro Nome
|
firstName | string |
O nome do usuário. |
|
|
Apelido
|
lastName | string |
O sobrenome do usuário. |
|
|
IDs de divisão
|
divisionIds | array of integer |
Uma lista de divisões às quais o usuário será atribuído. |
|
|
IDs de destino
|
targetIds | array of integer |
Uma lista de destinos a serem atribuídos ao usuário. |
|
|
Nome
|
name | string |
A marca ou o nome do atributo |
|
|
Value
|
value | string |
O valor opcional |
|
|
Enviar Email de Convite
|
sendInvitationEmail | boolean |
Determina se um email de convite deve ser enviado ao usuário. |
|
|
Mensagem de convite
|
invitationMessage | string |
Uma mensagem de texto sem formatação opcional a ser incluída no email de convite. |
|
|
Padrão de notificações
|
notificationsDefault | string |
Configuração que controla quando os usuários começarão a receber notificações por email. |
|
|
Pode compartilhar postagens
|
canSharePosts | boolean |
Indica se o usuário tem a capacidade de compartilhar postagens |
|
|
Pode comentar postagens
|
canCommentPosts | boolean |
Indica se o usuário tem a capacidade de comentar e curtir postagens |
|
|
Pode enviar postagens
|
canSubmitPosts | boolean |
Indica se o usuário tem a capacidade de enviar postagens |
|
|
Pode gerenciar a organização
|
canManageOrganization | boolean |
Indica se o usuário tem a capacidade de se comunicar com relatórios diretos e indiretos dentro da comunidade |
Retornos
- response
- userRequestResponse
Definições
successResponse
Uma resposta simples que indica que a ação foi realizada com êxito
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
code | string |
Um valor de "êxito" indica uma operação bem-sucedida |
targetDefinitionsInfoResponse
Uma lista de definições de destino e destinos associados para a comunidade.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Informações detalhadas para uma definição de destino específica e seus destinos associados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da definição de destino |
|
Nome
|
name | string |
O nome da definição de destino |
|
Obter confirmação do usuário
|
getUserConfirmation | boolean |
Determina se um usuário é solicitado a confirmar/selecionar sua preferência |
|
Permitir várias seleções
|
allowMultipleSelections | boolean |
Determina se vários destinos podem ser selecionados |
|
Seleção necessária
|
selectionRequired | boolean |
Determina se uma seleção nessa definição é necessária |
|
Prompt de Seleção de Destino
|
targetSelectionPrompt | string |
Um rótulo personalizado para solicitar que os usuários selecionem suas preferências |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Informações detalhadas para um destino específico.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descritção de destinos |
|
ID de definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID Principal
|
parentId | integer |
A ID do pai de destino, se ele tiver um |
|
Está inscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
Uma lista de marcas de postagem definidas no sistema
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Informações detalhadas de uma marca de postagem específica
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da marca |
|
Nome
|
name | string |
O nome da marca |
|
Está disponível para membros
|
isAvailableToMembers | boolean |
Determina se a marca pode ser usada em páginas pós-envio voltadas para membro (se habilitada) |
manageUserTagsResponse
Uma lista de marcas de usuário definidas no sistema
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Informações detalhadas de uma marca de usuário específica
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da marca |
|
Nome
|
name | string |
O nome da marca |
|
tipo
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
Informações detalhadas relacionadas a categorias
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Prompt de assinatura
|
subscriptionPrompt | string |
O rótulo para solicitar que os membros selecionem assinaturas de categoria |
|
Habilitar Assinatura de Categoria
|
enableCategorySubscription | boolean |
Se os membros têm permissão para modificar suas assinaturas de categoria |
|
Exigir seleção de assinatura
|
requireSubscriptionSelection | boolean |
Se os membros são necessários para selecionar assinaturas de categoria durante a integração |
|
Categoria padrão da página de aterrissagem
|
landingPageDefaultCategory | integer |
O conteúdo padrão a ser mostrado ao carregar informações do feed de notícias |
categoryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
Description
|
description | string |
A descrição da categoria |
|
Ordem de Exibição
|
displayOrder | integer |
A ordem na qual exibir a categoria |
|
Está fixado
|
isPinned | boolean |
Se a categoria foi fixada por um administrador |
|
É forçado
|
isForced | boolean |
Se o usuário autenticado está inscrito à força na categoria determinada |
|
Está inscrito
|
isSubscribed | boolean |
Wther, o usuário autenticado, está inscrito na categoria fornecida |
|
Está oculto
|
isHidden | boolean |
Se a categoria está oculta por um administrador |
|
É selecionável pelo usuário
|
isUserSelectable | boolean |
Se os usuários têm permissão para selecionar categorias para postagens enviadas |
|
ID da categoria pai
|
parentCategoryId | integer |
A ID da categoria pai |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
Uma postagem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da postagem
|
postId | uuid |
A ID da postagem |
|
Postar ID de Origem
|
postSourceId | integer |
A ID de origem |
|
Title
|
title | string |
O título da postagem |
|
Description
|
description | string |
A breve descrição da postagem |
|
Linha de Marcação
|
tagLine | string |
A linha de marcação da postagem |
|
Content
|
content | string |
O corpo da postagem |
|
Conteúdo Bruto
|
rawContent | string |
O corpo da postagem incluindo todos os HTML (quando o Conteúdo e RawContent são incluídos) |
|
Comentários do Criador
|
creatorComments | string |
Uma mensagem associada à postagem |
|
|
creatorInfo | userOverviewResponse |
Informações resumidas sobre um usuário |
|
Localização
|
location | string |
Localização geográfica relacionada à postagem |
|
Propriedades
|
properties | object |
Propriedades diversas da postagem. Não disponível com todos os tipos de postagem |
|
Perma Link
|
permaLink | string |
A URL externa referenciada pela postagem |
|
Limpar Link do Perma
|
cleanPermaLink | string |
O permalink (excluindo espaços problemáticos e novas linhas) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Fornecedor
|
provider | string |
O provedor social do qual o post se originou (por exemplo, Facebook, Twitter). |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
status
|
status | string | |
|
Editável pelo Usuário
|
userEditable | boolean | |
|
Shareable do usuário
|
userShareable | boolean |
Indica se o usuário atual é capaz de compartilhar a postagem. Se nenhum usuário atual, o padrão será true. |
|
Comentário do usuário
|
userCommentable | boolean |
Indica se o usuário atual pode participar de dicussões na postagem. Se nenhum usuário atual, o padrão será false. |
|
Compartilhável
|
sharable | boolean |
Se a plataforma e os widgets permitirão que a postagem seja compartilhada |
|
Transmitido
|
broadcasted | boolean |
Se a postagem foi transmitida aos usuários para compartilhamento |
|
Pinned
|
pinned | boolean |
Se a postagem foi definida para exibição de prioridade em fluxos |
|
Data de Publicação
|
publishDate | date-time |
Para conteúdo enviado pelo usuário, a data da postagem do envio; para o conteúdo importado de uma fonte externa, a data de publicação de acordo com a fonte |
|
Data de Início
|
startDate | date-time |
A data após a qual a postagem está disponível para exibição |
|
Data de Término
|
endDate | date-time |
A data após a qual a postagem não estará mais disponível para exibição |
|
Data de início do evento
|
eventStartDate | date-time |
A data em que o evento começa (para postagens do tipo evento) |
|
Data de término do evento
|
eventEndDate | date-time |
A data em que o evento termina (para postagens do tipo evento) |
|
Carimbo de Data/Hora do Provedor
|
providerTimeStamp | date-time |
A data da postagem da perspectiva dos provedores, ou seja, quando ela foi originalmente postada no provedor social |
|
Pontos de publicação recebidos
|
receivedPublishPoints | boolean |
Se o usuário que enviou a postagem recebeu pontos quando a postagem foi publicada |
|
Texto de compartilhamento sugerido
|
suggestedShareText | string |
O texto de compartilhamento sugerido para a postagem |
|
Texto de compartilhamento sugerido curto
|
shortSuggestedShareText | string |
O texto de compartilhamento sugerido para a postagem para provedores de mensagens curtas |
|
suggestedShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Compartilhar pontos
|
sharePoints | integer |
O número de pontos concedidos quando um usuário compartilha a postagem |
|
Clique em Pontos
|
clickPoints | integer |
O número de pontos concedidos quando alguém clica em um link compartilhado para a postagem |
|
ID de Postagem do Provedor
|
providerPostId | string |
A ID original da postagem na rede de provedores |
|
Url Slug
|
urlSlug | string |
O texto SEO a ser colocado em links públicos para a postagem |
|
Classification
|
classification | string |
O tipo de postagem na rede de provedores. |
|
Compartilhar com imagens
|
shareWithImages | boolean |
Controla se as postagens compartilhadas em serviços de mensagens curtas (como o Twitter) têm imagens compartilhadas |
|
Compartilhar somente imagens
|
shareImagesOnly | boolean |
Controla se as postagens compartilhadas em determinados serviços são tratadas como atualizações somente de imagem/foto |
|
Ações
|
actions | string |
Um blob JSON que contém uma lista de itens de ação para a postagem e URLs |
|
Menções
|
mentions | string |
As menções (usuários, marcas de hash etc.) armazenadas como um blob JSON. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
mídia
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
Visível
|
visible | boolean |
Se a postagem está visível no momento |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Linguagem
|
language | string |
O idioma do conteúdo da postagem |
|
Usuário Oculto
|
userHidden | boolean |
Se o usuário escondeu a postagem de um ou mais fluxos |
|
É exibido pelo usuário
|
isViewedByUser | boolean |
Se a postagem foi exibida pelo usuário atual. |
|
É a discussão exibida pelo usuário
|
isDiscussionViewedByUser | boolean |
Se o thread de discussão de postagens foi exibido pelo usuário atual |
|
É curtido pelo usuário
|
isLikedByUser | boolean |
Se a postagem foi curtida internamente pelo usuário atual. |
|
É comentado pelo usuário
|
isCommentedByUser | boolean |
Se a postagem foi comentada pelo usuário atual. |
|
É compartilhado pelo usuário
|
isSharedByUser | boolean |
Se a postagem foi compartilhada anteriormente pelo usuário atual |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Hora Atual
|
currentTime | date-time |
A hora atual no servidor. |
categoryOverviewResponse
Informações básicas da categoria
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
ID da categoria pai
|
parentCategoryId | integer |
A ID da categoria pai |
targetOverviewResponse
Uma resposta de destino leve que consiste no nome dos destinos, ID e a ID da definição de destino à qual pertence
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome dos destinos |
|
ID
|
id | integer |
A ID de destino |
|
ID de definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
postShareCommentRulesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
Compartilhar limite máximo de caracteres
|
shareMaxCharacterLimit | integer |
O comprimento máximo de um comentário de usuários em um compartilhamento neste provedor. |
postShareDisclosureResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
Nome de Exibição do Provedor
|
providerDisplayName | string |
O nome de exibição dos provedores |
|
Compartilhar Texto de Divulgação
|
shareDisclosureText | string |
O texto de divulgação acrescentado a cada compartilhamento |
postCandidateImageResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
A URL de imagens |
|
Largura
|
width | integer |
A largura das imagens |
|
Altura
|
height | integer |
A altura das imagens |
|
Tipo mime
|
mimeType | string |
O tipo MIME de imagens |
|
Ssl Url
|
sslUrl | string |
A URL segura de imagens |
postMediaRequestResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome do objeto de mídia |
|
Largura
|
width | integer |
A largura do objeto de mídia em pixels |
|
Altura
|
height | integer |
A altura do objeto de mídia em pixels |
|
Tipo mime
|
mimeType | string |
O tipo MIME do objeto de mídia |
|
Html
|
html | string |
HTML que pode ser usado para renderizar o objeto de mídia |
|
URL
|
url | string |
A URL para o objeto de mídia |
|
Origin
|
origin | string |
Se disponível, especifica o local original do objeto de mídia |
|
Fornecedor
|
provider | string |
O nome do provedor social |
|
Função
|
role | string |
O tipo de mídia (se determinado) |
|
Duração
|
duration | integer |
A duração do vídeo em milissegundos |
|
Description
|
description | string |
A descrição do formato de vídeo |
|
Tem URL de Vídeo
|
hasVideoUrl | boolean |
Indica que essa mídia tem uma URL de vídeo que deve ser assinada usando a inclusão "WatchVideo" |
postTagRequestResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome da marca |
postLinkRequestResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
A URL de postagens |
|
Url expandida
|
expandedUrl | string |
A URL expandida (se ela existir) |
|
Title
|
title | string |
O título das postagens |
|
Domínio
|
domain | string |
O domínio de links |
|
Favicon Url
|
faviconUrl | string |
A URL de favicon do link |
|
Nome
|
name | string |
O nome do link atribuído pelo provedor social |
|
Legenda
|
caption | string |
A legenda curta do link (ou seja, o texto no link) |
|
Description
|
description | string |
A descrição do link (ou seja, o texto mais longo na legenda) |
|
Data modificada
|
modifiedDate | date-time | |
|
Data de criação
|
createdDate | date-time |
postAuthorRequestResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Autor
|
author | string |
O texto armazenado a ser exibido como o autor. |
|
URL da Imagem de Perfil
|
profileImageUrl | string |
A imagem de perfil dos autores na rede social |
|
ID do usuário do provedor
|
providerUserId | string |
A ID dos autores na rede social |
|
Nome de Usuário do Provedor
|
providerUserName | string |
O nome dos autores na rede social |
|
URL de Perfil
|
profileUrl | string |
A URL do perfil dos autores na rede social |
|
Nome da origem da postagem
|
postSourceName | string |
O nome da origem da postagem. |
|
Site de origem de postagem
|
postSourceSite | string |
O site no qual a postagem se originou |
postUserShareInfoResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Pontos Ganhos
|
pointsEarned | integer |
O número de pontos ganhos pelo usuário para compartilhamento |
|
Contagem de compartilhamentos
|
shareCount | integer |
O número de vezes que o usuário compartilhou |
|
Data de compartilhamento mais recente
|
mostRecentShareDate | date-time |
Data do compartilhamento mais recente dos usuários desta postagem |
postStatisticsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total na contagem de compartilhamentos de aplicativo
|
totalInAppShareCount | integer |
Sinônimo para ShareCount |
|
ID de acompanhamento
|
trackingId | string | |
|
Contagem de compartilhamentos
|
shareCount | integer |
A contagem de compartilhamentos iniciados no aplicativo que foram verificados como compartilhados com êxito |
|
Contagem de reações
|
reactionCount | integer |
A contagem de reações (likes, retweets etc.) para compartilhamentos |
|
Contagem de impressões
|
impressionCount | integer |
As possíveis exibições de uma postagem de amigos e seguidores do sharers |
|
Contagem visualizada
|
viewedCount | integer |
O número de vezes que a postagem foi visitada por usuários conectados |
|
Clique em Contagem
|
clickCount | integer |
A contagem de cliques no link de postagens de compartilhamentos |
|
Como Contagem
|
likeCount | integer |
A contagem de curtidas internas na postagem |
|
Contagem de comentários
|
commentCount | integer |
A contagem de comentários internos na postagem |
|
Contagem de comentários semelhantes a
|
commentLikeCount | integer |
A soma de todos os likes em todos os comentários internos na postagem |
userOverviewResponse
Informações resumidas sobre um usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Usuário
|
userId | integer |
ID do usuário |
|
Nome de Exibição
|
displayName | string |
Nome de exibição do usuário |
|
profilePictureImages
|
profilePictureImages | object | |
|
Está ativo
|
isActive | boolean |
Se o usuário ainda é um membro ativo da comunidade |
uploadImageResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador de imagem
|
imageIdentifier | string |
O identificador para a imagem carregada |
userRequestResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID interna dos usuários |
|
Email
|
string |
O endereço de email dos usuários |
|
|
Manejar
|
handle | string |
O identificador dos usuários (o "nome de usuário") |
|
Nome de Exibição
|
displayName | string |
O nome de exibição preferencial dos usuários |
|
Nome Completo
|
fullName | string |
O nome e o sobrenome do usuário |
|
Primeiro Nome
|
firstName | string |
O nome dos usuários |
|
Apelido
|
lastName | string |
O sobrenome dos usuários |
|
displayNameFormat
|
displayNameFormat | string | |
|
status
|
status | string | |
|
Perfil Concluído
|
profileCompleted | boolean |
Se o perfil de usuários foi concluído durante a integração |
|
Data da última atividade
|
lastActivityDate | date-time |
A última vez que o usuário interagiu com o sistema. |
|
Title
|
title | string |
O título dos usuários |
|
Localização
|
location | string |
O local auto-descrito pelos usuários (pode não ser uma localização geográfica real) |
|
ID do usuário da API externa
|
externalApiUserId | string |
A ID dos usuários no sistema externo gerenciado pelo chamador dessa API |
|
ID do usuário do gerenciador
|
managerUserId | integer |
A ID do gerenciador de usuários (para recursos de hierarquia organizacional) |
|
Fuso horário
|
timeZone | string |
Fuso horário do usuário representado como um nome de fuso horário de banco de dados tz, conforme definido pela IANA. Exemplo: "América/Los_Angeles". |
|
Fuso horário selecionado
|
selectedTimeZone | string |
Os usuários selecionaram o fuso horário representado como um nome de fuso horário de banco de dados tz, conforme definido pela IANA. Exemplo: "América/Los_Angeles". |
|
Balanceamento de pontos
|
pointBalance | integer |
O total de pontos ganhos até o momento |
|
Pontos não resgatados
|
unredeemedPoints | integer |
Os pontos disponíveis no momento para resgate |
|
Pontos resgatados
|
redeemedPoints | integer |
O número de pontos resgatados ao longo do tempo de vida dos usuários |
|
Informações da API
|
apiInfo | string |
Recipiente de propriedades específico da API |
|
Tem senha
|
hasPassword | boolean |
Se o usuário tem uma senha associada à conta. |
|
Deve alterar senha
|
mustChangePassword | boolean |
Se o usuário deve alterar sua senha com base nas configurações da comunidade |
|
A conta é verificada
|
isAccountVerified | boolean |
Indica se o usuário verificou seu endereço de email |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Emblemas
|
badges | object | |
|
Afiliações
|
affiliations | array of userAffiliationResponse | |
|
Divisões
|
divisions | array of divisionResponse | |
|
canais
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Idiomas
|
languages | array of string | |
|
Língua Primária
|
primaryLanguage | string |
O idioma da interface primária dos usuários |
|
|
scheduleSettings | userScheduleSettingsResponse |
Preferências de compartilhamento agendadas por usuários |
|
É Sso
|
isSso | boolean |
Se o usuário está configurado para autenticar usando o SSO |
|
|
permissions | userPermissionsResponse |
Permissões de gerentes |
|
|
privileges | userPrivilegesResponse |
Privilégios de usuários |
|
Identificadores
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Uma coleção de padrões de usuários |
|
Faixa de boas-vindas ignorada
|
welcomeBannerDismissed | boolean |
Se o usuário descartou a faixa de boas-vindas |
userDefaultsRequestResponse
Uma coleção de padrões de usuários
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Pós-Mostrar Discussões Internas Padrão
|
defaultPostShowInternalDiscussions | boolean |
O estado de discussões internas de postagem padrão dos usuários ao criar uma postagem |
|
Informações padrão do Criador do Post Show
|
defaultPostShowCreatorInfo | boolean |
O estado padrão dos usuários ao criar uma postagem sobre como mostrar o nome do criador e a foto |
allowlistIdentifiersResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID de definição de lista de permissões |
|
Value
|
value | string |
A resposta dos usuários para a definição de lista de permissões fornecida |
userPrivilegesResponse
Privilégios de usuários
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Pode enviar postagens
|
canSubmitPosts | boolean |
Indica se o usuário tem a capacidade de enviar postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode compartilhar postagens
|
canSharePosts | boolean |
Indica se o usuário tem a capacidade de compartilhar postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode comentar postagens
|
canCommentPosts | boolean |
Indica se o usuário tem a capacidade de comentar e curtir postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode gerenciar a comunidade
|
canManageCommunity | boolean |
Indica se o usuário é um gerente dentro da comunidade, com base em seus privilégios e nas configurações da comunidade |
|
Pode gerenciar a organização
|
canManageOrganization | boolean |
Indica se o usuário tem a capacidade de se comunicar com relatórios diretos e indiretos dentro da comunidade, com base em seus privilégios e nas configurações da comunidade |
|
Pode definir Post Shareable
|
canSetPostShareable | boolean |
Se o usuário pode definir o status compartilhável ao enviar uma postagem |
userPermissionsResponse
Permissões de gerentes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Exibir Difusão
|
viewBroadcast | boolean |
Permite que o gerente exiba transmissões |
|
List Broadcast
|
listBroadcast | boolean |
Permite que o gerente exiba listas de transmissões |
|
Editar Difusão
|
editBroadcast | boolean |
Permite que o gerente crie e edite transmissões |
|
Exibir Estatísticas de Difusão
|
viewBroadcastStats | boolean |
Permite que o gerente exiba estatísticas de transmissão |
|
Exibir Postagem
|
viewPost | boolean |
Permite que o gerente exiba postagens |
|
Postagem de Lista
|
listPost | boolean |
Permite que o gerente exiba listas de postagens |
|
Editar Postagem
|
editPost | boolean |
Permite que o gerente crie e edite postagens |
|
Exibir Estatísticas de Postagem
|
viewPostStats | boolean |
Permite que o gerente exiba estatísticas de postagem |
|
Exibir Pesquisa
|
viewSurvey | boolean |
Permite que o gerente exiba pesquisas |
|
Listar Pesquisa
|
listSurvey | boolean |
Permite que o gerente exiba listas de pesquisas |
|
Editar Pesquisa
|
editSurvey | boolean |
Permite que o gerente crie e edite pesquisas |
|
Configurações da comunidade
|
communitySettings | boolean |
Permite que o gerente exiba e edite as configurações da comunidade |
userScheduleSettingsResponse
Preferências de compartilhamento agendadas por usuários
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dias
|
days | string | |
|
vezes
|
times | array of string |
userChannelResponse
Um canal de usuário.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Canal do Usuário
|
userChannelId | integer |
A ID do canal de usuário interno |
|
ID do Usuário
|
userId | integer |
A ID do usuário interno |
|
fornecedor
|
provider | string | |
|
Nome
|
name | string |
O nome dos usuários no provedor social |
|
Nome de Exibição
|
displayName | string |
Os usuários exibem o nome no provedor social |
|
ID do usuário do provedor
|
providerUserId | string |
A ID de usuário dos provedores |
|
status
|
status | string | |
|
URL
|
url | string |
A URL do canal |
|
Amigos
|
friends | integer |
O número de amigos que o usuário tem no canal |
|
Seguidores
|
followers | integer |
O número de seguidores que o usuário tem no canal |
|
Seguindo
|
following | integer |
O número de pessoas que o usuário está seguindo no canal |
|
Posts
|
posts | integer |
O número de postagens que o usuário fez no canal. |
|
Visões
|
views | integer |
O número de exibições que o usuário tem no canal |
|
Balanceamento de pontos
|
pointBalance | integer |
O equilíbrio de pontos do usuário no canal |
|
Nome de exibição de origem
|
sourceDisplayName | string |
O nome de exibição do canal do usuário quando usado como uma fonte de conteúdo |
|
Alcance
|
reach | integer |
Os usuários acessam o canal |
|
Compartilhável
|
sharable | boolean |
Se o canal dá suporte ao compartilhamento |
|
Padrão de compartilhamento
|
sharingDefault | boolean |
Se o canal está pré-selecionado para compartilhamento |
|
Autenticação necessária
|
authRequired | boolean |
Se as credenciais de canais precisam ser renovadas |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
Uma definição de divisão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da divisão
|
divisionId | integer |
A ID da divisão |
|
Nome
|
name | string |
O nome da divisão |
|
ID da divisão pai
|
parentDivisionId | integer |
A ID deste pai de divisões |
userAffiliationResponse
Uma afiliação de usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Uma pergunta de afiliação |
|
|
answer | affiliationAnswerResponse |
Uma resposta de afiliação |
affiliationAnswerResponse
Uma resposta de afiliação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da resposta
|
answerId | integer |
A ID da resposta |
|
Resposta
|
answer | string |
A resposta |
|
Score
|
score | double |
A pontuação, se fornecida |
|
Texto gratuito
|
freeText | string |
Texto para perguntas com o tipo de pergunta FreeText |
|
Recusar a resposta
|
declineToAnswer | boolean |
Se definido, essa é a resposta que significa que um usuário se recusou a responder à pergunta. |
|
Cargo
|
position | integer |
A posição de classificação de respostas |
affiliationQuestionResponse
Uma pergunta de afiliação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da pergunta
|
questionId | integer |
A ID da pergunta |
|
Nome
|
name | string |
A pergunta |
|
Posição de pontuação
|
scorePosition | integer |
A posição de classificação de perguntas |
|
Description
|
description | string |
A descrição das perguntas |
|
questionType
|
questionType | string | |
|
Obrigatório
|
required | boolean |
Se a pergunta precisa ser respondida para se registrar |
|
Está publicamente visível
|
isPubliclyVisible | boolean |
documentInfoResponse
Informações relevantes para um documento anexado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | uuid |
A ID dos documentos |
|
Nome do Arquivo
|
fileName | string |
O nome do arquivo de documentos (com extensão) |
|
Extension
|
extension | string |
A extensão de arquivo de documentos |
|
Tipo mime
|
mimeType | string |
O tipo MIME de documentos |
divisionsResponse
As divisões definidas no sistema
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Divisões
|
divisions | array of divisionResponse | |
|
Rápido
|
prompt | string |
O rótulo para solicitar que os membros selecionem uma divisão |
|
Mostrar Seleção de Divisão de Usuários
|
showUserDivisionSelection | boolean |
Se os membros registrados podem alterar sua própria divisão |
|
Mostrar seleção de divisão de usuário durante a integração
|
showUserDivisionSelectionDuringOnboarding | boolean |
Se novos membros devem selecionar sua própria divisão durante o registro |
|
Exigir seleção de divisão de usuário
|
requireUserDivisionSelection | boolean |
Se os membros devem selecionar sua própria divisão. |
|
Permitir várias divisões
|
allowMultipleDivisions | boolean |
Se os membros têm permissão para selecionar várias ou apenas uma divisão |
categoryResponse1
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
Description
|
description | string |
A descrição da categoria |
|
Ordem de Exibição
|
displayOrder | integer |
A ordem na qual exibir a categoria |
|
Está fixado
|
isPinned | boolean |
Se a categoria foi fixada por um administrador |
|
É forçado
|
isForced | boolean |
Se o usuário autenticado está inscrito à força na categoria determinada |
|
Está inscrito
|
isSubscribed | boolean |
Wther, o usuário autenticado, está inscrito na categoria fornecida |
|
Está oculto
|
isHidden | boolean |
Se a categoria está oculta por um administrador |
|
É selecionável pelo usuário
|
isUserSelectable | boolean |
Se os usuários têm permissão para selecionar categorias para postagens enviadas |
|
ID da categoria pai
|
parentCategoryId | integer |
A ID da categoria pai |
targetInfoResponse1
Informações detalhadas para um destino específico.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descritção de destinos |
|
ID de definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID Principal
|
parentId | integer |
A ID do pai de destino, se ele tiver um |
|
Está inscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Informações detalhadas para um destino específico.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descritção de destinos |
|
ID de definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID Principal
|
parentId | integer |
A ID do pai de destino, se ele tiver um |
|
Está inscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Informações detalhadas para um destino específico.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descritção de destinos |
|
ID de definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID Principal
|
parentId | integer |
A ID do pai de destino, se ele tiver um |
|
Está inscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |