
Sprog 🇩🇰 Dansk
Dokumentation
Kom i gang
API-reference
Brug
Aggregering
Revisionslogge
Bloker fra kommentar
Kontroller blokerede kommentarer
Kommentarer
Domænekonfigurationer
E-mailskabeloner
Hændelseslog
Feed-opslag
Marker kommentar
Hashtags
Moderatorer
Notifikationstælling
Notifikationer
Sider
Afventende webhook-hændelser
Spørsmålskonfigurationer
Spørgeresultater
Aggregering af spørgeresultater
SSO-brugere
Abonnementer
Lejer dagligt forbrug
Lejerpakker
Lejerbrugere
Lejere
Upload billede
Brugerbadge-fremgang
Brugerbadges
Brugernotifikationer
Brugertilstedeværelsesstatus
Brugersøgning
Brugere
Stemmer
FastComments Nim SDK
Dette er den officielle Nim SDK til FastComments.
Officiel Nim SDK til FastComments API
Repository
Installation 
Brug af Nimble
nimble install fastcomments
Byg fra kildekoden
nimble build
Bibliotekets indhold
Dette bibliotek indeholder den genererede API-klient og SSO-værktøjer, som gør det nemmere at arbejde med API'et.
Offentlige vs Sikrede API'er
For API-klienten er der to API-moduler, api_default og api_public. api_default indeholder metoder, der kræver din API-nøgle, og api_public indeholder API-opkald
der kan foretages direkte fra en browser/mobil enhed/etc. uden autentificering.
Hurtig start 
Brug af autentificerede API'er (DefaultAPI)
Vigtigt: Autentificerede endpoints kræver, at din API-nøgle er indstillet som headeren x-api-key.
import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
# Foretag autentificerede API-kald
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Brug af offentlige API'er (PublicAPI)
Offentlige endpoints kræver ikke autentificering:
import httpclient
import fastcomments
import fastcomments/apis/api_public
let client = newHttpClient()
# Foretag offentlige API-kald
let (response, httpResponse) = getCommentsPublic(
httpClient = client,
tenantId = "your-tenant-id",
urlId = "your-url-id",
page = 0,
direction = SortDirections.DESC,
sso = "",
skip = 0,
skipChildren = 0,
limit = 0,
limitChildren = 0,
countChildren = false,
fetchPageForCommentId = "",
includeConfig = false,
countAll = false,
includei10n = false,
locale = "",
modules = "",
isCrawler = false,
includeNotificationCount = false,
asTree = false,
maxTreeDepth = 0,
useFullTranslationIds = false,
parentId = "",
searchText = "",
hashTags = @[],
userId = "",
customConfigStr = "",
afterCommentId = "",
beforeCommentId = ""
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Almindelige problemer
- 401 autentificeringsfejl: Sørg for, at du indstiller headeren
x-api-keypå din HttpClient, før du foretager DefaultAPI-forespørgsler:client.headers["x-api-key"] = "your-api-key" - Forkert API-klasse: Brug
api_defaulttil serverside-autentificerede forespørgsler,api_publictil klientside/offentlige forespørgsler.
Foretage API-kald 
Alle API-metoder i dette SDK returnerer tupler af (Option[ResponseType], Response). Det første element indeholder det parsede svar, hvis det lykkes, og det andet element er den rå HTTP-respons.
Eksempel: Hentning af kommentarer
import httpclient
import options
import fastcomments
import fastcomments/apis/api_default
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if httpResponse.code == Http200:
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Noter 
Broadcast-id'er
Du vil se, at du skal sende en broadcastId i nogle API-kald. Når du modtager begivenheder, får du dette ID tilbage, så du ved, at du skal ignorere begivenheden, 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 unikt nok til ikke at forekomme to gange i en browsersession.
SSO (Single Sign-On)
For SSO-eksempler, se nedenfor.
SSO-brug 
Simpel SSO
import fastcomments/sso
let user = newSimpleSSOUserData(
userId = "user-123",
email = "user@example.com",
avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()
echo "SSO Token: ", token
Sikker SSO
import fastcomments/sso
let user = newSecureSSOUserData(
userId = "user-123",
email = "user@example.com",
username = "johndoe",
avatar = "https://example.com/avatar.jpg"
)
let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()
echo "Secure SSO Token: ", token
Dokumentation for fastcomments 
Dokumentation for fastcomments
Dokumentation for API-endepunkter
Alle URI'er er relative til https://fastcomments.com
| Klasse | Metode | HTTP-anmodning | Beskrivelse |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Aggregerer dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes. |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | kræver tenantId afterId |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | kræver tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | kræver tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | kræver tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | kræver tenantId urlId userIdWS |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Aktivér eller deaktiver notifikationer for en specifik kommentar. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Aktivér eller deaktiver notifikationer for en side. Når brugere abonnerer på en side, oprettes notifikationer for nye overordnede kommentarer, og også |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Upload og ændre størrelse på et billede |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Dokumentation for modeller
- APIAuditLog
- APIComment
- APICommentBase
- APICreateUserBadgeResponse
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfig_200_response
- AddDomainConfig_200_response_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResultsResponse
- AggregateQuestionResults_200_response
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- BlockFromCommentParams
- BlockFromCommentPublic_200_response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkAggregateQuestionResults_200_response
- ChangeCommentPinStatusResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked_200_response
- CombineCommentsWithQuestionResults_200_response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic_200_response
- CreateFeedPostParams
- CreateFeedPostPublic_200_response
- CreateFeedPostResponse
- CreateFeedPost_200_response
- CreateFeedPostsResponse
- CreateSubscriptionAPIResponse
- CreateUserBadgeParams
- CreateUserBadge_200_response
- CustomConfigParameters
- DeleteCommentAction
- DeleteCommentPublic_200_response
- DeleteCommentResult
- DeleteCommentVote_200_response
- DeleteComment_200_response
- DeleteDomainConfig_200_response
- DeleteFeedPostPublic_200_response
- DeleteFeedPostPublic_200_response_anyOf
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- EventLogEntry
- FComment
- FComment_meta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentPublic_200_response
- FlagCommentResponse
- FlagComment_200_response
- GetAuditLogsResponse
- GetAuditLogs_200_response
- GetCommentText_200_response
- GetCommentVoteUserNamesSuccessResponse
- GetCommentVoteUserNames_200_response
- GetComment_200_response
- GetCommentsPublic_200_response
- GetCommentsResponseWithPresence_PublicComment_
- GetCommentsResponse_PublicComment_
- GetComments_200_response
- GetDomainConfig_200_response
- GetDomainConfigs_200_response
- GetDomainConfigs_200_response_anyOf
- GetDomainConfigs_200_response_anyOf_1
- GetEventLogResponse
- GetEventLog_200_response
- GetFeedPostsPublic_200_response
- GetFeedPostsResponse
- GetFeedPostsStats_200_response
- GetFeedPosts_200_response
- GetMyNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPublicFeedPostsResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicate_value
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic_200_response
- ReactFeedPostResponse
- Record_string__before_string_or_null__after_string_or_null___value
- Record_string_string_or_number__value
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ResetUserNotificationsResponse
- ResetUserNotifications_200_response
- SORT_DIR
- SSOSecurityLevel
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveComment_200_response
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsers_200_response
- SetCommentTextResult
- SetCommentText_200_response
- SizePreset
- SortDirections
- SpamRule
- UnBlockCommentPublic_200_response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateDomainConfigParams
- UpdateFeedPostParams
- UpdateUserBadgeParams
- UpdateUserBadge_200_response
- UpdateUserNotificationStatus_200_response
- UploadImageResponse
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSessionInfo
- VoteBodyParams
- VoteComment_200_response
- VoteDeleteResponse
- VoteResponse
- VoteResponseUser
- VoteStyle
Dokumentation for autorisation
api_key
- Type: API-nøgle
- Parameternavn for API-nøgle: x-api-key
- Placering: HTTP-header
Aggreger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| aggregationRequest | AggregationRequest | Nej | |
| parentTenantId | string | Nej | |
| includeStats | bool | Nej |
Svar
Returnerer: Option[AggregationResponse]
Eksempel

Hent revisionslogge 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| limit | float64 | Nej | |
| skip | float64 | Nej | |
| order | SORTDIR | Nej | |
| after | float64 | Nej | |
| before | float64 | Nej |
Svar
Returnerer: Option[GetAuditLogs_200_response]
Eksempel

Bloker fra kommentar (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[BlockFromCommentPublic_200_response]
Eksempel

Fjern blokering af kommentar (offentlig) 
Parametre
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[UnBlockCommentPublic_200_response]
Eksempel

Kontroller kommentarer for blokerede 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentIds | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[CheckedCommentsForBlocked_200_response]
Eksempel

Bloker bruger fra kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| blockFromCommentParams | BlockFromCommentParams | Nej | |
| userId | string | Nej | |
| anonUserId | string | Nej |
Svar
Returnerer: Option[BlockFromCommentPublic_200_response]
Eksempel

Opret kommentar (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Nej | |
| commentData | CommentData | Nej | |
| sessionId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[CreateCommentPublic_200_response]
Eksempel

Slet kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| contextUserId | string | Nej | |
| isLive | bool | Nej |
Svar
Returnerer: Option[DeleteComment_200_response]
Eksempel

Slet kommentar (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| editKey | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[DeleteCommentPublic_200_response]
Eksempel

Slet stemme på kommentar 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| voteId | string | No | |
| urlId | string | Yes | |
| broadcastId | string | No | |
| editKey | string | No | |
| sso | string | No |
Svar
Returnerer: Option[DeleteCommentVote_200_response]
Eksempel

Marker kommentar 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| userId | string | Nej | |
| anonUserId | string | Nej |
Svar
Returnerer: Option[FlagComment_200_response]
Eksempel

Hent kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Respons
Returnerer: Option[GetComment_200_response]
Eksempel

Hent kommentarer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| page | int | Nej | |
| limit | int | Nej | |
| skip | int | Nej | |
| asTree | bool | Nej | |
| skipChildren | int | Nej | |
| limitChildren | int | Nej | |
| maxTreeDepth | int | Nej | |
| urlId | string | Ja | |
| userId | string | Nej | |
| anonUserId | string | Nej | |
| contextUserId | string | Nej | |
| hashTag | string | Nej | |
| parentId | string | Nej | |
| direction | SortDirections | Nej |
Svar
Returnerer: Option[GetComments_200_response]
Eksempel

Hent kommentarer (offentlig) 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| page | int | Nej | |
| direction | SortDirections | Nej | |
| sso | string | Nej | |
| skip | int | Nej | |
| skipChildren | int | Nej | |
| limit | int | Nej | |
| limitChildren | int | Nej | |
| countChildren | bool | Nej | |
| fetchPageForCommentId | string | Nej | |
| includeConfig | bool | Nej | |
| countAll | bool | Nej | |
| includei10n | bool | Nej | |
| locale | string | Nej | |
| modules | string | Nej | |
| isCrawler | bool | Nej | |
| includeNotificationCount | bool | Nej | |
| asTree | bool | Nej | |
| maxTreeDepth | int | Nej | |
| useFullTranslationIds | bool | Nej | |
| parentId | string | Nej | |
| searchText | string | Nej | |
| hashTags | seq[string] | Nej | |
| userId | string | Nej | |
| customConfigStr | string | Nej | |
| afterCommentId | string | Nej | |
| beforeCommentId | string | Nej |
Svar
Returnerer: Option[GetCommentsPublic_200_response]
Eksempel

Hent kommentartekst 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| editKey | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[GetCommentText_200_response]
Eksempel

Hent brugernavne for kommentarstemmer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| dir | int | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[GetCommentVoteUserNames_200_response]
Eksempel

Lås kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Respons
Returnerer: Option[LockComment_200_response]
Eksempel

Fastgør kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[PinComment_200_response]
Eksempel

Gem kommentar 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createCommentParams | CreateCommentParams | Nej | |
| isLive | bool | Nej | |
| doSpamCheck | bool | Nej | |
| sendEmails | bool | Nej | |
| populateNotifications | bool | Nej |
Svar
Returnerer: Option[SaveComment_200_response]
Eksempel

Gem kommentarer i bulk 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Yes | |
| createCommentParams | seq[CreateCommentParams] | No | |
| isLive | bool | No | |
| doSpamCheck | bool | No | |
| sendEmails | bool | No | |
| populateNotifications | bool): (Option[seq[SaveComment_200_response]] | No | |
| id | string | No | |
| unBlockFromCommentParams | UnBlockFromCommentParams | No | |
| userId | string | No | |
| anonUserId | string | No |
Respons
Returnerer: Option[UnBlockCommentPublic_200_response]
Eksempel

Indstil kommentartekst 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Nej | |
| editKey | string | Nej | |
| sso | string | Nej |
Respons
Returnerer: Option[SetCommentText_200_response]
Eksempel

Fjern blokering af bruger fra kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Nej | |
| userId | string | Nej | |
| anonUserId | string | Nej |
Respons
Returnerer: Option[UnBlockCommentPublic_200_response]
Eksempel

Fjern markering af kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| userId | string | No | |
| anonUserId | string | No |
Svar
Returnerer: Option[FlagComment_200_response]
Eksempel

Oplås kommentar 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[LockComment_200_response]
Eksempel

Fjern fastgørelse af kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[PinComment_200_response]
Eksempel

Opdater kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updatableCommentParams | UpdatableCommentParams | Nej | |
| contextUserId | string | Nej | |
| doSpamCheck | bool | Nej | |
| isLive | bool | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Stem på kommentar 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Nej | |
| voteBodyParams | VoteBodyParams | Nej | |
| sessionId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[VoteComment_200_response]
Eksempel

Tilføj domænekonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| addDomainConfigParams | AddDomainConfigParams | Nej |
Svar
Returnerer: Option[AddDomainConfig_200_response]
Eksempel

Slet domænekonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Nej |
Svar
Returnerer: Option[DeleteDomainConfig_200_response]
Eksempel

Hent domænekonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Nej |
Svar
Returnerer: Option[GetDomainConfig_200_response]
Eksempel

Hent domænekonfigurationer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja |
Svar
Returnerer: Option[GetDomainConfigs_200_response]
Eksempel

Delvis opdater domænekonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Nej | |
| patchDomainConfigParams | PatchDomainConfigParams | Nej |
Svar
Returnerer: Option[GetDomainConfig_200_response]
Eksempel

Erstat domænekonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Nej | |
| updateDomainConfigParams | UpdateDomainConfigParams | Nej |
Respons
Returnerer: Option[GetDomainConfig_200_response]
Eksempel

Opret e-mailskabelon 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createEmailTemplateBody | CreateEmailTemplateBody | Nej |
Respons
Returnerer: Option[CreateEmailTemplate_200_response]
Eksempel

Slet e-mailskabelon 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Slet fejl ved gengivelse af e-mailskabelon 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| errorId | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent e-mailskabelon 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetEmailTemplate_200_response]
Eksempel

Hent definitioner for e-mailskabeloner 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja |
Respons
Returnerer: Option[GetEmailTemplateDefinitions_200_response]
Eksempel

Hent gengivelsesfejl for e-mailskabeloner 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetEmailTemplateRenderErrors_200_response]
Eksempel

Hent e-mailskabeloner 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetEmailTemplates_200_response]
Eksempel

Gengiv e-mailskabelon 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Nej | |
| locale | string | Nej |
Svar
Returnerer: Option[RenderEmailTemplate_200_response]
Eksempel

Opdater e-mailskabelon 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent hændelseslog 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Nej | |
| startTime | int64 | Nej | |
| endTime | int64 | Nej |
Svar
Returnerer: Option[GetEventLog_200_response]
Eksempel

Hent global hændelseslog 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Nej | |
| startTime | int64 | Nej | |
| endTime | int64 | Nej |
Svar
Returnerer: Option[GetEventLog_200_response]
Eksempel

Opret feed-opslag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Nej | |
| broadcastId | string | Nej | |
| isLive | bool | Nej | |
| doSpamCheck | bool | Nej | |
| skipDupCheck | bool | Nej |
Respons
Returnerer: Option[CreateFeedPost_200_response]
Eksempel

Opret feed-opslag (offentlig) 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Nej | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[CreateFeedPostPublic_200_response]
Eksempel

Slet feed-opslag (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Nej | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[DeleteFeedPostPublic_200_response]
Eksempel

Hent feed-opslag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nej | |
| limit | int | Nej | |
| tags | seq[string] | Nej |
Svar
Returnerer: Option[GetFeedPosts_200_response]
Eksempel

Hent feed-opslag (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nej | |
| limit | int | Nej | |
| tags | seq[string] | Nej | |
| sso | string | Nej | |
| isCrawler | bool | Nej | |
| includeUserInfo | bool | Nej |
Svar
Returnerer: Option[GetFeedPostsPublic_200_response]
Eksempel

Hent statistik for feed-opslag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| postIds | seq[string] | Nej | |
| sso | string | Nej |
Response
Returnerer: Option[GetFeedPostsStats_200_response]
Eksempel

Hent brugerreaktioner (offentlig) 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| postIds | seq[string] | No | |
| sso | string | No |
Svar
Returnerer: Option[GetUserReactsPublic_200_response]
Eksempel

Reager på feed-opslag (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Nej | |
| reactBodyParams | ReactBodyParams | Nej | |
| isUndo | bool | Nej | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[ReactFeedPostPublic_200_response]
Eksempel

Opdater feed-opslag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| feedPost | FeedPost | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opdater feed-opslag (offentlig) 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Nej | |
| updateFeedPostParams | UpdateFeedPostParams | Nej | |
| broadcastId | string | Nej | |
| sso | string | Nej |
Respons
Returnerer: Option[CreateFeedPostPublic_200_response]
Eksempel

Marker kommentar (offentlig) 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| isFlagged | bool | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Tilføj hashtag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createHashTagBody | CreateHashTagBody | Nej |
Svar
Returnerer: Option[AddHashTag_200_response]
Eksempel

Tilføj hashtags i bulk 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Nej |
Svar
Returnerer: Option[AddHashTagsBulk_200_response]
Eksempel

Slet hashtag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tag | string | Nej | |
| tenantId | string | Ja | |
| deleteHashTagRequest | DeleteHashTagRequest | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent hashtags 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| page | float64 | Nej |
Svar
Returnerer: Option[GetHashTags_200_response]
Eksempel

Delvis opdater hashtag 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tag | string | Nej | |
| tenantId | string | Ja | |
| updateHashTagBody | UpdateHashTagBody | Nej |
Svar
Returnerer: Option[PatchHashTag_200_response]
Eksempel

Opret moderator 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createModeratorBody | CreateModeratorBody | Nej |
Svar
Returnerer: Option[CreateModerator_200_response]
Eksempel

Slet moderator 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| sendEmail | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent moderator 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetModerator_200_response]
Eksempel

Hent moderatorer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetModerators_200_response]
Eksempel

Opdater moderator 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateModeratorBody | UpdateModeratorBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Slet notifikationstælling 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Respons
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent cachet notifikationstælling 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetCachedNotificationCount_200_response]
Eksempel

Hent notifikationstælling 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej | |
| urlId | string | Ja | |
| fromCommentId | string | Nej | |
| viewed | bool | Nej |
Respons
Returnerer: Option[GetNotificationCount_200_response]
Eksempel

Hent notifikationer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej | |
| urlId | string | Ja | |
| fromCommentId | string | Nej | |
| viewed | bool | Nej | |
| skip | float64 | Nej |
Respons
Returnerer: Option[GetNotifications_200_response]
Eksempel

Opdater notifikation 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateNotificationBody | UpdateNotificationBody | Nej | |
| userId | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Tilføj side 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPIPageData | CreateAPIPageData | Nej |
Svar
Returnerer: Option[AddPageAPIResponse]
Eksempel

Slet side 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Respons
Returnerer: Option[DeletePageAPIResponse]
Eksempel

Hent side efter URL-id 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Svar
Returnerer: Option[GetPageByURLIdAPIResponse]
Eksempel

Hent sider 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja |
Svar
Returnerer: Option[GetPagesAPIResponse]
Eksempel

Delvis opdater side 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateAPIPageData | UpdateAPIPageData | Nej |
Svar
Returnerer: Option[PatchPageAPIResponse]
Eksempel

Slet afventende webhook-hændelse 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent antal afventende webhook-hændelser 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| externalId | string | No | |
| eventType | string | No | |
| domain | string | No | |
| attemptCountGT | float64 | No |
Respons
Returnerer: Option[GetPendingWebhookEventCount_200_response]
Eksempel

Hent afventende webhook-hændelser 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| externalId | string | Nej | |
| eventType | string | Nej | |
| domain | string | Nej | |
| attemptCountGT | float64 | Nej | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetPendingWebhookEvents_200_response]
Eksempel

Opret spørsmålskonfiguration 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionConfigBody | CreateQuestionConfigBody | Nej |
Svar
Returnerer: Option[CreateQuestionConfig_200_response]
Eksempel

Slet spørsmålskonfiguration 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent spørsmålskonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetQuestionConfig_200_response]
Eksempel

