core_v2_tags Script API

Enables scripted content fragments to get tags.

Properties
Add
CanAddTags
CanAddTagsInApplication
CanAddTagsInApplicationType
CanDeleteTagsInApplication
CanDeleteTagsInApplicationType
CanRemoveTags
CanRenameTagsInApplication
CanRenameTagsInApplicationType
Delete
Get
List
ListTaggedContent
ListTags
Remove
Rename
Set
Sort
SupportsTags
ToStrings

Properties

Name	Access	Type	Description
Current	Read	`IList of String`	Current

Methods

Add

Add Overload 1

Add a tag or tags to a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Add($contentId, $contentTypeId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Add(contentId, contentTypeId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Add Overload 2

Add a tag or tags to a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Add($contentId, $contentTypeId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Add(contentId, contentTypeId, tags);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required

Add Overload 3

Add a tag or tags to a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Add($contentUrl, $oauthClientId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Add(contentUrl, oauthClientId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Add Overload 4

Add a tag or tags to a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Add($contentUrl, $oauthClientId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Add(contentUrl, oauthClientId, tags);

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required

Add Overload 5

Creates a seed tag.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Add($tag, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Add(tag, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
tag	`String`	Tag	Required
options	Options	Set of optional parameters including:	Required
ApplicationId	`Guid`	A content application identifier to filter by	Optional
ApplicationTypeId	`Guid`	A content application type identifier to filter by	Optional
TypeId	`Guid`	A tag type identifier to filter by	Optional

Returns

AdditionalInfo

CanAddTags

CanAddTags Overload 1

Checks whether the accessing user can add tags to this content type.

Velocity

#set($booleanResponse = $core_v2_tags.CanAddTags($contentId, $contentTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanAddTags(contentId, contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

CanAddTags Overload 2

Checks whether the accessing user can add tags to this content type.

Velocity

#set($booleanResponse = $core_v2_tags.CanAddTags($contentUrl, $oauthClientId))

JavaScript

var booleanResponse = core_v2_tags.CanAddTags(contentUrl, oauthClientId);

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required

Returns

Boolean

CanAddTagsInApplication

Checks whether the accessing user can add seed tags for a specific application

Velocity

#set($booleanResponse = $core_v2_tags.CanAddTagsInApplication($applicationId, $applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanAddTagsInApplication(applicationId, applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanAddTagsInApplicationType

Checks whether the accessing user can add seed tags for a specific application

Velocity

#set($booleanResponse = $core_v2_tags.CanAddTagsInApplicationType($applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanAddTagsInApplicationType(applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanDeleteTagsInApplication

Checks whether the accessing user can remove tags in bulk for a specific application

Velocity

#set($booleanResponse = $core_v2_tags.CanDeleteTagsInApplication($applicationId, $applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanDeleteTagsInApplication(applicationId, applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanDeleteTagsInApplicationType

Checks whether the accessing user can remove tags in bulk for a specific application type

Velocity

#set($booleanResponse = $core_v2_tags.CanDeleteTagsInApplicationType($applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanDeleteTagsInApplicationType(applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanRemoveTags

CanRemoveTags Overload 1

Checks whether the accessing user can remove tags from this content type.

Velocity

#set($booleanResponse = $core_v2_tags.CanRemoveTags($contentId, $contentTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanRemoveTags(contentId, contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

CanRemoveTags Overload 2

Checks whether the accessing user can remove tags from this content type.

Velocity

#set($booleanResponse = $core_v2_tags.CanRemoveTags($contentUrl, $oauthClientId))

JavaScript

var booleanResponse = core_v2_tags.CanRemoveTags(contentUrl, oauthClientId);

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required

Returns

Boolean

CanRenameTagsInApplication

Checks whether the accessing user can rename tags in bulk for a specific application

Velocity

#set($booleanResponse = $core_v2_tags.CanRenameTagsInApplication($applicationId, $applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanRenameTagsInApplication(applicationId, applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanRenameTagsInApplicationType

Checks whether the accessing user can rename tags in bulk for a specific application

Velocity

#set($booleanResponse = $core_v2_tags.CanRenameTagsInApplicationType($applicationTypeId))

JavaScript

var booleanResponse = core_v2_tags.CanRenameTagsInApplicationType(applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

Delete

Delete a tag.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Delete($tag, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Delete(tag, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
tag	`String`	Tag	Required
options	Options	Set of optional parameters including:	Required
ApplicationId	`Guid`	A content application identifier to filter by	Optional
ApplicationTypeId	`Guid`	A content application type identifier to filter by	Optional
TypeId	`Guid`	A tag type identifier to filter by	Optional

Returns

AdditionalInfo

Get

Get Overload 1

Get tags for a piece of content.

Velocity

#set($apiListResponse = $core_v2_tags.Get($contentId, $contentTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var apiListResponse = core_v2_tags.Get(contentId, contentTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Get Overload 2

Get tags for a piece of content.

Velocity

#set($apiListResponse = $core_v2_tags.Get($contentId, $contentTypeId))

JavaScript

var apiListResponse = core_v2_tags.Get(contentId, contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

Get Overload 3

Get tags for a piece of content.

Velocity

#set($apiListResponse = $core_v2_tags.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var apiListResponse = core_v2_tags.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Get Overload 4

Get tags for a piece of content.

Velocity

#set($apiListResponse = $core_v2_tags.Get($contentUrl, $oauthClientId))

JavaScript

var apiListResponse = core_v2_tags.Get(contentUrl, oauthClientId);

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required

Returns

ApiList of ContentTag

List

Gets a list of tags given the options provided.

Velocity

#set($pagedListResponse = $core_v2_tags.List("%{ ApplicationIds = $applicationIdsArg, ApplicationTypeIds = $applicationTypeIdsArg, ContainerIds = $containerIdsArg, ContentTypeIds = $contentTypeIdsArg, IncludeSubContainers = $includeSubContainersArg, LogicallyOrTags = $logicallyOrTagsArg, MinimumContentCount = $minimumContentCountArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TagNameFilter = $tagNameFilterArg, Tags = $tagsArg, TypeId = $typeIdArg }"))

JavaScript

var pagedListResponse = core_v2_tags.List({ ApplicationIds: applicationIdsArg, ApplicationTypeIds: applicationTypeIdsArg, ContainerIds: containerIdsArg, ContentTypeIds: contentTypeIdsArg, IncludeSubContainers: includeSubContainersArg, LogicallyOrTags: logicallyOrTagsArg, MinimumContentCount: minimumContentCountArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TagNameFilter: tagNameFilterArg, Tags: tagsArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ApplicationIds	`String`	Comma-separated list of content application identifiers to filter by	Optional
ApplicationTypeIds	`String`	Comma-separated list of content application type identifiers to filter by	Optional
ContainerIds	`String`	Comma-separated list of content container identifiers to filter by	Optional
ContentTypeIds	`String`	Comma-separated list of content type identifiers to filter by	Optional
IncludeSubContainers	`String`	Include sub containers of the containers listed in ContainerIds	Optional
LogicallyOrTags	`Boolean`	Enables filtering by logically OR-ing the filter tags	Optional	False
MinimumContentCount	`Int32`	Sets the minimum number of matching content required to return a tag	Optional	1
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortBy	`String`	How the results will be sorted(Name, ContentCount, LatestTaggedDate)	Optional	Name
SortOrder	`String`	The sort order of the items	Optional	Ascending	Ascending, Descending
TagNameFilter	`String`	Search for tags by name	Optional
Tags	`String`	A comma-seperated list of filter tags	Optional
TypeId	`Guid`	A tag type identifier to filter by	Optional

Returns

PagedList of Tag

ListTaggedContent

Lists tagged content. This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.

Velocity

#set($pagedListResponse = $core_v2_tags.ListTaggedContent($tags, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_tags.ListTaggedContent(tags, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
tags	`IList of String`	Tags	Required
options	Options	Set of optional parameters including:	Required
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20

Returns

PagedList of TaggedContent

ListTags

Lists tags. This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

Velocity

#set($pagedListResponse = $core_v2_tags.ListTags("%{ FilterTags = $filterTagsArg }"))

JavaScript

var pagedListResponse = core_v2_tags.ListTags({ FilterTags: filterTagsArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
FilterTags	`IList of String`	Comma separated list of tags to filter	Optional

Returns

PagedList of Tag

Remove

Remove Overload 1

Remove a tag or tags from a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Remove($contentId, $contentTypeId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Remove(contentId, contentTypeId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Remove Overload 2

Remove a tag or tags from a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Remove($contentId, $contentTypeId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Remove(contentId, contentTypeId, tags);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required

Remove Overload 3

Remove a tag or tags from a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Remove($contentUrl, $oauthClientId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Remove(contentUrl, oauthClientId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Remove Overload 4

Remove a tag or tags from a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Remove($contentUrl, $oauthClientId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Remove(contentUrl, oauthClientId, tags);

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required

Returns

AdditionalInfo

Rename

Rename a tag.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Rename($originalTag, $replacementTag, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Rename(originalTag, replacementTag, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
originalTag	`String`	Original Tag	Required
replacementTag	`String`	Replacement Tag	Required
options	Options	Set of optional parameters including:	Required
ApplicationId	`Guid`	A content application identifier to filter by	Optional
ApplicationTypeId	`Guid`	A content application type identifier to filter by	Optional
TypeId	`Guid`	A tag type identifier to filter by	Optional

Returns

AdditionalInfo

Set

Set Overload 1

Set tags for a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Set($contentId, $contentTypeId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Set(contentId, contentTypeId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Set Overload 2

Set tags for a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Set($contentId, $contentTypeId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Set(contentId, contentTypeId, tags);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
tags	`String`	Comma-separated list of tags	Required

Set Overload 3

Set tags for a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Set($contentUrl, $oauthClientId, $tags, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_tags.Set(contentUrl, oauthClientId, tags, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

Set Overload 4

Set tags for a piece of content.

Velocity

#set($additionalInfoResponse = $core_v2_tags.Set($contentUrl, $oauthClientId, $tags))

JavaScript

var additionalInfoResponse = core_v2_tags.Set(contentUrl, oauthClientId, tags);

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
tags	`String`	Comma-separated list of tags	Required

Returns

AdditionalInfo

Sort

Sort Overload 1

Sorts a list of tag instances

Velocity

#set($iListResponse = $core_v2_tags.Sort($tags))

JavaScript

var iListResponse = core_v2_tags.Sort(tags);

Parameters

Name	Type	Description	Required	Default	Options
tags	`IList of Tag`	Tags	Required

Sort Overload 2

Sorts a list of tag instances

Velocity

#set($iListResponse = $core_v2_tags.Sort($tags, "%{ CssClasses = $cssClassesArg, MaximumNumberOfTags = $maximumNumberOfTagsArg, MinimumItemsPerTag = $minimumItemsPerTagArg }"))

JavaScript

var iListResponse = core_v2_tags.Sort(tags, { CssClasses: cssClassesArg, MaximumNumberOfTags: maximumNumberOfTagsArg, MinimumItemsPerTag: minimumItemsPerTagArg });

Parameters

Name	Type	Description	Required
tags	`IList of Tag`	Tags	Required
options	Options	Set of optional parameters including:	Required
CssClasses	`IList of String`	When provided, applies CSS classes to tags according to their relative use.	Optional
MaximumNumberOfTags	`Int32`	When provided, removes tags that are used more than the maximum threshold from the sorted list	Optional
MinimumItemsPerTag	`Int32`	When provided, removes tags that are used less than the minium threshold from the sorted list	Optional

Returns

IList of Tag

SupportsTags

Check whether the content type supports tagging.

Velocity

#set($booleanResponse = $core_v2_tags.SupportsTags($contentTypeId))

JavaScript

var booleanResponse = core_v2_tags.SupportsTags(contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content Type Id	Required

Returns

Boolean

ToStrings

Converts a list of tag instances to a list of tag name strings

Velocity

#set($iListResponse = $core_v2_tags.ToStrings($tags))

JavaScript

var iListResponse = core_v2_tags.ToStrings(tags);

Parameters

Name	Type	Description	Required	Default	Options
tags	`IList of Tag`	Tags	Required

Returns

IList of String

Recommended