Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation articles_v1_articleVersions 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

articles_v1_articleVersions Script API


Exposes the article history api to widgets,themes and automation.

  • Create
  • Delete
  • Get
  • List
  • Undelete
  • Update

Methods

Create

Used to create a new article in a collection. When creating a new article a new article version is created.

Velocity

#set($articleVersionResponse = $articles_v1_articleVersions.Create($title, $body, $typeId, "%{ ArticleId = $articleIdArg, CollectionId = $collectionIdArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, PublishDate = $publishDateArg, PublishEndDate = $publishEndDateArg, PublishGroupId = $publishGroupIdArg, ReadyToPublish = $readyToPublishArg, SuppressNotifications = $suppressNotificationsArg, Tags = $tagsArg }"))

JavaScript

var articleVersionResponse = articles_v1_articleVersions.Create(title, body, typeId, { ArticleId: articleIdArg, CollectionId: collectionIdArg, MetaDescription: metaDescriptionArg, MetaKeywords: metaKeywordsArg, MetaTitle: metaTitleArg, PublishDate: publishDateArg, PublishEndDate: publishEndDateArg, PublishGroupId: publishGroupIdArg, ReadyToPublish: readyToPublishArg, SuppressNotifications: suppressNotificationsArg, Tags: tagsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
titleStringTitle of the article.Required
bodyStringContent of the article.Required
typeIdInt32The id of the article type that best describes this article.Required
optionsOptionsSet of optional parameters including:Required
ArticleIdGuidId of the article to create a new article version for. Either ArticleId or CollectionId must be provided.Optional
CollectionIdGuidId of the collection to create a new article in. Either ArticleId or CollectionId must be provided.Optional
MetaDescriptionStringA short description placed in the description meta tag of the page for search engine optimization.Optional
MetaKeywordsStringA comma-separated list of tags placed in the keywords meta tag of the page for search engine optimization. If not specified tags will be used if tags are specified.Optional
MetaTitleStringA title used in the meta tag of the page for search engine optimization.Optional
PublishDateDateTimeSpecifies when the article version should be published. Cannot be set if the article version is part of a publish group. Will not publish autormatically unlese ReadyToPublish is true.Optional
PublishEndDateDateTimeSpecifies when the article version should be unpublished. Will unpublish automatically event if part of a publish group.Optional
PublishGroupIdInt32Specifies a publish group the article version belongs to. When a publish group is specified, the publish date cannot be set. The publish date comes from the publish group.Optional
ReadyToPublishBooleanSpecifies whether or not to publish the article version. If not ready to publish, the version will be editable, the article will not be searchable nor viewable by users who can not manage the article collection until after the version is published.OptionalFalse
SuppressNotificationsBooleanAllows suppressing notifications when publishing articles.OptionalFalse
TagsStringA comma separated list of tags.Optional

Returns

ArticleVersion

Delete

Velocity

#set($additionalInfoResponse = $articles_v1_articleVersions.Delete($articleId, $version))

JavaScript

var additionalInfoResponse = articles_v1_articleVersions.Delete(articleId, version);

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article version to deleteRequired
versionGuidVersion of the article version to deleteRequired

Returns

AdditionalInfo

Get

Velocity

#set($articleVersionResponse = $articles_v1_articleVersions.Get($articleId, $version))

JavaScript

var articleVersionResponse = articles_v1_articleVersions.Get(articleId, version);

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article.Required
versionGuidVersion of the article.Required

Returns

ArticleVersion

List

List Overload 1

Velocity

#set($pagedListResponse = $articles_v1_articleVersions.List($articleId))

JavaScript

var pagedListResponse = articles_v1_articleVersions.List(articleId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article.Required

List Overload 2

Velocity

#set($pagedListResponse = $articles_v1_articleVersions.List($articleId, "%{ InCategory = $inCategoryArg, IncludeArticleTypeIds = $includeArticleTypeIdsArg, InPublishGroup = $inPublishGroupArg, IsDefault = $isDefaultArg, IsDeleted = $isDeletedArg, IsPublished = $isPublishedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PublishGroupId = $publishGroupIdArg, ReadyToPublish = $readyToPublishArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = articles_v1_articleVersions.List(articleId, { InCategory: inCategoryArg, IncludeArticleTypeIds: includeArticleTypeIdsArg, InPublishGroup: inPublishGroupArg, IsDefault: isDefaultArg, IsDeleted: isDeletedArg, IsPublished: isPublishedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PublishGroupId: publishGroupIdArg, ReadyToPublish: readyToPublishArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article.Required
optionsOptionsSet of optional parameters including:Required
InCategoryBooleanAllows filtering only article versions within or not within a category.OptionalTrue
IncludeArticleTypeIdsStringComma separated list of article type ids to filter the article versions by.Optional
InPublishGroupBooleanAllows filtering only article versions within or not within a publish group. Ignored if PublishGroupId is passed in.Optional
IsDefaultBooleanAllows filtering articles that are the default of a category or a collection.Optional
IsDeletedBooleanFilters versions that have been deleted.OptionalFalse
IsPublishedBooleanFilters versions that have been publised or are still unpublished.Optional
PageIndexInt32The page index to return based on page size. This value is 'zero' based and defaults to zero.Optional
PageSizeInt32The total amount of versions to return per paged request. The default is 20, the maximum is 100.Optional
PublishGroupIdInt32Id of the publish group to filter article versions by.Optional
ReadyToPublishBooleanWhether the article version is ready to publish or not.Optional
SortByStringThe sort option for the versions.OptionalLastUpdateDateDeleteDate, IsPublished, LastUpdateDate, PublishDate, ReadyToPublish, Title
SortOrderStringThe direction to sort the versions by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default.Optional

Returns

PagedList of ArticleVersion

Undelete

Velocity

#set($articleVersionResponse = $articles_v1_articleVersions.Undelete($articleId, $version))

JavaScript

var articleVersionResponse = articles_v1_articleVersions.Undelete(articleId, version);

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article version to undeleteRequired
versionGuidVersion of the article version to undeleteRequired

Returns

ArticleVersion

Update

Velocity

#set($articleVersionResponse = $articles_v1_articleVersions.Update($articleId, $version, "%{ Body = $bodyArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, PublishDate = $publishDateArg, PublishEndDate = $publishEndDateArg, PublishGroupId = $publishGroupIdArg, ReadyToPublish = $readyToPublishArg, RemovePublishDate = $removePublishDateArg, RemovePublishEndDate = $removePublishEndDateArg, RemovePublishGroup = $removePublishGroupArg, SuppressNotifications = $suppressNotificationsArg, Tags = $tagsArg, Title = $titleArg, TypeId = $typeIdArg }"))

JavaScript

var articleVersionResponse = articles_v1_articleVersions.Update(articleId, version, { Body: bodyArg, MetaDescription: metaDescriptionArg, MetaKeywords: metaKeywordsArg, MetaTitle: metaTitleArg, PublishDate: publishDateArg, PublishEndDate: publishEndDateArg, PublishGroupId: publishGroupIdArg, ReadyToPublish: readyToPublishArg, RemovePublishDate: removePublishDateArg, RemovePublishEndDate: removePublishEndDateArg, RemovePublishGroup: removePublishGroupArg, SuppressNotifications: suppressNotificationsArg, Tags: tagsArg, Title: titleArg, TypeId: typeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
articleIdGuidId of the article to update.Required
versionGuidVersion of the article to update.Required
optionsOptionsSet of optional parameters including:Required
BodyStringContent of the article.Optional
MetaDescriptionStringA short description placed in the description meta tag of the page for search engine optimization.Optional
MetaKeywordsStringA comma-separated list of tags placed in the keywords meta tag of the page for search engine optimization. If not specified tags will be used if tags are specified.Optional
MetaTitleStringA title used in the meta tag of the page for search engine optimization.Optional
PublishDateDateTimeSpecifies when the article version should be published. Cannot be set if the article version is part of a publish group. Will not publish autormatically unlese ReadyToPublish is true.Optional
PublishEndDateDateTimeSpecifies when the article version should be unpublished. Will unpublish automatically event if part of a publish group.Optional
PublishGroupIdInt32Specifies a publish group the article version belongs to. When a publish group is specified, the publish date cannot be set. The publish date comes from the publish group.Optional
ReadyToPublishBooleanSpecifies whether or not to publish the article version. If not ready to publish, the version will be editable, the article will not be searchable nor viewable by users who can not manage the article collection until after the version is published.Optional
RemovePublishDateBooleanAllows removing PublishDate.Optional
RemovePublishEndDateBooleanAllows removing PublishEndDate.Optional
RemovePublishGroupBooleanAllows removing PublishGroup.Optional
SuppressNotificationsBooleanAllows suppressing notifications when publishing articles.Optional
TagsStringA comma separated list of tagsOptional
TitleStringTitle of the article.Optional
TypeIdInt32The id of the article type that best describes this article.Optional

Returns

ArticleVersion


  • 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