
Sprache 🇩🇪 Deutsch
Erste Schritte
Dokumentation
Aggregation
Audit-Protokolle
Vom Kommentar blockieren
Check gesperrter Kommentare
Kommentare
Domain-Konfigurationen
E-Mail-Vorlagen
Ereignisprotokoll
Feed-Beiträge
Kommentar melden
Hashtags
Moderatoren
Benachrichtigungsanzahl
Benachrichtigungen
Seiten
Ausstehende Webhook-Ereignisse
Fragekonfigurationen
Frageergebnisse
Aggregation von Frageergebnissen
SSO-Benutzer
Abonnements
Tägliche Mandantennutzung
Mandantenpakete
Mandantenbenutzer
Mandanten
Tickets
Bild hochladen
Fortschritt der Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Benutzer-Präsenzstatus
Benutzersuche
Benutzer
Abstimmungen
FastComments Python SDK
Dies ist das offizielle Python-SDK für FastComments.
Offizielles Python-SDK für die FastComments-API
Repository
Installation 
PyPI
pip install fastcomments
Bibliotheksinhalte
Diese Bibliothek enthält zwei Module: den generierten API-Client und die Kern-Python-Bibliothek, die handgeschriebene Hilfsfunktionen enthält, um die Arbeit mit der API zu erleichtern, einschließlich SSO-Unterstützung.
Öffentliche vs. gesicherte APIs
Für den API-Client gibt es zwei Klassen, DefaultApi und PublicApi. Die DefaultApi enthält Methoden, die deinen API-Schlüssel benötigen, und PublicApi enthält API-Aufrufe, die direkt aus einem Browser/Mobilgerät/etc. ohne Authentifizierung durchgeführt werden können.
Schnellstart 
Verwendung authentifizierter APIs (DefaultApi)
Wichtig: Du musst deinen API-Schlüssel in der Configuration setzen, bevor du authentifizierte Anfragen durchführst. Wenn du das nicht tust, schlagen Anfragen mit einem 401-Fehler fehl.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Erstelle und konfiguriere den API-Client
config = Configuration()
config.host = "https://fastcomments.com/api"
# ERFORDERLICH: Setze deinen API-Schlüssel (diesen bekommst du in deinem FastComments-Dashboard)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Erstelle die API-Instanz mit dem konfigurierten Client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Jetzt kannst du authentifizierte API-Aufrufe machen
try:
# Beispiel: Einen SSO-Benutzer hinzufügen
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Häufige Fehler:
# - 401: API-Schlüssel fehlt oder ist ungültig
# - 400: Anfragevalidierung fehlgeschlagen
Verwendung öffentlicher APIs (PublicApi)
Öffentliche Endpunkte erfordern keine Authentifizierung:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Verwendung von SSO (Single Sign-On)
Das SDK enthält Hilfsfunktionen zum Erzeugen sicherer SSO-Tokens:
from sso import FastCommentsSSO, SecureSSOUserData
# Erstelle Benutzerdaten
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Erstelle eine SSO-Instanz mit deinem API-Geheimnis
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Generiere das SSO-Token
sso_token = sso.create_token()
# Verwende dieses Token im Frontend oder übergib es an API-Aufrufe
print(f"SSO Token: {sso_token}")
Für einfaches SSO (weniger sicher, zum Testen):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Häufige Probleme
- 401 "missing-api-key" Fehler: Stelle sicher, dass du
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}setzt, bevor du die DefaultApi-Instanz erstellst. - Falsche API-Klasse: Verwende
DefaultApifür serverseitige authentifizierte Anfragen,PublicApifür clientseitige/öffentliche Anfragen. - Importfehler: Stelle sicher, dass du aus dem richtigen Modul importierst:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Hinweise 
Broadcast-IDs
Sie werden feststellen, dass Sie in einigen API-Aufrufen ein broadcast_id übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen auf dem Client optimistisch anwenden möchten (was Sie wahrscheinlich tun sollten, da es die beste Nutzererfahrung bietet). Übergeben Sie hier eine UUID. Die ID sollte so einzigartig sein, dass sie in einer Browsersitzung nicht zweimal vorkommt.
Anforderungen 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
Aggregieren 
Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg, etc.) werden unterstützt.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nein | |
| includeStats | boolean | query | Nein |
Antwort
Gibt zurück: AggregationResponse
Beispiel

