Compartir a través de


Dynamic Signal (versión preliminar)

Dynamic Signal es una plataforma de comunicación y participación de empleados, de confianza para que las organizaciones se conecten, alineen y interactúen con los empleados. Conéctese a Dynamic Signal para crear y administrar sus publicaciones y usuarios.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Metadatos del conector
Publicador Señal dinámica

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Token de portador securestring Token de portador para esta API Cierto
Dirección URL de señal dinámica cuerda / cadena Dirección URL en la que se accede a Dynamic Signal. Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar una publicación

Edita una publicación existente.

Adición de una imagen a una publicación a través de la carga

Establece la imagen de publicación a través de la carga binaria.

Administrar publicaciones

Permite que las llamadas autenticadas por el servidor actualicen las propiedades de varias publicaciones en una sola solicitud.

Agregar una imagen a una publicación a través de la dirección URL

Establece la imagen de publicación a través de una dirección URL.

Anulación del registro de un usuario

Crea un nuevo usuario en el estado registrado previamente.

Cargar imagen

Carga una imagen mediante la carga binaria

Cargar un documento en una publicación

Carga un documento en una publicación a través de la carga binaria

Creación de una publicación

Crea una publicación.

Obtención de destinos

Obtiene una lista de los destinos y definiciones de destino de la comunidad.

Obtención de etiquetas de publicación

Obtiene las etiquetas post definidas en el sistema.

Obtención de etiquetas de usuario

Obtiene una lista de etiquetas de usuario definidas en el sistema.

Obtener categorías

Obtiene una lista de categorías visibles para el usuario autenticado.

Obtener divisiones

Obtiene la lista de divisiones.

Obtener un usuario por correo electrónico

Recupera un usuario por su dirección de correo electrónico

Obtener una publicación

Obtiene una publicación específica por identificador.

Actualizar una publicación

Edita una publicación existente.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
id True uuid

El identificador de publicación

Title
title string

Título de la publicación

Description
description string

Descripción breve de la publicación

Línea de etiqueta
tagLine string

Línea de etiqueta de la publicación

Content
content string

El cuerpo de la publicación

Comentarios del creador
creatorComments string

Mensaje asociado a la publicación

Vínculo de Perma
permaLink string

Dirección URL externa a la que hace referencia la publicación

Discusiones internas habilitadas
internalDiscussionsEnabled boolean

Si los miembros pueden realizar acciones similares y agregar comentarios a las publicaciones internamente

Devoluciones

Una publicación

response
postResponse

Adición de una imagen a una publicación a través de la carga

Establece la imagen de publicación a través de la carga binaria.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
id True uuid

El identificador de publicación

Archivo
File True binary

Archivo que se va a cargar

Tipo de contenido, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
Content-Type True string

Tipo de contenido del archivo cargado

Devoluciones

Una respuesta sencilla que indica que la acción se realizó correctamente

response
successResponse

Administrar publicaciones

Permite que las llamadas autenticadas por el servidor actualicen las propiedades de varias publicaciones en una sola solicitud.

Parámetros

Nombre Clave Requerido Tipo Description
Identificadores posteriores
postIds True array of uuid

Las publicaciones que se están modificando

Etiquetas
tags array of string

Colección de nombres de etiqueta que se pueden aplicar a las publicaciones

Identificadores de división
divisionIds array of integer

Identificadores de división a los que pertenecen las publicaciones

Identificadores de categoría
categoryIds array of integer

Identificador de categoría al que pertenecen las publicaciones

Identificadores de destino
targetIds array of integer

Identificador de destino al que pertenecen las publicaciones

Estado de aprobación
approvalState string

El estado aprobación de las publicaciones (esto no se ve afectado por las solicitudes DELETE)

Devoluciones

Una respuesta sencilla que indica que la acción se realizó correctamente

response
successResponse

Agregar una imagen a una publicación a través de la dirección URL

Establece la imagen de publicación a través de una dirección URL.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
id True uuid

El identificador de publicación, obligatorio: true

URL
url True string

Dirección URL HTTP o HTTPS

Devoluciones

Una respuesta sencilla que indica que la acción se realizó correctamente

response
successResponse

Anulación del registro de un usuario

Crea un nuevo usuario en el estado registrado previamente.

Parámetros

Nombre Clave Requerido Tipo Description
Correo Electrónico
email string

La dirección de correo electrónico del usuario

Id. de usuario del inicio de sesión único externo
externalSsoUserId string

Identificador del usuario en el sistema externo administrado por el proveedor de identidades de SSO

Asa
handle string

Identificador del usuario

Nombre
firstName string

Nombre del usuario.

Apellido
lastName string

Apellidos del usuario.

Identificadores de división
divisionIds array of integer

Lista de divisiones a las que se asignará el usuario.

Identificadores de destino
targetIds array of integer

Lista de destinos que se van a asignar al usuario.

Nombre
name string

El nombre de la etiqueta o atributo

Importancia
value string

Valor opcional

Enviar correo electrónico de invitación
sendInvitationEmail boolean