Hent spørsmålskonfigurationer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetQuestionConfigs_200_response]
Eksempel

Opdater spørsmålskonfiguration 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opret spørgeresultat 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionResultBody | CreateQuestionResultBody | Nej |
Respons
Returnerer: Option[CreateQuestionResult_200_response]
Eksempel

Slet spørgeresultat 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent spørgeresultat 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetQuestionResult_200_response]
Eksempel

Hent spørgeresultater 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userId | string | Nej | |
| startDate | string | Nej | |
| questionId | string | Nej | |
| questionIds | string | Nej | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetQuestionResults_200_response]
Eksempel

Opdater spørgeresultat 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateQuestionResultBody | UpdateQuestionResultBody | Nej |
Respons
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Aggreger spørgeresultater 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nej | |
| questionIds | seq[string] | Nej | |
| urlId | string | Ja | |
| timeBucket | AggregateTimeBucket | Nej | |
| startDate | string | Nej | |
| forceRecalculate | bool | Nej |
Svar
Returnerer: Option[AggregateQuestionResults_200_response]
Eksempel

Aggreger spørgeresultater i bulk 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Nej | |
| forceRecalculate | bool | Nej |
Respons
Returnerer: Option[BulkAggregateQuestionResults_200_response]
Eksempel

Kombiner kommentarer med spørgeresultater 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nej | |
| questionIds | seq[string] | Nej | |
| urlId | string | Ja | |
| startDate | string | Nej | |
| forceRecalculate | bool | Nej | |
| minValue | float64 | Nej | |
| maxValue | float64 | Nej | |
| limit | float64 | Nej |
Svar
Returnerer: Option[CombineCommentsWithQuestionResults_200_response]
Eksempel

