Staffbase (Vorschau)
Mit dem Staffbase Connector überbrücken Sie unterschiedlichste Tools und Systeme und integrieren die Staffbase-Plattform in Ihre automatisierten Workflows. Dazu gehören ihre Mitarbeiter-App oder Ihr Intranet, um Prozesse zu automatisieren, Aufgaben nach einem Zeitplan auszuführen oder Benutzer zu benachrichtigen, wenn Ereignisse auftreten.
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) |
| Kontakt | |
|---|---|
| Name | Staffbase Support |
| URL | https://www.staffbase.com |
| support@staffbase.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Staffbase GmbH |
| Webseite | https://www.staffbase.com |
| Datenschutzrichtlinie | https://staffbase.com/en/privacy-policy/ |
| Kategorien | Kommunikation; Personalabteilung |
Staffbase Connector
Mit dem Staffbase Connector für Power Automate überbrücken Sie die Lücke zwischen verschiedenen Tools und Systemen und schließen die Staffbase-Plattform in Ihre automatisierten Workflows ein. Nutzen Sie die Leistungsfähigkeit automatisierter Workflows, die Ihre Mitarbeiter-App oder Ihr Intranet umfassen, um Prozesse zu automatisieren, Aufgaben nach einem Zeitplan auszuführen oder Benutzer zu benachrichtigen, wenn Ereignisse stattfinden.
Voraussetzungen
- Ein Microsoft Power Apps- oder Power Automate-Plan mit benutzerdefiniertem Connectorfeature
- Eine Staffbase-Lizenz für Ihre Organisation
- Die Rolle des Administrators für Ihre Organisation auf der Staffbase-Plattform
- Das API-Token zum Konfigurieren der Authentifizierung
- Informationen dazu, auf welcher Staffasbe-Infrastruktur Ihre Anwendung gehostet wird, wenden Sie sich an weitere Informationen.support@staffbase.com
Unterstützte Vorgänge
ChannelsGetList
Abrufen einer Liste von Nachrichtenkanälen
ChannelsGetPosts
Abrufen einer Liste von Beiträgen innerhalb des angegebenen Kanals
ChannelsPostPost
Senden eines Beitrags an einen bestimmten Kanal
CommentsGet
Abrufen aller Kommentare aus Ihrer Staffbase-Instanz
MediaGet
Abrufen aller Medien aus Ihrer Staffbase-Instanz
MediaGetByID
Medien nach ID abrufen
MediaDelete
Medien nach ID löschen
NotificationPost
Sendet Benachrichtigung an Benutzer(en)
PostsGetAll
Abrufen einer Liste von Beiträgen
PostsGetByID
Abrufen eines Beitrags nach ID
PostsDelete
Entfernt einen Beitrag
PostsPut
Aktualisiert einen Beitrag
UserGetAll
Liste der Benutzer abrufen
UserPost
Einladen eines Benutzers nach Vorname, Nachname und eMail
UserGetByID
Abrufen von Benutzerinformationen
User_delete
Benutzer nach ID löschen
UserPut
Aktualisieren von Benutzerinformationen
UserPostRecovery
Senden einer Wiederherstellungs-E-Mail
ProxyVersionGet
Nur für die interne Verwendung, um die aktuelle API-Proxyversion zu überprüfen
Abrufen von Anmeldeinformationen
Für die Standardauthentifizierung zwischen Ihrer Staffbase-Plattform und dem in Power Automate erstellten Workflow benötigen Sie ein API-Token. Sie können das API-Token aus dem Staffbase Experience Studio generieren.
Erste Schritte
Konfigurieren Sie den Connector mit standardauthentifizierung und der Hosting-URL.
- Navigieren Sie in Power Automate zu Connectors.
- Suchen Sie nach Staffbase-Connector.
- Klicken Sie auf den Staffbase-Connector. Ein Dialogfeld zum Konfigurieren des Connectors wird geöffnet.
- Fügen Sie im Feld "API-Token" das API-Token mithilfe der folgenden Syntax hinzu: Basic [API-Token]
Hinweis: Sie müssen einen leeren Leerraum zwischen "Basic" und dem API-Token hinzufügen.
Geben Sie im Feld "Host-ID" den Bezeichner für die Infrastruktur ein, in der Ihre Staffbase-Plattform gehostet wird:
- Deutsche Infrastruktur: de1
- Internationale Infrastruktur: us1
Ausführliche Informationen finden Sie im Staffbase-Supportportal.
Bekannte Probleme und Einschränkungen
Der Staffbase-Connector unterstützt derzeit nicht alle Staffbase-API-Features. Ausführlichere Informationen zu Staffbase-APIs finden Sie im Staffbase Developer Portal.
Häufig gestellte Fragen
Welche Geschäftsworkflows können mithilfe des Staffbase-Connectors automatisiert werden?
Viele Geschäftsprozesse können mithilfe des Staffbase-Connectors automatisiert werden. Benachrichtigen Sie Ihre Mitarbeiter beispielsweise direkt in ihrer Mitarbeiter-App oder im Intranet, als und wenn Aktionen in anderen Tools ausgeführt werden. Weitere Informationen zu solchen Geschäftsanwendungsfällen finden Sie hier.
Gibt es Lernprogramme, die mir bei den ersten Schritten mit einem automatisierten Workflow mithilfe des Staffbase-Connectors helfen können?
Staffbase bietet Lernprogramme, die unser Forms-Plug-In und den Staffbase-Connector verwenden, um Ihr Facility Management zu automatisieren. Erfahren Sie alles darüber, wie Sie es in diesem Abschnitt einrichten.
Bereitstellungsanweisungen
Führen Sie die folgenden Befehle aus, und folgen Sie den Eingabeaufforderungen:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
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 |
|---|---|---|---|
| API-Key | securestring | "API-Key" für die Staffbase-Instanz | Richtig |
| Hosting-ID | Schnur | Geben Sie Ihre Hosting-ID an: hostingID | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Beiträge: Abrufen einer Liste von Beiträgen |
Rufen Sie eine Liste der Beiträge ab, auf die für das API-Token zugegriffen werden kann. |
| Beiträge: Abrufen eines Beitrags nach ID |
Fordert die angegebenen Beiträge einschließlich einer Gruppe von Kommentaren an. |
| Beiträge: Abrufen von Kommentaren |
Dient zum Abrufen einer Liste von Kommentaren. |
| Beiträge: Aktualisiert einen Beitrag |
Aktualisiert einen Beitrag, nur geändertes Feld (inkrementell). |
| Beiträge: Entfernt einen Beitrag |
Entfernt einen Beitrag aus dem System. |
| Benachrichtigung: Benachrichtigung sendet |
Sendet Benachrichtigungen an bestimmte Benutzer. |
| Benutzer: Abrufen von Benutzerinformationen |
Rufen Sie bestimmte Benutzerinformationen anhand der Benutzer-ID ab. |
| Benutzer: Aktualisieren von Benutzerinformationen |
Aktualisieren von Benutzerinformationen. |
| Benutzer: Benutzer einladen |
Der Benutzer erhält eine E-Mail zur Registrierung. |
| Benutzer: Benutzer löschen |
Löscht den angegebenen Benutzer. |
| Benutzer: Liste der Benutzer abrufen |
Abrufen einer Liste von Benutzern, abhängig vom API-Zugriffstoken. |
| Benutzer: Senden einer Wiederherstellungs-E-Mail |
Sendet eine Wiederherstellungs-E-Mail an den angegebenen Benutzer. |
| Kanäle: Abrufen einer Liste von Beiträgen innerhalb des angegebenen Kanals |
Dient zum Abrufen einer Liste von Beiträgen innerhalb des angegebenen Kanals. |
| Kanäle: Abrufen einer Liste von Nachrichtenkanälen |
Dient zum Abrufen einer Liste von Nachrichtenkanälen. |
| Kanäle: Senden eines Beitrags an einen bestimmten Kanal |
Senden Sie einen Beitrag an einen bestimmten Nachrichtenkanal. |
| Medien: Abrufen aller Medien |
Anforderungsbeschreibung aller im aktuellen Kontext verfügbaren Medien. |
| Medien: Medien löschen |
Löscht die angegebenen Medien im aktuellen Kontext. |
| Medien: Medien nach ID abrufen |
Rufen Sie Metadaten für einzelne Medien anhand ihrer ID ab. |
| Proxy: Version abrufen |
Gibt die aktuelle Proxyversion zurück. |
Beiträge: Abrufen einer Liste von Beiträgen
Rufen Sie eine Liste der Beiträge ab, auf die für das API-Token zugegriffen werden kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Query
|
query | string |
Eine Zeichenfolge, die zum Durchsuchen des Beitragsinhalts verwendet werden kann. |
|
|
Limit
|
limit | integer |
Die Anzahl der Elemente, die zurückgegeben werden sollen (Standard und maximal 100). |
|
|
Offset
|
offset | integer |
Definieren Sie einen Offset zum Abrufen der Elemente ab dieser Zahl. |
|
|
Beherrschbar
|
manageable | boolean |
Optionaler Filter für die angegebenen Postinhaltstypen. Standardmäßig wird nicht gefiltert. |
|
|
Inhaltstyp
|
contentType | string |
Optionaler Filter für die angegebenen Postinhaltstypen. (Standardmäßig nicht filtern) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer |
Gesamtanzahl der gefundenen Beiträge. |
|
Begrenzung
|
limit | integer |
Die Menge der elemente, die zurückgegeben werden. |
|
offset
|
offset | integer |
Der aktuelle definierte Offset zum Abrufen der Elemente ab dieser Zahl. |
|
Daten
|
data | array of postData |
Beiträge: Abrufen eines Beitrags nach ID
Fordert die angegebenen Beiträge einschließlich einer Gruppe von Kommentaren an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Dies ist die ID des Beitrags. |
Gibt zurück
- Body
- postData
Beiträge: Abrufen von Kommentaren
Dient zum Abrufen einer Liste von Kommentaren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Verwalten
|
manage | boolean |
Wenn "true" und die Tokenrolle das Verwalten von Kommentaren zulässt , werden auch keine veröffentlichten Kommentare in der Liste angezeigt. |
|
|
Limit
|
limit | integer |
Die Anzahl der Elemente, die zurückgegeben werden sollen (Standard und maximal 100). |
|
|
Offset
|
offset | integer |
Definieren Sie einen Offset zum Abrufen der Elemente ab dieser Zahl. |
|
|
Filter
|
filter | string |
Filtern Sie im SCIM2-Format mit teilweiser Unterstützung. Nur flache Struktur (keine geschachtelten Klauseln) und Vergleichsklauseln wie eq = "equals", gt = "greater than", ge = "greater than or equals", lt = "less than", le = "less than or equals" werden unterstützt. Für Kommentare unterstützte Filterfelder sind: erstellt und aktualisiert. Der Wert für diese Felder kann in der UTC DateTime-Zeichenfolge angegeben werden, die eine lange Anzahl von Millisekunden der Unix-Epoche darstellt. Beispiel 1: filter=updated ge "2020-11-26T10:14:48.947Z" und aktualisiert le "2020-11-26T10:14:48.947Z". In diesem Beispiel wird der DateTime-Bereichsfilter auf aktualisierte Felder mit ge- und le-Vergleichsklauseln und booleschen Klauseln angewendet. Beispiel 2: filter=created gt "2020-11-26T10:14:48.947Z". Rufen Sie alle Kommentare ab, die nach dem Spitzdatum erstellt wurden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer |
Die Gesamtzahl der gefundenen Kommentare. |
|
Begrenzung
|
limit | integer |
Die Menge der elemente, die zurückgegeben werden. |
|
offset
|
offset | integer |
Der aktuelle definierte Offset zum Abrufen der Elemente ab dieser Zahl. |
|
Daten
|
data | array of object | |
|
id
|
data.id | string |
Dies ist die ID des Kommentars. |
|
parentID
|
data.parentID | string |
Die ID des übergeordneten Elements des Kommentars kann entweder ein Beitrag oder ein Kommentar sein. |
|
parentType
|
data.parentType | string |
Der übergeordnete Typ kann entweder ein Beitrag oder ein Kommentar sein. |
|
Kommentartext
|
data.text | string |
Dies ist der Kommentarinhalt / Test selbst. |
|
Post-ID
|
data.rootID | string |
Dies ist die ID des Beitrags, mit dem dieser Kommentar verknüpft ist. |
|
Autor
|
data.author | authorObject | |
|
gesamt
|
data.likes.total | integer |
Dies ist die Anzahl der Kommentar likes. |
|
isLiked
|
data.likes.isLiked | string |
Ist dieser Kommentar mit "Gefällt mir" gekennzeichnet? |
|
erstellt
|
data.created | string |
Das Erstellungsdatum des Kommentars. |
|
aktualisierte
|
data.updated | string |
Das aktualisierte Datum des Kommentars. |
|
image
|
data.image | imageObject |
Beiträge: Aktualisiert einen Beitrag
Aktualisiert einen Beitrag, nur geändertes Feld (inkrementell).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Dies kann entweder die post-ID sein, die von der API definiert wurde, oder wenn sie die externe POST-ID festlegen. |
|
externalID
|
externalID | string |
Optional: Geben Sie hier eine externe ID ein. |
|
|
Gebietsschema
|
locale | string |
Gebietsschema einfügen, z. B. de_DE, en_US usw. |
|
|
Inhalt
|
content | string |
Geben Sie hier Newsinhalte ein. |
|
|
image
|
image | string |
Geben Sie hier einen Link zu Bild ein. |
|
|
Teaser
|
teaser | string |
Geben Sie hier Ihren Teaser ein. |
|
|
title
|
title | string |
Geben Sie hier Ihren Titel ein. |
|
|
veröffentlicht
|
published | string |
Geben Sie Ihr hier veröffentlichtes Datum ein. |
Beiträge: Entfernt einen Beitrag
Entfernt einen Beitrag aus dem System.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Dies kann entweder die post-ID sein, die von der API definiert wurde, oder wenn sie die externe POST-ID festlegen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
identifier
|
identifier | integer |
Der Bezeichner des Löschvorgangs. |
|
statusCode (englisch)
|
statusCode | integer |
Der Statuscode der Aktion. |
|
message
|
message | string |
Die Nachricht der Aktion. |
|
type
|
type | string |
Der Typ der Aktion. |
Benachrichtigung: Benachrichtigung sendet
Sendet Benachrichtigungen an bestimmte Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
accessorIds
|
accessorIds | array of string | ||
|
Gebietsschema
|
locale | string |
Gebietsschema einfügen, z. B. de_DE, en_US usw. |
|
|
title
|
title | string |
Sprachabhängiger Titel einfügen. |
|
|
link
|
link | string |
Optinal: Link hier einfügen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Dies ist die ID der Benachrichtigung. |
|
accessorIds
|
recipients.accessorIds | array of string |
Dies ist die Liste der Empfänger-IDs. |
|
Inhalt
|
content | array of object | |
|
title
|
content.title | string |
Der Titel der Benachrichtigung, die lokalisiert wird. |
|
Gebietsschema
|
content.locale | string |
Dies ist das Gebietsschema des Titels. |
|
link
|
link | string |
Dies ist der Benachrichtigungslink. |
|
type
|
type | string |
Dies ist der Benachrichtigungstyp. |
|
ErstelltAm
|
createdAt | string |
Das Erstellungsdatum der Benachrichtigung. |
|
erstellt
|
created | string |
Das Erstellungsdatum der Benachrichtigung. |
Benutzer: Abrufen von Benutzerinformationen
Rufen Sie bestimmte Benutzerinformationen anhand der Benutzer-ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
Die ID kann entweder auf der Benutzer-ID basieren, die automatisch von der Staffbase-Plattform oder der externen ID generiert wird, wenn sie für den Benutzer hinzugefügt wird. |
Gibt zurück
- Body
- userData
Benutzer: Aktualisieren von Benutzerinformationen
Aktualisieren von Benutzerinformationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
Die ID kann entweder auf der Benutzer-ID basieren, die automatisch von der Staffbase-Plattform oder der externen ID generiert wird, wenn sie für den Benutzer hinzugefügt wird. |
|
id
|
id | string |
Die ID des Benutzers |
|
|
externalID
|
externalID | string |
Die externe ID des Benutzers |
|
|
Vorname
|
firstName | string |
Der Vorname des Benutzers |
|
|
lastName
|
lastName | string |
Der Nachname des Benutzers |
|
|
publicEmailAddress
|
publicEmailAddress | string |
Die öffentliche E-Mail des Benutzers |
|
|
Gebietsschema
|
locale | string |
Das Gebietsschema des Benutzers |
|
|
E-Mail
|
value | string |
Die E-Mail-Adresse |
|
|
primär
|
primary | boolean |
Ist es die primäre E-Mail? |
|
|
groupIDs
|
groupIDs | array of string | ||
|
Position
|
position | string |
Die Position des Benutzers |
|
|
Abteilung
|
department | string |
Die Abteilung des Benutzers |
|
|
location
|
location | string |
Der Speicherort des Benutzers |
|
|
Telefonnummer
|
phoneNumber | string |
Die Telefonnummer des Benutzers |
|
|
erstellt
|
created | string |
Das Erstellungsdatum des Benutzers |
|
|
aktualisierte
|
updated | string |
Das Aktualisierungsdatum des Benutzers |
|
|
Aktiviert
|
activated | string |
Ist der Benutzer aktiviert? |
Gibt zurück
- Body
- userData
Benutzer: Benutzer einladen
Der Benutzer erhält eine E-Mail zur Registrierung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail
|
string |
Dies ist die E-Mail-Adresse des Benutzers. |
||
|
Vorname
|
firstName | string |
Dies ist der Vorname des Benutzers. |
|
|
lastName
|
lastName | string |
Dies ist der Nachname des Benutzers. |
Benutzer: Benutzer löschen
Löscht den angegebenen Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
Die ID kann entweder auf der Benutzer-ID basieren, die automatisch von der Staffbase-Plattform oder der externen ID generiert wird, wenn sie für den Benutzer hinzugefügt wird. |
Benutzer: Liste der Benutzer abrufen
Abrufen einer Liste von Benutzern, abhängig vom API-Zugriffstoken.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
SCIM-Notation kann zum Filtern verwendet werden
|
filter | string |
SCIM-Notation kann zum Filtern verwendet werden. |
|
|
Die Volltextsuche kann mit dem Filter kombiniert werden.
|
query | string |
Hier können Sie in jedem Profilfeld serachen. |
Benutzer: Senden einer Wiederherstellungs-E-Mail
Sendet eine Wiederherstellungs-E-Mail an den angegebenen Benutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
Die ID kann entweder auf der Benutzer-ID basieren, die automatisch von der Staffbase-Plattform oder der externen ID generiert wird, wenn sie für den Benutzer hinzugefügt wird. |
Kanäle: Abrufen einer Liste von Beiträgen innerhalb des angegebenen Kanals
Dient zum Abrufen einer Liste von Beiträgen innerhalb des angegebenen Kanals.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Fügen Sie hier die Kanal-ID ein, z. B. von getChannels abgerufen. |
|
Limit
|
limit | integer |
Die Anzahl der Elemente, die zurückgegeben werden sollen (Standard und maximal 100). |
|
|
Offset
|
offset | integer |
Definieren Sie einen Offset zum Abrufen der Elemente ab dieser Zahl. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer |
Gesamtanzahl der gefundenen Beiträge. |
|
Begrenzung
|
limit | integer |
Die Menge der elemente, die zurückgegeben werden. |
|
offset
|
offset | integer |
Der aktuelle definierte Offset zum Abrufen der Elemente ab dieser Zahl. |
|
Daten
|
data | array of postData |
Kanäle: Abrufen einer Liste von Nachrichtenkanälen
Dient zum Abrufen einer Liste von Nachrichtenkanälen.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer |
Die Gesamtzahl der gefundenen Kanäle. |
|
Begrenzung
|
limit | integer |
Die Menge der elemente, die zurückgegeben werden. |
|
offset
|
offset | integer |
Der aktuelle definierte Offset zum Abrufen der Elemente ab dieser Zahl. |
|
Daten
|
data | array of object | |
|
id
|
data.id | string |
Dies ist die ID des Kanals. |
|
Lokalisierung
|
data.config.localization | array of object | |
|
title
|
data.config.localization.title | string |
Der Kanaltitel, der lokalisiert wird. |
|
Gebietsschema
|
data.config.localization.locale | string |
Dies ist das Gebietsschema des Kanaltitels. |
|
spaceID
|
data.spaceID | string |
Die ID des Leerzeichens, dem der Kanal zugewiesen ist. |
|
erstellt
|
data.created | string |
Das Erstellungsdatum des Kanals. |
|
veröffentlicht
|
data.published | string |
Das Veröffentlichungsdatum des Kanals. |
|
aktualisierte
|
data.updated | string |
Das Aktualisierungsdatum des Kanals. |
Kanäle: Senden eines Beitrags an einen bestimmten Kanal
Senden Sie einen Beitrag an einen bestimmten Nachrichtenkanal.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Fügen Sie hier die Kanal-ID ein. |
|
externalID
|
externalID | string |
Optional: Geben Sie hier eine externe ID ein. |
|
|
Gebietsschema
|
locale | string |
Gebietsschema einfügen, z. B. de_DE, en_US usw. |
|
|
Inhalt
|
content | string |
Geben Sie hier Newsinhalte ein. |
|
|
Bild (Link)
|
image | string |
Geben Sie hier den Bildlink ein. |
|
|
Teaser
|
teaser | string |
Geben Sie hier Ihren Teaser ein. |
|
|
title
|
title | string |
Geben Sie hier Ihren Titel ein. |
|
|
veröffentlicht
|
published | string |
Geben Sie Ihr hier veröffentlichtes Datum ein. |
Medien: Abrufen aller Medien
Anforderungsbeschreibung aller im aktuellen Kontext verfügbaren Medien.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Beschränken Sie hier die Anzahl der Elemente. |
|
|
Offset
|
offset | integer |
Legen Sie einen Offset für die Abfrage fest. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer |
Die Gesamtanzahl der gefundenen Ressourcen. |
|
Begrenzung
|
limit | integer |
Die Menge der elemente, die zurückgegeben werden. |
|
offset
|
offset | integer |
Der aktuelle definierte Offset zum Abrufen der Elemente ab dieser Zahl. |
|
Daten
|
data | array of mediaData |
Medien: Medien löschen
Löscht die angegebenen Medien im aktuellen Kontext.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
MediumID
|
mediumID | True | string |
Löscht das Medium anhand seiner ID. Dies wird die Ressource zwar sofort von unseren Servern entfernen, aber das CDN kann den Inhalt weiterhin über die URL bereitstellen, die in resourceInfo.url angegeben ist, bis cdN ungültig wird. |
Medien: Medien nach ID abrufen
Rufen Sie Metadaten für einzelne Medien anhand ihrer ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
MediumID
|
mediumID | True | string |
Fordert Informationen zu einem bestimmten Medium an. |
Gibt zurück
- Body
- mediaData
Proxy: Version abrufen
Gibt die aktuelle Proxyversion zurück.
Definitionen
mediaData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Dies ist die ID der Ressource. |
|
ownerID
|
ownerID | string |
Dies ist die ID des Besitzers dieser Ressource. |
|
parentID
|
parentID | string |
Dies ist die ID der übergeordneten Medienressource. |
|
publicID
|
publicID | string |
Dies ist die öffentliche ID für den Zugriff auf die Ressource. |
|
type
|
resourceInfo.type | string |
Dies ist der Ressourcentyp der Ressource. |
|
Byte
|
resourceInfo.bytes | integer |
Dies ist die Ressourcengröße (in Byte). |
|
width
|
resourceInfo.width | integer |
Dies ist die Ressourcenbreite. |
|
height
|
resourceInfo.height | integer |
Dies ist die Ressourcenhöhe. |
|
URL
|
resourceInfo.url | string |
Dies ist die Ressourcen-URL. |
|
format
|
resourceInfo.format | string |
Dies ist das Ressourcenformat. |
|
mimeType
|
resourceInfo.mimeType | string |
Dies ist der MIME-Ressourcentyp. |
|
fileName
|
fileName | string |
Dies ist der Mediendateiname. |
|
title
|
title | string |
Dies ist der Medientitel. |
|
label
|
label | string |
Dies ist die Medienbezeichnung. |
|
erstellt
|
created | string |
Das Erstellungsdatum der Ressource. |
Benutzerdaten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Die ID des Benutzers |
|
externalID
|
externalID | string |
Die externe ID des Benutzers |
|
Vorname
|
firstName | string |
Der Vorname des Benutzers |
|
lastName
|
lastName | string |
Der Nachname des Benutzers |
|
publicEmailAddress
|
publicEmailAddress | string |
Die öffentliche E-Mail des Benutzers |
|
Gebietsschema
|
config.locale | string |
Das Gebietsschema des Benutzers |
|
E-Mails
|
emails | array of object |
Benutzer-E-Mail-Informationen |
|
E-Mail
|
emails.value | string |
Die E-Mail-Adresse |
|
primär
|
emails.primary | boolean |
Ist es die primäre E-Mail? |
|
groupIDs
|
groupIDs | array of string | |
|
Position
|
position | string |
Die Position des Benutzers |
|
Abteilung
|
department | string |
Die Abteilung des Benutzers |
|
location
|
location | string |
Der Speicherort des Benutzers |
|
Telefonnummer
|
phoneNumber | string |
Die Telefonnummer des Benutzers |
|
erstellt
|
created | string |
Das Erstellungsdatum des Benutzers |
|
aktualisierte
|
updated | string |
Das Aktualisierungsdatum des Benutzers |
|
Aktiviert
|
activated | string |
Ist der Benutzer aktiviert? |
postData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Die ID des Beitrags. |
|
Autor
|
author | authorObject | |
|
contents
|
contents | array of object | |
|
Inhalt
|
contents.content | string |
Der Beitragsinhalt, der lokalisiert wird. |
|
image
|
contents.image | imageObject | |
|
Teaser
|
contents.teaser | string |
Der Post Teaser, der lokalisiert wird. |
|
title
|
contents.title | string |
Der Beitragstitel, der lokalisiert wird. |
|
Gebietsschema
|
contents.locale | string |
Dies ist das Gebietsschema des Elements. |
|
id
|
channel.id | string |
Dies ist die ID des Kanals. |
|
Lokalisierung
|
channel.config.localization | array of object | |
|
title
|
channel.config.localization.title | string |
Dies ist der Kanaltitel, der lokalisiert wird. |
|
Gebietsschema
|
channel.config.localization.locale | string |
Dies ist das Gebietsschema des Kanaltitels. |
|
veröffentlicht
|
published | string |
Das Veröffentlichungsdatum des Beitrags. |
|
erstellt
|
created | string |
Das Erstellungsdatum des Beitrags. |
|
aktualisierte
|
updated | string |
Das Aktualisierungsdatum des Beitrags. |
authorObject
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorname
|
firstName | string |
Dies ist der Vorname des Autors. |
|
id
|
id | string |
Dies ist die ID des Autors. |
|
lastName
|
lastName | string |
Dies ist der Nachname des Autors. |
|
URL
|
avatar.original.url | string |
Dies ist die originale URL des Avatarbilds des Autors. |
|
width
|
avatar.original.width | integer |
Dies ist die originale Breite des Avatarbilds des Autors. |
|
height
|
avatar.original.height | integer |
Dies ist die Originalhöhe des Avatarbilds des Autors. |
|
size
|
avatar.original.size | integer |
Dies ist das Avatarbild des Autors, das original sie (in Bytes) ist. |
|
format
|
avatar.original.format | string |
Dies ist das Originalformat des Autors. |
|
mimeType
|
avatar.original.mimeType | string |
Dies ist das athor Avatar-Bild original mimeType. |
|
erstellt
|
avatar.original.created | string |
Dies ist das Ursprüngliche Erstellungsdatum des Autors. |
|
URL
|
avatar.icon.url | string |
Dies ist die Url des Avatarsymbols "Autor". |
|
width
|
avatar.icon.width | integer |
Dies ist die Breite des Avatar-Avatars des Autors. |
|
height
|
avatar.icon.height | integer |
Dies ist die Symbolhöhe des Autors. |
|
format
|
avatar.icon.format | string |
Dies ist das Avatarsymbolformat des Autors. |
|
mimeType
|
avatar.icon.mimeType | string |
Dies ist das Avatarsymbol des Autors mimeType. |
|
URL
|
avatar.thumb.url | string |
Dies ist die Avatar-Url des Autors. |
|
width
|
avatar.thumb.width | integer |
Dies ist die Miniaturbreite des Autors. |
|
height
|
avatar.thumb.height | integer |
Dies ist die Miniaturhöhe des Autors. |
|
format
|
avatar.thumb.format | string |
Dies ist das Avatar-Miniaturformat des Autors. |
|
mimeType
|
avatar.thumb.mimeType | string |
Dies ist der Athor Avatar thumb mimeType. |
|
publicID
|
avatar.publicID | string |
Dies ist die öffentliche AVATAR-ID des Autors. |
imageObject
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL
|
original.url | string |
Dies ist die ursprüngliche Bild-URL. |
|
width
|
original.width | integer |
Dies ist die Ursprüngliche Breite des Bilds. |
|
height
|
original.height | integer |
Dies ist die ursprüngliche Höhe des Bilds. |
|
size
|
original.size | integer |
Dies ist die Originalgröße des Bilds (in Bytes). |
|
format
|
original.format | string |
Dies ist das Originalformat des Bilds. |
|
mimeType
|
original.mimeType | string |
Dies ist der ursprüngliche MimeType des Bilds. |
|
URL
|
original_scaled.url | string |
Dies ist die ursprüngliche Bild-URL. |
|
width
|
original_scaled.width | integer |
Dies ist die Ursprüngliche Breite des Bilds. |
|
height
|
original_scaled.height | integer |
Dies ist die ursprüngliche Höhe des Bilds. |
|
format
|
original_scaled.format | string |
Dies ist das Originalformat des Bilds. |
|
mimeType
|
original_scaled.mimeType | string |
Dies ist der ursprüngliche MimeType des Bilds. |
|
URL
|
compact.url | string |
Dies ist die Bildkomprimen-URL. |
|
width
|
compact.width | integer |
Dies ist die kompakte Bildbreite. |
|
height
|
compact.height | integer |
Dies ist die kompakte Bildhöhe. |
|
format
|
compact.format | string |
Dies ist das Bildkomprimformat. |
|
mimeType
|
compact.mimeType | string |
Dies ist der compact mimeType des Bilds. |