
Sprog 🇩🇰 Dansk
Kom godt i gang
Dokumentation
Aggregering
Revisionslog
Autentificering
Bloker fra kommentar
Kontroller blokerede kommentarer
Kommentarer
Kommentarer for bruger
Domænekonfigurationer
E-mail-skabeloner
Hændelseslog
Feedindlæg
Marker kommentar
GIF'er
Hashtags
Moderering
Moderatorer
Notifikationstælling
Notifikationer
Side-reaktioner
Sider
Afventende webhook-hændelser
Spørgsmålskonfigurationer
Spørgeresultater
Aggregering af spørgeresultater
SSO-brugere
Abonnementer
Lejers daglige forbrug
Lejerpakker
Lejerbrugere
Lejere
Billetter
Oversættelser
Upload billede
Brugerbadge-fremskridt
Brugerbadges
Brugernotifikationer
Brugertilstedeværelsesstatus
Brugersøgning
Brugere
Stemmer
FastComments Python SDK
Dette er den officielle Python SDK til FastComments.
Officiel Python SDK til FastComments API'en
Repository
Installation 
Installer fra GitHub
Installer direkte fra et udgivelses‑tag (anbefalet, fuldt reproducerbart):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Fastgør tagget i stedet for en gren, så bygninger er deterministiske. Den samme form virker i requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Hver tagget GitHub Release har også et bygget wheel vedhæftet, hvis du foretrækker at installere en binær artefakt direkte.
Biblioteksindhold
Dette bibliotek indeholder to moduler: den genererede API‑klient og kjerne‑Python‑biblioteket, som indeholder håndskrevne værktøjer for at gøre arbejdet med API'en lettere, herunder SSO‑understøttelse.
Offentlige vs Sikrede API'er
For API‑klienten er der tre klasser, DefaultApi, PublicApi og ModerationApi. DefaultApi indeholder metoder, der kræver din API‑nøgle, og PublicApi indeholder metoder, der kan udføres direkte fra en browser/mobil enhed osv. uden autentifikation. ModerationApi leverer en omfattende række af live og hurtige moderations‑API'er. Hver ModerationApi‑metode accepterer en sss‑parameter og kan autentificere via SSO eller en FastComments.com‑session cookie.
Hurtig start 
Using Authenticated APIs (DefaultApi)
Vigtigt: Du skal indstille din API‑nøgle på Configuration, før du foretager autentificerede anmodninger. Hvis du ikke gør det, vil anmodninger fejle med en 401‑fejl.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Opret og konfigurer API-klienten
config = Configuration()
config.host = "https://fastcomments.com"
# KRAV: Angiv din API-nøgle (hent denne fra dit FastComments-dashboard)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Opret API‑instansen med den konfigurerede klient
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Nu kan du foretage autentificerede API‑opkald
try:
# Eksempel: Tilføj en SSO‑bruger
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Almindelige fejl:
# - 401: API-nøgle mangler eller er ugyldig
# - 400: Anmodningsvalidering mislykkedes
Using Public APIs (PublicApi)
Offentlige endpoints kræver ikke godkendelse:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Using the Moderation Dashboard (ModerationApi)
ModerationApi driver moderator‑dashboardet. Metoder kaldes på vegne af en moderator ved at videregive en sso‑token:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Tæl de kommentarer, der venter på moderation
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Using SSO (Single Sign-On)
SDK’en indeholder værktøjer til at generere sikre SSO‑tokens:
from sso import FastCommentsSSO, SecureSSOUserData
# Opret brugerdata (id, e‑mail og brugernavn er påkrævet)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Signer den med din API-hemmelighed (HMAC‑SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Generér SSO‑tokenet til at videregive til widget’en eller et API‑opkald
sso_token = sso.create_token()
# Brug dette token i din frontend eller videregiv det til API‑opkald
print(f"SSO Token: {sso_token}")
For simpel SSO (mindre sikker, til test):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Common Issues
- 401 "missing-api-key" fejl: Sørg for, at du angiver
config.api_key = {"api_key": "YOUR_KEY"}inden du opretter DefaultApi‑instansen. - Forkert API-klasse: Brug
DefaultApitil server‑side autentificerede anmodninger,PublicApitil klient‑side/offentlige anmodninger, ogModerationApitil anmodninger fra moderator‑dashboardet. - Import-fejl: Sørg for, at du importerer fra den korrekte modul:
- API-klient:
from client import ... - SSO-værktøjer:
from sso import ...
- API-klient:
Noter 
Broadcast-ID'er
Du vil se, at du skal sende et broadcast_id i nogle API-kald. Når du modtager hændelser, får du dette ID tilbage, så du kan ignorere hændelsen, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.
Krav 
- Python >= 3.8
Den grundlæggende installation er pure-stdlib og leverer SSO‑værktøjerne. Den genererede API‑klient (DefaultApi/PublicApi/ModerationApi) har brug for client‑extraen, som henter urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 og typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
aggregate 
Aggregere dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer.
Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nej | |
| includeStats | boolean | query | Nej |
Svar
Returnerer: AggregateResponse
Eksempel