Tilføj SSO-bruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPISSOUserData | CreateAPISSOUserData | Nej |
Svar
Returnerer: Option[AddSSOUserAPIResponse]
Eksempel

Slet SSO-bruger 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| deleteComments | bool | Nej | |
| commentDeleteMode | string | Nej |
Svar
Returnerer: Option[DeleteSSOUserAPIResponse]
Eksempel

Hent SSO-bruger efter e-mail 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| string | Nej |
Svar
Returnerer: Option[GetSSOUserByEmailAPIResponse]
Eksempel

Hent SSO-bruger efter id 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetSSOUserByIdAPIResponse]
Eksempel

Hent SSO-brugere 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | int | Nej |
Svar
Returnerer: Option[GetSSOUsers_200_response]
Eksempel

Delvis opdater SSO-bruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateAPISSOUserData | UpdateAPISSOUserData | Nej | |
| updateComments | bool | Nej |
Svar
Returnerer: Option[PatchSSOUserAPIResponse]
Eksempel

Erstat SSO-bruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateAPISSOUserData | UpdateAPISSOUserData | Nej | |
| updateComments | bool | Nej |
Svar
Returnerer: Option[PutSSOUserAPIResponse]
Eksempel

Opret abonnement 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Nej |
Respons
Returnerer: Option[CreateSubscriptionAPIResponse]
Eksempel

