Exposes the article collection api to widgets,themes and automation.
Properties
| Name | Access | Type | Description |
|---|---|---|---|
| ApplicationTypeId | Read | Guid | Application Type Id |
| Current | Read | ArticleCollection | Current |
| ThemeTypeId | Read | Guid | Theme Type Id |
| TotalLicensedRemaining | Read | Int32 | Total number licensed article collections remaining. |
Methods
Create
Create Overload 1
Velocity
#set($articleCollectionResponse = $articles_v1_articleCollections.Create($groupId, $name))
JavaScript
var articleCollectionResponse = articles_v1_articleCollections.Create(groupId, name);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Id of the group where the collection will be created. | Required | ||
| name | String | Name of the collection. | Required |
Create Overload 2
Velocity
#set($articleCollectionResponse = $articles_v1_articleCollections.Create($groupId, $name, "%{ DefaultTypeId = $defaultTypeIdArg, Description = $descriptionArg, IsEnabled = $isEnabledArg, Prefix = $prefixArg, UrlKey = $urlKeyArg }"))JavaScript
var articleCollectionResponse = articles_v1_articleCollections.Create(groupId, name, { DefaultTypeId: defaultTypeIdArg, Description: descriptionArg, IsEnabled: isEnabledArg, Prefix: prefixArg, UrlKey: urlKeyArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Id of the group where the collection will be created. | Required | ||
| name | String | Name of the collection. | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| DefaultTypeId | Int32 | The Id of the default article type. | Optional | ||
| Description | String | A description of the article collection and/or it's contents. | Optional | ||
| IsEnabled | Boolean | Whether the collection is enabled or not. | Optional | ||
| Prefix | String | The prefix used to generate article identifiers. For example setting this value to 'TE' will create identifiers like 'TE0000000'. | Optional | ||
| UrlKey | String | The key to be used in the collection url. | Optional |
Returns
Delete
Velocity
#set($additionalInfoResponse = $articles_v1_articleCollections.Delete($id))
JavaScript
var additionalInfoResponse = articles_v1_articleCollections.Delete(id);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id of the collection to be deleted. | Required |
Returns
Get
Velocity
#set($articleCollectionResponse = $articles_v1_articleCollections.Get("%{ GroupId = $groupIdArg, Id = $idArg, UrlKey = $urlKeyArg }"))JavaScript
var articleCollectionResponse = articles_v1_articleCollections.Get({ GroupId: groupIdArg, Id: idArg, UrlKey: urlKeyArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| GroupId | Int32 | The group id the article collection belongs to. A url key is required when only a group id is specified, otherwise it is disregarded. | Optional | ||
| Id | Guid | The id of the article collection. When an id is specified other option values are ignored. | Optional | ||
| UrlKey | String | The url key of the article collection. A group id is required when loading by url key. | Optional |
Returns
List
List Overload 1
Velocity
#set($pagedListResponse = $articles_v1_articleCollections.List())
JavaScript
var pagedListResponse = articles_v1_articleCollections.List();
List Overload 2
Velocity
#set($pagedListResponse = $articles_v1_articleCollections.List("%{ ArticleCollectionIds = $articleCollectionIdsArg, ContainerIds = $containerIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IsDeleted = $isDeletedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))JavaScript
var pagedListResponse = articles_v1_articleCollections.List({ ArticleCollectionIds: articleCollectionIdsArg, ContainerIds: containerIdsArg, GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, IsDeleted: isDeletedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PermissionId: permissionIdArg, SortBy: sortByArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ArticleCollectionIds | String | A comma-separated list of article collection ids to return. To maintain the order specified in your list, set 'SortBy' to 'ArticleCollectionIds'. | Optional | ||
| ContainerIds | String | A comma-separated list of group container ids to filter the collection set by. | Optional | ||
| GroupId | Int32 | The group to list the collections by. | Optional | ||
| IncludeSubGroups | Boolean | Whether to include collections within subgroups. Only used when GroupId is specified. | Optional | ||
| IsDeleted | Boolean | Filters collections that have been deleted. | 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 collections to return per paged request. The default is 20, the maximum is 100. | Optional | ||
| PermissionId | Guid | The permission ID required to be granted within the article collection for it to be included. | Optional | ||
| SortBy | String | The sort option for the article collections. | Optional | CreateDate | CollectionIdsOrder, CreateDate, DeleteDate, Name |
| SortOrder | String | The direction to sort the article collection by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default. | Optional |
Returns
Lookup
Lookup Overload 1
Velocity
#set($apiListResponse = $articles_v1_articleCollections.Lookup($query))
JavaScript
var apiListResponse = articles_v1_articleCollections.Lookup(query);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| query | String | Query | Required |
Lookup Overload 2
Velocity
#set($apiListResponse = $articles_v1_articleCollections.Lookup($query, "%{ GroupId = $groupIdArg }"))JavaScript
var apiListResponse = articles_v1_articleCollections.Lookup(query, { GroupId: groupIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| query | String | Query | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| GroupId | Int32 | The ID of the group to search for article collections. | Optional |
Returns
Undelete
Velocity
#set($articleCollectionResponse = $articles_v1_articleCollections.Undelete($id))
JavaScript
var articleCollectionResponse = articles_v1_articleCollections.Undelete(id);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id of the dollection to undelete. | Required |
Returns
Update
Velocity
#set($articleCollectionResponse = $articles_v1_articleCollections.Update($id, "%{ DefaultArticleId = $defaultArticleIdArg, DefaultTypeId = $defaultTypeIdArg, Description = $descriptionArg, GroupId = $groupIdArg, IsEnabled = $isEnabledArg, Name = $nameArg, Prefix = $prefixArg, RemoveDefaultArticleId = $removeDefaultArticleIdArg, RemoveDefaultTypeId = $removeDefaultTypeIdArg, RemoveGroupId = $removeGroupIdArg, UrlKey = $urlKeyArg }"))JavaScript
var articleCollectionResponse = articles_v1_articleCollections.Update(id, { DefaultArticleId: defaultArticleIdArg, DefaultTypeId: defaultTypeIdArg, Description: descriptionArg, GroupId: groupIdArg, IsEnabled: isEnabledArg, Name: nameArg, Prefix: prefixArg, RemoveDefaultArticleId: removeDefaultArticleIdArg, RemoveDefaultTypeId: removeDefaultTypeIdArg, RemoveGroupId: removeGroupIdArg, UrlKey: urlKeyArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id of the collection to be updated. | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| DefaultArticleId | Guid | The Id of the default article. | Optional | ||
| DefaultTypeId | Int32 | The Id of the default article type. | Optional | ||
| Description | String | A description of the article collection and/or it's contents. | Optional | ||
| GroupId | Int32 | The Id of the group this article collection belongs to. | Optional | ||
| IsEnabled | Boolean | Whether the collection is enabled or not. | Optional | ||
| Name | String | The name of the article collection. Note that changing this value does not change the url key currently in place. | Optional | ||
| Prefix | String | The prefix used to generate article identifiers. For example setting this value to 'TE' will create identifiers like 'TE0000000'. | Optional | ||
| RemoveDefaultArticleId | Boolean | Allows removing the collections default article. | Optional | ||
| RemoveDefaultTypeId | Boolean | Allows removing the collections default type. | Optional | ||
| RemoveGroupId | Boolean | Allows removing the GroupId associated with the article collection. The article collection is then associated with the root group. | Optional | ||
| UrlKey | String | The key to be used in the collection url. | Optional |