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_categories 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_categories Script API


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

  • Properties
  • Create
  • Delete
  • Get
  • List
  • Lookup
  • Undelete
  • Update

Properties

NameAccessTypeDescription
CurrentReadCategoryCurrent

Methods

Create

Create Overload 1

Velocity

#set($categoryResponse = $articles_v1_categories.Create($collectionId, $name))

JavaScript

var categoryResponse = articles_v1_categories.Create(collectionId, name);

Parameters

NameTypeDescriptionRequiredDefaultOptions
collectionIdGuidId of the collection where the category is to be created.Required
nameStringName of the category.Required

Create Overload 2

Velocity

#set($categoryResponse = $articles_v1_categories.Create($collectionId, $name, "%{ DefaultArticleId = $defaultArticleIdArg, Description = $descriptionArg, ImageFileName = $imageFileNameArg, ImageFileUploadContext = $imageFileUploadContextArg, ParentId = $parentIdArg, SortOrder = $sortOrderArg }"))

JavaScript

var categoryResponse = articles_v1_categories.Create(collectionId, name, { DefaultArticleId: defaultArticleIdArg, Description: descriptionArg, ImageFileName: imageFileNameArg, ImageFileUploadContext: imageFileUploadContextArg, ParentId: parentIdArg, SortOrder: sortOrderArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
collectionIdGuidId of the collection where the category is to be created.Required
nameStringName of the category.Required
optionsOptionsSet of optional parameters including:Required
DefaultArticleIdGuidId of the article that is the default for the category.Optional
DescriptionStringA description of the article category and/or it's contents.Optional
ImageFileNameStringFile Name. Required when updating featured item using FileUploadContext. Optional parameterOptional
ImageFileUploadContextStringFile Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameterOptional
ParentIdInt32The parent category of the category being created.Optional
SortOrderInt32Used to determine the order in which the category is displayed alongside other categories.Optional

Returns

Category

Delete

Delete Overload 1

Velocity

#set($additionalInfoResponse = $articles_v1_categories.Delete($id))

JavaScript

var additionalInfoResponse = articles_v1_categories.Delete(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
IdInt32Id of the category to be deleted.Required

Delete Overload 2

Velocity

#set($additionalInfoResponse = $articles_v1_categories.Delete($id, "%{ ReassignToCategoryId = $reassignToCategoryIdArg }"))

JavaScript

var additionalInfoResponse = articles_v1_categories.Delete(id, { ReassignToCategoryId: reassignToCategoryIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
IdInt32Id of the category to be deleted.Required
optionsOptionsSet of optional parameters including:Required
ReassignToCategoryIdInt32The category id to assign the articles and child categories to after deletion.Optional

Returns

AdditionalInfo

Get

Velocity

#set($categoryResponse = $articles_v1_categories.Get("%{ ArticleCollectionId = $articleCollectionIdArg, Id = $idArg, UrlKey = $urlKeyArg }"))

JavaScript

var categoryResponse = articles_v1_categories.Get({ ArticleCollectionId: articleCollectionIdArg, Id: idArg, UrlKey: urlKeyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ArticleCollectionIdGuidUsed when passing a UrlKey. ArticleCollectionId and UrlKey are used to find the specific category.Optional
IdInt32Id of the category to return. When passed, ArticleCollectionId, and UrlKey are ignored.Optional
UrlKeyStringUsed when passing an ArticleCollectionId. ArticleCollectionId and UrlKey are used to find the specific category.Optional

Returns

Category

List

List Overload 1

Velocity

#set($apiListResponse = $articles_v1_categories.List($collectionId))

JavaScript

var apiListResponse = articles_v1_categories.List(collectionId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
collectionIdGuidId of the collection to filter categories byRequired

List Overload 2

Velocity

#set($apiListResponse = $articles_v1_categories.List($collectionId, "%{ ArticleId = $articleIdArg, CategoryOrChildrenHaveArticles = $categoryOrChildrenHaveArticlesArg, DefaultArticleId = $defaultArticleIdArg, IsDeleted = $isDeletedArg, ParentId = $parentIdArg, RootLevelOnly = $rootLevelOnlyArg }"))

JavaScript

var apiListResponse = articles_v1_categories.List(collectionId, { ArticleId: articleIdArg, CategoryOrChildrenHaveArticles: categoryOrChildrenHaveArticlesArg, DefaultArticleId: defaultArticleIdArg, IsDeleted: isDeletedArg, ParentId: parentIdArg, RootLevelOnly: rootLevelOnlyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
collectionIdGuidId of the collection to filter categories byRequired
optionsOptionsSet of optional parameters including:Required
ArticleIdGuidId of the article. Filter categores to a specific article.Optional
CategoryOrChildrenHaveArticlesBooleanOnly returns categories that have published articles, or direct children have published articles. Cannot be used if filtering by ArticleId.Optional
DefaultArticleIdGuidId of the article. Filter categories to ones that use the provided article as their default.Optional
IsDeletedBooleanFilters categories that have been deleted.Optional
ParentIdInt32Id of the parent category to filter by.Optional
RootLevelOnlyBooleanOnly returns the root level categories. When true, parent id is ignored.Optional

Returns

ApiList of Category

Lookup

Lookup Overload 1

Velocity

#set($apiListResponse = $articles_v1_categories.Lookup($query))

JavaScript

var apiListResponse = articles_v1_categories.Lookup(query);

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryStringQueryRequired

Lookup Overload 2

Velocity

#set($apiListResponse = $articles_v1_categories.Lookup($query, "%{ ArticleCollectionId = $articleCollectionIdArg }"))

JavaScript

var apiListResponse = articles_v1_categories.Lookup(query, { ArticleCollectionId: articleCollectionIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryStringQueryRequired
optionsOptionsSet of optional parameters including:Required
ArticleCollectionIdGuidThe ID of the ArticleCollection to search for articles. When not specified, categories can only be found by ID or URL.Optional

Returns

ApiList of Category

Undelete

Velocity

#set($categoryResponse = $articles_v1_categories.Undelete($id))

JavaScript

var categoryResponse = articles_v1_categories.Undelete(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
IdInt32Id of the category to undelete.Required

Returns

Category

Update

Velocity

#set($categoryResponse = $articles_v1_categories.Update($id, "%{ DefaultArticleId = $defaultArticleIdArg, Description = $descriptionArg, ImageFileName = $imageFileNameArg, ImageFileUploadContext = $imageFileUploadContextArg, Name = $nameArg, ParentId = $parentIdArg, RemoveDefaultArticleId = $removeDefaultArticleIdArg, RemoveImage = $removeImageArg, RemoveParentId = $removeParentIdArg, RemoveSortOrder = $removeSortOrderArg, SortOrder = $sortOrderArg }"))

JavaScript

var categoryResponse = articles_v1_categories.Update(id, { DefaultArticleId: defaultArticleIdArg, Description: descriptionArg, ImageFileName: imageFileNameArg, ImageFileUploadContext: imageFileUploadContextArg, Name: nameArg, ParentId: parentIdArg, RemoveDefaultArticleId: removeDefaultArticleIdArg, RemoveImage: removeImageArg, RemoveParentId: removeParentIdArg, RemoveSortOrder: removeSortOrderArg, SortOrder: sortOrderArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
IdInt32Id of the category to be updated.Required
optionsOptionsSet of optional parameters including:Required
DefaultArticleIdGuidId of the article that is the default for the category.Optional
DescriptionStringA description of the article category and/or it's contents.Optional
ImageFileNameStringFile Name. Required when updating featured item using FileUploadContext. Optional parameterOptional
ImageFileUploadContextStringFile Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameterOptional
NameStringName of the category.Optional
ParentIdInt32The parent category of the category being updated.Optional
RemoveDefaultArticleIdBooleanAllows removing a categories default article.Optional
RemoveImageBooleanAllows removing a categories image.Optional
RemoveParentIdBooleanAllows removing a categories parent, moving the category to the root level.Optional
RemoveSortOrderBooleanAllows resetting a categories sort order.Optional
SortOrderInt32Used to determine the order in which the category is displayed alongside other categories.Optional

Returns

Category


  • 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