Slet abonnement 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| userId | string | No |
Svar
Returnerer: Option[DeleteSubscriptionAPIResponse]
Eksempel

Hent abonnementer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej |
Svar
Returnerer: Option[GetSubscriptionsAPIResponse]
Eksempel

Hent lejers daglige forbrug 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| yearNumber | float64 | Nej | |
| monthNumber | float64 | Nej | |
| dayNumber | float64 | Nej | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetTenantDailyUsages_200_response]
Eksempel

Opret lejerpakke 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantPackageBody | CreateTenantPackageBody | Nej |
Svar
Returnerer: Option[CreateTenantPackage_200_response]
Eksempel

Slet lejerpakke 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent lejerpakke 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Respons
Returnerer: Option[GetTenantPackage_200_response]
Eksempel

Hent lejerpakker 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetTenantPackages_200_response]
Eksempel

Erstat lejerpakke 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opdater lejerpakke 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateTenantPackageBody | UpdateTenantPackageBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opret lejerbruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantUserBody | CreateTenantUserBody | Nej |
Svar
Returnerer: Option[CreateTenantUser_200_response]
Eksempel

Slet lejerbruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| deleteComments | string | Nej | |
| commentDeleteMode | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent lejerbruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetTenantUser_200_response]
Eksempel