Audit-Protokolle abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nein | |
| skip | number | query | Nein | |
| order | string | query | Nein | |
| after | number | query | Nein | |
| before | number | query | Nein |
Antwort
Gibt zurück: GetAuditLogs200Response
Beispiel

Öffentlichen Kommentar blockieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: BlockFromCommentPublic200Response
Beispiel

Öffentliche Kommentar-Blockierung aufheben 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UnBlockCommentPublic200Response
Beispiel

Auf gesperrte Kommentare prüfen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Eine durch Kommas getrennte Liste von Kommentar-IDs. |
| sso | string | query | No |
Antwort
Gibt zurück: CheckedCommentsForBlocked200Response
Beispiel

Benutzer vom Kommentar blockieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: BlockFromCommentPublic200Response
Beispiel

Öffentlichen Kommentar erstellen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateCommentPublic200Response
Beispiel

Kommentar löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Gibt zurück: DeleteComment200Response
Beispiel

Öffentlichen Kommentar löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| commentId | string | Pfad | Ja | |
| broadcastId | string | Abfrage | Ja | |
| editKey | string | Abfrage | Nein | |
| sso | string | Abfrage | Nein |
Antwort
Gibt zurück: DeleteCommentPublic200Response
Beispiel

Kommentar-Abstimmung löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: DeleteCommentVote200Response
Beispiel

Kommentar melden 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: FlagComment200Response
Beispiel

Kommentar abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetComment200Response
Beispiel

Kommentartext abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetCommentText200Response
Beispiel

Nutzernamen der Kommentarabstimmungen abrufen 
Parameter
| Name | Typ | Standort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: GetCommentVoteUserNames200Response
Beispiel

Kommentare abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nein | |
| limit | integer | query | Nein | |
| skip | integer | query | Nein | |
| asTree | boolean | query | Nein | |
| skipChildren | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein | |
| contextUserId | string | query | Nein | |
| hashTag | string | query | Nein | |
| parentId | string | query | Nein | |
| direction | string | query | Nein |
Antwort
Gibt zurück: GetComments200Response
Beispiel

Öffentliche Kommentare abrufen 
req tenantId urlId
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nein | |
| direction | string | query | Nein | |
| sso | string | query | Nein | |
| skip | integer | query | Nein | |
| skipChildren | integer | query | Nein | |
| limit | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| countChildren | boolean | query | Nein | |
| fetchPageForCommentId | string | query | Nein | |
| includeConfig | boolean | query | Nein | |
| countAll | boolean | query | Nein | |
| includei10n | boolean | query | Nein | |
| locale | string | query | Nein | |
| modules | string | query | Nein | |
| isCrawler | boolean | query | Nein | |
| includeNotificationCount | boolean | query | Nein | |
| asTree | boolean | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| useFullTranslationIds | boolean | query | Nein | |
| parentId | string | query | Nein | |
| searchText | string | query | Nein | |
| hashTags | array | query | Nein | |
| userId | string | query | Nein | |
| customConfigStr | string | query | Nein | |
| afterCommentId | string | query | Nein | |
| beforeCommentId | string | query | Nein |
Antwort
Gibt zurück: GetCommentsPublic200Response
Beispiel

Kommentar sperren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: LockComment200Response
Beispiel

Kommentar anpinnen 
Parameters
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Response
Gibt zurück: PinComment200Response
Beispiel

Kommentar speichern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| sendEmails | boolean | query | Nein | |
| populateNotifications | boolean | query | Nein |
Antwort
Gibt zurück: SaveComment200Response
Beispiel

Kommentare stapelweise speichern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Antwort
Gibt zurück: SaveComment200Response
Beispiel

Kommentartext setzen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: SetCommentText200Response
Beispiel