Determina si se va a enviar un correo electrónico de invitación al usuario.

Mensaje de invitación
invitationMessage string

Mensaje de texto sin formato opcional que se va a incluir en el correo electrónico de invitación.

Notificaciones predeterminadas
notificationsDefault string

Establecer que controla cuándo los usuarios comenzarán a recibir notificaciones por correo electrónico.

Puede compartir publicaciones
canSharePosts boolean

Indica si el usuario tiene la capacidad de compartir publicaciones.

Can Comment Posts
canCommentPosts boolean

Indica si el usuario tiene la capacidad de comentar y gustar las publicaciones.

Puede enviar publicaciones
canSubmitPosts boolean

Indica si el usuario tiene la capacidad de enviar publicaciones.

Puede administrar la organización
canManageOrganization boolean

Indica si el usuario tiene la capacidad de comunicarse con informes directos e indirectos dentro de la comunidad.

Devoluciones

Cargar imagen

Carga una imagen mediante la carga binaria

Parámetros

Nombre Clave Requerido Tipo Description
Archivo
File True binary

Archivo que se va a cargar

Tipo de contenido, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
Content-Type True string

Tipo de contenido del archivo cargado

Devoluciones

Cargar un documento en una publicación

Carga un documento en una publicación a través de la carga binaria

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de archivo
fileName True string

Nombre de archivo preferido del documento (con extensión)

identificación
id True uuid

El identificador de publicación

Archivo
File True binary

Archivo que se va a cargar

Tipo de contenido, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
Content-Type True string

Tipo de contenido del archivo cargado

Devoluciones

Información relevante para un documento adjunto

Creación de una publicación

Crea una publicación.

Parámetros

Nombre Clave Requerido Tipo Description
Description
description string

Descripción breve de la publicación

Línea de etiqueta
tagLine string

Línea de etiqueta de la publicación

Content
content string

El cuerpo de la publicación

Comentarios del creador
creatorComments string

Mensaje asociado a la publicación

Vínculo de Perma
permaLink string

Dirección URL externa a la que hace referencia la publicación

Discusiones internas habilitadas
internalDiscussionsEnabled boolean

Si los miembros pueden realizar acciones similares y agregar comentarios a las publicaciones internamente

Title
title True string

Título de la publicación

Dirección URL de vídeo de miembro
memberVideoUrl string

Dirección URL del vídeo a la que hace referencia la publicación

Tipo de publicación
postType string

El tipo básico de la publicación

Estado de aprobación
approvalState string

Estado de aprobación de la publicación. El valor predeterminado es la configuración De estado de revisión del autor.

Modo de presentación
displayMode string

Indica el redireccionamiento de una publicación a una ubicación interna o externa.

Compartible
sharable boolean

Si la plataforma VoiceStorm y los widgets permitirán que la publicación se comparta.

Fecha de inicio
startDate date-time

Fecha después de la cual la publicación está disponible para su visualización

Fecha de finalización
endDate date-time

Fecha a la que la publicación ya no estará disponible para su visualización.

Texto de recurso compartido sugerido
suggestedShareText string

Texto de recurso compartido sugerido para la publicación

Texto de recurso compartido sugerido breve
shortSuggestedShareText string

Texto de recurso compartido sugerido para la publicación para proveedores de mensajes cortos

Puntos de recursos compartidos
sharePoints integer

Número de puntos concedidos cuando un usuario comparte la publicación

Haga clic en Puntos.
clickPoints integer

Número de puntos concedidos cuando alguien hace clic en un vínculo compartido a la publicación

Uso compartido con imágenes
shareWithImages boolean

Controla si las publicaciones compartidas en servicios de mensajes cortos (como Twitter) tienen imágenes compartidas

Compartir imágenes solo
shareImagesOnly boolean

Controla si las publicaciones compartidas en determinados servicios se tratan como actualizaciones solo de imágenes o fotos.

Nombre
name string

Nombre de etiqueta

Language
language string

Idioma del contenido de la publicación

Documentos
documents array of uuid

Lista de identificadores de documentos que se van a adjuntar a esta publicación

Id. de creador
creatorId integer

El usuario que crea la publicación; Esta propiedad solo está disponible para las solicitudes autenticadas por el servidor en este momento. Todas las demás publicaciones se establecen automáticamente en el usuario autenticado.

Creador de pantalla
displayCreator boolean

Controla si la información del creador se va a mostrar con la publicación o no; Esta propiedad solo está disponible para las solicitudes autenticadas por el servidor en este momento.

Identificadores de categoría
categoryIds array of integer

Lista de identificadores de categoría asignados a la publicación

Identificadores de destino
targetIds array of integer

Lista de identificadores de destino asignados a la publicación

Devoluciones

Una publicación

response
postResponse

Obtención de destinos

Obtiene una lista de los destinos y definiciones de destino de la comunidad.

Devoluciones

Lista de definiciones de destino y destinos asociados para la comunidad.

Obtención de etiquetas de publicación