get_audit_logs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Svar
Returnerer: GetAuditLogsResponse
Eksempel

logout_public 
Svar
Returnerer: APIEmptyResponse
Eksempel

block_from_comment_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: BlockSuccess
Eksempel

un_block_comment_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UnblockSuccess
Eksempel

checked_comments_for_blocked 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | En kommasepareret liste over kommentar-id'er. |
| sso | string | query | Nej |
Svar
Returnerer: CheckBlockedCommentsResponse
Eksempel

block_user_from_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: BlockSuccess
Eksempel

create_comment_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: SaveCommentsResponseWithPresence
Eksempel

delete_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: DeleteCommentResult
Eksempel

delete_comment_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPIDeleteCommentResponse
Eksempel

delete_comment_vote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteDeleteResponse
Eksempel

flag_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagCommentResponse
Eksempel

get_comment 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetCommentResponse
Eksempel

get_comment_text 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPIGetCommentTextResponse
Eksempel

get_comment_vote_user_names 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentVoteUserNamesSuccessResponse
Eksempel

get_comments 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Svar
Returnerer: APIGetCommentsResponse
Eksempel

get_comments_public 
req tenantId urlId
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Svar
Returnerer: GetCommentsResponseWithPresencePublicComment
Eksempel

lock_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| commentId | string | sti | Ja | |
| broadcastId | string | forespørgsel | Ja | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

pin_comment 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

save_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Svar
Returnerer: APISaveCommentResponse
Eksempel

save_comments_bulk 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: SaveCommentsBulkResponse
Eksempel

set_comment_text 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: PublicAPISetCommentTextResponse
Eksempel

un_block_user_from_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: UnblockSuccess
Eksempel

un_flag_comment 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Response
Returnerer: FlagCommentResponse
Example

un_lock_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| commentId | string | sti | Ja | |
| broadcastId | string | forespørgsel | Ja | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

un_pin_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

update_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| isLive | boolean | query | Nej |
Respons
Returnerer: APIEmptyResponse
Eksempel

vote_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

get_comments_for_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Svar
Returnerer: GetCommentsForUserResponse
Eksempel

add_domain_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: AddDomainConfigResponse
Eksempel

delete_domain_config 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Svar
Returnerer: DeleteDomainConfigResponse
Eksempel

get_domain_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: GetDomainConfigResponse
Eksempel

get_domain_configs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetDomainConfigsResponse
Eksempel

patch_domain_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Returnerer: PatchDomainConfigResponse
Eksempel

put_domain_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Returnerer: PutDomainConfigResponse
Eksempel

create_email_template 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateEmailTemplateResponse
Eksempel

delete_email_template 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

delete_email_template_render_error 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_email_template 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetEmailTemplateResponse
Eksempel

get_email_template_definitions 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: GetEmailTemplateDefinitionsResponse
Eksempel

get_email_template_render_errors 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplateRenderErrorsResponse
Eksempel

get_email_templates 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplatesResponse
Eksempel

render_email_template 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
Svar
Returnerer: RenderEmailTemplateResponse
Eksempel

update_email_template 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: APIEmptyResponse
Eksempel

get_event_log 
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel

get_global_event_log 
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
Svar
Returnerer: GetEventLogResponse
Eksempel

create_feed_post 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Svar
Returnerer: CreateFeedPostsResponse
Eksempel

create_feed_post_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

delete_feed_post_public 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: DeleteFeedPostPublicResponse
Eksempel

get_feed_posts 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Svar
Returnerer: GetFeedPostsResponse
Eksempel

get_feed_posts_public 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Svar
Returnerer: PublicFeedPostsResponse
Eksempel

get_feed_posts_stats 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| postIds | array | forespørgsel | Ja | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: FeedPostsStatsResponse
Eksempel

get_user_reacts_public 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nej | |
| sso | string | query | Nej |
Svar
Returns: UserReactsResponse
Eksempel

react_feed_post_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ReactFeedPostResponse
Eksempel

update_feed_post 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel

update_feed_post_public 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