Hent lejerbrugere 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | float64 | Nej |
Respons
Returnerer: Option[GetTenantUsers_200_response]
Eksempel

Erstat lejerbruger 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| replaceTenantUserBody | ReplaceTenantUserBody | Nej | |
| updateComments | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Send login-link 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| redirectURL | string | Nej |
Respons
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opdater lejerbruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateTenantUserBody | UpdateTenantUserBody | Nej | |
| updateComments | string | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Opret lejer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantBody | CreateTenantBody | Nej |
Svar
Returnerer: Option[CreateTenant_200_response]
Eksempel

Slet lejer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| sure | string | No |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Hent lejer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetTenant_200_response]
Eksempel

Hent lejere 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| meta | string | Nej | |
| skip | float64 | Nej |
Respons
Returnerer: Option[GetTenants_200_response]
Eksempel

Opdater lejer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateTenantBody | UpdateTenantBody | Nej |
Svar
Returnerer: Option[FlagCommentPublic_200_response]
Eksempel

Upload billede 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| file | string | Nej | |
| sizePreset | SizePreset | Nej | |
| urlId | string | Ja |
Svar
Returnerer: Option[UploadImageResponse]
Eksempel

Hent brugerbadge-fremgang efter id 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetUserBadgeProgressById_200_response]
Eksempel