Obtiene las etiquetas post definidas en el sistema.

Devoluciones

Lista de etiquetas de publicación definidas en el sistema

Obtención de etiquetas de usuario

Obtiene una lista de etiquetas de usuario definidas en el sistema.

Devoluciones

Lista de etiquetas de usuario definidas en el sistema

Obtener categorías

Obtiene una lista de categorías visibles para el usuario autenticado.

Devoluciones

Información detallada relacionada con las categorías

Obtener divisiones

Obtiene la lista de divisiones.

Devoluciones

Divisiones definidas en el sistema

Obtener un usuario por correo electrónico

Recupera un usuario por su dirección de correo electrónico

Parámetros

Nombre Clave Requerido Tipo Description
Correo Electrónico
email True string

Correo electrónico del usuario

Incluir
include array of string

Especifica los datos opcionales que se van a devolver con el usuario.

Devoluciones

Obtener una publicación

Obtiene una publicación específica por identificador.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
id True uuid

El post ID.; Este es el identificador único de la publicación.

Id. de usuario
userId integer

Usuario que está viendo la publicación. El usuario que ha iniciado sesión se usará si no se especifica ningún identificador.

Devoluciones

Una publicación

response
postResponse

Definiciones

successResponse

Una respuesta sencilla que indica que la acción se realizó correctamente

Nombre Ruta de acceso Tipo Description
Código
code string

Un valor de "correcto" indica una operación correcta

targetDefinitionsInfoResponse

Lista de definiciones de destino y destinos asociados para la comunidad.

Nombre Ruta de acceso Tipo Description
definitions
definitions array of targetDefinitionInfoResponse

targetDefinitionInfoResponse

Información detallada de una definición de destino específica y sus destinos asociados

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de la definición de destino

Nombre
name string

Nombre de la definición de destino

Obtener confirmación del usuario
getUserConfirmation boolean

Determina si se le pide a un usuario que confirme o seleccione su preferencia.

Permitir varias selecciones
allowMultipleSelections boolean

Determina si se pueden seleccionar varios destinos.

Selección requerida
selectionRequired boolean

Determina si se requiere una selección en esta definición.

Mensaje de selección de destino
targetSelectionPrompt string

Una etiqueta personalizada para pedir a los usuarios que seleccionen sus preferencias

childTargets
childTargets array of targetInfoResponse

targetInfoResponse

Información detallada de un destino específico.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de destino

Nombre
name string

Nombre del destino

Description
description string

Descritption de destinos

Identificador de definición
definitionId integer

Identificador de la definición de destino a la que pertenece el destino

Id. primario
parentId integer

Identificador del elemento primario de destinos, si tiene uno.

Está suscrito
isSubscribed boolean

Si el usuario está suscrito a un destino específico

childTargets
childTargets array of targetInfoResponse1

managePostTagsResponse

Lista de etiquetas de publicación definidas en el sistema

Nombre Ruta de acceso Tipo Description
tags
tags array of managePostTagResponse

managePostTagResponse

Información detallada de una etiqueta post específica

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de etiqueta

Nombre
name string

Nombre de etiqueta

Está disponible para los miembros
isAvailableToMembers boolean

Determina si la etiqueta se puede usar en páginas de envío posteriores orientadas a miembros (si está habilitada)

manageUserTagsResponse

Lista de etiquetas de usuario definidas en el sistema

Nombre Ruta de acceso Tipo Description
tags
tags array of manageUserTagResponse

manageUserTagResponse

Información detallada de una etiqueta de usuario específica

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de etiqueta

Nombre
name string

Nombre de etiqueta

type
type string
acceptedValues
acceptedValues array of string

categoriesResponse

Información detallada relacionada con las categorías

Nombre Ruta de acceso Tipo Description
categories
categories array of categoryResponse
Solicitud de suscripción
subscriptionPrompt string

Etiqueta para pedir a los miembros que seleccionen suscripciones de categoría.

Habilitar suscripción de categoría
enableCategorySubscription boolean

Si los miembros pueden modificar sus suscripciones de categoría

Requerir selección de suscripción
requireSubscriptionSelection boolean

Si se requiere que los miembros seleccionen suscripciones de categoría durante la incorporación

Categoría predeterminada de la página de aterrizaje
landingPageDefaultCategory integer

El contenido predeterminado que se va a mostrar al cargar la información de la fuente de noticias

categoryResponse

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de categoría

Nombre
name string

El nombre de la categoría

Description
description string

Descripción de la categoría

Mostrar orden
displayOrder integer

Orden en el que se va a mostrar la categoría

Está anclado
isPinned boolean

Si un administrador ha anclado la categoría

Se fuerza
isForced boolean

Si el usuario autenticado está suscrito forzadamente a la categoría especificada

Está suscrito
isSubscribed boolean

Wther the authenticated user is subscribed to the given category (Wther el usuario autenticado se suscribe a la categoría especificada)

Está oculto
isHidden boolean

Si un administrador oculta la categoría

¿Se puede seleccionar el usuario?
isUserSelectable boolean

