Exposes the article version category api to widgets,themes and automation.
Methods
Create
Create Overload 1
Velocity
#set($articleVersionCategoryResponse = $articles_v1_articleVersionCategories.Create($articleId, $version, $categoryId))
JavaScript
var articleVersionCategoryResponse = articles_v1_articleVersionCategories.Create(articleId, version, categoryId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| articleId | Guid | Id of the article the category is assigned. | Required | ||
| version | Guid | Version of the article the category is assigned. | Required | ||
| categoryId | Int32 | Id of the category assigned to the article. | Required |
Create Overload 2
Velocity
#set($articleVersionCategoryResponse = $articles_v1_articleVersionCategories.Create($articleId, $version, $categoryId, "%{ RemoveSortOrder = $removeSortOrderArg, SortOrder = $sortOrderArg }"))JavaScript
var articleVersionCategoryResponse = articles_v1_articleVersionCategories.Create(articleId, version, categoryId, { RemoveSortOrder: removeSortOrderArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| articleId | Guid | Id of the article the category is assigned. | Required | ||
| version | Guid | Version of the article the category is assigned. | Required | ||
| categoryId | Int32 | Id of the category assigned to the article. | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| RemoveSortOrder | Int32 | Removes the SortOrder of the article within the category. | Optional | ||
| SortOrder | Int32 | The order in which the article will appear in the article list within the category. | Optional |
Returns
Delete
Velocity
#set($additionalInfoResponse = $articles_v1_articleVersionCategories.Delete($articleId, $version, $categoryId))
JavaScript
var additionalInfoResponse = articles_v1_articleVersionCategories.Delete(articleId, version, categoryId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| articleId | Guid | Id of the article the category is assigned. | Required | ||
| version | Guid | Version of the article the category is assigned. | Required | ||
| categoryId | Int32 | Id of the category assigned to the article. | Required |
Returns
Get
Velocity
#set($articleVersionCategoryResponse = $articles_v1_articleVersionCategories.Get($articleId, $version, $categoryId))
JavaScript
var articleVersionCategoryResponse = articles_v1_articleVersionCategories.Get(articleId, version, categoryId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| articleId | Guid | Id of the article the category is assigned. | Required | ||
| version | Guid | version of the article the category is assigned. | Required | ||
| categoryId | Int32 | Id of the category assigned to the article. | Required |
Returns
List
List Overload 1
Velocity
#set($pagedListResponse = $articles_v1_articleVersionCategories.List($categoryId, $publishGroupId))
JavaScript
var pagedListResponse = articles_v1_articleVersionCategories.List(categoryId, publishGroupId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| categoryId | Int32 | Id of the category assigned to the article version. | Required | ||
| publishGroupId | Int32 | Id of the publish group assigned to the article version. | Required |
List Overload 2
Velocity
#set($pagedListResponse = $articles_v1_articleVersionCategories.List($categoryId, $publishGroupId, "%{ IncludeArticleTypeIds = $includeArticleTypeIdsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))JavaScript
var pagedListResponse = articles_v1_articleVersionCategories.List(categoryId, publishGroupId, { IncludeArticleTypeIds: includeArticleTypeIdsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| categoryId | Int32 | Id of the category assigned to the article version. | Required | ||
| publishGroupId | Int32 | Id of the publish group assigned to the article version. | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| IncludeArticleTypeIds | String | A comma-separated list of article type ids to filter the article versions by. | Optional | ||
| PageIndex | Int32 | The page index to return based on page size. This value is 'zero' based and defaults to zero. | Optional | ||
| PageSize | Int32 | The total amount of article version categories to return per paged request. The default is 20, the maximum is 100. | Optional | ||
| SortBy | String | The sort option for the articles version categories. | Optional | SortOrder | |
| SortOrder | String | The direction to sort the article version categories by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default. | Optional |