Benutzerblockierung vom Kommentar aufheben 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: UnBlockCommentPublic200Response
Beispiel

Kommentarmeldung aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: FlagComment200Response
Beispiel

Kommentar entsperren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: LockComment200Response
Beispiel

Kommentar entpinnen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: PinComment200Response
Beispiel

Kommentar aktualisieren 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Für Kommentar abstimmen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: VoteComment200Response
Beispiel

Domain-Konfiguration hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddDomainConfig200Response
Beispiel

Domain-Konfiguration löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Gibt zurück: DeleteDomainConfig200Response
Beispiel

Domain-Konfiguration abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
Beispiel

Domain-Konfigurationen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetDomainConfigs200Response
Beispiel

Domain-Konfiguration teilweise aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
Beispiel

Domain-Konfiguration ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
Beispiel

E-Mail-Vorlage erstellen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateEmailTemplate200Response
Beispiel

E-Mail-Vorlage löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

E-Mail-Vorlagen-Renderfehler löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

E-Mail-Vorlage abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetEmailTemplate200Response
Beispiel

Definitionen der E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetEmailTemplateDefinitions200Response
Beispiel

Renderfehler der E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Antwort
Rückgabe: GetEmailTemplateRenderErrors200Response
Beispiel

E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetEmailTemplates200Response
Beispiel

E-Mail-Vorlage rendern 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nein |
Antwort
Gibt zurück: RenderEmailTemplate200Response
Beispiel

E-Mail-Vorlage aktualisieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Ereignisprotokoll abrufen 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Antwort
Gibt zurück: GetEventLog200Response
Beispiel

Globales Ereignisprotokoll abrufen 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Antwort
Gibt zurück: GetEventLog200Response
Beispiel

Feed-Beitrag erstellen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nein | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| skipDupCheck | boolean | query | Nein |
Antwort
Gibt zurück: CreateFeedPost200Response
Beispiel

Öffentlichen Feed-Beitrag erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateFeedPostPublic200Response
Beispiel

Öffentlichen Feed-Beitrag löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| postId | string | Pfad | Ja | |
| broadcastId | string | Abfrage | Nein | |
| sso | string | Abfrage | Nein |
Antwort
Gibt zurück: DeleteFeedPostPublic200Response
Beispiel

Feed-Beiträge abrufen 
req tenantId afterId
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Antwort
Gibt zurück: GetFeedPosts200Response
Beispiel

Öffentliche Feed-Beiträge abrufen 
req tenantId afterId
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nein | |
| limit | integer | query | Nein | |
| tags | array | query | Nein | |
| sso | string | query | Nein | |
| isCrawler | boolean | query | Nein | |
| includeUserInfo | boolean | query | Nein |
Antwort
Gibt zurück: GetFeedPostsPublic200Response
Beispiel

Statistiken der Feed-Beiträge abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetFeedPostsStats200Response
Beispiel

Öffentliche Nutzerreaktionen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetUserReactsPublic200Response
Beispiel

Auf öffentlichen Feed-Beitrag reagieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ReactFeedPostPublic200Response
Beispiel

Feed-Beitrag aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Öffentlichen Feed-Beitrag aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateFeedPostPublic200Response
Beispiel

Öffentlichen Kommentar melden 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Hashtag hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Nein |
Antwort
Gibt zurück: AddHashTag200Response
Beispiel

Hashtags stapelweise hinzufügen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Nein |
Response
Gibt zurück: AddHashTagsBulk200Response
Beispiel

Hashtag löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Hashtags abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nein |
Antwort
Gibt zurück: GetHashTags200Response
Beispiel

Hashtag teilweise aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nein |
Antwort
Gibt zurück: PatchHashTag200Response
Beispiel

Moderator erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateModerator200Response
Beispiel

Moderator löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Moderator abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetModerator200Response
Beispiel

Moderatoren abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetModerators200Response
Beispiel