Si los usuarios pueden seleccionar categorías para las publicaciones enviadas

Id. de categoría principal
parentCategoryId integer

Identificador de categoría principal

childCategories
childCategories array of categoryResponse1

postResponse

Una publicación

Nombre Ruta de acceso Tipo Description
Id. de publicación
postId uuid

El identificador de publicación

Identificador de origen posterior
postSourceId integer

Identificador de origen

Title
title string

Título de la publicación

Description
description string

Descripción breve de la publicación

Línea de etiqueta
tagLine string

Línea de etiqueta de la publicación

Content
content string

El cuerpo de la publicación

Contenido sin formato
rawContent string

El cuerpo de la publicación, incluido todo HTML (cuando se incluyen Content y RawContent)

Comentarios del creador
creatorComments string

Mensaje asociado a la publicación

creatorInfo userOverviewResponse

Información de resumen sobre un usuario

Ubicación
location string

Ubicación geográfica relacionada con la publicación

Propiedades
properties object

Propiedades varias de la publicación. No disponible con todos los tipos de publicación

Vínculo de Perma
permaLink string

Dirección URL externa a la que hace referencia la publicación

Clean Perma Link
cleanPermaLink string

Vínculo permanente (excluyendo espacios problemáticos y nuevas líneas)

postType
postType string
postSourceType
postSourceType string
postBylineType
postBylineType string
Provider
provider string

Proveedor social del que se originó la publicación (por ejemplo, Facebook, Twitter).

approvalState
approvalState string
displayMode
displayMode string
estado
status string
Editable por el usuario
userEditable boolean
Usuario que se puede compartir
userShareable boolean

Indica si el usuario actual puede compartir la publicación. Si no hay ningún usuario actual, el valor predeterminado es true.

User Commentable
userCommentable boolean

Indica si el usuario actual puede participar en dicusiones en la publicación. Si no hay ningún usuario actual, el valor predeterminado es false.

Compartible
sharable boolean

Si la plataforma y los widgets permitirán que la publicación se comparta

Transmitido
broadcasted boolean

Indica si la publicación se ha transmitido a los usuarios para compartir

Anclado
pinned boolean

Indica si la publicación se ha establecido para la visualización de prioridad en secuencias

Fecha de publicación
publishDate date-time

Para el contenido enviado por el usuario, la fecha de envío posterior; para el contenido importado desde un origen externo, la fecha de publicación según el origen

Fecha de inicio
startDate date-time

Fecha después de la cual la publicación está disponible para su visualización

Fecha de finalización
endDate date-time

Fecha a la que la publicación ya no estará disponible para su visualización.

Fecha de inicio del evento
eventStartDate date-time

Fecha en que comienza el evento (para entradas de tipo de evento)

Fecha de finalización del evento
eventEndDate date-time

Fecha en que finaliza el evento (para publicaciones de tipo de evento)

Marca de tiempo del proveedor
providerTimeStamp date-time

La fecha de publicación desde la perspectiva de los proveedores, es decir, cuando se publicó originalmente en el proveedor social

Puntos de publicación recibidos
receivedPublishPoints boolean

Si el usuario que envió la publicación recibió puntos cuando se publicó la publicación

Texto de recurso compartido sugerido
suggestedShareText string

Texto de recurso compartido sugerido para la publicación

Texto de recurso compartido sugerido breve
shortSuggestedShareText string

Texto de recurso compartido sugerido para la publicación para proveedores de mensajes cortos

suggestedShareTextList
suggestedShareTextList array of string
shortSuggestedShareTextList
shortSuggestedShareTextList array of string
Puntos de recursos compartidos
sharePoints integer

Número de puntos concedidos cuando un usuario comparte la publicación

Haga clic en Puntos.
clickPoints integer

Número de puntos concedidos cuando alguien hace clic en un vínculo compartido a la publicación

Id. de publicación del proveedor
providerPostId string

Identificador original de la publicación en la red de proveedores

Url Slug
urlSlug string

Texto seo que se va a poner en enlaces públicos a la publicación

Classification
classification string

Tipo de publicación en la red de proveedores.

Uso compartido con imágenes
shareWithImages boolean

Controla si las publicaciones compartidas en servicios de mensajes cortos (como Twitter) tienen imágenes compartidas

Compartir imágenes solo
shareImagesOnly boolean

Controla si las publicaciones compartidas en determinados servicios se tratan como actualizaciones solo de imágenes o fotos.

Acciones
actions string

Un blob JSON que contiene una lista de elementos de acción para la publicación y las direcciones URL

Menciones
mentions string

Las menciones (usuarios, etiquetas hash, etc.) almacenadas como un blob JSON.

statistics postStatisticsResponse
userShareInfo postUserShareInfoResponse
author postAuthorRequestResponse
Enlaces
links array of postLinkRequestResponse
tags
tags array of postTagRequestResponse
medios
media array of postMediaRequestResponse
images
images object
candidateImages
candidateImages array of postCandidateImageResponse
Visible
visible boolean