Hent brugerbadge-fremgang efter bruger-id 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej |
Svar
Returnerer: Option[GetUserBadgeProgressById_200_response]
Eksempel

Hent liste over brugerbadge-fremgang 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej | |
| limit | float64 | Nej | |
| skip | float64 | Nej |
Respons
Returnerer: Option[GetUserBadgeProgressList_200_response]
Eksempel

Opret brugerbadge 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| createUserBadgeParams | CreateUserBadgeParams | Nej |
Svar
Returnerer: Option[CreateUserBadge_200_response]
Eksempel

Slet brugerbadge 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[UpdateUserBadge_200_response]
Eksempel

Hent brugerbadge 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetUserBadge_200_response]
Eksempel

Hent brugerbadges 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nej | |
| badgeId | string | Nej | |
| displayedOnComments | bool | Nej | |
| limit | float64 | Nej | |
| skip | float64 | Nej |
Svar
Returnerer: Option[GetUserBadges_200_response]
Eksempel

Opdater brugerbadge 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| updateUserBadgeParams | UpdateUserBadgeParams | Nej |
Svar
Returnerer: Option[UpdateUserBadge_200_response]
Eksempel

Hent brugerens notifikationstælling 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| sso | string | Nej |
Svar
Returnerer: Option[GetUserNotificationCount_200_response]
Eksempel

