
Sprache 🇩🇪 Deutsch
Erste Schritte
Dokumentation
API-Referenz
Aggregation
Audit-Protokolle
Vom Kommentar blockieren
Gesperrte Kommentare prüfen
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 Nutzung des Mandanten
Mandantenpakete
Mandantenbenutzer
Mandanten
Bild hochladen
Fortschritt der Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Status der Benutzeranwesenheit
Benutzersuche
Benutzer
Stimmen
FastComments Swift SDK
Dies ist das offizielle Swift SDK für FastComments.
Offizielles Swift SDK für die FastComments API
Repository
Installation 
Swift Package Manager
Fügen Sie Folgendes zu Ihrer Package.swift-Datei hinzu:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
Oder in Xcode:
- Datei > Pakete hinzufügen...
- Geben Sie die Repository-URL ein:
https://github.com/fastcomments/fastcomments-swift.git - Wählen Sie die gewünschte Version aus
Anforderungen
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Bibliotheksinhalt 
Die FastComments Swift SDK besteht aus mehreren Modulen:
Client-Modul - Auto-generierter API-Client für die FastComments REST-APIs
- Vollständige Typdefinitionen für alle API-Modelle
- Sowohl authentifizierte (
DefaultAPI) als auch öffentliche (PublicAPI) Endpunkte - Volle async/await-Unterstützung
- Siehe client/README.md für detaillierte API-Dokumentation
SSO-Modul - Serverseitige Single Sign-On-Dienstprogramme
- Sichere Token-Erzeugung für die Benutzerauthentifizierung
- Unterstützung für sowohl einfache als auch sichere SSO-Modi
- Auf HMAC-SHA256 basierende Token-Signierung mit CryptoKit
Schnellstart 
Verwendung der öffentlichen API
import FastCommentsSwift
// API-Client erstellen
let publicApi = PublicAPI()
// Kommentare für eine Seite abrufen
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Verwendung der authentifizierten API
import FastCommentsSwift
// Konfiguration mit API-Schlüssel erstellen
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Kommentare mit der authentifizierten API abrufen
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
SSO für die Authentifizierung verwenden
Sicheres SSO (Für den Produktiveinsatz empfohlen)
import FastCommentsSwift
let apiKey = "your-api-key"
// Sichere SSO-Benutzerdaten erstellen (nur serverseitig!)
let userData = SecureSSOUserData(
id: "user-123", // Benutzer-ID
email: "user@example.com", // E-Mail
username: "johndoe", // Benutzername
avatar: "https://example.com/avatar.jpg" // Avatar-URL
)
// SSO-Token generieren
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Übergeben Sie dieses Token an Ihr Frontend zur Authentifizierung
} catch {
print("Error creating SSO token: \(error)")
}
Einfaches SSO (Für Entwicklung/Tests)
import FastCommentsSwift
// Einfache SSO-Benutzerdaten erstellen (kein API-Schlüssel erforderlich)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Einfaches SSO-Token generieren
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Öffentliche vs. gesicherte APIs 
Das FastComments SDK bietet zwei Arten von API-Endpunkten:
PublicAPI - Client-sichere Endpunkte
Die PublicAPI enthält Endpunkte, die sicher von clientseitigem Code (iOS/macOS-Apps) aufgerufen werden können. Diese Endpunkte:
- Benötigen keinen API key
- Können SSO-Tokens für die Authentifizierung verwenden
- Unterliegen einer Ratenbegrenzung pro Benutzer/Gerät
- Eignen sich für Endanwender-Anwendungen
Beispielanwendung: Abrufen und Erstellen von Kommentaren in Ihrer iOS-App
DefaultAPI - Serverseitige Endpunkte
Die DefaultAPI enthält authentifizierte Endpunkte, die einen API key erfordern. Diese Endpunkte:
- Erfordern Ihren FastComments API key
- Sollten AUSSCHLIESSLICH von serverseitigem Code aufgerufen werden
- Bieten vollen Zugriff auf Ihre FastComments-Daten
- Unterliegen einer Ratenbegrenzung pro Mandant
Beispielanwendung: Administrative Vorgänge, Massenexport von Daten, Moderationstools
WICHTIG: Geben Sie Ihren API key niemals in clientseitigem Code preis. API keys sollten nur serverseitig verwendet werden.
API-Aufrufe durchführen 
Das Swift SDK verwendet die moderne async/await-Syntax für alle API-Aufrufe:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Häufige Probleme 
401 – Nicht autorisiert
Wenn Sie 401-Fehler erhalten, wenn Sie die authentifizierte API verwenden:
- Überprüfen Sie Ihren API-Schlüssel: Stellen Sie sicher, dass Sie den korrekten API-Schlüssel aus Ihrem FastComments-Dashboard verwenden
- Überprüfen Sie die tenant ID: Stellen Sie sicher, dass die tenant ID mit Ihrem Konto übereinstimmt
- API key format: Der API-Schlüssel sollte beim API-Client gesetzt werden:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Falsche API verwenden: Stellen Sie sicher, dass Sie
DefaultAPI(nichtPublicAPI) für authentifizierte Aufrufe verwenden
SSO-Token-Probleme
Wenn SSO-Token nicht funktionieren:
- Sicheren Modus für Produktion verwenden: Verwenden Sie in der Produktion immer
FastCommentsSSO.createSecure()mit Ihrem API-Schlüssel - Nur serverseitig: Generieren Sie sichere SSO-Token auf Ihrem Server, geben Sie Ihren API-Schlüssel niemals an Clients weiter
- Benutzerdaten prüfen: Stellen Sie sicher, dass alle erforderlichen Felder (id, email, username) angegeben sind
- Token-Ablauf: Sichere SSO-Token enthalten einen Zeitstempel und können ablaufen. Generieren Sie bei Bedarf neue Token.
SSL/TLS-Fehler
Wenn Sie auf SSL/TLS-Fehler stoßen:
- Stellen Sie sicher, dass die Info.plist Ihrer App HTTPS-Verbindungen zu fastcomments.com erlaubt
- Prüfen Sie, dass Sie keine App Transport Security-Ausnahmen verwenden, die die Verbindung blockieren könnten
Hinweise 
Broadcast-IDs
Sie werden sehen, dass Sie in einigen API-Aufrufen ein broadcastId ü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 vermutlich tun sollten, da es die beste Nutzererfahrung bietet). Übergeben Sie hier eine UUID. Die ID sollte so eindeutig sein, dass sie innerhalb einer Sitzung nicht zweimal vorkommt.
let broadcastId = UUID().uuidString
aggregieren 
Aggregiert Dokumente, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) 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 | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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

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

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