Si la publicación está visible actualmente

shareDisclosures
shareDisclosures array of postShareDisclosureResponse
shareCommentRules
shareCommentRules array of postShareCommentRulesResponse
Language
language string

Idioma del contenido de la publicación

Usuario oculto
userHidden boolean

Si el usuario ha ocultado la publicación de uno o varios flujos

Es visto por el usuario
isViewedByUser boolean

Indica si el usuario actual ha visto la publicación.

Se ve la discusión por el usuario
isDiscussionViewedByUser boolean

Si el usuario actual ha visto el subproceso de discusión de publicaciones

Le gusta el usuario
isLikedByUser boolean

Indica si el usuario actual ha gustado internamente la publicación.

Es comentado por el usuario
isCommentedByUser boolean

Indica si el usuario actual ha comentado la publicación.

Es compartido por el usuario
isSharedByUser boolean

Si el usuario actual ha compartido previamente la publicación

targets
targets array of targetOverviewResponse
categories
categories array of categoryOverviewResponse
Hora actual
currentTime date-time

Hora actual en el servidor.

categoryOverviewResponse

Información de categoría básica

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de categoría

Nombre
name string

El nombre de la categoría

Id. de categoría principal
parentCategoryId integer

Identificador de categoría principal

targetOverviewResponse

Una respuesta de destino ligera que consta del nombre, el identificador y el identificador de la definición de destino a la que pertenece.

Nombre Ruta de acceso Tipo Description
Nombre
name string

El nombre de los destinos

identificación
id integer

Identificador de destino

Identificador de definición
definitionId integer

Identificador de la definición de destino a la que pertenece el destino

postShareCommentRulesResponse

Nombre Ruta de acceso Tipo Description
provider
provider string
Límite máximo de caracteres de recurso compartido
shareMaxCharacterLimit integer

Longitud máxima de un comentario de los usuarios en un recurso compartido en este proveedor.

postShareDisclosureResponse

Nombre Ruta de acceso Tipo Description
provider
provider string
Nombre para mostrar del proveedor
providerDisplayName string

El nombre para mostrar de los proveedores

Compartir texto de divulgación
shareDisclosureText string

El texto de divulgación anexado a cada recurso compartido

postCandidateImageResponse

Nombre Ruta de acceso Tipo Description
URL
url string

La dirección URL de las imágenes

Ancho
width integer

Ancho de las imágenes

Altura
height integer

Alto de las imágenes

Tipo mime
mimeType string

Tipo MIME de imágenes

Ssl Url
sslUrl string

Dirección URL segura de imágenes

postMediaRequestResponse

Nombre Ruta de acceso Tipo Description
Nombre
name string

Nombre del objeto multimedia

Ancho
width integer

Ancho del objeto multimedia en píxeles

Altura
height integer

Alto del objeto multimedia en píxeles

Tipo mime
mimeType string

Tipo MIME del objeto multimedia

HTML
html string

HTML que se puede usar para representar el objeto multimedia

URL
url string

Dirección URL del objeto multimedia

Origen
origin string

Si está disponible, especifica la ubicación original del objeto multimedia.

Provider
provider string

El nombre del proveedor de redes sociales

Rol
role string

Tipo de medio (si se determina)

Duración
duration integer

Duración del vídeo en milisegundos

Description
description string

Descripción del formato de vídeo

Tiene dirección URL de vídeo
hasVideoUrl boolean

Indica que este medio tiene una dirección URL de vídeo que debe estar firmada mediante la inclusión "WatchVideo"

postTagRequestResponse

Nombre Ruta de acceso Tipo Description
Nombre
name string

Nombre de etiqueta

postLinkRequestResponse

Nombre Ruta de acceso Tipo Description
URL
url string

Dirección URL de publicaciones

Dirección URL expandida
expandedUrl string

Dirección URL expandida (si existe)

Title
title string

El título de las publicaciones

Dominio
domain string

Dominio de vínculos

Favicon Url
faviconUrl string

Dirección URL de favicon del vínculo

Nombre
name string

Nombre del vínculo asignado por el proveedor de redes sociales

Subtítulo
caption string

Título corto del vínculo (es decir, el texto debajo del vínculo)

Description
description string

Descripción del vínculo (es decir, el texto más largo bajo el título)

Fecha de modificación
modifiedDate date-time
Fecha de creación
createdDate date-time

postAuthorRequestResponse

Nombre Ruta de acceso Tipo Description
Autor
author string

Texto almacenado que se va a mostrar como autor.

Dirección URL de la imagen de perfil
profileImageUrl string

Imagen de perfil de los autores en la red social

Id. de usuario del proveedor
providerUserId string

Identificador de autores en la red social

Nombre de usuario del proveedor
providerUserName string

El nombre de los autores en la red social

Dirección URL del perfil
profileUrl string

La dirección URL del perfil de los autores en la red social

Nombre de origen posterior
postSourceName string

Nombre del origen de la publicación.

Sitio de origen posterior
postSourceSite string

El sitio web en el que se originó la publicación

