core_v2_wiki Script API

Enables scripted content fragments to use Wikis

Properties
Create
Delete
Get
List
ListForQuickPost
ListTaggedContent
ListTags
Search
Update

Properties

Name	Access	Type	Description
ApplicationTypeId	Read	`Guid`	Wikis application type identifier
ContentTypeId	Read	`Guid`	Wikis content type identifier
Current	Read	`Wiki`	Returns the current contextual wiki
IsCurrentExplicit	Read	`Boolean`	Returns true when the current wiki page is the default of the current wiki
TotalLicensedRemaining	Read	`Int32`	Total number licensed wikis

Methods

Create

Create Overload 1

Create a Wiki

Velocity

#set($wikiResponse = $core_v2_wiki.Create($groupId, $name))

JavaScript

var wikiResponse = core_v2_wiki.Create(groupId, name);

Parameters

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

Create Overload 2

Create a Wiki

Velocity

#set($wikiResponse = $core_v2_wiki.Create($groupId, $name, "%{ Description = $descriptionArg, Enabled = $enabledArg, Key = $keyArg }"))

JavaScript

var wikiResponse = core_v2_wiki.Create(groupId, name, { Description: descriptionArg, Enabled: enabledArg, Key: keyArg });

Parameters

Name	Type	Description	Required	Default
groupId	`Int32`	Group Id	Required
name	`String`	Name	Required
options	Options	Set of optional parameters including:	Required
Description	`String`	Description	Optional	Empty String
Enabled	`Boolean`	Enabled	Optional	True
Key	`String`	If not specified, the key will be generated	Optional

Returns

Wiki

Delete

Delete a Wiki

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_wiki.Delete(id);

Parameters

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

Returns

AdditionalInfo

Get

Get Overload 1

Get a Wiki

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required
options	Options	Set of optional parameters including:	Required
GroupId	`Int32`	Either Id or Key + GroupId are required	Optional
Id	`Int32`	Either Id or Key + GroupId are required	Optional
Key	`String`	Either Id or Key + GroupId are required	Optional

Get Overload 2

Get a Wiki

Velocity

#set($wikiResponse = $core_v2_wiki.Get($applicationId))

JavaScript

var wikiResponse = core_v2_wiki.Get(applicationId);

Parameters

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

Returns

Wiki

List

List Wikis

Velocity

#set($pagedListResponse = $core_v2_wiki.List("%{ ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeDisabled = $includeDisabledArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, UserId = $userIdArg }"))

JavaScript

var pagedListResponse = core_v2_wiki.List({ ApplicationIds: applicationIdsArg, GroupId: groupIdArg, IncludeDisabled: includeDisabledArg, IncludeSubGroups: includeSubGroupsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PermissionId: permissionIdArg, SortBy: sortByArg, UserId: userIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ApplicationIds	`String`	Comma separated list of ApplicationIds. Used to limit to a specific set of wikis as well as sort order if SortBy is set to ApplicationIdsOrder	Optional
GroupId	`Int32`	Group Id	Optional
IncludeDisabled	`Boolean`	Include Disabled	Optional	False
IncludeSubGroups	`Boolean`	Only used when GroupId is specified.	Optional	False
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
PermissionId	`String`	Used to get a list of wikis for which the accessing or impersonated user has the provided Permission ID.	Optional
SortBy	`String`	Sort By	Optional	Name	ApplicationIdsOrder, Name
UserId	`Int32`	Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead	Optional

Returns

PagedList of Wiki

ListForQuickPost

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

Velocity

#set($iListResponse = $core_v2_wiki.ListForQuickPost())

JavaScript

var iListResponse = core_v2_wiki.ListForQuickPost();

Returns

IList of Wiki

ListTaggedContent

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

Velocity

#set($pagedListResponse = $core_v2_wiki.ListTaggedContent($tags, "%{ GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, WikiId = $wikiIdArg }"))

JavaScript

var pagedListResponse = core_v2_wiki.ListTaggedContent(tags, { GroupId: groupIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, WikiId: wikiIdArg });

Parameters

Name	Type	Description	Required	Default
tags	`IList of String`	Tags	Required
options	Options	Set of optional parameters including:	Required
GroupId	`Int32`	Group Id	Optional
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
WikiId	`Int32`	Wiki Id	Optional

Returns

PagedList of TaggedContent

ListTags

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

Velocity

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

JavaScript

var pagedListResponse = core_v2_wiki.ListTags({ FilterTags: filterTagsArg, GroupId: groupIdArg, MinimumItemsPerTag: minimumItemsPerTagArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, WikiId: wikiIdArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
FilterTags	`IList of String`	Filter Tags	Optional
GroupId	`Int32`	Group Id	Optional
MinimumItemsPerTag	`Int32`	Minimum Items Per Tag	Optional
PageIndex	`Int32`	Page Index	Optional	0
PageSize	`Int32`	Page Size	Optional	100
WikiId	`Int32`	Wiki Id	Optional

Returns

PagedList of Tag

Search

Search for wikis or groups

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default
queryText	`String`	Query Text	Required
options	Options	Set of optional parameters including:	Required
GroupId	`Int32`	Group Id	Optional
IncludeSubGroups	`Boolean`	Include Sub Groups	Optional	False
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 SearchResult

Update

Update a Wiki

Velocity

#set($wikiResponse = $core_v2_wiki.Update($id, "%{ Description = $descriptionArg, Enabled = $enabledArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg }"))

JavaScript

var wikiResponse = core_v2_wiki.Update(id, { Description: descriptionArg, Enabled: enabledArg, GroupId: groupIdArg, Key: keyArg, Name: nameArg });

Parameters

Name	Type	Description	Required	Default
id	`Int32`	Id	Required
options	Options	Set of optional parameters including:	Required
Description	`String`	Description	Optional	Default is an empty string.
Enabled	`Boolean`	Enabled	Optional	True
GroupId	`Int32`	Group Id	Optional
Key	`String`	Key	Optional
Name	`String`	Name	Optional

Returns

Wiki

Recommended