Dynamisches Signal (Vorschau)
Dynamic Signal ist eine Mitarbeiterkommunikations- und Engagement-Plattform, die von Organisationen als vertrauenswürdig eingestuft wird, um Mitarbeiter zu verbinden, auszurichten und zu binden. Stellen Sie eine Verbindung mit Dynamic Signal her, um Ihre Beiträge und Benutzer zu erstellen und zu verwalten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Connectormetadaten | |
|---|---|
| Herausgeber | Dynamisches Signal |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Bearertoken | securestring | Das Bearertoken für diese API | Richtig |
| Dynamische Signal-URL | Schnur | Die URL, unter der Sie auf dynamisches Signal zugreifen. | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen eines Beitrags |
Ruft einen bestimmten Beitrag nach ID ab |
| Abrufen eines Benutzers per E-Mail |
Ruft einen Benutzer anhand seiner E-Mail-Adresse ab. |
| Abrufen von Beitragstags |
Ruft die im System definierten Posttags ab. |
| Abrufen von Benutzertags |
Ruft eine Liste der im System definierten Benutzertags ab. |
| Abrufen von Zielen |
Ruft eine Liste der Ziele und Zieldefinitionen der Community ab. |
| Aktualisieren eines Beitrags |
Bearbeitet einen vorhandenen Beitrag. |
| Bild hochladen |
Lädt ein Bild über binären Upload hoch |
| Divisionen abrufen |
Ruft die Liste der Abteilungen ab. |
| Erstellen eines Beitrags |
Erstellt einen Beitrag. |
| Hinzufügen eines Bilds zu einem Beitrag über die URL |
Legt das Beitragsbild über eine URL fest. |
| Hinzufügen eines Bilds zu einem Beitrag über upload |
Legt das Beitragsbild über den binären Upload fest. |
| Hochladen eines Dokuments in einen Beitrag |
Lädt ein Dokument über binären Upload in einen Beitrag hoch. |
| Kategorien abrufen |
Ruft eine Liste der Kategorien ab, die für den authentifizierten Benutzer sichtbar sind |
| Verwalten von Beiträgen |
Ermöglicht es serverauthentifizierungsgesteuerten Aufrufen, Eigenschaften für mehrere Beiträge in einer einzigen Anforderung zu aktualisieren. |
| Vorabregistrierung eines Benutzers |
Erstellt einen neuen Benutzer im vorab registrierten Zustand. |
Abrufen eines Beitrags
Ruft einen bestimmten Beitrag nach ID ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
Die Post-ID.; Dies ist der eindeutige Bezeichner für den Beitrag. |
|
Benutzer-ID
|
userId | integer |
Der Benutzer, der den Beitrag anzeigt. Der angemeldete Benutzer wird verwendet, wenn keine ID angegeben wird. |
Gibt zurück
Ein Beitrag
- response
- postResponse
Abrufen eines Benutzers per E-Mail
Ruft einen Benutzer anhand seiner E-Mail-Adresse ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email
|
True | string |
Die E-Mail des Benutzers |
|
|
Include
|
include | array of string |
Gibt optionale Daten an, die mit dem Benutzer zurückgegeben werden sollen. |
Gibt zurück
- response
- userRequestResponse
Abrufen von Beitragstags
Ruft die im System definierten Posttags ab.
Gibt zurück
Eine Liste der im System definierten Posttags
- response
- managePostTagsResponse
Abrufen von Benutzertags
Ruft eine Liste der im System definierten Benutzertags ab.
Gibt zurück
Eine Liste der im System definierten Benutzertags
- response
- manageUserTagsResponse
Abrufen von Zielen
Ruft eine Liste der Ziele und Zieldefinitionen der Community ab.
Gibt zurück
Eine Liste der Zieldefinitionen und zugehörigen Ziele für die Community.
- response
- targetDefinitionsInfoResponse
Aktualisieren eines Beitrags
Bearbeitet einen vorhandenen Beitrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
Die Beitrags-ID |
|
Title
|
title | string |
Der Titel des Beitrags |
|
|
Description
|
description | string |
Die kurze Beschreibung des Beitrags |
|
|
Tagzeile
|
tagLine | string |
Die Tagzeile des Beitrags |
|
|
Content
|
content | string |
Der Textkörper des Beitrags |
|
|
Erstellerkommentare
|
creatorComments | string |
Eine Nachricht, die dem Beitrag zugeordnet ist |
|
|
Perma-Link
|
permaLink | string |
Die externe URL, auf die vom Beitrag verwiesen wird |
|
|
Interne Diskussionen aktiviert
|
internalDiscussionsEnabled | boolean |
Gibt an, ob Mitglieder aktionen wie Aktionen ausführen und intern Kommentare zu Beiträgen hinzufügen dürfen. |
Gibt zurück
Ein Beitrag
- response
- postResponse
Bild hochladen
Lädt ein Bild über binären Upload hoch
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datei
|
File | True | binary |
Datei, die hochgeladen werden soll |
|
Inhaltstyp wie bild/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Inhaltstyp der hochgeladenen Datei |
Gibt zurück
- response
- uploadImageResponse
Divisionen abrufen
Ruft die Liste der Abteilungen ab.
Gibt zurück
Die im System definierten Divisionen
- response
- divisionsResponse
Erstellen eines Beitrags
Erstellt einen Beitrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Description
|
description | string |
Die kurze Beschreibung des Beitrags |
|
|
Tagzeile
|
tagLine | string |
Die Tagzeile des Beitrags |
|
|
Content
|
content | string |
Der Textkörper des Beitrags |
|
|
Erstellerkommentare
|
creatorComments | string |
Eine Nachricht, die dem Beitrag zugeordnet ist |
|
|
Perma-Link
|
permaLink | string |
Die externe URL, auf die vom Beitrag verwiesen wird |
|
|
Interne Diskussionen aktiviert
|
internalDiscussionsEnabled | boolean |
Gibt an, ob Mitglieder aktionen wie Aktionen ausführen und intern Kommentare zu Beiträgen hinzufügen dürfen. |
|
|
Title
|
title | True | string |
Der Titel des Beitrags |
|
Membervideo-URL
|
memberVideoUrl | string |
Die Video-URL, auf die vom Beitrag verwiesen wird |
|
|
Beitragstyp
|
postType | string |
Der grundlegende Typ des Beitrags |
|
|
Genehmigungsstatus
|
approvalState | string |
Der Genehmigungsstatus des Beitrags. Standardmäßig wird die Einstellung "Status überprüfen" des Autors festgelegt. |
|
|
Anzeigemodus
|
displayMode | string |
Gibt die Umleitung eines Beitrags an einen internen oder externen Speicherort an. |
|
|
Verteilbar
|
sharable | boolean |
Gibt an, ob die VoiceStorm-Plattform und -Widgets zulassen, dass der Beitrag freigegeben werden kann. |
|
|
Startdatum
|
startDate | date-time |
Das Datum, nach dem der Beitrag für die Anzeige verfügbar ist |
|
|
Enddatum
|
endDate | date-time |
Das Datum, nach dem der Beitrag nicht mehr für die Anzeige verfügbar ist |
|
|
Vorgeschlagenes Freigeben von Text
|
suggestedShareText | string |
Der vorgeschlagene Freigabetext für den Beitrag |
|
|
Kurzer Vorgeschlagener Text teilen
|
shortSuggestedShareText | string |
Der vorgeschlagene Freigabetext für den Beitrag für Kurznachrichtenanbieter |
|
|
Teilen von Punkten
|
sharePoints | integer |
Die Anzahl der Punkte, die vergeben werden, wenn ein Benutzer den Beitrag teilt |
|
|
Click Points
|
clickPoints | integer |
Die Anzahl der Punkte, die vergeben werden, wenn jemand auf einen freigegebenen Link zum Beitrag klickt |
|
|
Mit Bildern teilen
|
shareWithImages | boolean |
Steuerelemente, wenn Beiträge, die für kurze Nachrichtendienste (z. B. Twitter) freigegeben wurden, Bilder freigegeben haben |
|
|
Nur Bilder freigeben
|
shareImagesOnly | boolean |
Steuerelemente, wenn Beiträge, die für bestimmte Dienste freigegeben wurden, nur als Bild-/Fotoaktualisierungen behandelt werden |
|
|
Name
|
name | string |
Der Tagname |
|
|
Language
|
language | string |
Die Sprache des Beitragsinhalts |
|
|
Dokumente
|
documents | array of uuid |
Eine Liste der Dokumenten-IDs, die an diesen Beitrag angefügt werden sollen |
|
|
Creator-ID
|
creatorId | integer |
Der Benutzer, der den Beitrag erstellt; Diese Eigenschaft ist derzeit nur für serverauthentifizierungsfähige Anforderungen verfügbar. Alle anderen Beiträge werden automatisch auf den authentifizierten Benutzer festgelegt. |
|
|
Creator anzeigen
|
displayCreator | boolean |
Steuert, ob die Erstellerinformationen mit dem Beitrag angezeigt werden sollen oder nicht; Diese Eigenschaft ist derzeit nur für serverauthentifizierungsfähige Anforderungen verfügbar. |
|
|
Kategorie-IDs
|
categoryIds | array of integer |
Eine Liste der Kategorie-IDs, die dem Beitrag zugewiesen wurden |
|
|
Ziel-IDs
|
targetIds | array of integer |
Eine Liste der Ziel-IDs, die dem Beitrag zugewiesen wurden |
Gibt zurück
Ein Beitrag
- response
- postResponse
Hinzufügen eines Bilds zu einem Beitrag über die URL
Legt das Beitragsbild über eine URL fest.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
Die Post-ID, erforderlich: true |
|
URL
|
url | True | string |
Die HTTP- oder HTTPS-URL |
Gibt zurück
Eine einfache Antwort, die angibt, dass die Aktion erfolgreich ausgeführt wurde
- response
- successResponse
Hinzufügen eines Bilds zu einem Beitrag über upload
Legt das Beitragsbild über den binären Upload fest.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
Die Beitrags-ID |
|
Datei
|
File | True | binary |
Datei, die hochgeladen werden soll |
|
Inhaltstyp wie bild/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Inhaltstyp der hochgeladenen Datei |
Gibt zurück
Eine einfache Antwort, die angibt, dass die Aktion erfolgreich ausgeführt wurde
- response
- successResponse
Hochladen eines Dokuments in einen Beitrag
Lädt ein Dokument über binären Upload in einen Beitrag hoch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiname
|
fileName | True | string |
Der bevorzugte Dateiname des Dokuments (mit Erweiterung) |
|
ID
|
id | True | uuid |
Die Beitrags-ID |
|
Datei
|
File | True | binary |
Datei, die hochgeladen werden soll |
|
Inhaltstyp wie bild/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Inhaltstyp der hochgeladenen Datei |
Gibt zurück
Informationen, die für ein angefügtes Dokument relevant sind
- response
- documentInfoResponse
Kategorien abrufen
Ruft eine Liste der Kategorien ab, die für den authentifizierten Benutzer sichtbar sind
Gibt zurück
Detaillierte Informationen zu Kategorien
- response
- categoriesResponse
Verwalten von Beiträgen
Ermöglicht es serverauthentifizierungsgesteuerten Aufrufen, Eigenschaften für mehrere Beiträge in einer einzigen Anforderung zu aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Posten von IDs
|
postIds | True | array of uuid |
Die zu ändernden Beiträge |
|
Stichwörter
|
tags | array of string |
Eine Sammlung von Tagnamen, die auf Beiträge angewendet werden können |
|
|
Abteilungs-IDs
|
divisionIds | array of integer |
Die Abteilungs-IDs, zu denen die Beiträge gehören |
|
|
Kategorie-IDs
|
categoryIds | array of integer |
Die Kategorie-ID, zu der die Beiträge gehören |
|
|
Ziel-IDs
|
targetIds | array of integer |
Die Ziel-ID, zu der die Beiträge gehören |
|
|
Genehmigungsstatus
|
approvalState | string |
Der Genehmigungsstatus für die Beiträge (dies ist nicht von den DELETE-Anforderungen betroffen) |
Gibt zurück
Eine einfache Antwort, die angibt, dass die Aktion erfolgreich ausgeführt wurde
- response
- successResponse
Vorabregistrierung eines Benutzers
Erstellt einen neuen Benutzer im vorab registrierten Zustand.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email
|
string |
Die E-Mail-Adresse des Benutzers |
||
|
Externe Sso-Benutzer-ID
|
externalSsoUserId | string |
Die Benutzer-ID im externen System, das vom SSO-Identitätsanbieter verwaltet wird |
|
|
Griff
|
handle | string |
Der Benutzerhandle |
|
|
Vorname
|
firstName | string |
Der Vorname des Benutzers. |
|
|
Nachname
|
lastName | string |
Der Nachname des Benutzers. |
|
|
Abteilungs-IDs
|
divisionIds | array of integer |
Eine Liste der Abteilungen, denen der Benutzer zugewiesen wird. |
|
|
Ziel-IDs
|
targetIds | array of integer |
Eine Liste der Ziele, die dem Benutzer zugewiesen werden sollen. |
|
|
Name
|
name | string |
Der Tag- oder Attributname |
|
|
Wert
|
value | string |
Der optionale Wert |
|
|
Einladungs-E-Mail senden
|
sendInvitationEmail | boolean |
Bestimmt, ob eine Einladungs-E-Mail an den Benutzer gesendet werden soll. |
|
|
Einladungsnachricht
|
invitationMessage | string |
Eine optionale Nur-Text-Nachricht, die in die Einladungs-E-Mail aufgenommen werden soll. |
|
|
Benachrichtigungsstandard
|
notificationsDefault | string |
Festlegen, die steuert, wann die Benutzer E-Mail-Benachrichtigungen erhalten. |
|
|
Kann Beiträge freigeben
|
canSharePosts | boolean |
Gibt an, ob der Benutzer die Möglichkeit hat, Beiträge zu teilen |
|
|
Kann Beiträge kommentieren
|
canCommentPosts | boolean |
Gibt an, ob der Benutzer die Möglichkeit hat, Beiträge zu kommentieren und zu liken |
|
|
Kann Beiträge übermitteln
|
canSubmitPosts | boolean |
Gibt an, ob der Benutzer die Möglichkeit hat, Beiträge zu übermitteln. |
|
|
Kann Organisation verwalten
|
canManageOrganization | boolean |
Gibt an, ob der Benutzer über die Möglichkeit verfügt, mit direkten und indirekten Berichten innerhalb der Community zu kommunizieren. |
Gibt zurück
- response
- userRequestResponse
Definitionen
successResponse
Eine einfache Antwort, die angibt, dass die Aktion erfolgreich ausgeführt wurde
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
code | string |
Ein Wert von "Success" gibt einen erfolgreichen Vorgang an. |
targetDefinitionsInfoResponse
Eine Liste der Zieldefinitionen und zugehörigen Ziele für die Community.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Detaillierte Informationen zu einer bestimmten Zieldefinition und den zugehörigen Zielen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die ID der Zieldefinition |
|
Name
|
name | string |
Der Name der Zieldefinition |
|
Benutzerbestätigung abrufen
|
getUserConfirmation | boolean |
Bestimmt, ob ein Benutzer aufgefordert wird, seine Einstellung zu bestätigen/auszuwählen. |
|
Mehrfachauswahl zulassen
|
allowMultipleSelections | boolean |
Bestimmt, ob mehrere Ziele ausgewählt werden können. |
|
Auswahl erforderlich
|
selectionRequired | boolean |
Bestimmt, ob eine Auswahl in dieser Definition erforderlich ist. |
|
Zielauswahlaufforderung
|
targetSelectionPrompt | string |
Eine benutzerdefinierte Bezeichnung, um Benutzer aufzufordern, ihre Einstellung auszuwählen |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Detaillierte Informationen für ein bestimmtes Ziel.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Ziel-ID |
|
Name
|
name | string |
Der Name des Ziels |
|
Description
|
description | string |
Die Ziele desCritption |
|
Definitions-ID
|
definitionId | integer |
Die ID der Zieldefinition, zu der das Ziel gehört |
|
Übergeordnete ID
|
parentId | integer |
Die ID des übergeordneten Zielobjekts, sofern er über eine verfügt |
|
Ist abonniert
|
isSubscribed | boolean |
Gibt an, ob der Benutzer ein bestimmtes Ziel abonniert hat. |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
Eine Liste der im System definierten Posttags
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Detaillierte Informationen für ein bestimmtes Posttag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Tag-ID |
|
Name
|
name | string |
Der Tagname |
|
Ist für Mitglieder verfügbar
|
isAvailableToMembers | boolean |
Bestimmt, ob das Tag für die Verwendung auf Seiten nach der Übermittlung mit Membern (sofern aktiviert) verwendet werden kann. |
manageUserTagsResponse
Eine Liste der im System definierten Benutzertags
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Detaillierte Informationen für ein bestimmtes Benutzertag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Tag-ID |
|
Name
|
name | string |
Der Tagname |
|
type
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
Detaillierte Informationen zu Kategorien
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Abonnementaufforderung
|
subscriptionPrompt | string |
Die Bezeichnung zum Auffordern von Mitgliedern zum Auswählen von Kategorieabonnements |
|
Kategorieabonnement aktivieren
|
enableCategorySubscription | boolean |
Gibt an, ob Mitglieder ihre Kategorieabonnements ändern dürfen |
|
Abonnementauswahl anfordern
|
requireSubscriptionSelection | boolean |
Gibt an, ob Mitglieder während des Onboardings Kategorieabonnements auswählen müssen |
|
Zielseite Standardkategorie
|
landingPageDefaultCategory | integer |
Der Standardinhalt, der beim Laden von Newsfeedinformationen angezeigt werden soll |
categoryResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Kategorie-ID |
|
Name
|
name | string |
Der Name der Kategorie |
|
Description
|
description | string |
Die Kategoriebeschreibung |
|
Reihenfolge anzeigen
|
displayOrder | integer |
Die Reihenfolge, in der die Kategorie angezeigt werden soll |
|
Ist angeheftet
|
isPinned | boolean |
Gibt an, ob die Kategorie von einem Administrator angeheftet wurde |
|
Ist erzwungen
|
isForced | boolean |
Gibt an, ob der authentifizierte Benutzer erzwingt die angegebene Kategorie abonniert hat. |
|
Ist abonniert
|
isSubscribed | boolean |
Wther the authenticated user is subscribed to the given category |
|
Ist ausgeblendet
|
isHidden | boolean |
Gibt an, ob die Kategorie von einem Administrator ausgeblendet wird. |
|
Ist der Benutzer auswählbar
|
isUserSelectable | boolean |
Gibt an, ob Benutzer Kategorien für übermittelte Beiträge auswählen dürfen. |
|
Übergeordnete Kategorie-ID
|
parentCategoryId | integer |
Die übergeordnete Kategorie-ID |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
Ein Beitrag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beitrags-ID
|
postId | uuid |
Die Beitrags-ID |
|
Post Source ID
|
postSourceId | integer |
Die Quell-ID |
|
Title
|
title | string |
Der Titel des Beitrags |
|
Description
|
description | string |
Die kurze Beschreibung des Beitrags |
|
Tagzeile
|
tagLine | string |
Die Tagzeile des Beitrags |
|
Content
|
content | string |
Der Textkörper des Beitrags |
|
Unformatierter Inhalt
|
rawContent | string |
Der Textkörper des Beitrags einschließlich aller HTML -Elemente (wenn Sowohl Inhalt als auch RawContent enthalten sind) |
|
Erstellerkommentare
|
creatorComments | string |
Eine Nachricht, die dem Beitrag zugeordnet ist |
|
|
creatorInfo | userOverviewResponse |
Zusammenfassungsinformationen zu einem Benutzer |
|
Standort
|
location | string |
Geografischer Standort im Zusammenhang mit dem Beitrag |
|
Eigenschaften
|
properties | object |
Verschiedene Eigenschaften des Beitrags. Nicht für alle Beitragstypen verfügbar |
|
Perma-Link
|
permaLink | string |
Die externe URL, auf die vom Beitrag verwiesen wird |
|
Perma-Verknüpfung bereinigen
|
cleanPermaLink | string |
Der Permalink (mit Ausnahme problematischer Leerzeichen und Neuerleitungen) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
Der Soziale Anbieter, von dem der Beitrag stammt (z.B. Facebook, Twitter). |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
status
|
status | string | |
|
Benutzer bearbeitbar
|
userEditable | boolean | |
|
Benutzerfreigabefähig
|
userShareable | boolean |
Gibt an, ob der aktuelle Benutzer den Beitrag freigeben kann. Wenn kein aktueller Benutzer vorhanden ist, wird standardmäßig "true" festgelegt. |
|
Benutzerkommentare
|
userCommentable | boolean |
Gibt an, ob der aktuelle Benutzer an Dicussions am Beitrag teilnehmen kann. Wenn kein aktueller Benutzer vorhanden ist, wird standardmäßig "false" festgelegt. |
|
Verteilbar
|
sharable | boolean |
Gibt an, ob die Plattform und widgets zulassen, dass der Beitrag freigegeben wird. |
|
Ausgestrahlt
|
broadcasted | boolean |
Gibt an, ob der Beitrag für die Freigabe an Benutzer übertragen wurde. |
|
Pinned
|
pinned | boolean |
Gibt an, ob der Beitrag für die Prioritätsanzeige in Datenströmen festgelegt wurde. |
|
Veröffentlichungsdatum
|
publishDate | date-time |
Für vom Benutzer übermittelte Inhalte das Datum der Übermittlung; für Inhalte, die aus einer externen Quelle importiert wurden, das Veröffentlichungsdatum entsprechend der Quelle |
|
Startdatum
|
startDate | date-time |
Das Datum, nach dem der Beitrag für die Anzeige verfügbar ist |
|
Enddatum
|
endDate | date-time |
Das Datum, nach dem der Beitrag nicht mehr für die Anzeige verfügbar ist |
|
Startdatum des Ereignisses
|
eventStartDate | date-time |
Das Datum, an dem das Ereignis beginnt (für Beiträge vom Ereignistyp) |
|
Enddatum des Ereignisses
|
eventEndDate | date-time |
Das Datum, an dem das Ereignis endet (für Beiträge vom Ereignistyp) |
|
Anbieterzeitstempel
|
providerTimeStamp | date-time |
Das Datum des Beitrags aus der Sicht der Anbieter, d. h., wann er ursprünglich auf dem Sozialen Anbieter gepostet wurde |
|
Empfangene Veröffentlichungspunkte
|
receivedPublishPoints | boolean |
Gibt an, ob der Benutzer, der den Beitrag übermittelt hat, Punkte erhalten hat, wenn der Beitrag veröffentlicht wurde. |
|
Vorgeschlagenes Freigeben von Text
|
suggestedShareText | string |
Der vorgeschlagene Freigabetext für den Beitrag |
|
Kurzer Vorgeschlagener Text teilen
|
shortSuggestedShareText | string |
Der vorgeschlagene Freigabetext für den Beitrag für Kurznachrichtenanbieter |
|
suggestedShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Teilen von Punkten
|
sharePoints | integer |
Die Anzahl der Punkte, die vergeben werden, wenn ein Benutzer den Beitrag teilt |
|
Click Points
|
clickPoints | integer |
Die Anzahl der Punkte, die vergeben werden, wenn jemand auf einen freigegebenen Link zum Beitrag klickt |
|
Anbieter-Beitrags-ID
|
providerPostId | string |
Die ursprüngliche ID des Beitrags im Anbieternetzwerk |
|
Url Slug
|
urlSlug | string |
Der SEO-Text, der in öffentlichen Links zum Beitrag platziert werden soll |
|
Klassifizierung
|
classification | string |
Der Typ des Beitrags im Anbieternetzwerk. |
|
Mit Bildern teilen
|
shareWithImages | boolean |
Steuerelemente, wenn Beiträge, die für kurze Nachrichtendienste (z. B. Twitter) freigegeben wurden, Bilder freigegeben haben |
|
Nur Bilder freigeben
|
shareImagesOnly | boolean |
Steuerelemente, wenn Beiträge, die für bestimmte Dienste freigegeben wurden, nur als Bild-/Fotoaktualisierungen behandelt werden |
|
Aktionen
|
actions | string |
Ein JSON-Blob mit einer Liste von Aktionselementen für den Beitrag und URLs |
|
Erwähnungen
|
mentions | string |
Die Erwähnungen (Benutzer, Hashtags usw.), die als JSON-Blob gespeichert sind. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
Verknüpfungen
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
media
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
Sichtbar
|
visible | boolean |
Gibt an, ob der Beitrag zurzeit sichtbar ist. |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Language
|
language | string |
Die Sprache des Beitragsinhalts |
|
Benutzer ausgeblendet
|
userHidden | boolean |
Gibt an, ob der Benutzer den Beitrag aus einem oder mehreren Datenströmen ausgeblendet hat. |
|
Wird vom Benutzer angezeigt
|
isViewedByUser | boolean |
Gibt an, ob der Beitrag vom aktuellen Benutzer angezeigt wurde. |
|
Wird vom Benutzer angezeigte Diskussion
|
isDiscussionViewedByUser | boolean |
Gibt an, ob der Diskussionsthread für Beiträge vom aktuellen Benutzer angezeigt wurde. |
|
Wird vom Benutzer mit "Gefällt mir" gekennzeichnet
|
isLikedByUser | boolean |
Gibt an, ob der Beitrag intern vom aktuellen Benutzer mit "Gefällt mir" gekennzeichnet wurde. |
|
Wird vom Benutzer kommentiert
|
isCommentedByUser | boolean |
Gibt an, ob der Beitrag vom aktuellen Benutzer kommentiert wurde. |
|
Wird vom Benutzer freigegeben
|
isSharedByUser | boolean |
Gibt an, ob der Beitrag zuvor vom aktuellen Benutzer freigegeben wurde. |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Aktuelle Uhrzeit
|
currentTime | date-time |
Die aktuelle Uhrzeit auf dem Server. |
categoryOverviewResponse
Grundlegende Kategorieinformationen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Kategorie-ID |
|
Name
|
name | string |
Der Name der Kategorie |
|
Übergeordnete Kategorie-ID
|
parentCategoryId | integer |
Die übergeordnete Kategorie-ID |
targetOverviewResponse
Eine einfache Zielantwort, die aus dem Namen, der ID und der ID der Zieldefinition besteht, zu der sie gehört
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
Der Zielname |
|
ID
|
id | integer |
Die Ziel-ID |
|
Definitions-ID
|
definitionId | integer |
Die ID der Zieldefinition, zu der das Ziel gehört |
postShareCommentRulesResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
provider
|
provider | string | |
|
Maximale Anzahl von Zeichen teilen
|
shareMaxCharacterLimit | integer |
Die maximale Länge eines Kommentars eines Benutzers in einer Freigabe für diesen Anbieter. |
postShareDisclosureResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
provider
|
provider | string | |
|
Anbieteranzeigename
|
providerDisplayName | string |
Der Anzeigename der Anbieter |
|
Freigeben von Offenlegungstext
|
shareDisclosureText | string |
Der an jede Freigabe angefügte Offenlegungstext |
postCandidateImageResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL
|
url | string |
Die Bild-URL |
|
Breite
|
width | integer |
Die Breite der Bilder |
|
Höhe
|
height | integer |
Die Höhe der Bilder |
|
MIME-Typ
|
mimeType | string |
Der MIME-Typ der Bilder |
|
SSL-URL
|
sslUrl | string |
Die sichere URL der Bilder |
postMediaRequestResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
Der Name des Medienobjekts |
|
Breite
|
width | integer |
Die Breite des Medienobjekts in Pixeln |
|
Höhe
|
height | integer |
Die Höhe des Medienobjekts in Pixeln |
|
MIME-Typ
|
mimeType | string |
Der MIME-Typ des Medienobjekts |
|
HTML
|
html | string |
HTML, das zum Rendern des Medienobjekts verwendet werden kann |
|
URL
|
url | string |
Die URL zum Medienobjekt |
|
Ursprung
|
origin | string |
Falls verfügbar, gibt die ursprüngliche Position des Medienobjekts an. |
|
Provider
|
provider | string |
Der Name des Anbieters für soziale Netzwerke |
|
Rolle
|
role | string |
Der Medientyp (falls bestimmt) |
|
Dauer
|
duration | integer |
Die Videodauer in Millisekunden |
|
Description
|
description | string |
Die Beschreibung des Videoformats |
|
Enthält Video-URL
|
hasVideoUrl | boolean |
Gibt an, dass diese Medien über eine Video-URL verfügen, die mit dem "WatchVideo" signiert werden muss. |
postTagRequestResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
Der Tagname |
postLinkRequestResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL
|
url | string |
Die Beitrags-URL |
|
Erweiterte URL
|
expandedUrl | string |
Die erweiterte URL (sofern vorhanden) |
|
Title
|
title | string |
Titel der Beiträge |
|
Domäne
|
domain | string |
Die Verknüpfungsdomäne |
|
Favicon-URL
|
faviconUrl | string |
Die favicon-URL des Links |
|
Name
|
name | string |
Der Name des links, der vom Anbieter für soziale Netzwerke zugewiesen wurde |
|
Überschrift
|
caption | string |
Die Kurzbeschriftung des Links (d. h. der Text unter dem Link) |
|
Description
|
description | string |
Die Beschreibung des Links (d. h. der längere Text unter der Beschriftung) |
|
Änderungsdatum
|
modifiedDate | date-time | |
|
Erstellt am
|
createdDate | date-time |
postAuthorRequestResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Autor
|
author | string |
Der gespeicherte Text, der als Autor angezeigt werden soll. |
|
Profilbild-URL
|
profileImageUrl | string |
Das Profilbild der Autoren im sozialen Netzwerk |
|
Anbieterbenutzer-ID
|
providerUserId | string |
Die Autoren-ID im sozialen Netzwerk |
|
Anbieterbenutzername
|
providerUserName | string |
Der Name der Autoren im sozialen Netzwerk |
|
Profil-URL
|
profileUrl | string |
Die Autorenprofil-URL im sozialen Netzwerk |
|
Name der Postquelle
|
postSourceName | string |
Der Name der Quelle des Beitrags. |
|
Post Source Site
|
postSourceSite | string |
Die Website, auf der der Beitrag entstanden ist |
postUserShareInfoResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesammelte Punkte
|
pointsEarned | integer |
Die Anzahl der punkte, die der Benutzer für die Freigabe verdient hat |
|
Anzahl freigeben
|
shareCount | integer |
Die Häufigkeit, mit der der Benutzer geteilt hat |
|
Neuestes Freigabedatum
|
mostRecentShareDate | date-time |
Datum der letzten Freigabe dieses Beitrags für die Benutzer |
postStatisticsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtanzahl der App-Freigaben
|
totalInAppShareCount | integer |
Synonym für ShareCount |
|
Tracking-ID
|
trackingId | string | |
|
Anzahl freigeben
|
shareCount | integer |
Die Anzahl der in der App initiierten Freigaben, die als erfolgreich freigegeben überprüft wurden |
|
Reaktionsanzahl
|
reactionCount | integer |
Anzahl der Reaktionen (z. B. Retweets usw.) auf Aktien |
|
Impression Count
|
impressionCount | integer |
Die potenziellen Ansichten eines Beitrags von teilenern Freunden und Followern |
|
Angezeigte Anzahl
|
viewedCount | integer |
Die Häufigkeit, mit der der Beitrag von angemeldeten Benutzern besucht wurde |
|
Klicken Sie auf Anzahl
|
clickCount | integer |
Die Anzahl der Klicks auf den Beitragslink von Freigaben |
|
Gefällt mir Anzahl
|
likeCount | integer |
Die Anzahl interner Likes für den Beitrag |
|
Kommentaranzahl
|
commentCount | integer |
Die Anzahl der internen Kommentare zu dem Beitrag |
|
Kommentar wie Anzahl
|
commentLikeCount | integer |
Die Summe aller Likes in allen internen Kommentaren zum Beitrag |
userOverviewResponse
Zusammenfassungsinformationen zu einem Benutzer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer-ID
|
userId | integer |
ID des Benutzers |
|
Anzeigename
|
displayName | string |
Anzeigename des Benutzers |
|
profilePictureImages
|
profilePictureImages | object | |
|
Ist aktiv
|
isActive | boolean |
Gibt an, ob der Benutzer noch aktives Mitglied der Community ist. |
uploadImageResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bildbezeichner
|
imageIdentifier | string |
Der Bezeichner für das hochgeladene Bild |
userRequestResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die interne ID der Benutzer |
|
Email
|
string |
Die E-Mail-Adresse der Benutzer |
|
|
Griff
|
handle | string |
Die Benutzer behandeln (der "Benutzername") |
|
Anzeigename
|
displayName | string |
Der bevorzugte Anzeigename der Benutzer |
|
Vollständiger Name
|
fullName | string |
Der Vor- und Nachname des Benutzers |
|
Vorname
|
firstName | string |
Vorname der Benutzer |
|
Nachname
|
lastName | string |
Nachname der Benutzer |
|
displayNameFormat
|
displayNameFormat | string | |
|
status
|
status | string | |
|
Profil abgeschlossen
|
profileCompleted | boolean |
Gibt an, ob das Benutzerprofil während des Onboardings abgeschlossen wurde |
|
Datum der letzten Aktivität
|
lastActivityDate | date-time |
Das letzte Mal, wenn der Benutzer mit dem System interagiert hat. |
|
Title
|
title | string |
Der Titel der Benutzer |
|
Standort
|
location | string |
Der selbst beschriebene Standort der Benutzer (möglicherweise kein tatsächlicher geografischer Standort) |
|
Benutzer-ID der externen API
|
externalApiUserId | string |
Die Benutzer-ID im externen System, die vom Aufrufer dieser API verwaltet wird |
|
Manager-Benutzer-ID
|
managerUserId | integer |
Die ID des Benutzer-Managers (für Organisationshierarchiefeatures) |
|
Zeitzone
|
timeZone | string |
Die Zeitzone des Benutzers, die als tz-Datenbank-Zeitzonenname dargestellt wird, wie von IANA festgelegt. Beispiel: "America/Los_Angeles". |
|
Ausgewählte Zeitzone
|
selectedTimeZone | string |
Die von IANA festgelegte Zeitzone wird als tz-Datenbank-Zeitzonenname dargestellt. Beispiel: "America/Los_Angeles". |
|
Punktsaldo
|
pointBalance | integer |
Die gesamtzahl der bis heute erzielten Punkte |
|
Nicht eingelöste Punkte
|
unredeemedPoints | integer |
Die derzeit für die Einlösung verfügbaren Punkte |
|
Eingelöste Punkte
|
redeemedPoints | integer |
Die Anzahl der punkte, die während der Lebensdauer der Benutzer eingelöst wurden |
|
API-Informationen
|
apiInfo | string |
API-spezifischer Eigenschaftenbehälter |
|
Verfügt über ein Kennwort
|
hasPassword | boolean |
Gibt an, ob dem Benutzer ein Kennwort zugeordnet ist. |
|
Kennwort muss geändert werden
|
mustChangePassword | boolean |
Gibt an, ob der Benutzer sein Kennwort basierend auf Communityeinstellungen ändern muss. |
|
Ist Konto überprüft
|
isAccountVerified | boolean |
Gibt an, ob der Benutzer seine E-Mail-Adresse überprüft hat. |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Kennzeichen
|
badges | object | |
|
zugehörigkeiten
|
affiliations | array of userAffiliationResponse | |
|
Geschäftsbereiche
|
divisions | array of divisionResponse | |
|
Kanäle
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Sprachen
|
languages | array of string | |
|
Primäre Sprache
|
primaryLanguage | string |
Die primäre Benutzeroberflächensprache |
|
|
scheduleSettings | userScheduleSettingsResponse |
Geplante Freigabeeinstellungen für Benutzer |
|
Ist Sso
|
isSso | boolean |
Gibt an, ob der Benutzer die Authentifizierung mithilfe von SSO durchführen soll. |
|
|
permissions | userPermissionsResponse |
Berechtigungen für Manager |
|
|
privileges | userPrivilegesResponse |
Benutzerberechtigungen |
|
Bezeichner
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Eine Sammlung von Standardeinstellungen für Benutzer |
|
Willkommensbanner geschlossen
|
welcomeBannerDismissed | boolean |
Gibt an, ob der Benutzer das Willkommensbanner geschlossen hat. |
userDefaultsRequestResponse
Eine Sammlung von Standardeinstellungen für Benutzer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Standardbeitrag "Interne Diskussionen anzeigen"
|
defaultPostShowInternalDiscussions | boolean |
Der Standardstatus der Benutzer nach internen Diskussionen beim Erstellen eines Beitrags |
|
Standardmäßige Beitragspräsentations-Creator-Informationen
|
defaultPostShowCreatorInfo | boolean |
Der Standardstatus der Benutzer beim Erstellen eines Beitrags zum Anzeigen des Erstellernamens und Fotos |
allowlistIdentifiersResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Id der Zulassungslistendefinition |
|
Wert
|
value | string |
Die Antwort der Benutzer für die angegebene Zulassungslistendefinition |
userPrivilegesResponse
Benutzerberechtigungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kann Beiträge übermitteln
|
canSubmitPosts | boolean |
Gibt an, ob der Benutzer die Möglichkeit hat, Beiträge basierend auf seinen Berechtigungen und den Communityeinstellungen zu übermitteln. |
|
Kann Beiträge freigeben
|
canSharePosts | boolean |
Gibt an, ob der Benutzer die Möglichkeit hat, Beiträge basierend auf seinen Berechtigungen und den Communityeinstellungen zu teilen. |
|
Kann Beiträge kommentieren
|
canCommentPosts | boolean |
Gibt an, ob der Benutzer basierend auf seinen Berechtigungen und den Communityeinstellungen die Möglichkeit hat, Beiträge zu kommentieren und zu liken. |
|
Kann Community verwalten
|
canManageCommunity | boolean |
Gibt an, ob der Benutzer ein Manager innerhalb der Community ist, basierend auf seinen Berechtigungen und den Communityeinstellungen |
|
Kann Organisation verwalten
|
canManageOrganization | boolean |
Gibt an, ob der Benutzer basierend auf seinen Berechtigungen und den Communityeinstellungen die Möglichkeit hat, mit direkten und indirekten Berichten innerhalb der Community zu kommunizieren. |
|
Kann beitragsfreigabefähig festlegen
|
canSetPostShareable | boolean |
Gibt an, ob der Benutzer den Freigabestatus festlegen kann, wenn er einen Beitrag übermittelt. |
userPermissionsResponse
Berechtigungen für Manager
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Broadcast anzeigen
|
viewBroadcast | boolean |
Ermöglicht dem Vorgesetzten das Anzeigen von Übertragungen |
|
Broadcast auflisten
|
listBroadcast | boolean |
Ermöglicht dem Vorgesetzten, Listen von Übertragungen anzuzeigen |
|
Übertragung bearbeiten
|
editBroadcast | boolean |
Ermöglicht dem Vorgesetzten, Übertragungen zu erstellen und zu bearbeiten |
|
Übertragungsstatistiken anzeigen
|
viewBroadcastStats | boolean |
Ermöglicht dem Vorgesetzten, Übertragungsstatistiken anzuzeigen |
|
Beitrag anzeigen
|
viewPost | boolean |
Ermöglicht dem Vorgesetzten das Anzeigen von Beiträgen |
|
Listenbeitrag
|
listPost | boolean |
Ermöglicht dem Vorgesetzten, Listen von Beiträgen anzuzeigen |
|
Beitrag bearbeiten
|
editPost | boolean |
Ermöglicht dem Vorgesetzten das Erstellen und Bearbeiten von Beiträgen |
|
Beitragsstatistiken anzeigen
|
viewPostStats | boolean |
Ermöglicht dem Vorgesetzten, Beitragsstatistiken anzuzeigen. |
|
Umfrage anzeigen
|
viewSurvey | boolean |
Ermöglicht dem Vorgesetzten, Umfragen anzuzeigen |
|
Umfrage auflisten
|
listSurvey | boolean |
Ermöglicht dem Vorgesetzten das Anzeigen von Umfragenlisten |
|
Umfrage bearbeiten
|
editSurvey | boolean |
Ermöglicht dem Vorgesetzten, Umfragen zu erstellen und zu bearbeiten |
|
Communityeinstellungen
|
communitySettings | boolean |
Ermöglicht dem Vorgesetzten, Communityeinstellungen anzuzeigen und zu bearbeiten |
userScheduleSettingsResponse
Geplante Freigabeeinstellungen für Benutzer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Tage
|
days | string | |
|
mal
|
times | array of string |
userChannelResponse
Ein Benutzerkanal.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzerkanal-ID
|
userChannelId | integer |
Die interne Benutzerkanal-ID |
|
Benutzer-ID
|
userId | integer |
Die interne Benutzer-ID |
|
provider
|
provider | string | |
|
Name
|
name | string |
Der Benutzername des Anbieters für soziale Netzwerke |
|
Anzeigename
|
displayName | string |
Der Anzeigename der Benutzer auf dem Anbieter für soziale Netzwerke |
|
Anbieterbenutzer-ID
|
providerUserId | string |
Die Benutzer-ID der Anbieter |
|
status
|
status | string | |
|
URL
|
url | string |
Die URL für den Kanal |
|
Freunde
|
friends | integer |
Die Anzahl der Freunde, die der Benutzer im Kanal hat |
|
Follower
|
followers | integer |
Die Anzahl der Follower, die der Benutzer im Kanal hat |
|
Folgende
|
following | integer |
Die Anzahl der Personen, die der Benutzer im Kanal folgt |
|
Posts
|
posts | integer |
Die Anzahl der Beiträge, die der Benutzer im Kanal vorgenommen hat. |
|
Ansichten
|
views | integer |
Die Anzahl der Ansichten, die der Benutzer im Kanal hat |
|
Punktsaldo
|
pointBalance | integer |
Der Punktsaldo des Benutzers im Kanal |
|
Quellanzeigename
|
sourceDisplayName | string |
Der Anzeigename des Benutzerkanals, wenn er als Inhaltsquelle verwendet wird |
|
Reichweite
|
reach | integer |
Die Benutzer erreichen den Kanal |
|
Verteilbar
|
sharable | boolean |
Gibt an, ob der Kanal die Freigabe unterstützt. |
|
Freigabestandard
|
sharingDefault | boolean |
Gibt an, ob der Kanal für die Freigabe vorab ausgewählt ist. |
|
Authentifizierung erforderlich
|
authRequired | boolean |
Gibt an, ob die Anmeldeinformationen für Kanäle erneuert werden müssen. |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
Eine Abteilungsdefinition
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abteilungs-ID
|
divisionId | integer |
Die Abteilungs-ID |
|
Name
|
name | string |
Der Abteilungsname |
|
Id der übergeordneten Abteilung
|
parentDivisionId | integer |
Die ID dieses übergeordneten Bereichs |
userAffiliationResponse
Eine Benutzerzugehörigkeit
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Eine Zugehörigkeitsfrage |
|
|
answer | affiliationAnswerResponse |
Eine Zugehörigkeitsantwort |
affiliationAnswerResponse
Eine Zugehörigkeitsantwort
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwort-ID
|
answerId | integer |
Die Antwort-ID |
|
Antwort
|
answer | string |
Die Antwort |
|
Score
|
score | double |
Die Bewertung, sofern angegeben |
|
Freitext
|
freeText | string |
Text für Fragen mit Dem FreeText-Fragetyp |
|
Ablehnen zur Antwort
|
declineToAnswer | boolean |
Wenn festgelegt, ist dies die Antwort, die bedeutet, dass ein Benutzer abgelehnt hat, die Frage zu beantworten. |
|
Position
|
position | integer |
Die Antwortsortierungsposition |
affiliationQuestionResponse
Eine Zugehörigkeitsfrage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Frage-ID
|
questionId | integer |
Die Frage-ID |
|
Name
|
name | string |
Die Frage |
|
Bewertungsposition
|
scorePosition | integer |
Die Sortierposition der Fragen |
|
Description
|
description | string |
Beschreibung der Fragen |
|
questionType
|
questionType | string | |
|
Erforderlich
|
required | boolean |
Ob die Frage beantwortet werden muss, um sich zu registrieren |
|
Ist öffentlich sichtbar
|
isPubliclyVisible | boolean |
documentInfoResponse
Informationen, die für ein angefügtes Dokument relevant sind
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | uuid |
Die Dokument-ID |
|
Dateiname
|
fileName | string |
Der Dateiname der Dokumente (mit Erweiterung) |
|
Extension
|
extension | string |
Die Dateierweiterung "Documents" |
|
MIME-Typ
|
mimeType | string |
Der MIME-Typ der Dokumente |
divisionResponse
Die im System definierten Divisionen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Geschäftsbereiche
|
divisions | array of divisionResponse | |
|
Prompt
|
prompt | string |
Die Bezeichnung, die Mitglieder auffordert, eine Abteilung auszuwählen |
|
Auswahl der Benutzerabteilung anzeigen
|
showUserDivisionSelection | boolean |
Gibt an, ob registrierte Mitglieder ihre eigene Abteilung ändern können |
|
Auswahl der Benutzerabteilung während des Onboardings anzeigen
|
showUserDivisionSelectionDuringOnboarding | boolean |
Ob neue Mitglieder während der Registrierung ihre eigene Abteilung auswählen sollen |
|
Benutzerteilungsauswahl erforderlich
|
requireUserDivisionSelection | boolean |
Gibt an, ob Mitglieder ihre eigene Abteilung auswählen müssen. |
|
Mehrere Abteilungen zulassen
|
allowMultipleDivisions | boolean |
Gibt an, ob Mitglieder mehrere oder nur eine Abteilung auswählen dürfen |
categoryResponse1
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Kategorie-ID |
|
Name
|
name | string |
Der Name der Kategorie |
|
Description
|
description | string |
Die Kategoriebeschreibung |
|
Reihenfolge anzeigen
|
displayOrder | integer |
Die Reihenfolge, in der die Kategorie angezeigt werden soll |
|
Ist angeheftet
|
isPinned | boolean |
Gibt an, ob die Kategorie von einem Administrator angeheftet wurde |
|
Ist erzwungen
|
isForced | boolean |
Gibt an, ob der authentifizierte Benutzer erzwingt die angegebene Kategorie abonniert hat. |
|
Ist abonniert
|
isSubscribed | boolean |
Wther the authenticated user is subscribed to the given category |
|
Ist ausgeblendet
|
isHidden | boolean |
Gibt an, ob die Kategorie von einem Administrator ausgeblendet wird. |
|
Ist der Benutzer auswählbar
|
isUserSelectable | boolean |
Gibt an, ob Benutzer Kategorien für übermittelte Beiträge auswählen dürfen. |
|
Übergeordnete Kategorie-ID
|
parentCategoryId | integer |
Die übergeordnete Kategorie-ID |
targetInfoResponse1
Detaillierte Informationen für ein bestimmtes Ziel.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Ziel-ID |
|
Name
|
name | string |
Der Name des Ziels |
|
Description
|
description | string |
Die Ziele desCritption |
|
Definitions-ID
|
definitionId | integer |
Die ID der Zieldefinition, zu der das Ziel gehört |
|
Übergeordnete ID
|
parentId | integer |
Die ID des übergeordneten Zielobjekts, sofern er über eine verfügt |
|
Ist abonniert
|
isSubscribed | boolean |
Gibt an, ob der Benutzer ein bestimmtes Ziel abonniert hat. |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Detaillierte Informationen für ein bestimmtes Ziel.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Ziel-ID |
|
Name
|
name | string |
Der Name des Ziels |
|
Description
|
description | string |
Die Ziele desCritption |
|
Definitions-ID
|
definitionId | integer |
Die ID der Zieldefinition, zu der das Ziel gehört |
|
Übergeordnete ID
|
parentId | integer |
Die ID des übergeordneten Zielobjekts, sofern er über eine verfügt |
|
Ist abonniert
|
isSubscribed | boolean |
Gibt an, ob der Benutzer ein bestimmtes Ziel abonniert hat. |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Detaillierte Informationen für ein bestimmtes Ziel.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Ziel-ID |
|
Name
|
name | string |
Der Name des Ziels |
|
Description
|
description | string |
Die Ziele desCritption |
|
Definitions-ID
|
definitionId | integer |
Die ID der Zieldefinition, zu der das Ziel gehört |
|
Übergeordnete ID
|
parentId | integer |
Die ID des übergeordneten Zielobjekts, sofern er über eine verfügt |
|
Ist abonniert
|
isSubscribed | boolean |
Gibt an, ob der Benutzer ein bestimmtes Ziel abonniert hat. |