postUserShareInfoResponse

Nombre Ruta de acceso Tipo Description
Puntos obtenidos
pointsEarned integer

Número de puntos obtenidos por el usuario para compartir

Recuento de recursos compartidos
shareCount integer

Número de veces que el usuario ha compartido

Fecha de uso compartido más reciente
mostRecentShareDate date-time

Fecha de las acciones más recientes de los usuarios de esta publicación

postStatisticsResponse

Nombre Ruta de acceso Tipo Description
Recuento total de recursos compartidos de aplicaciones
totalInAppShareCount integer

Sinónimo de ShareCount

Id. de seguimiento
trackingId string
Recuento de recursos compartidos
shareCount integer

Recuento de recursos compartidos iniciados en la aplicación que se han comprobado como compartidos correctamente.

Recuento de reacciones
reactionCount integer

Recuento de reacciones (likes, retweets, etc.) para los recursos compartidos

Recuento de impresiones
impressionCount integer

Las posibles vistas de una publicación por parte de los amigos y seguidores de sharers

Recuento de visualizaciones
viewedCount integer

Número de veces que los usuarios que han iniciado sesión han visitado la publicación

Haga clic en Recuento.
clickCount integer

Recuento de clics en el vínculo de publicaciones desde recursos compartidos

Like Count
likeCount integer

Recuento de likes internos en la publicación

Recuento de comentarios
commentCount integer

Recuento de comentarios internos en la publicación

Recuento de comentarios similares
commentLikeCount integer

La suma de todos los likes en todos los comentarios internos de la publicación

userOverviewResponse

Información de resumen sobre un usuario

Nombre Ruta de acceso Tipo Description
Id. de usuario
userId integer

Identificador del usuario

Nombre de pantalla
displayName string

Nombre para mostrar del usuario

profilePictureImages
profilePictureImages object
Está activo
isActive boolean

Si el usuario sigue siendo miembro activo de la comunidad

uploadImageResponse

Nombre Ruta de acceso Tipo Description
Identificador de imagen
imageIdentifier string

Identificador de la imagen cargada

userRequestResponse

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador interno de los usuarios

Correo Electrónico
email string

La dirección de correo electrónico de los usuarios

Asa
handle string

El identificador de los usuarios (el "nombre de usuario")

Nombre de pantalla
displayName string

Nombre para mostrar preferido de los usuarios

Nombre completo
fullName string

Nombre y apellido del usuario

Nombre
firstName string

Nombre de los usuarios

Apellido
lastName string

Apellidos de los usuarios

displayNameFormat
displayNameFormat string
estado
status string
Perfil completado
profileCompleted boolean

Si el perfil de los usuarios se completó durante la incorporación

Fecha de la última actividad
lastActivityDate date-time

La última vez que el usuario interactúó con el sistema.

Title
title string

Título de los usuarios

Ubicación
location string

La ubicación autoexcrita de los usuarios (puede que no sea una ubicación geográfica real)

Id. de usuario de api externa
externalApiUserId string

Identificador de usuarios en el sistema externo administrado por el autor de la llamada de esta API

Id. de usuario del administrador
managerUserId integer

Identificador del administrador de usuarios (para las características de la jerarquía organizativa)

Zona horaria
timeZone string

Zona horaria de usuario representada como un nombre de zona horaria de base de datos tz según lo establecido por IANA. Ejemplo: "America/Los_Angeles".

Zona horaria seleccionada
selectedTimeZone string

Los usuarios seleccionaron la zona horaria representada como un nombre de zona horaria de base de datos tz establecida por IANA. Ejemplo: "America/Los_Angeles".

Saldo de punto
pointBalance integer

Los puntos totales obtenidos hasta la fecha

Puntos no bloqueados
unredeemedPoints integer

Los puntos disponibles actualmente para el canje

Puntos canjeados
redeemedPoints integer

Número de puntos canjeados durante la vigencia de los usuarios

Información de API
apiInfo string

Contenedor de propiedades específico de la API

Tiene contraseña
hasPassword boolean

Si el usuario tiene una contraseña asociada a la cuenta.

Debe cambiar la contraseña
mustChangePassword boolean

Si el usuario debe cambiar su contraseña en función de la configuración de la comunidad

¿Se ha comprobado la cuenta?
isAccountVerified boolean

Indica si el usuario ha comprobado su dirección de correo electrónico.

statistics postStatisticsResponse
tags
tags object
Insignias
badges object
Afiliaciones
affiliations array of userAffiliationResponse
divisiones
divisions array of divisionResponse
canales nueva
channels array of userChannelResponse
profilePictureImages
profilePictureImages object
Idiomas
languages array of string
Lengua materna
primaryLanguage string

Idioma de la interfaz principal de los usuarios

scheduleSettings userScheduleSettingsResponse

Preferencias de uso compartido programadas de los usuarios

Is Sso
isSso boolean

Si el usuario está configurado para autenticarse mediante SSO

permissions userPermissionsResponse

Permisos de administradores

privileges userPrivilegesResponse

