articles_v1_articleUrls Script API

Ben Tiedt — Fri, 08 Mar 2024 17:15:01 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:15:01

Exposes the article urls api to widgets, themes and automation.

Properties
Article
ArticleCollection
ArticleCollectionTags
ArticleCollectionTagsHome
Category
CreateArticle
CustomPage
EditArticle
GroupHome
ReviewFeedback
ViewSubscribers

Properties

Name	Access	Type	Description
Current	Read	`String`	Current

Methods

Article

Article Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.Article($id))

JavaScript

var stringResponse = articles_v1_articleUrls.Article(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

Article Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.Article($id, $categoryId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.Article(id, categoryId, checkPermissions);

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
categoryId	`Int32`	Category Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Article Overload 3

Velocity

#set($stringResponse = $articles_v1_articleUrls.Article($id, $categoryId))

JavaScript

var stringResponse = articles_v1_articleUrls.Article(id, categoryId);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
categoryId	`Int32`	Category Id	Required

Article Overload 4

Velocity

#set($stringResponse = $articles_v1_articleUrls.Article($id, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.Article(id, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ArticleCollection

ArticleCollection Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollection($collectionId))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollection(collectionId);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required

ArticleCollection Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollection($collectionId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollection(collectionId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ArticleCollectionTags

ArticleCollectionTags Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollectionTags($collectionId, $tags))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollectionTags(collectionId, tags);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
tags	`IList of String`	Tags	Required

ArticleCollectionTags Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollectionTags($collectionId, $tags, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollectionTags(collectionId, tags, checkPermissions);

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
tags	`IList of String`	Tags	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ArticleCollectionTagsHome

ArticleCollectionTagsHome Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollectionTagsHome($collectionId))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollectionTagsHome(collectionId);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required

ArticleCollectionTagsHome Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.ArticleCollectionTagsHome($collectionId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.ArticleCollectionTagsHome(collectionId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Category Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.Category($collectionId, $categoryKey))

JavaScript

var stringResponse = articles_v1_articleUrls.Category(collectionId, categoryKey);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
categoryKey	`String`	Category Key	Required

Category Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.Category($collectionId, $categoryKey, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.Category(collectionId, categoryKey, checkPermissions);

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
categoryKey	`String`	Category Key	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

CreateArticle

CreateArticle Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.CreateArticle($collectionId))

JavaScript

var stringResponse = articles_v1_articleUrls.CreateArticle(collectionId);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required

CreateArticle Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.CreateArticle($collectionId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.CreateArticle(collectionId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

CustomPage

CustomPage Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.CustomPage($collectionId, $pageName))

JavaScript

var stringResponse = articles_v1_articleUrls.CustomPage(collectionId, pageName);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
pageName	`String`	Page Name	Required

CustomPage Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.CustomPage($collectionId, $pageName, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.CustomPage(collectionId, pageName, checkPermissions);

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
pageName	`String`	Page Name	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditArticle

EditArticle Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.EditArticle($id))

JavaScript

var stringResponse = articles_v1_articleUrls.EditArticle(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

EditArticle Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.EditArticle($id, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.EditArticle(id, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

EditArticle Overload 3

Velocity

#set($stringResponse = $articles_v1_articleUrls.EditArticle($id, $publishGroupId))

JavaScript

var stringResponse = articles_v1_articleUrls.EditArticle(id, publishGroupId);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
publishGroupId	`Int32`	Publish Group Id	Required

EditArticle Overload 4

Velocity

#set($stringResponse = $articles_v1_articleUrls.EditArticle($id, $publishGroupId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.EditArticle(id, publishGroupId, checkPermissions);

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
publishGroupId	`Int32`	Publish Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupHome

GroupHome Overload 1

Velocity

#set($stringResponse = $articles_v1_articleUrls.GroupHome($groupId))

JavaScript

var stringResponse = articles_v1_articleUrls.GroupHome(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupHome Overload 2

Velocity

#set($stringResponse = $articles_v1_articleUrls.GroupHome($groupId, $checkPermissions))

JavaScript

var stringResponse = articles_v1_articleUrls.GroupHome(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ReviewFeedback

Velocity

#set($stringResponse = $articles_v1_articleUrls.ReviewFeedback($collectionId, "%{ ArticleId = $articleIdArg }"))

JavaScript

var stringResponse = articles_v1_articleUrls.ReviewFeedback(collectionId, { ArticleId: articleIdArg });

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
options	Options	Set of optional parameters including:	Required
ArticleId	`Guid`	Id of article.	Optional

Returns

String

ViewSubscribers

Velocity

#set($stringResponse = $articles_v1_articleUrls.ViewSubscribers($collectionId, "%{ ArticleId = $articleIdArg, TypeId = $typeIdArg }"))

JavaScript

var stringResponse = articles_v1_articleUrls.ViewSubscribers(collectionId, { ArticleId: articleIdArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
options	Options	Set of optional parameters including:	Required
ArticleId	`Guid`	Id of article.	Optional
TypeId	`Guid`	Type Id of the subscription.	Optional

Returns

String