POST (Header:PUT) api.ashx/v2/articles/collections/{id}.{json|xml}
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
DefaultArticleId | int | Request Body | The Id of the default article. | Optional | ||
DefaultTypeId | int | Request Body | The Id of the default article type. | Optional | ||
Description | string | Request Body | A description of the article collection and/or it's contents. | Optional | ||
EnableHelpfulness | bool | Request Body | Allows users to specify if an article is helpful or not and leave feedback. | Optional | ||
GroupId | int | Request Body | Id of the group where the collection will be created. | Required | ||
IsEnabled | bool | Request Body | Whether the collection is enabled or not. | Optional | ||
Name | string | Request Body | Name of the collection. | Required | ||
Prefix | string | Request Body | The prefix used to generate article identifiers. For example setting this value to 'TE' will create identifiers like 'TE0000000'. | Optional | ||
RemoveDefaultArticleId | bool | Request Body | Allows removing the collections default article. | Optional | ||
RemoveDefaultTypeId | bool | Request Body | Allows removing the collections default type. | Optional | ||
RemoveGroupId | bool | Request Body | Allows removing the GroupId associated with the article collection. The article collection is then associated with the root group. | Optional | ||
Undelete | Request Body | Used to restore a deleted collection. When provided, all other options are ignored. | Optional | |||
UrlKey | string | Request Body | The key to be used in the collection url. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.put({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/articles/collections/{id}.json', data: { 'GroupId': '6', 'Name': 'name' } }).then(function(response) { // use response });