Kommentare auf Sperrung prüfen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Eine durch Kommas getrennte Liste von Kommentar-IDs. |
| sso | string | query | Nein |
Antwort
Gibt zurück: CheckedCommentsForBlocked200Response
Beispiel

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

Öffentlich: Kommentar erstellen 
Parameter
| Name | Typ | Ort | 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

Öffentlich: Kommentar löschen 
Parameter
| Name | Typ | Location | 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: DeleteCommentPublic200Response
Beispiel

Kommentarbewertung löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | 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 abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetComment200Response
Beispiel

Kommentare abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No |
Antwort
Gibt zurück: GetComments200Response
Beispiel

Öffentlich: 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

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

Benutzernamen der Kommentarstimmenden abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetCommentVoteUserNames200Response
Beispiel

Kommentar sperren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: LockComment200Response
Beispiel

Kommentar anpinnen 
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: 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 im Batch speichern 
Parameter
| Name | Typ | Location | 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

Kommentartext setzen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

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

Kommentar-Meldung aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: 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 | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: PinComment200Response
Beispiel

Kommentar aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

Kommentar bewerten 
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 | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddDomainConfig200Response
Beispiel

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

Domain-Konfiguration abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
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 | Yes | |
| domainToUpdate | string | path | Yes |
Antwort
Gibt zurück: GetDomainConfig200Response
Beispiel

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

E-Mail-Vorlage erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateEmailTemplate200Response
Beispiel

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

Renderfehler einer E-Mail-Vorlage 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 | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetEmailTemplate200Response
Beispiel

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

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

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

E-Mail-Vorlage rendern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nein |
Antwort
Gibt zurück: RenderEmailTemplate200Response
Beispiel

E-Mail-Vorlage aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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

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

Öffentlich: Feed-Beitrag löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: DeleteFeedPostPublic200Response
Beispiel

Feed-Beiträge abrufen 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nein | |
| limit | integer | query | Nein | |
| tags | array | query | Nein |
Response
Gibt zurück: GetFeedPosts200Response
Example

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

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

Öffentlich: Nutzerreaktionen abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Antwort
Gibt zurück: GetUserReactsPublic200Response
Beispiel

Öffentlich: Auf Feed-Beitrag reagieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

