core_v2_blog Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:34 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:07:34

Enables scripted content fragments to use Blogs

Properties

Name	Access	Type	Description
ApplicationTypeId	Read	`[[Guid Script API Type\|Guid]]`	Blogs application type identifier
ContentTypeId	Read	`[[Guid Script API Type\|Guid]]`	Blogs content type identifier
Current	Read	`[[Blog Script API Type\|Blog]]`	Current contextual blog
ThemeTypeId	Read	`[[Guid Script API Type\|Guid]]`	Blogs theme type identifier
TotalLicensedRemaining	Read	`[[Number Script API Type\|Number]]`	Total number licensed blogs remaining.

Methods

Create

Create Overload 1

Creates a new blog

Velocity

#set($blogResponse = $core_v2_blog.Create($groupId, $name))

JavaScript

var blogResponse = core_v2_blog.Create(groupId, name);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`[[Number Script API Type\|Number]]`	Group Id	Required
name	`[[String Script API Type\|String]]`	Name	Required

Create Overload 2

Creates a new blog

Velocity

#set($blogResponse = $core_v2_blog.Create($groupId, $name, "%{ Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, Key = $keyArg }"))

JavaScript

var blogResponse = core_v2_blog.Create(groupId, name, { Authors: authorsArg, DefaultPostImageUrl: defaultPostImageUrlArg, Description: descriptionArg, Enabled: enabledArg, ExtendedAttributes: extendedAttributesArg, Key: keyArg });

Parameters

Name	Type	Description	Required	Default
groupId	`[[Number Script API Type\|Number]]`	Group in which to create the blog	Required
name	`[[String Script API Type\|String]]`	Name of the blog	Required
options	Options	Set of optional parameters including:	Required
Authors	`[[String Script API Type\|String]]`	Comma separated list of usernames	Optional
DefaultPostImageUrl	`[[String Script API Type\|String]]`	Default Post Image Url	Optional
Description	`[[String Script API Type\|String]]`	Description	Optional
Enabled	`[[Boolean Script API Type\|Boolean]]`	Enabled	Optional	True
ExtendedAttributes	`[[String Script API Type\|String]]`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
Key	`[[String Script API Type\|String]]`	If not specified, the key will be generated	Optional

Returns

[[Blog Script API Type|Blog]]

CreateContactRequest

Creates a contact request

Velocity

#set($blogContactRequestResponse = $core_v2_blog.CreateContactRequest($blogId, $subject, $body, $name, $emailAddress, $dateCreated, $ipAddress))

JavaScript

var blogContactRequestResponse = core_v2_blog.CreateContactRequest(blogId, subject, body, name, emailAddress, dateCreated, ipAddress);

Parameters

Name	Type	Description	Required
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required
subject	`[[String Script API Type\|String]]`	Subject	Required
body	`[[String Script API Type\|String]]`	Body	Required
name	`[[String Script API Type\|String]]`	Name	Required
emailAddress	`[[String Script API Type\|String]]`	Email Address	Required
dateCreated	`[[DateTime Script API Type\|DateTime]]`	Date Created	Required
ipAddress	`[[String Script API Type\|String]]`	Obsolete in 14	Required

Returns

[[BlogContactRequest Script API Type|BlogContactRequest]]

Delete

