core_v2_wikiPageRevision Script API

Tom Paolucci — Wed, 27 Oct 2021 22:24:29 GMT

Current Revision posted to API Documentation by Tom Paolucci on 10/27/2021 22:24:29

Enables scripted content fragments to use Wiki page revisions

Properties
Delete
Get
List

Properties

Name	Access	Type	Description
Current	Read	`[[WikiPageRevision Script API Type\|WikiPageRevision]]`	Current Wiki Page Revision

Methods

Delete

Delete a wiki page revision

Velocity

#set($additionalInfoResponse = $core_v2_wikiPageRevision.Delete($pageId, $revisionNumber))

JavaScript

var additionalInfoResponse = core_v2_wikiPageRevision.Delete(pageId, revisionNumber);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
revisionNumber	`Int32`	Revision Number	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a wiki page revision

Velocity

#set($wikiPageRevisionResponse = $core_v2_wikiPageRevision.Get($wikiId, $revisionNumber, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var wikiPageRevisionResponse = core_v2_wikiPageRevision.Get(wikiId, revisionNumber, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
wikiId	`Int32`	Wiki Id	Required
revisionNumber	`Int32`	Revision Number	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

[[WikiPageRevision Script API Type|WikiPageRevision]]

List

Lists wiki page revisions

Velocity

#set($pagedListResponse = $core_v2_wikiPageRevision.List($wikiId, "%{ PageId = $pageIdArg, PageIndex = $pageIndexArg, PageKey = $pageKeyArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_wikiPageRevision.List(wikiId, { PageId: pageIdArg, PageIndex: pageIndexArg, PageKey: pageKeyArg, PageSize: pageSizeArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
options	Options	Set of optional parameters including:	Required
PageId	`Int32`	Either Id or WikiId and PageKey should be specified	Optional		Required without PageKey
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageKey	`String`	Either Id or WikiId and PageKey should be specified	Optional		Required without PageID
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortOrder	`String`	Sort Order	Optional	Descending	Ascending, Descending

Returns

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

core_v2_wikiPageRevision Script API

Tom Paolucci — Wed, 27 Oct 2021 22:09:59 GMT

Revision 2 posted to API Documentation by Tom Paolucci on 10/27/2021 22:09:59

Enables scripted content fragments to use Wiki page revisions

Properties
Delete
Get
List

Properties

Name	Access	Type	Description
Current	Read	`[[WikiPageRevision Script API Type\|WikiPageRevision]]`	Current Wiki Page Revision

Methods

Delete

Delete a wiki page revision

Velocity

#set($additionalInfoResponse = $core_v2_wikiPageRevision.Delete($pageId, $revisionNumber))

JavaScript

var additionalInfoResponse = core_v2_wikiPageRevision.Delete(pageId, revisionNumber);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
revisionNumber	`Int32`	Revision Number	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a wiki page revision

Velocity

#set($wikiPageRevisionResponse = $core_v2_wikiPageRevision.Get($wikiId, $revisionNumber, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var wikiPageRevisionResponse = core_v2_wikiPageRevision.Get(wikiId, revisionNumber, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
wikiId	`Int32`	Wiki Id	Required
revisionNumber	`Int32`	Revision Number	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

[[WikiPageRevision Script API Type|WikiPageRevision]]

List

Lists wiki page revisions

Velocity

#set($pagedListResponse = $core_v2_wikiPageRevision.List($wikiId, "%{ PageId = $pageIdArg, PageIndex = $pageIndexArg, PageKey = $pageKeyArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_wikiPageRevision.List(wikiId, { PageId: pageIdArg, PageIndex: pageIndexArg, PageKey: pageKeyArg, PageSize: pageSizeArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
PageId	`Int32`	Either Id or WikiId and PageKey should be specified	Optional		Required without PageKey
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageKey	`String`	Either Id or WikiId and PageKey should be specified	Optional		Required without PageID
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortOrder	`String`	Sort Order	Optional	Descending	Ascending, Descending

Returns

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

core_v2_wikiPageRevision Script API

Ben Tiedt — Wed, 20 Nov 2019 14:55:49 GMT

Revision 1 posted to API Documentation by Ben Tiedt on 11/20/2019 14:55:49

Enables scripted content fragments to use Wiki page revisions

Properties
Delete
Get
List

Properties

Name	Access	Type	Description
Current	Read	`[[WikiPageRevision Script API Type\|WikiPageRevision]]`	Current Wiki Page Revision

Methods

Delete

Delete a wiki page revision

Velocity

#set($additionalInfoResponse = $core_v2_wikiPageRevision.Delete($pageId, $revisionNumber))

JavaScript

var additionalInfoResponse = core_v2_wikiPageRevision.Delete(pageId, revisionNumber);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
revisionNumber	`Int32`	Revision Number	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a wiki page revision

Velocity

#set($wikiPageRevisionResponse = $core_v2_wikiPageRevision.Get($wikiId, $revisionNumber, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var wikiPageRevisionResponse = core_v2_wikiPageRevision.Get(wikiId, revisionNumber, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
wikiId	`Int32`	Wiki Id	Required
revisionNumber	`Int32`	Revision Number	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

[[WikiPageRevision Script API Type|WikiPageRevision]]

List

Lists wiki page revisions

Velocity

#set($pagedListResponse = $core_v2_wikiPageRevision.List($wikiId, "%{ PageId = $pageIdArg, PageIndex = $pageIndexArg, PageKey = $pageKeyArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_wikiPageRevision.List(wikiId, { PageId: pageIdArg, PageIndex: pageIndexArg, PageKey: pageKeyArg, PageSize: pageSizeArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
PageId	`Int32`	Either Id or WikiId and PageKey should be specified	Optional
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageKey	`String`	Either Id or WikiId and PageKey should be specified	Optional
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortOrder	`String`	Sort Order	Optional	Descending	Ascending, Descending

Returns

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