Privilegios de usuarios

Identificadores
identifiers array of allowlistIdentifiersResponse
targets
targets array of targetOverviewResponse
defaults userDefaultsRequestResponse

Colección de valores predeterminados de los usuarios

Banner de bienvenida descartado
welcomeBannerDismissed boolean

Si el usuario ha descartado el banner de bienvenida

userDefaultsRequestResponse

Colección de valores predeterminados de los usuarios

Nombre Ruta de acceso Tipo Description
defaultPostState
defaultPostState string
defaultPostApprovalState
defaultPostApprovalState string
Publicación predeterminada Mostrar discusiones internas
defaultPostShowInternalDiscussions boolean

Los usuarios publican de forma predeterminada el estado de discusiones internas al crear una publicación.

Mostrar información del creador de publicación predeterminada
defaultPostShowCreatorInfo boolean

El estado predeterminado de los usuarios al crear una publicación con respecto a mostrar el nombre del creador y la foto

allowlistIdentifiersResponse

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de definición de lista de permitidos

Importancia
value string

La respuesta de los usuarios para la definición de lista de permitidos especificada

userPrivilegesResponse

Privilegios de usuarios

Nombre Ruta de acceso Tipo Description
Puede enviar publicaciones
canSubmitPosts boolean

Indica si el usuario tiene la capacidad de enviar publicaciones, en función de sus privilegios y de la configuración de la comunidad.

Puede compartir publicaciones
canSharePosts boolean

Indica si el usuario tiene la capacidad de compartir publicaciones, en función de sus privilegios y la configuración de la comunidad.

Can Comment Posts
canCommentPosts boolean

Indica si el usuario tiene la capacidad de comentar y like publicaciones, en función de sus privilegios y la configuración de la comunidad.

Puede administrar la comunidad
canManageCommunity boolean

Indica si el usuario es un administrador dentro de la comunidad, en función de sus privilegios y de la configuración de la comunidad.

Puede administrar la organización
canManageOrganization boolean

Indica si el usuario tiene la capacidad de comunicarse con informes directos e indirectos dentro de la comunidad, en función de sus privilegios y de la configuración de la comunidad.

Puede establecer post shareable
canSetPostShareable boolean

Si el usuario puede establecer el estado De uso compartido al enviar una publicación

userPermissionsResponse

Permisos de administradores

Nombre Ruta de acceso Tipo Description
Ver difusión
viewBroadcast boolean

Permite al administrador ver las transmisiones

Difusión de lista
listBroadcast boolean

Permite al administrador ver listas de difusión

Editar difusión
editBroadcast boolean

Permite al administrador crear y editar difusiones

Ver estadísticas de difusión
viewBroadcastStats boolean

Permite al administrador ver las estadísticas de difusión

Ver publicación
viewPost boolean

Permite al administrador ver publicaciones

Publicación de lista
listPost boolean

Permite al administrador ver listas de publicaciones

Editar publicación
editPost boolean

Permite al administrador crear y editar publicaciones

Ver estadísticas posteriores
viewPostStats boolean

Permite al administrador ver estadísticas posteriores

Ver encuesta
viewSurvey boolean

Permite al administrador ver encuestas

Enumerar encuesta
listSurvey boolean

Permite al administrador ver listas de encuestas

Editar encuesta
editSurvey boolean

Permite al administrador crear y editar encuestas

Configuración de la comunidad
communitySettings boolean

Permite al administrador ver y editar la configuración de la comunidad

userScheduleSettingsResponse

Preferencias de uso compartido programadas de los usuarios

Nombre Ruta de acceso Tipo Description
Días
days string
veces
times array of string

userChannelResponse

Un canal de usuario.

Nombre Ruta de acceso Tipo Description
Identificador de canal de usuario
userChannelId integer

Identificador interno del canal de usuario

Id. de usuario
userId integer

Identificador de usuario interno

provider
provider string
Nombre
name string

El nombre de los usuarios en el proveedor de redes sociales

Nombre de pantalla
displayName string

Nombre para mostrar de los usuarios en el proveedor de redes sociales

Id. de usuario del proveedor
providerUserId string

Identificador de usuario de proveedores

estado
status string
URL
url string

Dirección URL del canal

Amigos
friends integer

El número de amigos que el usuario tiene en el canal

Seguidores
followers integer

Número de seguidores que el usuario tiene en el canal

Siguiendo
following integer

El número de personas que sigue el usuario en el canal

Posts
posts integer

Número de publicaciones que el usuario ha realizado en el canal.

Views
views integer

El número de vistas que tiene el usuario en el canal

Saldo de punto
pointBalance integer

Saldo de punto del usuario en el canal

Nombre para mostrar de origen
sourceDisplayName string

Nombre para mostrar del canal de usuario cuando se usa como origen de contenido

Alcance
reach integer

Los usuarios llegan al canal

Compartible
sharable boolean

Si el canal admite el uso compartido

Uso compartido predeterminado
sharingDefault boolean

Si el canal está preseleccionado para compartir