flag_comment_public 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_gif_large 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| largeInternalURLSanitized | string | query | Yes |
Svar
Returnerer: GifGetLargeResponse
Eksempel

get_gifs_search 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Svar
Returnerer: GetGifsSearchResponse
Eksempel

get_gifs_trending 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Svar
Returnerer: GetGifsTrendingResponse
Eksempel

add_hash_tag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateHashTagResponse
Eksempel

add_hash_tags_bulk 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: BulkCreateHashTagsResponse
Eksempel

delete_hash_tag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_hash_tags 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej |
Svar
Returnerer: GetHashTagsResponse
Eksempel

patch_hash_tag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Svar
Returnerer: UpdateHashTagResponse
Eksempel

delete_moderation_vote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteDeleteResponse
Eksempel

get_api_comments 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIGetCommentsResponse
Eksempel

get_api_export_status 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationExportStatusResponse
Eksempel

get_api_ids 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIGetCommentIdsResponse
Eksempel

get_ban_users_from_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersFromCommentResponse
Eksempel

get_comment_ban_status 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returnerer: GetCommentBanStatusResponse
Eksempel

get_comment_children 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

get_count 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filter | string | query | Nej | |
| searchFilters | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICountCommentsResponse
Eksempel

get_counts 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersCountResponse
Eksempel

get_logs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respons
Returnerer: ModerationAPIGetLogsResponse
Eksempel

get_manual_badges 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: GetTenantManualBadgesResponse
Eksempel

get_manual_badges_for_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetUserManualBadgesResponse
Eksempel

get_moderation_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPICommentResponse
Eksempel

get_moderation_comment_text 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returns: GetCommentTextResponse
Eksempel

get_pre_ban_summary 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: PreBanSummary
Eksempel

get_search_comments_summary 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationCommentSearchResponse
Eksempel

get_search_pages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationPageSearchResponse
Eksempel

get_search_sites 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSiteSearchResponse
Eksempel

get_search_suggest 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: ModerationSuggestResponse
Eksempel

get_search_users 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationUserSearchResponse
Eksempel

get_trust_factor 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserTrustFactorResponse
Eksempel

get_user_ban_preference 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIModerateGetUserBanPreferencesResponse
Eksempel

get_user_internal_profile 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: GetUserInternalProfileResponse
Example

post_adjust_comment_votes 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: AdjustVotesResponse
Eksempel

post_api_export 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Response
Returnerer: ModerationExportResponse
Example

post_ban_user_from_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| banEmail | boolean | query | Nej | |
| banEmailDomain | boolean | query | Nej | |
| banIP | boolean | query | Nej | |
| deleteAllUsersComments | boolean | query | Nej | |
| bannedUntil | string | query | Nej | |
| isShadowBan | boolean | query | Nej | |
| updateId | string | query | Nej | |
| banReason | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: BanUserFromCommentResult
Eksempel

post_ban_user_undo 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

post_bulk_pre_ban_summary 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: BulkPreBanSummary
Eksempel

post_comments_by_ids 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

post_flag_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Response
Returns: APIEmptyResponse
Example

post_remove_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PostRemoveCommentApiResponse
Eksempel

post_restore_deleted_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returns: APIEmptyResponse
Eksempel

post_set_comment_approval_status 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: SetCommentApprovedResponse
Eksempel

post_set_comment_review_status 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

post_set_comment_spam_status 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nej | |
| permNotSpam | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

post_set_comment_text 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: SetCommentTextResponse
Eksempel

post_un_flag_comment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

post_vote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| direction | string | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteResponse
Eksempel

put_award_badge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nej | |
| commentId | string | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: AwardUserBadgeResponse
Eksempel

put_close_thread 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

put_remove_badge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returnerer: RemoveUserBadgeResponse
Eksempel

put_reopen_thread 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

set_trust_factor 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Svar
Returns: SetUserTrustFactorResponse
Eksempel

create_moderator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateModeratorResponse
Eksempel

delete_moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetModeratorResponse
Eksempel

get_moderators 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Respons
Returnerer: GetModeratorsResponse
Eksempel

send_invite 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

update_moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

delete_notification_count 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_cached_notification_count 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetCachedNotificationCountResponse
Eksempel

get_notification_count 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Svar
Returnerer: GetNotificationCountResponse
Eksempel

get_notifications 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetNotificationsResponse
Eksempel

update_notification 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

create_v1_page_react 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel

create_v2_page_react 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel

delete_v1_page_react 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: CreateV1PageReact
Eksempel

delete_v2_page_react 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Svar
Returnerer: CreateV1PageReact
Eksempel

get_v1_page_likes 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetV1PageLikes
Eksempel