Hent brugernotifikationer 
Parametre
| Name | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Yes | |
| pageSize | int | No | |
| afterId | string | No | |
| includeContext | bool | No | |
| afterCreatedAt | int64 | No | |
| unreadOnly | bool | No | |
| dmOnly | bool | No | |
| noDm | bool | No | |
| includeTranslations | bool | No | |
| sso | string | No |
Respons
Returnerer: Option[GetUserNotifications_200_response]
Eksempel

Nulstil brugerens notifikationstælling 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| sso | string | Nej |
Svar
Returnerer: Option[ResetUserNotifications_200_response]
Eksempel

Nulstil brugernotifikationer 
Parametre
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| afterId | string | No | |
| afterCreatedAt | int64 | No | |
| unreadOnly | bool | No | |
| dmOnly | bool | No | |
| noDm | bool | No | |
| sso | string | No |
Svar
Returnerer: Option[ResetUserNotifications_200_response]
Eksempel

Opdater brugerens abonnementsstatus for kommentar-notifikationer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| notificationId | string | Nej | |
| optedInOrOut | string | Nej | |
| commentId | string | Ja | |
| sso | string | Nej |
Respons
Returnerer: Option[UpdateUserNotificationStatus_200_response]
Eksempel

Opdater brugerens abonnementsstatus for side-notifikationer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| url | string | Nej | |
| pageTitle | string | Nej | |
| subscribedOrUnsubscribed | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[UpdateUserNotificationStatus_200_response]
Eksempel