Einladung senden 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Moderator aktualisieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Benachrichtigungsanzahl löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Zwischengespeicherte Benachrichtigungsanzahl abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetCachedNotificationCount200Response
Beispiel

Benachrichtigungsanzahl abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein |
Antwort
Gibt zurück: GetNotificationCount200Response
Beispiel

Benachrichtigungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetNotifications200Response
Beispiel

Benachrichtigung aktualisieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Seite hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddPageAPIResponse
Beispiel

Seite löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Gibt zurück: DeletePageAPIResponse
Beispiel

Seite nach URL-ID abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetPageByURLIdAPIResponse
Beispiel

Seiten abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetPagesAPIResponse
Beispiel

Seite teilweise aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: PatchPageAPIResponse
Beispiel

Ausstehendes Webhook-Ereignis löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Anzahl ausstehender Webhook-Ereignisse abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| externalId | string | query | Nein | |
| eventType | string | query | Nein | |
| type | string | query | Nein | |
| domain | string | query | Nein | |
| attemptCountGT | number | query | Nein |
Antwort
Gibt zurück: GetPendingWebhookEventCount200Response
Beispiel

Ausstehende Webhook-Ereignisse abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| externalId | string | query | Nein | |
| eventType | string | query | Nein | |
| type | string | query | Nein | |
| domain | string | query | Nein | |
| attemptCountGT | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetPendingWebhookEvents200Response
Beispiel

Fragekonfiguration erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateQuestionConfig200Response
Beispiel

Fragekonfiguration löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Fragekonfiguration abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetQuestionConfig200Response
Beispiel

Fragekonfigurationen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetQuestionConfigs200Response
Beispiel

Fragekonfiguration aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Frageergebnis erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateQuestionResult200Response
Beispiel

Frageergebnis löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Frageergebnis abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetQuestionResult200Response
Beispiel

Frageergebnisse abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| startDate | string | query | Nein | |
| questionId | string | query | Nein | |
| questionIds | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetQuestionResults200Response
Beispiel

Frageergebnis aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Frageergebnisse aggregieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Antwort
Gibt zurück: AggregateQuestionResults200Response
Beispiel

Frageergebnisse stapelweise aggregieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nein |
Antwort
Gibt zurück: BulkAggregateQuestionResults200Response
Beispiel

Kommentare mit Frageergebnissen kombinieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nein | |
| questionIds | array | query | Nein | |
| urlId | string | query | Nein | |
| startDate | string | query | Nein | |
| forceRecalculate | boolean | query | Nein | |
| minValue | number | query | Nein | |
| maxValue | number | query | Nein | |
| limit | number | query | Nein |
Antwort
Gibt zurück: CombineCommentsWithQuestionResults200Response
Beispiel

SSO-Benutzer hinzufügen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddSSOUserAPIResponse
Beispiel

SSO-Benutzer löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Rückgabe: DeleteSSOUserAPIResponse
Beispiel

SSO-Benutzer per E-Mail abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByEmailAPIResponse
Beispiel

SSO-Benutzer per ID abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetSSOUserByIdAPIResponse
Beispiel

SSO-Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Antwort
Gibt zurück: GetSSOUsers200Response
Beispiel

SSO-Benutzer teilweise aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Gibt zurück: PatchSSOUserAPIResponse
Beispiel

SSO-Benutzer ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Antwort
Gibt zurück: PutSSOUserAPIResponse
Beispiel

Abonnement erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateSubscriptionAPIResponse
Beispiel

Abonnement löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: DeleteSubscriptionAPIResponse
Beispiel

Abonnements abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: GetSubscriptionsAPIResponse
Beispiel

Abonnement aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: UpdateSubscriptionAPIResponse
Beispiel

Tägliche Mandantennutzung abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nein | |
| monthNumber | number | query | Nein | |
| dayNumber | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantDailyUsages200Response
Beispiel

Mandantenpaket erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantPackage200Response
Beispiel

Mandantenpaket löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenpaket abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantPackage200Response
Beispiel

Mandantenpakete abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantPackages200Response
Beispiel

