articles_v1_publishGroups Script API

Ben Tiedt — Fri, 23 Apr 2021 19:54:36 GMT

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

Exposes the article publish group api to widgets, themes and automation.

Properties
Create
Delete
Get
List
Lookup
Update

Properties

Name	Access	Type	Description
Current	Read	`[[PublishGroup Script API Type\|PublishGroup]]`	Current

Methods

Create

Create Overload 1

Velocity

#set($publishGroupResponse = $articles_v1_publishGroups.Create($collectionId, $name))

JavaScript

var publishGroupResponse = articles_v1_publishGroups.Create(collectionId, name);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Id of the collection to create the publish group in.	Required
name	`String`	Name of the publish group.	Required

Create Overload 2

Velocity

#set($publishGroupResponse = $articles_v1_publishGroups.Create($collectionId, $name, "%{ PublishDate = $publishDateArg, PublishEndDate = $publishEndDateArg }"))

JavaScript

var publishGroupResponse = articles_v1_publishGroups.Create(collectionId, name, { PublishDate: publishDateArg, PublishEndDate: publishEndDateArg });

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Id of the collection to create the publish group in.	Required
name	`String`	Name of the publish group.	Required
options	Options	Set of optional parameters including:	Required
PublishDate	`DateTime`	Date when all associated article versions that are ready to publish will be published.	Optional
PublishEndDate	`DateTime`	Date when all associated published article versions will be unpublished.	Optional

Returns

[[PublishGroup Script API Type|PublishGroup]]

Delete

Velocity

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

JavaScript

var additionalInfoResponse = articles_v1_publishGroups.Delete(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Int32`	Id of the publish group to be deleted.	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Velocity

#set($publishGroupResponse = $articles_v1_publishGroups.Get($id))

JavaScript

var publishGroupResponse = articles_v1_publishGroups.Get(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Int32`	Id of the publish group to return.	Required

Returns

[[PublishGroup Script API Type|PublishGroup]]

List

List Overload 1

Velocity

#set($pagedListResponse = $articles_v1_publishGroups.List($collectionId))

JavaScript

var pagedListResponse = articles_v1_publishGroups.List(collectionId);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Id of the collection for the publish groups.	Required

List Overload 2

Velocity

#set($pagedListResponse = $articles_v1_publishGroups.List($collectionId, "%{ IsPublished = $isPublishedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = articles_v1_publishGroups.List(collectionId, { IsPublished: isPublishedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Id of the collection for the publish groups.	Required
options	Options	Set of optional parameters including:	Required
IsPublished	`Boolean`	Filter article publish groups by published.	Optional
PageIndex	`Int32`	The page index to return based on page size. This value is 'zero' based.	Optional	0
PageSize	`Int32`	The total amount of publish groups to return per paged request. The default is 20, the maximum is 100.	Optional	20
SortBy	`String`	The sort option for the publish groups.	Optional	Date	Date, DeleteDate, Name
SortOrder	`String`	The direction to sort the publish groups by based on the current SortBy options. The options are 'ascending' or 'descending'.	Optional	ascending

Returns

[[PagedList Script API Type|PagedList]] of [[PublishGroup Script API Type|PublishGroup]]

Lookup

Velocity

#set($apiListResponse = $articles_v1_publishGroups.Lookup($query, $collectionId))

JavaScript

var apiListResponse = articles_v1_publishGroups.Lookup(query, collectionId);

Parameters

Name	Type	Description	Required	Default	Options
query	`String`	Query	Required
collectionId	`Guid`	Collection Id	Required

Returns

[[ApiList Script API Type|ApiList]] of [[PublishGroup Script API Type|PublishGroup]]

Update

Velocity

#set($publishGroupResponse = $articles_v1_publishGroups.Update($id, "%{ Name = $nameArg, PublishDate = $publishDateArg, PublishEndDate = $publishEndDateArg, RemovePublishDate = $removePublishDateArg, RemovePublishEndDate = $removePublishEndDateArg }"))

JavaScript

var publishGroupResponse = articles_v1_publishGroups.Update(id, { Name: nameArg, PublishDate: publishDateArg, PublishEndDate: publishEndDateArg, RemovePublishDate: removePublishDateArg, RemovePublishEndDate: removePublishEndDateArg });

Parameters

Name	Type	Description	Required
Id	`Int32`	Id of the publish group to update.	Required
options	Options	Set of optional parameters including:	Required
Name	`String`	Name of the publish group.	Optional
PublishDate	`DateTime`	Date when all associated article versions that are ready to publish will be published.	Optional
PublishEndDate	`DateTime`	Date when all associated published article versions will be unpublished.	Optional
RemovePublishDate	`Boolean`	Allows removing PublishDate.	Optional
RemovePublishEndDate	`Boolean`	Allows removing PublishEndDate.	Optional

Returns

[[PublishGroup Script API Type|PublishGroup]]