Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_rating Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

core_v2_rating Script API


Enables scripted content fragments to use ratings

  • CanCreate
  • CanDelete
  • Create
  • Delete
  • Get
  • List
  • Supports

Methods

CanCreate

CanCreate Overload 1

Returns whether the accessing user can rate a given piece of content

Velocity

#set($booleanResponse = $core_v2_rating.CanCreate($contentId, $contentTypeId))

JavaScript

var booleanResponse = core_v2_rating.CanCreate(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

CanCreate Overload 2

Returns whether the accessing user can rate a given piece of external content

Velocity

#set($booleanResponse = $core_v2_rating.CanCreate($contentUrl, $oauthClientId))

JavaScript

var booleanResponse = core_v2_rating.CanCreate(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Returns

Boolean

CanDelete

CanDelete Overload 1

Returns whether the accessing user can delete a rating of a piece of content

Velocity

#set($booleanResponse = $core_v2_rating.CanDelete($contentId, $ratingUserId, "%{ TypeId = $typeIdArg }"))

JavaScript

var booleanResponse = core_v2_rating.CanDelete(contentId, ratingUserId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
ratingUserIdInt32User who rated the contentRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

CanDelete Overload 2

Returns whether the accessing user can delete a rating of a piece of content

Velocity

#set($booleanResponse = $core_v2_rating.CanDelete($contentId, $ratingUserId))

JavaScript

var booleanResponse = core_v2_rating.CanDelete(contentId, ratingUserId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
ratingUserIdInt32User who rated the contentRequired

CanDelete Overload 3

Returns whether the accessing user can delete a rating of a piece of external content

Velocity

#set($booleanResponse = $core_v2_rating.CanDelete($contentUrl, $oauthClientId, $ratingUserId))

JavaScript

var booleanResponse = core_v2_rating.CanDelete(contentUrl, oauthClientId, ratingUserId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
ratingUserIdInt32User who rated the contentRequired

CanDelete Overload 4

Returns whether the accessing user can delete a rating of a piece of external content

Velocity

#set($booleanResponse = $core_v2_rating.CanDelete($contentUrl, $oauthClientId, $ratingUserId, "%{ TypeId = $typeIdArg }"))

JavaScript

var booleanResponse = core_v2_rating.CanDelete(contentUrl, oauthClientId, ratingUserId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
ratingUserIdInt32User who rated the contentRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

Returns

Boolean

Create

Create Overload 1

Rates a piece of content for the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Create($contentId, $contentTypeId))

JavaScript

var ratingResponse = core_v2_rating.Create(contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

Create Overload 2

Rates a piece of content for the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Create($contentId, $contentTypeId, "%{ TypeId = $typeIdArg, Value = $valueArg }"))

JavaScript

var ratingResponse = core_v2_rating.Create(contentId, contentTypeId, { TypeId: typeIdArg, Value: valueArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional
ValueDoubleValue of the ratingOptional

Create Overload 3

Rates a piece of content for the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Create($contentUrl, $oauthClientId))

JavaScript

var ratingResponse = core_v2_rating.Create(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Create Overload 4

Rates a piece of content for the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Create($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg, Value = $valueArg }"))

JavaScript

var ratingResponse = core_v2_rating.Create(contentUrl, oauthClientId, { TypeId: typeIdArg, Value: valueArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional
ValueDoubleValue of the ratingOptional

Returns

Rating

Delete

Delete Overload 1

Deletes a rating of a piece of content by the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_rating.Delete($contentId))

JavaScript

var additionalInfoResponse = core_v2_rating.Delete(contentId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Delete Overload 2

Deletes a rating of a piece of content by the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_rating.Delete($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_rating.Delete(contentId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

Delete Overload 3

Deletes a rating of a piece of content by the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_rating.Delete($contentUrl, $oauthClientId))

JavaScript

var additionalInfoResponse = core_v2_rating.Delete(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Delete Overload 4

Deletes a rating of a piece of content by the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_rating.Delete($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_rating.Delete(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

Returns

AdditionalInfo

Get

Get Overload 1

Gets an existing rating for a piece of content by the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Get($contentId))

JavaScript

var ratingResponse = core_v2_rating.Get(contentId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Get Overload 2

Gets an existing rating for a piece of content by the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Get($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var ratingResponse = core_v2_rating.Get(contentId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

Get Overload 3

Gets an existing rating for a piece of content by the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Get($contentUrl, $oauthClientId))

JavaScript

var ratingResponse = core_v2_rating.Get(contentUrl, oauthClientId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired

Get Overload 4

Gets an existing rating for a piece of content by the accessing user

Velocity

#set($ratingResponse = $core_v2_rating.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var ratingResponse = core_v2_rating.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlStringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
optionsOptionsSet of optional parameters including:Required
TypeIdGuidCategorization typeOptional

Returns

Rating

List

Lists ratings

Velocity

#set($pagedListResponse = $core_v2_rating.List("%{ ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg, ContentUrl = $contentUrlArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg, UserId = $userIdArg }"))

JavaScript

var pagedListResponse = core_v2_rating.List({ ApplicationId: applicationIdArg, ContainerId: containerIdArg, ContentId: contentIdArg, ContentTypeId: contentTypeIdArg, ContentUrl: contentUrlArg, IncludeSubContainers: includeSubContainersArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TypeId: typeIdArg, UserId: userIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ApplicationIdGuidContent application identifierOptional
ContainerIdGuidContent container identifier Optional
ContentIdGuidContent identifierOptional
ContentTypeIdGuidContent type identifierOptional
ContentUrlStringContent urlOptional
IncludeSubContainersBooleanInclude sub containers Optional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
SortByStringSort mechanismOptionalRatingDate, Rating
SortOrderStringSort orderOptionalAscendingAscending, Descending
TypeIdGuidCategorization typeOptional
UserIdInt32User identifierOptional

Returns

PagedList of Rating

Supports

Returns whether a content type supports rating

Velocity

#set($booleanResponse = $core_v2_rating.Supports($contentTypeId))

JavaScript

var booleanResponse = core_v2_rating.Supports(contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentTypeIdGuidContent Type IdRequired

Returns

Boolean


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community