Mandantenpaket ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenpaket aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenbenutzer erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantUser200Response
Beispiel

Mandantenbenutzer löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenbenutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantUser200Response
Beispiel

Mandantenbenutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantUsers200Response
Beispiel

Mandantenbenutzer ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Login-Link senden 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenbenutzer aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandant erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenant200Response
Beispiel

Mandant löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandant abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenant200Response
Beispiel

Mandanten abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenants200Response
Beispiel

Mandant aktualisieren 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Ticketstatus ändern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: ChangeTicketState200Response
Beispiel

Ticket erstellen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwort
Gibt zurück: CreateTicket200Response
Beispiel

Ticket abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: GetTicket200Response
Beispiel

Tickets abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| state | number | query | Nein | |
| skip | number | query | Nein | |
| limit | number | query | Nein |
Antwort
Gibt zurück: GetTickets200Response
Beispiel

Bild hochladen 
Bild hochladen und skalieren
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Größen-Vorgabe: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte) |
| urlId | string | query | No | Seiten-ID, von der der Upload stattfindet, zur Konfiguration |
Antwort
Gibt zurück: UploadImageResponse
Beispiel

Fortschritt des Benutzerabzeichens nach ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

Fortschritt des Benutzerabzeichens nach Benutzer-ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

Liste des Fortschritts der Benutzerabzeichen abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetUserBadgeProgressList200Response
Beispiel

Benutzerabzeichen erstellen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Gibt zurück: CreateUserBadge200Response
Beispiel

Benutzerabzeichen löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: UpdateUserBadge200Response
Beispiel

Benutzerabzeichen abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetUserBadge200Response
Beispiel

Benutzerabzeichen abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Antwort
Gibt zurück: GetUserBadges200Response
Beispiel

Benutzerabzeichen aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: UpdateUserBadge200Response
Beispiel

Benutzer-Benachrichtigungsanzahl abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetUserNotificationCount200Response
Beispiel

Benutzer-Benachrichtigungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| pageSize | integer | query | Nein | |
| afterId | string | query | Nein | |
| includeContext | boolean | query | Nein | |
| afterCreatedAt | integer | query | Nein | |
| unreadOnly | boolean | query | Nein | |
| dmOnly | boolean | query | Nein | |
| noDm | boolean | query | Nein | |
| includeTranslations | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetUserNotifications200Response
Beispiel

Benutzer-Benachrichtigungsanzahl zurücksetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ResetUserNotifications200Response
Beispiel

Benutzer-Benachrichtigungen zurücksetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nein | |
| afterCreatedAt | integer | query | Nein | |
| unreadOnly | boolean | query | Nein | |
| dmOnly | boolean | query | Nein | |
| noDm | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ResetUserNotifications200Response
Beispiel

Kommentar-Abonnementstatus des Benutzers aktualisieren 
Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

Seiten-Abonnementstatus des Benutzers aktualisieren 
Aktivieren oder deaktivieren Sie Benachrichtigungen für eine Seite. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und außerdem
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

Benachrichtigungsstatus des Benutzers aktualisieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

Benutzer-Präsenzstatus abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Antwort
Gibt zurück: GetUserPresenceStatuses200Response
Beispiel

Benutzer suchen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nein | |
| mentionGroupIds | array | query | Nein | |
| sso | string | query | Nein | |
| searchSection | string | query | Nein |
Antwort
Gibt zurück: SearchUsers200Response
Beispiel

Benutzer abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetUser200Response
Beispiel

Abstimmung erstellen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: VoteComment200Response
Beispiel

Abstimmung löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nein |
Antwort
Gibt zurück: DeleteCommentVote200Response
Beispiel

Abstimmungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetVotes200Response
Beispiel

Abstimmungen für Benutzer abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: GetVotesForUser200Response
Beispiel

Benötigen Sie Hilfe?
Wenn Sie auf Probleme stoßen oder Fragen zum Python SDK haben, bitte:
Mitwirken
Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Richtlinien zur Mitarbeit.