Opdater brugerens notifikationsstatus 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| notificationId | string | Nej | |
| newStatus | string | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[UpdateUserNotificationStatus_200_response]
Eksempel

Hent brugertilstedeværelsesstatusser 
Parametre
| Name | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlIdWS | string | Nej | |
| userIds | string | Nej |
Svar
Returnerer: Option[GetUserPresenceStatuses_200_response]
Eksempel

Søg efter brugere 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| usernameStartsWith | string | Nej | |
| mentionGroupIds | seq[string] | Nej | |
| sso | string | Nej |
Svar
Returnerer: Option[SearchUsers_200_response]
Eksempel

Hent bruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej |
Svar
Returnerer: Option[GetUser_200_response]
Eksempel

Opret stemme 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| direction | string | Nej | |
| userId | string | Nej | |
| anonUserId | string | Nej |
Respons
Returnerer: Option[VoteComment_200_response]
Eksempel

Slet stemme 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Nej | |
| editKey | string | Nej |
Svar
Returnerer: Option[DeleteCommentVote_200_response]
Eksempel

Hent stemmer 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Respons
Returnerer: Option[GetVotes_200_response]
Eksempel

Hent stemmer for bruger 
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userId | string | Nej | |
| anonUserId | string | Nej |
Svar
Returnerer: Option[GetVotesForUser_200_response]
Eksempel

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