articles_v1_articleVersions Script API

Ben Tiedt — Fri, 23 Apr 2021 19:55:13 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:55:13

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

Name	Type	Description	Required	Default
title	`String`	Title of the article.	Required
body	`String`	Content of the article.	Required
typeId	`Int32`	The id of the article type that best describes this article.	Required
options	Options	Set of optional parameters including:	Required
ArticleId	`Guid`	Id of the article to create a new article version for. Either ArticleId or CollectionId must be provided.	Optional
CollectionId	`Guid`	Id of the collection to create a new article in. Either ArticleId or CollectionId must be provided.	Optional
MetaDescription	`String`	A short description placed in the description meta tag of the page for search engine optimization.	Optional
MetaKeywords	`String`	A 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
MetaTitle	`String`	A title used in the meta tag of the page for search engine optimization.	Optional
PublishDate	`DateTime`	Specifies 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
PublishEndDate	`DateTime`	Specifies when the article version should be unpublished. Will unpublish automatically event if part of a publish group.	Optional
PublishGroupId	`Int32`	Specifies 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
ReadyToPublish	`Boolean`	Specifies 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	False
SuppressNotifications	`Boolean`	Allows suppressing notifications when publishing articles.	Optional	False
Tags	`String`	A comma separated list of tags.	Optional

Returns

[[ArticleVersion Script API Type|ArticleVersion]]

Delete

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Id of the article version to delete	Required
version	`Guid`	Version of the article version to delete	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Id of the article.	Required
version	`Guid`	Version of the article.	Required

Returns

[[ArticleVersion Script API Type|ArticleVersion]]

List

List Overload 1

Velocity

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

JavaScript

var pagedListResponse = articles_v1_articleVersions.List(articleId);

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Id 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

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Id of the article.	Required
options	Options	Set of optional parameters including:	Required
InCategory	`Boolean`	Allows filtering only article versions within or not within a category.	Optional	True
IncludeArticleTypeIds	`String`	Comma separated list of article type ids to filter the article versions by.	Optional
InPublishGroup	`Boolean`	Allows filtering only article versions within or not within a publish group. Ignored if PublishGroupId is passed in.	Optional
IsDefault	`Boolean`	Allows filtering articles that are the default of a category or a collection.	Optional
IsDeleted	`Boolean`	Filters versions that have been deleted.	Optional	False
IsPublished	`Boolean`	Filters versions that have been publised or are still unpublished.	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 versions to return per paged request. The default is 20, the maximum is 100.	Optional
PublishGroupId	`Int32`	Id of the publish group to filter article versions by.	Optional
ReadyToPublish	`Boolean`	Whether the article version is ready to publish or not.	Optional
SortBy	`String`	The sort option for the versions.	Optional	LastUpdateDate	DeleteDate, IsPublished, LastUpdateDate, PublishDate, ReadyToPublish, Title
SortOrder	`String`	The 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 Script API Type|PagedList]] of [[ArticleVersion Script API Type|ArticleVersion]]

Undelete

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Id of the article version to undelete	Required
version	`Guid`	Version of the article version to undelete	Required

Returns

[[ArticleVersion Script API Type|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

Name	Type	Description	Required
articleId	`Guid`	Id of the article to update.	Required
version	`Guid`	Version of the article to update.	Required
options	Options	Set of optional parameters including:	Required
Body	`String`	Content of the article.	Optional
MetaDescription	`String`	A short description placed in the description meta tag of the page for search engine optimization.	Optional
MetaKeywords	`String`	A 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
MetaTitle	`String`	A title used in the meta tag of the page for search engine optimization.	Optional
PublishDate	`DateTime`	Specifies 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
PublishEndDate	`DateTime`	Specifies when the article version should be unpublished. Will unpublish automatically event if part of a publish group.	Optional
PublishGroupId	`Int32`	Specifies 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
ReadyToPublish	`Boolean`	Specifies 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
RemovePublishDate	`Boolean`	Allows removing PublishDate.	Optional
RemovePublishEndDate	`Boolean`	Allows removing PublishEndDate.	Optional
RemovePublishGroup	`Boolean`	Allows removing PublishGroup.	Optional
SuppressNotifications	`Boolean`	Allows suppressing notifications when publishing articles.	Optional
Tags	`String`	A comma separated list of tags	Optional
Title	`String`	Title of the article.	Optional
TypeId	`Int32`	The id of the article type that best describes this article.	Optional

Returns

[[ArticleVersion Script API Type|ArticleVersion]]