Autenticación necesaria
authRequired boolean

Si es necesario renovar las credenciales de los canales

statistics postStatisticsResponse
profilePictureImages
profilePictureImages object

divisionResponse

Definición de división

Nombre Ruta de acceso Tipo Description
Id. de división
divisionId integer

Identificador de división

Nombre
name string

El nombre de la división

Id. de división primaria
parentDivisionId integer

El identificador de este elemento primario de divisiones

userAffiliationResponse

Una afiliación de usuario

Nombre Ruta de acceso Tipo Description
question affiliationQuestionResponse

Una pregunta de afiliación

answer affiliationAnswerResponse

Una respuesta de afiliación

afiliaciónAnswerResponse

Una respuesta de afiliación

Nombre Ruta de acceso Tipo Description
Id. de respuesta
answerId integer

Identificador de respuesta

Respuesta
answer string

La respuesta

Puntuación
score double

Puntuación, si se proporciona

Texto libre
freeText string

Texto para preguntas con el tipo de pregunta FreeText

Rechazar respuesta
declineToAnswer boolean

Si se establece, esta es la respuesta que indica que un usuario rechazó responder a la pregunta.

Position
position integer

Posición de ordenación de respuestas

affiliationQuestionResponse

Una pregunta de afiliación

Nombre Ruta de acceso Tipo Description
Id. de pregunta
questionId integer

Identificador de pregunta

Nombre
name string

La pregunta

Posición de puntuación
scorePosition integer

La posición de ordenación de preguntas

Description
description string

Descripción de las preguntas

questionType
questionType string
Obligatorio
required boolean

Si se debe responder a la pregunta para registrarse

Está visible públicamente
isPubliclyVisible boolean

documentInfoResponse

Información relevante para un documento adjunto

Nombre Ruta de acceso Tipo Description
identificación
id uuid

El identificador de documentos

Nombre de archivo
fileName string

El nombre de archivo de documentos (con extensión)

Extension
extension string

La extensión de archivo documents

Tipo mime
mimeType string

El tipo MIME de documentos

divisionsResponse

Divisiones definidas en el sistema

Nombre Ruta de acceso Tipo Description
divisiones
divisions array of divisionResponse
Pronto
prompt string

Etiqueta para pedir a los miembros que seleccionen una división.

Mostrar selección de división de usuario
showUserDivisionSelection boolean

Si los miembros registrados pueden cambiar su propia división

Mostrar selección de división de usuario durante la incorporación
showUserDivisionSelectionDuringOnboarding boolean

Si los nuevos miembros deben seleccionar su propia división durante el registro

Requerir selección de división de usuario
requireUserDivisionSelection boolean

Si los miembros deben seleccionar su propia división.

Permitir varias divisiones
allowMultipleDivisions boolean

Si los miembros pueden seleccionar varias o solo una división

categoryResponse1

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de categoría

Nombre
name string

El nombre de la categoría

Description
description string

Descripción de la categoría

Mostrar orden
displayOrder integer

Orden en el que se va a mostrar la categoría

Está anclado
isPinned boolean

Si un administrador ha anclado la categoría

Se fuerza
isForced boolean

Si el usuario autenticado está suscrito forzadamente a la categoría especificada

Está suscrito
isSubscribed boolean

Wther the authenticated user is subscribed to the given category (Wther el usuario autenticado se suscribe a la categoría especificada)

Está oculto
isHidden boolean

Si un administrador oculta la categoría

¿Se puede seleccionar el usuario?
isUserSelectable boolean

Si los usuarios pueden seleccionar categorías para las publicaciones enviadas

Id. de categoría principal
parentCategoryId integer

Identificador de categoría principal

targetInfoResponse1

Información detallada de un destino específico.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de destino

Nombre
name string

Nombre del destino

Description
description string

Descritption de destinos

Identificador de definición
definitionId integer

Identificador de la definición de destino a la que pertenece el destino

Id. primario
parentId integer

Identificador del elemento primario de destinos, si tiene uno.

Está suscrito
isSubscribed boolean

Si el usuario está suscrito a un destino específico

childTargets
childTargets array of targetInfoResponse2

targetInfoResponse2

Información detallada de un destino específico.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de destino

Nombre
name string

Nombre del destino

Description
description string

Descritption de destinos

Identificador de definición
definitionId integer

Identificador de la definición de destino a la que pertenece el destino

Id. primario
parentId integer

Identificador del elemento primario de destinos, si tiene uno.

Está suscrito
isSubscribed boolean

Si el usuario está suscrito a un destino específico

childTargets
childTargets array of targetInfoResponse3

targetInfoResponse3

Información detallada de un destino específico.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de destino

Nombre
name string

Nombre del destino

Description
description string

Descritption de destinos

Identificador de definición
definitionId integer

Identificador de la definición de destino a la que pertenece el destino

Id. primario
parentId integer

Identificador del elemento primario de destinos, si tiene uno.

Está suscrito
isSubscribed boolean

Si el usuario está suscrito a un destino específico