get_v2_page_react_users 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Respons
Returnerer: GetV2PageReactUsersResponse
Eksempel

get_v2_page_reacts 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetV2PageReacts
Eksempel

add_page 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddPageAPIResponse
Eksempel

delete_page 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: DeletePageAPIResponse
Eksempel

get_offline_users 
Past kommentatorer på siden som IKKE er online i øjeblikket. Sorteret efter displayName.
Brug dette efter at have udtømt /users/online for at gengive en "Members"-sektion.
Cursor-paginering på commenterName: serveren går den delvise {tenantId, urlId, commenterName}
indeks fra afterName fremad via $gt, ingen $skip-omkostning.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Side-URL-identifikator (rengjort på serveren). |
| afterName | string | query | Nej | Cursor: send nextAfterName fra det foregående svar. |
| afterUserId | string | query | Nej | Cursor-tiebreaker: send nextAfterUserId fra det foregående svar. Påkrævet når afterName er angivet så navnekoblinger ikke udelader poster. |
Svar
Returns: PageUsersOfflineResponse
Eksempel

get_online_users 
Aktuelle online‑seere af en side: personer, hvis websocket‑session er abonneret på siden lige nu.
Returnerer anonCount + totalCount (rum‑omfattende abonnenter, inklusiv anonyme seere, som vi ikke tæller op).
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side‑URL‑identifikator (rengjort på serveren). |
| afterName | string | query | No | Markør: send nextAfterName fra den forrige respons. |
| afterUserId | string | query | No | Markør‑tiebreaker: send nextAfterUserId fra den forrige respons. Påkrævet når afterName er angivet, så navneties ikke tabes. |
Respons
Returnerer: PageUsersOnlineResponse
Eksempel

get_page_by_urlid 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetPageByURLIdAPIResponse
Eksempel

get_pages 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: GetPagesAPIResponse
Eksempel

get_pages_public 
List sider for en lejer. Bruges af FChat skrivebordsklienten til at udfylde sin rumliste.
Kræver enableFChat at være sand på den løste brugerdefinerede konfiguration for hver side.
Sider der kræver SSO filtreres mod den anmodende brugers gruppeadgang.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Opak pagineringscursor returneret som nextCursor fra en tidligere anmodning. Bundet til den samme sortBy. |
| limit | integer | query | No | 1..200, default 50 |
| q | string | query | No | Valgfri case‑insensitiv titelpræfiksfilter. |
| sortBy | string | query | No | Sorteringsrækkefølge. updatedAt (standard, nyeste først), commentCount (fleste kommentarer først), eller title (alfabetisk). |
| hasComments | boolean | query | No | Hvis sand, returneres kun sider med mindst én kommentar. |
Response
Returns: GetPublicPagesResponse
Example

get_users_info 
Bulk-brugerinformation for en tenant. Givet userIds, returner visningsinformation fra User / SSOUser. Brugt af kommentarboksen til at berige brugere, der netop dukkede op via en presence-begivenhed. Ingen sidekontekst: privatliv håndhæves ensartet (private profiler maskeres).
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Komma-adskilte userIds. |
Response
Returnerer: PageUsersInfoResponse
Eksempel

patch_page 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: PatchPageAPIResponse
Eksempel

delete_pending_webhook_event 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_pending_webhook_event_count 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: GetPendingWebhookEventCountResponse
Eksempel

get_pending_webhook_events 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | |
| skip | number | query | No |
Svar
Returnerer: GetPendingWebhookEventsResponse
Eksempel

create_question_config 
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionConfigResponse
Eksempel

delete_question_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_question_config 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionConfigResponse
Eksempel

get_question_configs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionConfigsResponse
Eksempel

update_question_config 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

create_question_result 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateQuestionResultResponse
Eksempel

delete_question_result 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_question_result 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionResultResponse
Eksempel

get_question_results 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| startDate | string | query | Nej | |
| questionId | string | query | Nej | |
| questionIds | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionResultsResponse
Eksempel

update_question_result 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel

aggregate_question_results 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: AggregateQuestionResultsResponse
Eksempel

bulk_aggregate_question_results 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: BulkAggregateQuestionResultsResponse
Eksempel

combine_comments_with_question_results 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej | |
| minValue | number | query | Nej | |
| maxValue | number | query | Nej | |
| limit | number | query | Nej |
Svar
Returnerer: CombineQuestionResultsWithCommentsResponse
Eksempel

add_sso_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddSSOUserAPIResponse
Eksempel

delete_sso_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: DeleteSSOUserAPIResponse
Eksempel