Deletes a blog

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_blog.Delete(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`[[Number Script API Type\|Number]]`	Blog Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

DeleteContactRequest

Deletes a contact request

Velocity

#set($additionalInfoResponse = $core_v2_blog.DeleteContactRequest($blogId, $id))

JavaScript

var additionalInfoResponse = core_v2_blog.DeleteContactRequest(blogId, id);

Parameters

Name	Type	Description	Required	Default	Options
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required
id	`[[Number Script API Type\|Number]]`	Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get Overload 1

Gets a blog

Velocity

#set($blogResponse = $core_v2_blog.Get("%{ GroupId = $groupIdArg, Id = $idArg, Key = $keyArg }"))

JavaScript

var blogResponse = core_v2_blog.Get({ GroupId: groupIdArg, Id: idArg, Key: keyArg });

Parameters

Name	Type	Description	Required
options	Options	Set of optional parameters including:	Required
GroupId	`[[Number Script API Type\|Number]]`	Either the Id or the Key + GroupId are required	Optional
Id	`[[Number Script API Type\|Number]]`	Either the Id or the Key + GroupId are required	Optional
Key	`[[String Script API Type\|String]]`	Either the Id or the Key + GroupId are required	Optional

Get Overload 2

Gets a blog

Velocity

#set($blogResponse = $core_v2_blog.Get($applicationId))

JavaScript

var blogResponse = core_v2_blog.Get(applicationId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`[[Guid Script API Type\|Guid]]`	Application Id	Required

Returns

[[Blog Script API Type|Blog]]

GetContactRequest

Gets a contact request

Velocity

#set($blogContactRequestResponse = $core_v2_blog.GetContactRequest($id))

JavaScript

var blogContactRequestResponse = core_v2_blog.GetContactRequest(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`[[Number Script API Type\|Number]]`	Id	Required

Returns

[[BlogContactRequest Script API Type|BlogContactRequest]]

IsSubscribed

Returns subscribed status for the accessing user

Velocity

#set($booleanResponse = $core_v2_blog.IsSubscribed($blogId))

JavaScript

var booleanResponse = core_v2_blog.IsSubscribed(blogId);

Parameters

Name	Type	Description	Required	Default	Options
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required

Returns

[[Boolean Script API Type|Boolean]]

List

List Overload 1

Returns a listing of all blogs

Velocity

#set($pagedListResponse = $core_v2_blog.List())

JavaScript

var pagedListResponse = core_v2_blog.List();

List Overload 2

Returns a queried listing of blogs

Velocity

#set($pagedListResponse = $core_v2_blog.List("%{ ApplicationIds = $applicationIdsArg, ContainerIds = $containerIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, OwnerUserId = $ownerUserIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg }"))

JavaScript

var pagedListResponse = core_v2_blog.List({ ApplicationIds: applicationIdsArg, ContainerIds: containerIdsArg, GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, OwnerUserId: ownerUserIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PermissionId: permissionIdArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserId: userIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ApplicationIds	`[[String Script API Type\|String]]`	Comma separated list of ApplicationIds. Used to limit to a specific set of blogs as well as sort order if SortBy is set to ApplicationIdsOrder. Filtering by ApplicationIds will ignore GroupId and ContainerIds.	Optional
ContainerIds	`[[String Script API Type\|String]]`	Comma separated list of ContainerIds. Used to limit to a specific set of blogs.	Optional
GroupId	`[[Number Script API Type\|Number]]`	Group ID. Filtering by GroupId will ignore ContainerIds.	Optional
IncludeSubGroups	`[[Boolean Script API Type\|Boolean]]`	Whether or not query should include sub-groups. Only used when GroupId is specified.	Optional
OwnerUserId	`[[Number Script API Type\|Number]]`	User ID of the owner of the blogs. When this value is present, only blogs where the given user is an owner are returned. The accessing user must specify their own user Id or the accessing user must have impersonation rights.	Optional
PageIndex	`[[Number Script API Type\|Number]]`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`[[Number Script API Type\|Number]]`	Specify the number of results to return per page.	Optional	20
PermissionId	`[[String Script API Type\|String]]`	Used to get a list of blogs for which the user set in UserId has the provided Permission ID.	Optional
SortBy	`[[String Script API Type\|String]]`	Attribute to order the results	Optional		ApplicationIdsOrder, MostComments, MostRecent, MostViewed
SortOrder	`[[String Script API Type\|String]]`	Direction to sort the results	Optional	Ascending	Ascending, Descending
UserId	`[[Number Script API Type\|Number]]`	Obsolete in 9.2: Use the authenticated or impersonated user instead.	Optional

Returns

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

ListContactRequests

ListContactRequests Overload 1

Lists contact requests

Velocity

#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId))

JavaScript

var pagedListResponse = core_v2_blog.ListContactRequests(blogId);

Parameters

Name	Type	Description	Required	Default	Options
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required

ListContactRequests Overload 2

Lists contact requests

Velocity

#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId, "%{ IsModerated = $isModeratedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_blog.ListContactRequests(blogId, { IsModerated: isModeratedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required
options	Options	Set of optional parameters including:	Required
IsModerated	`[[Boolean Script API Type\|Boolean]]`	Is Moderated	Optional	False
PageIndex	`[[Number Script API Type\|Number]]`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`[[Number Script API Type\|Number]]`	Specify the number of results to return per page.	Optional	20

Returns

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

ListForQuickPost

Lists blogs available for a quick post context for the accessing user and current group

Velocity

#set($listResponse = $core_v2_blog.ListForQuickPost())

JavaScript

var listResponse = core_v2_blog.ListForQuickPost();

Returns

[[List Script API Type|List]] of [[Blog Script API Type|Blog]]

ListTaggedContent

Obsolete in 12: Use $core_v2_taggedContent.List() instead. Obsolete in 12: Use $core_v2_taggedContent.List() instead.

Velocity

#set($pagedListResponse = $core_v2_blog.ListTaggedContent($tags, "%{ BlogId = $blogIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_blog.ListTaggedContent(tags, { BlogId: blogIdArg, GroupId: groupIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
tags	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Tags	Required
options	Options	Set of optional parameters including:	Required
BlogId	`[[Number Script API Type\|Number]]`	Blog Id	Optional
GroupId	`[[Number Script API Type\|Number]]`	Group Id	Optional
PageIndex	`[[Number Script API Type\|Number]]`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`[[Number Script API Type\|Number]]`	Specify the number of results to return per page.	Optional	20

Returns

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

ListTags

Obsolete in 12: Use $core_v2_tags.List() instead. Obsolete in 12: Use $core_v2_tags.List() instead.

Velocity

#set($pagedListResponse = $core_v2_blog.ListTags("%{ BlogId = $blogIdArg, FilterTags = $filterTagsArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_blog.ListTags({ BlogId: blogIdArg, FilterTags: filterTagsArg, GroupId: groupIdArg, MinimumItemsPerTag: minimumItemsPerTagArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
BlogId	`[[Number Script API Type\|Number]]`	Blog Id	Optional
FilterTags	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Tags to filter by	Optional
GroupId	`[[Number Script API Type\|Number]]`	Group Id	Optional
MinimumItemsPerTag	`[[Number Script API Type\|Number]]`	Minimum Items Per Tag	Optional
PageIndex	`[[Number Script API Type\|Number]]`	Page Index	Optional	0
PageSize	`[[Number Script API Type\|Number]]`	Page Size	Optional	100

Returns

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

Search

Performs a blog search

Velocity

#set($pagedListResponse = $core_v2_blog.Search($queryText, "%{ GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg }"))

JavaScript

var pagedListResponse = core_v2_blog.Search(queryText, { GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, PageIndex: pageIndexArg });

Parameters

Name	Type	Description	Required	Default
queryText	`[[String Script API Type\|String]]`	Query Text	Required
options	Options	Set of optional parameters including:	Required
GroupId		Group Id	Optional
IncludeSubGroups		Include Sub Groups	Optional
PageIndex	`[[Number Script API Type\|Number]]`	Specify the page number of paged results to return. Zero-based index.	Optional	0

Returns

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

SetSubscribed

Sets subscribed status for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_blog.SetSubscribed($blogId, $subscribe))

JavaScript

var additionalInfoResponse = core_v2_blog.SetSubscribed(blogId, subscribe);

Parameters

Name	Type	Description	Required	Default	Options
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required
subscribe	`[[Boolean Script API Type\|Boolean]]`	Subscribed Status	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

SubscribeAnonymously

Velocity

#set($nullableResponse = $core_v2_blog.SubscribeAnonymously($blogId, $email))

JavaScript

var nullableResponse = core_v2_blog.SubscribeAnonymously(blogId, email);

Parameters

Name	Type	Description	Required	Default	Options
blogId	`[[Number Script API Type\|Number]]`	Blog Id	Required
email	`[[String Script API Type\|String]]`	Email	Required

Returns

[[Nullable Script API Type|Nullable]] of [[AnonymousBlogSubscriptionResponse Script API Type|AnonymousBlogSubscriptionResponse]]

ToString

Velocity

#set($stringResponse = $core_v2_blog.ToString())

JavaScript

var stringResponse = core_v2_blog.ToString();

Returns

[[String Script API Type|String]]

Update

Updates a blog

Velocity

#set($blogResponse = $core_v2_blog.Update($id, "%{ Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg }"))

JavaScript

var blogResponse = core_v2_blog.Update(id, { Authors: authorsArg, DefaultPostImageUrl: defaultPostImageUrlArg, Description: descriptionArg, Enabled: enabledArg, ExtendedAttributes: extendedAttributesArg, GroupId: groupIdArg, Key: keyArg, Name: nameArg });

Parameters

Name	Type	Description	Required	Default
id	`[[Number Script API Type\|Number]]`	Id	Required
options	Options	Set of optional parameters including:	Required
Authors	`[[String Script API Type\|String]]`	Comma separated list of usernames	Optional
DefaultPostImageUrl	`[[String Script API Type\|String]]`	Default Post Image Url	Optional
Description	`[[String Script API Type\|String]]`	Description	Optional
Enabled	`[[Boolean Script API Type\|Boolean]]`	Enabled	Optional	True
ExtendedAttributes	`[[String Script API Type\|String]]`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
GroupId	`[[Number Script API Type\|Number]]`	Group Id	Optional
Key	`[[String Script API Type\|String]]`	If not specified, the key will be generated	Optional
Name	`[[String Script API Type\|String]]`	Name	Optional

Returns

[[Blog Script API Type|Blog]]