Öffentlich: 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

Öffentlich: Kommentar melden 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nein |
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 im Bulk hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Nein |
Antwort
Gibt zurück: AddHashTagsBulk200Response
Beispiel

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

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

Hashtag teilweise aktualisieren 
Parameter
| Name | Typ | Location | 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 | Type | Location | Required | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

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

Moderatoren abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetModerators200Response
Beispiel

Einladung senden 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Response
Gibt zurück: FlagCommentPublic200Response
Example

Moderator aktualisieren 
Parameters
| Name | Typ | Ort | 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 | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetCachedNotificationCount200Response
Beispiel

Benachrichtigungsanzahl abrufen 
Parameter
| Name | Typ | Location | 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 | Location | 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

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

Seite löschen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: DeletePageAPIResponse
Beispiel

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

Seiten abrufen 
Parameter
| Name | Typ | Ort | 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Antwort
Gibt zurück: GetPendingWebhookEventCount200Response
Beispiel

Ausstehende Webhook-Ereignisse abrufen 
Parameter
| Name | Typ | Location | 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetQuestionConfig200Response
Beispiel

Fragekonfigurationen abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetQuestionConfigs200Response
Beispiel

Fragekonfiguration aktualisieren 
Parameter
| Name | Typ | Location | 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 | Yes |
Antwort
Gibt zurück: CreateQuestionResult200Response
Beispiel

Frageergebnis löschen 
Parameter
| Name | Typ | Location | 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 | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetQuestionResult200Response
Beispiel

Frageergebnisse abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ja | |
| questionId | string | query | Nein | |
| questionIds | array | query | Nein | |
| urlId | string | query | Nein | |
| timeBucket | string | query | Nein | |
| startDate | string | query | Nein | |
| forceRecalculate | boolean | query | Nein |
Antwort
Gibt zurück: AggregateQuestionResults200Response
Beispiel

Frageergebnisse im Bulk aggregieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Antwort
Gibt zurück: BulkAggregateQuestionResults200Response
Beispiel

Kommentare mit Frageergebnissen kombinieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Gibt zurück: DeleteSSOUserAPIResponse
Beispiel

SSO-Benutzer per E-Mail abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByEmailAPIResponse
Beispiel

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

SSO-Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nein |
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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Gibt zurück: PutSSOUserAPIResponse
Beispiel

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

Abonnement löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Antwort
Rückgabe: DeleteSubscriptionAPIResponse
Beispiel

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

Tägliche Nutzung des Mandanten 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Gibt zurück: FlagCommentPublic200Response
Beispiel

Mandantenpaket abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 | Location | 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 | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantUser200Response
Beispiel

Mandantenbenutzer abrufen 
Parameter
| Name | Typ | Location | 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 | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Antwort
Rückgabe: FlagCommentPublic200Response
Beispiel

Login-Link senden 
Parameter
| Name | Type | 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

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

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

Mandanten 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nein | |
| skip | number | query | Nein |
Response
Gibt zurück: GetTenants200Response
Beispiel

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

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

Benutzer-Abzeichenfortschritt per ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

Benutzer-Abzeichenfortschritt per Benutzer-ID abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

Liste des Benutzer-Abzeichenfortschritts abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetUserBadgeProgressList200Response
Beispiel

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

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

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

Benutzer-Abzeichen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| badgeId | string | query | Nein | |
| type | number | query | Nein | |
| displayedOnComments | boolean | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetUserBadges200Response
Beispiel

Benutzer-Abzeichen aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: UpdateUserBadge200Response
Beispiel

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

Benutzerbenachrichtigungen abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

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

Benutzerbenachrichtigungen zurücksetzen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

Abonnementstatus für Kommentarbenachrichtigungen des Benutzers aktualisieren 
Aktivieren oder deaktivieren Sie Benachrichtigungen für einen bestimmten Kommentar.
Parameter
| Name | Typ | Ort | 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

Abonnementstatus für Seitenbenachrichtigungen des Benutzers aktualisieren 
Enable 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 auch
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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

Status der Benutzeranwesenheit abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 | Ja | |
| mentionGroupIds | array | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: SearchUsers200Response
Beispiel

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

Stimme erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwort
Gibt zurück: VoteComment200Response
Beispiel

Stimme 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

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

Stimmen für Benutzer abrufen 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 Swift SDK haben, wenden Sie sich bitte an:
Mitwirken
Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Richtlinien zur Mitwirkung.