get_sso_user_by_email 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Svar
Returnerer: GetSSOUserByEmailAPIResponse
Eksempel

get_sso_user_by_id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetSSOUserByIdAPIResponse
Eksempel

get_sso_users 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nej |
Svar
Returnerer: GetSSOUsersResponse
Eksempel

patch_sso_user 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Response
Returnerer: PatchSSOUserAPIResponse
Eksempel

put_sso_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PutSSOUserAPIResponse
Eksempel

create_subscription 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateSubscriptionAPIResponse
Eksempel

delete_subscription 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Svar
Returnerer: DeleteSubscriptionAPIResponse
Eksempel

get_subscriptions 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetSubscriptionsAPIResponse
Eksempel

update_subscription 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: UpdateSubscriptionAPIResponse
Eksempel

get_tenant_daily_usages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetTenantDailyUsagesResponse
Eksempel

create_tenant_package 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateTenantPackageResponse
Eksempel

delete_tenant_package 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_tenant_package 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetTenantPackageResponse
Eksempel

get_tenant_packages 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantPackagesResponse
Eksempel

replace_tenant_package 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

update_tenant_package 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

create_tenant_user 
Parametre
| Navn | Type | Lokation | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateTenantUserResponse
Eksempel

delete_tenant_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_tenant_user 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetTenantUserResponse
Eksempel

get_tenant_users 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantUsersResponse
Eksempel

replace_tenant_user 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

send_login_link 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

update_tenant_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

create_tenant 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateTenantResponse
Eksempel

delete_tenant 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

get_tenant 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetTenantResponse
Eksempel

get_tenants 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetTenantsResponse
Eksempel

update_tenant 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

change_ticket_state 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: ChangeTicketStateResponse
Eksempel

create_ticket 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Svar
Returnerer: CreateTicketResponse
Eksempel

get_ticket 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetTicketResponse
Eksempel

get_tickets 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Svar
Returnerer: GetTicketsResponse
Eksempel

get_translations 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nej | |
| useFullTranslationIds | boolean | query | Nej |
Svar
Returnerer: GetTranslationsResponse
Eksempel

upload_image 
Upload og ændre størrelse på et billede
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Størrelsesforudindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser for populære enheder) |
| urlId | string | query | No | Side-id hvor uploaden sker fra, for at konfigurere |
Response
Returns: UploadImageResponse
Example

get_user_badge_progress_by_id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

get_user_badge_progress_by_user_id 
Parametre
| Navn | Type | Location | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

get_user_badge_progress_list 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Response
Returns: APIGetUserBadgeProgressListResponse
Example

create_user_badge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: APICreateUserBadgeResponse
Eksempel

delete_user_badge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

get_user_badge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIGetUserBadgeResponse
Eksempel

get_user_badges 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: APIGetUserBadgesResponse
Eksempel

update_user_badge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

get_user_notification_count 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotificationCountResponse
Eksempel

get_user_notifications 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Bruges til at bestemme, om den aktuelle side er abonneret. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetMyNotificationsResponse
Eksempel

reset_user_notification_count 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: ResetUserNotificationsResponse
Eksempel

reset_user_notifications 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| afterId | string | forespørgsel | Nej | |
| afterCreatedAt | integer | forespørgsel | Nej | |
| unreadOnly | boolean | forespørgsel | Nej | |
| dmOnly | boolean | forespørgsel | Nej | |
| noDm | boolean | forespørgsel | Nej | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel

update_user_notification_comment_subscription_status 
Aktivér eller deaktiver notifikationer for en specifik kommentar.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: UpdateUserNotificationCommentSubscriptionStatusResponse
Eksempel

update_user_notification_page_subscription_status 
Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes notifikationer for nye rodkommentarer, og også
Parameters
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationPageSubscriptionStatusResponse
Eksempel

update_user_notification_status 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: UpdateUserNotificationStatusResponse
Eksempel

get_user_presence_statuses 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Svar
Returnerer: GetUserPresenceStatusesResponse
Eksempel

search_users 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nej | |
| mentionGroupIds | array | query | Nej | |
| sso | string | query | Nej | |
| searchSection | string | query | Nej |
Svar
Returnerer: SearchUsersResult
Eksempel

get_user 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserResponse
Eksempel

create_vote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

delete_vote 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Svar
Returnerer: VoteDeleteResponse
Eksempel

get_votes 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetVotesResponse
Eksempel

get_votes_for_user 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: GetVotesForUserResponse
Eksempel

Brug for hjælp?
Hvis du støder på problemer eller har spørgsmål om Python SDK'et, så:
Bidrag
Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.