Dynamic Signal (préversion)
Dynamic Signal est une plateforme de communication et d’engagement des employés, approuvée par les organisations pour se connecter, aligner et impliquer les employés. Connectez-vous à Dynamic Signal pour créer et gérer vos publications et utilisateurs.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Signal dynamique |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Jeton du porteur | securestring | Jeton du porteur pour cette API | Vrai |
| URL de signal dynamique | ficelle | URL où vous accédez à Dynamic Signal. | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter une image à un billet via le chargement |
Définit l’image post via le chargement binaire. |
| Ajouter une image à un billet via une URL |
Définit l’image de publication via une URL. |
| Charger l’image |
Charge une image via le chargement binaire |
| Charger un document dans un billet |
Charge un document dans un billet via le chargement binaire |
| Créer un billet |
Crée un billet. |
| Gérer les publications |
Permet aux appels authentifiés par le serveur de mettre à jour les propriétés de plusieurs publications dans une seule requête |
| Mettre à jour un billet |
Modifie un billet existant. |
| Obtenir des balises de publication |
Obtient les balises de publication définies dans le système |
| Obtenir des balises utilisateur |
Obtient une liste de balises utilisateur définies dans le système |
| Obtenir des catégories |
Obtient une liste de catégories visibles par l’utilisateur authentifié |
| Obtenir des cibles |
Obtient une liste des définitions cibles et cibles de la communauté |
| Obtenir des divisions |
Obtient la liste des divisions |
| Obtenir un billet |
Obtient un billet spécifique par ID |
| Obtenir un utilisateur par e-mail |
Récupère un utilisateur par son adresse e-mail |
| Préinscrire un utilisateur |
Crée un utilisateur dans l’état préinscriré |
Ajouter une image à un billet via le chargement
Définit l’image post via le chargement binaire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
ID de publication |
|
Fichier
|
File | True | binary |
Fichier à charger |
|
Type de contenu tel que image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Type de contenu du fichier chargé |
Retours
Réponse simple indiquant que l’action a été effectuée avec succès
- response
- successResponse
Ajouter une image à un billet via une URL
Définit l’image de publication via une URL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
L’ID de publication, obligatoire : true |
|
URL
|
url | True | string |
URL HTTP ou HTTPS |
Retours
Réponse simple indiquant que l’action a été effectuée avec succès
- response
- successResponse
Charger l’image
Charge une image via le chargement binaire
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Fichier
|
File | True | binary |
Fichier à charger |
|
Type de contenu tel que image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Type de contenu du fichier chargé |
Retours
- response
- uploadImageResponse
Charger un document dans un billet
Charge un document dans un billet via le chargement binaire
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du fichier
|
fileName | True | string |
Nom de fichier préféré du document (avec extension) |
|
ID
|
id | True | uuid |
ID de publication |
|
Fichier
|
File | True | binary |
Fichier à charger |
|
Type de contenu tel que image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Type de contenu du fichier chargé |
Retours
Informations pertinentes pour un document joint
- response
- documentInfoResponse
Créer un billet
Crée un billet.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Descriptif
|
description | string |
Brève description du billet |
|
|
Ligne d’étiquette
|
tagLine | string |
Ligne d’étiquette du billet |
|
|
Content
|
content | string |
Corps du post |
|
|
Commentaires du créateur
|
creatorComments | string |
Message associé au billet |
|
|
Lien perma
|
permaLink | string |
URL externe référencée par le billet |
|
|
Discussions internes activées
|
internalDiscussionsEnabled | boolean |
Indique si les membres sont autorisés à effectuer des actions similaires et à ajouter des commentaires sur des publications en interne |
|
|
Titre
|
title | True | string |
Titre du billet |
|
URL de la vidéo membre
|
memberVideoUrl | string |
URL vidéo référencée par le billet |
|
|
Type de publication
|
postType | string |
Type de base du billet |
|
|
État d’approbation
|
approvalState | string |
État d’approbation du billet. La valeur par défaut est le paramètre État de révision de l’auteur. |
|
|
Mode d’affichage
|
displayMode | string |
Indique la redirection d’un billet vers un emplacement interne ou externe |
|
|
Partageable
|
sharable | boolean |
Indique si la plateforme et les widgets VoiceStorm autorisent le partage de la publication |
|
|
Date de début
|
startDate | date-time |
Date à laquelle le billet est disponible pour l’affichage |
|
|
Date de fin
|
endDate | date-time |
Date à laquelle le billet ne sera plus disponible pour l’affichage |
|
|
Texte de partage suggéré
|
suggestedShareText | string |
Texte de partage suggéré pour le billet |
|
|
Texte de partage suggéré court
|
shortSuggestedShareText | string |
Texte de partage suggéré pour le billet pour les fournisseurs de messages courts |
|
|
Points de partage
|
sharePoints | integer |
Nombre de points attribués lorsqu’un utilisateur partage le billet |
|
|
Cliquez sur Points
|
clickPoints | integer |
Nombre de points attribués lorsque quelqu’un clique sur un lien partagé vers le billet |
|
|
Partager avec des images
|
shareWithImages | boolean |
Contrôle si les publications partagées sur des services de messages courts (comme Twitter) ont des images partagées |
|
|
Partager des images uniquement
|
shareImagesOnly | boolean |
Contrôle si les publications partagées avec certains services sont traitées comme des mises à jour d’image/photo uniquement |
|
|
Nom
|
name | string |
Nom de la balise |
|
|
Language
|
language | string |
Langue du contenu de publication |
|
|
Documents
|
documents | array of uuid |
Liste des ID de documents à joindre à ce billet |
|
|
ID de créateur
|
creatorId | integer |
Utilisateur qui crée le billet ; Cette propriété est disponible uniquement pour les demandes authentifiées par le serveur pour l’instant. Toutes les autres publications sont automatiquement définies sur l’utilisateur authentifié. |
|
|
Créateur d’affichage
|
displayCreator | boolean |
Contrôle si les informations du créateur doivent être affichées avec le billet ou non ; Cette propriété est disponible uniquement pour les demandes authentifiées par le serveur pour l’instant. |
|
|
ID de catégorie
|
categoryIds | array of integer |
Liste des ID de catégorie qui ont été attribués au billet |
|
|
ID cibles
|
targetIds | array of integer |
Liste des ID cibles qui ont été affectés à la publication |
Retours
Un billet
- response
- postResponse
Gérer les publications
Permet aux appels authentifiés par le serveur de mettre à jour les propriétés de plusieurs publications dans une seule requête
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Post-ID
|
postIds | True | array of uuid |
Les publications en cours de modification |
|
Étiquettes
|
tags | array of string |
Collection de noms d’étiquettes qui peuvent être appliqués aux publications |
|
|
ID de division
|
divisionIds | array of integer |
ID de division auxquels appartiennent les postes |
|
|
ID de catégorie
|
categoryIds | array of integer |
ID de catégorie auquel appartiennent les billets |
|
|
ID cibles
|
targetIds | array of integer |
ID cible auquel appartiennent les publications |
|
|
État d’approbation
|
approvalState | string |
État d’approbation des publications (ceci n’est pas affecté par les demandes DELETE) |
Retours
Réponse simple indiquant que l’action a été effectuée avec succès
- response
- successResponse
Mettre à jour un billet
Modifie un billet existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
ID de publication |
|
Titre
|
title | string |
Titre du billet |
|
|
Descriptif
|
description | string |
Brève description du billet |
|
|
Ligne d’étiquette
|
tagLine | string |
Ligne d’étiquette du billet |
|
|
Content
|
content | string |
Corps du post |
|
|
Commentaires du créateur
|
creatorComments | string |
Message associé au billet |
|
|
Lien perma
|
permaLink | string |
URL externe référencée par le billet |
|
|
Discussions internes activées
|
internalDiscussionsEnabled | boolean |
Indique si les membres sont autorisés à effectuer des actions similaires et à ajouter des commentaires sur des publications en interne |
Retours
Un billet
- response
- postResponse
Obtenir des balises de publication
Obtient les balises de publication définies dans le système
Retours
Liste des balises de publication définies dans le système
- response
- managePostTagsResponse
Obtenir des balises utilisateur
Obtient une liste de balises utilisateur définies dans le système
Retours
Liste des balises utilisateur définies dans le système
- response
- manageUserTagsResponse
Obtenir des catégories
Obtient une liste de catégories visibles par l’utilisateur authentifié
Retours
Informations détaillées relatives aux catégories
- response
- categoriesResponse
Obtenir des cibles
Obtient une liste des définitions cibles et cibles de la communauté
Retours
Liste des définitions cibles et des cibles associées pour la communauté.
- response
- targetDefinitionsInfoResponse
Obtenir des divisions
Obtient la liste des divisions
Retours
Divisions définies dans le système
- response
- divisionsResponse
Obtenir un billet
Obtient un billet spécifique par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
ID de publication. Il s’agit de l’identificateur unique du billet. |
|
ID d’utilisateur
|
userId | integer |
Utilisateur qui consulte le billet. L’utilisateur connecté sera utilisé si aucun ID n’est spécifié |
Retours
Un billet
- response
- postResponse
Obtenir un utilisateur par e-mail
Récupère un utilisateur par son adresse e-mail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Messagerie électronique
|
True | string |
E-mail de l’utilisateur |
|
|
Include
|
include | array of string |
Spécifie les données facultatives à retourner avec l’utilisateur. |
Retours
- response
- userRequestResponse
Préinscrire un utilisateur
Crée un utilisateur dans l’état préinscriré
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Messagerie électronique
|
string |
L’adresse de messagerie de l'utilisateur |
||
|
ID utilisateur de l’authentification unique externe
|
externalSsoUserId | string |
ID de l’utilisateur sur le système externe géré par le fournisseur d’identité SSO |
|
|
Poignée
|
handle | string |
Handle de l’utilisateur |
|
|
Prénom
|
firstName | string |
Prénom de l’utilisateur. |
|
|
Nom de famille
|
lastName | string |
Nom de famille de l’utilisateur. |
|
|
ID de division
|
divisionIds | array of integer |
Liste des divisions auxquelles l’utilisateur sera affecté. |
|
|
ID cibles
|
targetIds | array of integer |
Liste des cibles à affecter à l’utilisateur. |
|
|
Nom
|
name | string |
Nom de l’attribut ou de la balise |
|
|
Valeur
|
value | string |
Valeur facultative |
|
|
Envoyer un e-mail d’invitation
|
sendInvitationEmail | boolean |
Détermine s’il faut envoyer un e-mail d’invitation à l’utilisateur. |
|
|
Message d’invitation
|
invitationMessage | string |
Message texte brut facultatif à inclure dans l’e-mail d’invitation. |
|
|
Notifications par défaut
|
notificationsDefault | string |
Définition de ce contrôle lorsque les utilisateurs commencent à recevoir des notifications par e-mail. |
|
|
Peut partager des publications
|
canSharePosts | boolean |
Indique si l’utilisateur a la possibilité de partager des publications |
|
|
Peut commenter des billets
|
canCommentPosts | boolean |
Indique si l’utilisateur a la possibilité de commenter et d’aimer des publications |
|
|
Peut envoyer des billets
|
canSubmitPosts | boolean |
Indique si l’utilisateur a la possibilité d’envoyer des publications |
|
|
Peut gérer l’organisation
|
canManageOrganization | boolean |
Indique si l’utilisateur a la possibilité de communiquer avec des rapports directs et indirects au sein de la communauté |
Retours
- response
- userRequestResponse
Définitions
successResponse
Réponse simple indiquant que l’action a été effectuée avec succès
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code
|
code | string |
Une valeur de « réussite » indique une opération réussie |
targetDefinitionsInfoResponse
Liste des définitions cibles et des cibles associées pour la communauté.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Informations détaillées pour une définition de cible spécifique et ses cibles associées
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de la définition cible |
|
Nom
|
name | string |
Nom de la définition cible |
|
Obtenir la confirmation de l’utilisateur
|
getUserConfirmation | boolean |
Détermine si un utilisateur est invité à confirmer/sélectionner sa préférence |
|
Autoriser plusieurs sélections
|
allowMultipleSelections | boolean |
Détermine si plusieurs cibles peuvent être sélectionnées |
|
Sélection requise
|
selectionRequired | boolean |
Détermine si une sélection dans cette définition est requise |
|
Invite de sélection cible
|
targetSelectionPrompt | string |
Étiquette personnalisée pour inviter les utilisateurs à sélectionner leur préférence |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Informations détaillées pour une cible spécifique.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID cible |
|
Nom
|
name | string |
Nom de la cible |
|
Descriptif
|
description | string |
Les cibles déscritption |
|
ID de définition
|
definitionId | integer |
ID de la définition cible à laquelle appartient la cible |
|
Parent ID
|
parentId | integer |
ID du parent cible, s’il en a un |
|
Est abonné
|
isSubscribed | boolean |
Indique si l’utilisateur est abonné à une cible spécifique |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
Liste des balises de publication définies dans le système
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Informations détaillées pour une balise de publication spécifique
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de balise |
|
Nom
|
name | string |
Nom de la balise |
|
Est disponible pour les membres
|
isAvailableToMembers | boolean |
Détermine si la balise peut être utilisée sur les pages de soumission de post-membre (si activée) |
manageUserTagsResponse
Liste des balises utilisateur définies dans le système
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Informations détaillées pour une balise utilisateur spécifique
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de balise |
|
Nom
|
name | string |
Nom de la balise |
|
type
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
Informations détaillées relatives aux catégories
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Invite d’abonnement
|
subscriptionPrompt | string |
Étiquette permettant d’inviter les membres à sélectionner des abonnements de catégorie |
|
Activer l’abonnement de catégorie
|
enableCategorySubscription | boolean |
Indique si les membres sont autorisés à modifier leurs abonnements de catégorie |
|
Exiger une sélection d’abonnement
|
requireSubscriptionSelection | boolean |
Indique si les membres doivent sélectionner des abonnements de catégorie lors de l’intégration |
|
Catégorie par défaut de la page d’accueil
|
landingPageDefaultCategory | integer |
Contenu par défaut à afficher lors du chargement des informations du flux d’actualités |
categoryResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de catégorie |
|
Nom
|
name | string |
Nom de la catégorie |
|
Descriptif
|
description | string |
Description de la catégorie |
|
Afficher l’ordre
|
displayOrder | integer |
Ordre dans lequel afficher la catégorie |
|
Est épinglé
|
isPinned | boolean |
Indique si la catégorie a été épinglée par un administrateur |
|
Est forcé
|
isForced | boolean |
Indique si l’utilisateur authentifié est abonné par force à la catégorie donnée |
|
Est abonné
|
isSubscribed | boolean |
Wther l’utilisateur authentifié est abonné à la catégorie donnée |
|
Est masqué
|
isHidden | boolean |
Indique si la catégorie est masquée par un administrateur |
|
Est sélectionnable par l’utilisateur
|
isUserSelectable | boolean |
Indique si les utilisateurs sont autorisés à sélectionner des catégories pour les publications soumises |
|
ID de catégorie parent
|
parentCategoryId | integer |
ID de catégorie parente |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
Un billet
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de publication
|
postId | uuid |
ID de publication |
|
Post Source ID
|
postSourceId | integer |
The source ID |
|
Titre
|
title | string |
Titre du billet |
|
Descriptif
|
description | string |
Brève description du billet |
|
Ligne d’étiquette
|
tagLine | string |
Ligne d’étiquette du billet |
|
Content
|
content | string |
Corps du post |
|
Contenu brut
|
rawContent | string |
Corps du billet incluant tout le code HTML (lorsque Contenu et RawContent sont inclus) |
|
Commentaires du créateur
|
creatorComments | string |
Message associé au billet |
|
|
creatorInfo | userOverviewResponse |
Informations récapitulatives sur un utilisateur |
|
Emplacement
|
location | string |
Emplacement géographique lié au billet |
|
Propriétés
|
properties | object |
Propriétés diverses du billet. Non disponible avec tous les types de publication |
|
Lien perma
|
permaLink | string |
URL externe référencée par le billet |
|
Nettoyer le lien Perma
|
cleanPermaLink | string |
Permalink (à l’exclusion d’espaces problématiques et de lignes nouvelles) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
Fournisseur social à partir duquel le billet provient (par exemple, Facebook, Twitter). |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
status
|
status | string | |
|
Modifiable par l’utilisateur
|
userEditable | boolean | |
|
Partage d’utilisateurs
|
userShareable | boolean |
Indique si l’utilisateur actuel est en mesure de partager le billet. Si aucun utilisateur actuel n’a la valeur true, la valeur par défaut est true. |
|
Commentable utilisateur
|
userCommentable | boolean |
Indique si l’utilisateur actuel est en mesure de participer à des dicussions sur le billet. Si aucun utilisateur actuel n’est utilisé, la valeur par défaut est false. |
|
Partageable
|
sharable | boolean |
Indique si la plateforme et les widgets autorisent le partage de la publication |
|
Diffusé
|
broadcasted | boolean |
Indique si la publication a été diffusée aux utilisateurs pour le partage |
|
Épinglé
|
pinned | boolean |
Indique si la publication a été définie pour l’affichage de priorité dans les flux |
|
Date de publication
|
publishDate | date-time |
Pour le contenu soumis par l’utilisateur, la date de publication ; pour le contenu importé à partir d’une source externe, la date de publication en fonction de la source |
|
Date de début
|
startDate | date-time |
Date à laquelle le billet est disponible pour l’affichage |
|
Date de fin
|
endDate | date-time |
Date à laquelle le billet ne sera plus disponible pour l’affichage |
|
Date de début de l’événement
|
eventStartDate | date-time |
Date de début de l’événement (pour les publications de type événement) |
|
Date de fin de l’événement
|
eventEndDate | date-time |
Date de fin de l’événement (pour les publications de type événement) |
|
Horodatage du fournisseur
|
providerTimeStamp | date-time |
Date de la publication du point de vue des fournisseurs, c’est-à-dire quand elle a été publiée à l’origine sur le fournisseur social |
|
Points de publication reçus
|
receivedPublishPoints | boolean |
Indique si l’utilisateur qui a envoyé le billet a reçu des points lors de la publication du billet |
|
Texte de partage suggéré
|
suggestedShareText | string |
Texte de partage suggéré pour le billet |
|
Texte de partage suggéré court
|
shortSuggestedShareText | string |
Texte de partage suggéré pour le billet pour les fournisseurs de messages courts |
|
suggestionShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Points de partage
|
sharePoints | integer |
Nombre de points attribués lorsqu’un utilisateur partage le billet |
|
Cliquez sur Points
|
clickPoints | integer |
Nombre de points attribués lorsque quelqu’un clique sur un lien partagé vers le billet |
|
ID de publication du fournisseur
|
providerPostId | string |
ID d’origine du billet sur le réseau des fournisseurs |
|
Url Slug
|
urlSlug | string |
Le texte SEO pour mettre en ligne des liens publics vers le post |
|
Classification
|
classification | string |
Type de publication sur le réseau des fournisseurs. |
|
Partager avec des images
|
shareWithImages | boolean |
Contrôle si les publications partagées sur des services de messages courts (comme Twitter) ont des images partagées |
|
Partager des images uniquement
|
shareImagesOnly | boolean |
Contrôle si les publications partagées avec certains services sont traitées comme des mises à jour d’image/photo uniquement |
|
Actions
|
actions | string |
Objet blob JSON contenant une liste d’éléments d’action pour la publication et les URL |
|
Mentions
|
mentions | string |
Les mentions (utilisateurs, balises de hachage, etc.) stockées en tant qu’objet 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 | |
|
Visible
|
visible | boolean |
Indique si le billet est actuellement visible |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Language
|
language | string |
Langue du contenu de publication |
|
Utilisateur masqué
|
userHidden | boolean |
Indique si l’utilisateur a masqué la publication à partir d’un ou plusieurs flux |
|
Est consulté par l’utilisateur
|
isViewedByUser | boolean |
Indique si la publication a été consultée par l’utilisateur actuel. |
|
Discussion consultée par l’utilisateur
|
isDiscussionViewedByUser | boolean |
Indique si le thread de discussion des publications a été consulté par l’utilisateur actuel |
|
Est aimé par l’utilisateur
|
isLikedByUser | boolean |
Indique si la publication a été aimée en interne par l’utilisateur actuel. |
|
Est commenté par l’utilisateur
|
isCommentedByUser | boolean |
Indique si le billet a été commenté par l’utilisateur actuel. |
|
Est partagé par l’utilisateur
|
isSharedByUser | boolean |
Indique si la publication a été précédemment partagée par l’utilisateur actuel |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Heure actuelle
|
currentTime | date-time |
Heure actuelle sur le serveur. |
categoryOverviewResponse
Informations de catégorie de base
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de catégorie |
|
Nom
|
name | string |
Nom de la catégorie |
|
ID de catégorie parent
|
parentCategoryId | integer |
ID de catégorie parente |
targetOverviewResponse
Réponse cible légère composée du nom, de l’ID et de l’ID de la définition cible à laquelle elle appartient
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom des cibles |
|
ID
|
id | integer |
ID de cible |
|
ID de définition
|
definitionId | integer |
ID de la définition cible à laquelle appartient la cible |
postShareCommentRulesResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
Limite maximale des caractères de partage
|
shareMaxCharacterLimit | integer |
Longueur maximale d’un commentaire utilisateur dans un partage sur ce fournisseur. |
postShareDisclosureResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
Nom complet du fournisseur
|
providerDisplayName | string |
Nom complet des fournisseurs |
|
Partager le texte de divulgation
|
shareDisclosureText | string |
Texte de divulgation ajouté à chaque partage |
postCandidateImageResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL des images |
|
Largeur
|
width | integer |
Largeur des images |
|
Hauteur
|
height | integer |
Hauteur des images |
|
Mime Type
|
mimeType | string |
Type MIME d’images |
|
Ssl Url
|
sslUrl | string |
URL sécurisée des images |
postMediaRequestResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom de l’objet multimédia |
|
Largeur
|
width | integer |
Largeur de l’objet multimédia en pixels |
|
Hauteur
|
height | integer |
Hauteur de l’objet multimédia en pixels |
|
Mime Type
|
mimeType | string |
Type MIME de l’objet multimédia |
|
HTML
|
html | string |
HTML qui peut être utilisé pour afficher l’objet multimédia |
|
URL
|
url | string |
URL de l’objet multimédia |
|
Origine
|
origin | string |
Si disponible, spécifie l’emplacement d’origine de l’objet multimédia |
|
Provider
|
provider | string |
Nom du fournisseur social |
|
Role
|
role | string |
Type de média (si déterminé) |
|
Durée
|
duration | integer |
Durée de la vidéo en millisecondes |
|
Descriptif
|
description | string |
Description du format vidéo |
|
Contient l’URL de la vidéo
|
hasVideoUrl | boolean |
Indique que ce média a une URL vidéo qui doit être signée à l’aide de l’élément « WatchVideo » |
postTagRequestResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom de la balise |
postLinkRequestResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL des billets |
|
URL développée
|
expandedUrl | string |
URL développée (s’il existe) |
|
Titre
|
title | string |
Titre des billets |
|
Domain
|
domain | string |
Domaine des liens |
|
Favicon Url
|
faviconUrl | string |
URL favicon du lien |
|
Nom
|
name | string |
Nom du lien attribué par le fournisseur social |
|
Légende
|
caption | string |
Légende abrégée du lien (c’est-à-dire le texte sous le lien) |
|
Descriptif
|
description | string |
Description du lien (c’est-à-dire le texte le plus long sous la légende) |
|
Date de modification
|
modifiedDate | date-time | |
|
Date de création
|
createdDate | date-time |
postAuthorRequestResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Auteur
|
author | string |
Texte stocké à afficher en tant qu’auteur. |
|
URL de l’image de profil
|
profileImageUrl | string |
L’image du profil des auteurs sur le réseau social |
|
ID d’utilisateur du fournisseur
|
providerUserId | string |
ID des auteurs sur le réseau social |
|
Nom d’utilisateur du fournisseur
|
providerUserName | string |
Nom des auteurs sur le réseau social |
|
URL du profil
|
profileUrl | string |
URL du profil des auteurs sur le réseau social |
|
Nom de la source post
|
postSourceName | string |
Nom de la source du billet. |
|
Post Source Site
|
postSourceSite | string |
Le site web dans lequel le billet provient |
postUserShareInfoResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Points gagnés
|
pointsEarned | integer |
Nombre de points gagnés par l’utilisateur pour le partage |
|
Nombre de partages
|
shareCount | integer |
Nombre de fois où l’utilisateur a partagé |
|
Date de partage la plus récente
|
mostRecentShareDate | date-time |
Date du partage le plus récent des utilisateurs de ce billet |
postStatisticsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Total dans le nombre de partages d’applications
|
totalInAppShareCount | integer |
Synonyme de ShareCount |
|
ID de suivi
|
trackingId | string | |
|
Nombre de partages
|
shareCount | integer |
Nombre de partages lancés dans l’application qui ont été vérifiés comme partagés avec succès |
|
Nombre de réactions
|
reactionCount | integer |
Nombre de réactions (likes, retweets, etc.) à des partages |
|
Nombre d’impression
|
impressionCount | integer |
Les vues potentielles d’un billet par des amis et des abonnés partageurs |
|
Nombre d’affichages
|
viewedCount | integer |
Nombre de fois où le billet a été visité par les utilisateurs connectés |
|
Nombre de clics
|
clickCount | integer |
Nombre de clics vers le lien de publications à partir de partages |
|
Like Count
|
likeCount | integer |
Nombre de likes internes sur le billet |
|
Nombre de commentaires
|
commentCount | integer |
Nombre de commentaires internes sur le billet |
|
Commentaire comme nombre
|
commentLikeCount | integer |
Somme de tous les commentaires internes sur le billet |
userOverviewResponse
Informations récapitulatives sur un utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
userId | integer |
ID de l’utilisateur |
|
Nom d’affichage
|
displayName | string |
Nom d’affichage de l’utilisateur |
|
profilePictureImages
|
profilePictureImages | object | |
|
Est actif
|
isActive | boolean |
Indique si l’utilisateur est toujours membre actif de la communauté |
uploadImageResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Identificateur d’image
|
imageIdentifier | string |
Identificateur de l’image chargée |
userRequestResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID interne des utilisateurs |
|
Messagerie électronique
|
string |
Adresse e-mail des utilisateurs |
|
|
Poignée
|
handle | string |
Les utilisateurs gèrent (le « nom d’utilisateur ») |
|
Nom d’affichage
|
displayName | string |
Nom d’affichage préféré des utilisateurs |
|
Nom complet
|
fullName | string |
Prénom et nom de l’utilisateur |
|
Prénom
|
firstName | string |
Prénom des utilisateurs |
|
Nom de famille
|
lastName | string |
Nom d’utilisateur |
|
displayNameFormat
|
displayNameFormat | string | |
|
status
|
status | string | |
|
Profil terminé
|
profileCompleted | boolean |
Indique si le profil des utilisateurs a été terminé lors de l’intégration |
|
Date de la dernière activité
|
lastActivityDate | date-time |
La dernière fois que l’utilisateur a interagissant avec le système. |
|
Titre
|
title | string |
Titre des utilisateurs |
|
Emplacement
|
location | string |
L’emplacement auto-décrit par les utilisateurs (peut ne pas être un emplacement géographique réel) |
|
ID utilisateur de l’API externe
|
externalApiUserId | string |
ID des utilisateurs sur le système externe géré par l’appelant de cette API |
|
ID d’utilisateur du gestionnaire
|
managerUserId | integer |
ID du gestionnaire d’utilisateurs (pour les fonctionnalités de hiérarchie organisationnelle) |
|
Fuseau horaire
|
timeZone | string |
Fuseau horaire utilisateur représenté sous la forme d’un nom de fuseau horaire de base de données tz défini par IANA. Exemple : « America/Los_Angeles ». |
|
Fuseau horaire sélectionné
|
selectedTimeZone | string |
Les utilisateurs ont sélectionné le fuseau horaire représenté sous la forme d’un nom de fuseau horaire de base de données tz défini par IANA. Exemple : « America/Los_Angeles ». |
|
Équilibre de point
|
pointBalance | integer |
Nombre total de points gagnés à ce jour |
|
Points non considérés
|
unredeemedPoints | integer |
Les points actuellement disponibles pour l’échange |
|
Points échangés
|
redeemedPoints | integer |
Nombre de points échangés pendant la durée de vie des utilisateurs |
|
Informations sur l’API
|
apiInfo | string |
Conteneur de propriétés spécifique à l’API |
|
Possède un mot de passe
|
hasPassword | boolean |
Indique si l’utilisateur a un mot de passe associé au compte. |
|
Doit modifier le mot de passe
|
mustChangePassword | boolean |
Indique si l’utilisateur doit modifier son mot de passe en fonction des paramètres de la communauté |
|
Est-ce que le compte est vérifié
|
isAccountVerified | boolean |
Indique si l’utilisateur a vérifié son adresse e-mail |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Badges
|
badges | object | |
|
Affiliations
|
affiliations | array of userAffiliationResponse | |
|
Divisions
|
divisions | array of divisionResponse | |
|
channels
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
langues
|
languages | array of string | |
|
Langue principale
|
primaryLanguage | string |
Langue de l’interface principale des utilisateurs |
|
|
scheduleSettings | userScheduleSettingsResponse |
Préférences de partage planifiées pour les utilisateurs |
|
Is Sso
|
isSso | boolean |
Indique si l’utilisateur est configuré pour s’authentifier à l’aide de l’authentification unique |
|
|
permissions | userPermissionsResponse |
Autorisations des gestionnaires |
|
|
privileges | userPrivilegesResponse |
Privilèges des utilisateurs |
|
Identificateurs
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Collection d’utilisateurs par défaut |
|
Bannière de bienvenue ignorée
|
welcomeBannerDismissed | boolean |
Indique si l’utilisateur a ignoré la bannière de bienvenue |
userDefaultsRequestResponse
Collection d’utilisateurs par défaut
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Publication par défaut afficher les discussions internes
|
defaultPostShowInternalDiscussions | boolean |
Les utilisateurs publient par défaut l’état des discussions internes lors de la création d’un billet |
|
Afficher les informations de créateur par défaut
|
defaultPostShowCreatorInfo | boolean |
État par défaut des utilisateurs lors de la création d’un billet concernant l’affichage du nom et de la photo du créateur |
allowlistIdentifiersResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de définition de liste verte |
|
Valeur
|
value | string |
Réponse des utilisateurs pour la définition de liste verte donnée |
userPrivilegesResponse
Privilèges des utilisateurs
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Peut envoyer des billets
|
canSubmitPosts | boolean |
Indique si l’utilisateur a la possibilité d’envoyer des publications, en fonction de ses privilèges et des paramètres de la communauté |
|
Peut partager des publications
|
canSharePosts | boolean |
Indique si l’utilisateur a la possibilité de partager des publications, en fonction de ses privilèges et des paramètres de la communauté |
|
Peut commenter des billets
|
canCommentPosts | boolean |
Indique si l’utilisateur a la possibilité de commenter et d’aimer des publications, en fonction de ses privilèges et des paramètres de la communauté |
|
Peut gérer la communauté
|
canManageCommunity | boolean |
Indique si l’utilisateur est un responsable au sein de la communauté, en fonction de ses privilèges et des paramètres de la communauté |
|
Peut gérer l’organisation
|
canManageOrganization | boolean |
Indique si l’utilisateur a la possibilité de communiquer avec des rapports directs et indirects au sein de la communauté, en fonction de ses privilèges et des paramètres de la communauté |
|
Peut définir une publication partageable
|
canSetPostShareable | boolean |
Indique si l’utilisateur peut définir l’état partageable lors de l’envoi d’un billet |
userPermissionsResponse
Autorisations des gestionnaires
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Afficher la diffusion
|
viewBroadcast | boolean |
Permet au gestionnaire d’afficher les diffusions |
|
Lister la diffusion
|
listBroadcast | boolean |
Permet au gestionnaire d’afficher les listes de diffusions |
|
Modifier la diffusion
|
editBroadcast | boolean |
Permet au gestionnaire de créer et de modifier des diffusions |
|
Afficher les statistiques de diffusion
|
viewBroadcastStats | boolean |
Permet au gestionnaire d’afficher les statistiques de diffusion |
|
Afficher la publication
|
viewPost | boolean |
Permet au responsable d’afficher les publications |
|
Publication de liste
|
listPost | boolean |
Permet au responsable d’afficher les listes de publications |
|
Modifier la publication
|
editPost | boolean |
Permet au responsable de créer et de modifier des publications |
|
Afficher les statistiques de publication
|
viewPostStats | boolean |
Permet au responsable d’afficher les statistiques de publication |
|
Afficher l’enquête
|
viewSurvey | boolean |
Permet au responsable d’afficher les enquêtes |
|
Lister l’enquête
|
listSurvey | boolean |
Permet au responsable d’afficher les listes d’enquêtes |
|
Modifier l’enquête
|
editSurvey | boolean |
Permet au responsable de créer et de modifier des enquêtes |
|
Paramètres de la communauté
|
communitySettings | boolean |
Permet au gestionnaire d’afficher et de modifier les paramètres de la communauté |
userScheduleSettingsResponse
Préférences de partage planifiées pour les utilisateurs
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Jours
|
days | string | |
|
fois
|
times | array of string |
userChannelResponse
Canal utilisateur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de canal utilisateur
|
userChannelId | integer |
ID de canal utilisateur interne |
|
ID d’utilisateur
|
userId | integer |
ID d’utilisateur interne |
|
provider
|
provider | string | |
|
Nom
|
name | string |
Nom des utilisateurs sur le fournisseur social |
|
Nom d’affichage
|
displayName | string |
Nom d’affichage des utilisateurs sur le fournisseur social |
|
ID d’utilisateur du fournisseur
|
providerUserId | string |
ID d’utilisateur des fournisseurs |
|
status
|
status | string | |
|
URL
|
url | string |
URL du canal |
|
Amis
|
friends | integer |
Nombre d’amis que l’utilisateur a sur le canal |
|
Abonnés
|
followers | integer |
Nombre d’abonnés que l’utilisateur a sur le canal |
|
Suivi
|
following | integer |
Le nombre de personnes que l’utilisateur suit sur le canal |
|
Posts
|
posts | integer |
Nombre de publications effectuées par l’utilisateur sur le canal. |
|
Points de vue
|
views | integer |
Nombre de vues que l’utilisateur a sur le canal |
|
Équilibre de point
|
pointBalance | integer |
Équilibre de point de l’utilisateur sur le canal |
|
Nom d’affichage de la source
|
sourceDisplayName | string |
Nom complet du canal utilisateur lorsqu’il est utilisé comme source de contenu |
|
Reach
|
reach | integer |
Les utilisateurs atteignent le canal |
|
Partageable
|
sharable | boolean |
Indique si le canal prend en charge le partage |
|
Partage par défaut
|
sharingDefault | boolean |
Indique si le canal est préélectionné pour le partage |
|
Authentification requise
|
authRequired | boolean |
Indique si les informations d’identification des canaux doivent être renouvelées |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
Définition d’une division
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Division ID
|
divisionId | integer |
ID de division |
|
Nom
|
name | string |
Nom de la division |
|
Parent Division ID
|
parentDivisionId | integer |
ID de ce parent de divisions |
userAffiliationResponse
Affiliation d’utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Une question d’affiliation |
|
|
answer | affiliationAnswerResponse |
Réponse d’affiliation |
affiliationAnswerResponse
Réponse d’affiliation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de réponse
|
answerId | integer |
ID de réponse |
|
Réponse
|
answer | string |
Réponse |
|
Score
|
score | double |
Score, s’il est fourni |
|
Texte libre
|
freeText | string |
Texte pour questions avec le type de question FreeText |
|
Refuser de répondre
|
declineToAnswer | boolean |
Si elle est définie, il s’agit de la réponse indiquant qu’un utilisateur a refusé de répondre à la question. |
|
Poste
|
position | integer |
Position de tri des réponses |
affiliationQuestionResponse
Une question d’affiliation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de question
|
questionId | integer |
ID de la question |
|
Nom
|
name | string |
La question |
|
Score Position
|
scorePosition | integer |
Position de tri des questions |
|
Descriptif
|
description | string |
Description des questions |
|
questionType
|
questionType | string | |
|
Obligatoire
|
required | boolean |
Si la question doit être répondue à l’inscription |
|
Est visible publiquement
|
isPubliclyVisible | boolean |
documentInfoResponse
Informations pertinentes pour un document joint
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | uuid |
ID de document |
|
Nom du fichier
|
fileName | string |
Nom de fichier des documents (avec extension) |
|
Extension
|
extension | string |
Extension de fichier de documents |
|
Mime Type
|
mimeType | string |
Type MIME de documents |
divisionsResponse
Divisions définies dans le système
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Divisions
|
divisions | array of divisionResponse | |
|
Prompt
|
prompt | string |
Étiquette permettant d’inviter les membres à sélectionner une division |
|
Afficher la sélection de division d’utilisateurs
|
showUserDivisionSelection | boolean |
Indique si les membres inscrits peuvent modifier leur propre division |
|
Afficher la sélection de division d’utilisateurs lors de l’intégration
|
showUserDivisionSelectionDuringOnboarding | boolean |
Indique si les nouveaux membres doivent sélectionner leur propre division lors de l’inscription |
|
Exiger une sélection de division d’utilisateurs
|
requireUserDivisionSelection | boolean |
Indique si les membres doivent sélectionner leur propre division. |
|
Autoriser plusieurs divisions
|
allowMultipleDivisions | boolean |
Indique si les membres sont autorisés à sélectionner plusieurs ou une seule division |
categoryResponse1
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID de catégorie |
|
Nom
|
name | string |
Nom de la catégorie |
|
Descriptif
|
description | string |
Description de la catégorie |
|
Afficher l’ordre
|
displayOrder | integer |
Ordre dans lequel afficher la catégorie |
|
Est épinglé
|
isPinned | boolean |
Indique si la catégorie a été épinglée par un administrateur |
|
Est forcé
|
isForced | boolean |
Indique si l’utilisateur authentifié est abonné par force à la catégorie donnée |
|
Est abonné
|
isSubscribed | boolean |
Wther l’utilisateur authentifié est abonné à la catégorie donnée |
|
Est masqué
|
isHidden | boolean |
Indique si la catégorie est masquée par un administrateur |
|
Est sélectionnable par l’utilisateur
|
isUserSelectable | boolean |
Indique si les utilisateurs sont autorisés à sélectionner des catégories pour les publications soumises |
|
ID de catégorie parent
|
parentCategoryId | integer |
ID de catégorie parente |
targetInfoResponse1
Informations détaillées pour une cible spécifique.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID cible |
|
Nom
|
name | string |
Nom de la cible |
|
Descriptif
|
description | string |
Les cibles déscritption |
|
ID de définition
|
definitionId | integer |
ID de la définition cible à laquelle appartient la cible |
|
Parent ID
|
parentId | integer |
ID du parent cible, s’il en a un |
|
Est abonné
|
isSubscribed | boolean |
Indique si l’utilisateur est abonné à une cible spécifique |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Informations détaillées pour une cible spécifique.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID cible |
|
Nom
|
name | string |
Nom de la cible |
|
Descriptif
|
description | string |
Les cibles déscritption |
|
ID de définition
|
definitionId | integer |
ID de la définition cible à laquelle appartient la cible |
|
Parent ID
|
parentId | integer |
ID du parent cible, s’il en a un |
|
Est abonné
|
isSubscribed | boolean |
Indique si l’utilisateur est abonné à une cible spécifique |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Informations détaillées pour une cible spécifique.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID cible |
|
Nom
|
name | string |
Nom de la cible |
|
Descriptif
|
description | string |
Les cibles déscritption |
|
ID de définition
|
definitionId | integer |
ID de la définition cible à laquelle appartient la cible |
|
Parent ID
|
parentId | integer |
ID du parent cible, s’il en a un |
|
Est abonné
|
isSubscribed | boolean |
Indique si l’utilisateur est abonné à une cible spécifique |