PageResource

Resource used for loading, saving and manipulating GCN pages.

The following resources are part of this group:

/page/autocomplete

Mount Point: /CNPortletapp/rest/page/autocomplete

GET

Do a quick search for pages that contain the given query string in their name or have it as ID. Return an html representation of the page list, sorted by node name, folder name and page name.

Parameters

name description type default
q query string, must contain at least three characters (otherwise an empty result is returned). query
limit maximum number of results returned. Default is 15 query

Response Body

element: (custom)
media types: text/html

html representation of matching pages

/page/copy

Mount Point: /CNPortletapp/rest/page/copy

POST

Copy a batch of pages or a single copy using the PageCopyRequest options.

Parameters

name description type default
wait wait timeout in milliseconds query 0

Request Body

element: pageCopyRequest
media types: */*
application/xml
application/json

Request containing data for the batch copy

Response Body

element: pageCopyResponse
media types: */*
application/xml
application/json

GenericResponse

/page/create

Mount Point: /CNPortletapp/rest/page/create

POST

Create a page based on the given pagecreaterequest

Request Body

element: pageCreateRequest
media types: */*
application/xml
application/json

containing data for creating the page

Response Body

element: pageLoadResponse
media types: application/json

PageLoadResponse with the created page

/page/disinherit

Mount Point: /CNPortletapp/rest/page/disinherit

GET

Get the multichannelling exclusion and disinherit status for a list of pages

Parameters

name description type default
id list of page IDs query
nodeId node ID query

Response Body

element: multiDisinheritResponse
media types: */*
application/xml
application/json

response containing the exclusion and disinherit status

POST

Set the multichannelling exclusion and disinherit status for a list of pages

Parameters

name description type default
id list of page IDs query
nodeId node ID query
wait wait timeout in milliseconds query 0

Request Body

element: disinheritRequest
media types: */*
application/xml
application/json

request object

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/localizationinfo

Mount Point: /CNPortletapp/rest/page/localizationinfo

GET

Get localization info for a list of pages for a given channel and all master channels

Parameters

name description type default
id list of page ids query
nodeId id of the node to start with query

Response Body

element: localizationInfo
media types: */*
application/xml
application/json

localization info

/page/move

Mount Point: /CNPortletapp/rest/page/move

POST

Move multiple pages to another folder

Request Body

element: multiObjectMoveRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/preview

Mount Point: /CNPortletapp/rest/page/preview

POST

Render given page in a preview (before actually saving it)

Request Body

element: pagePreviewRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: pagePreviewResponse
media types: */*
application/xml
application/json

preview of the page

/page/publish

Mount Point: /CNPortletapp/rest/page/publish

POST

Publish a list of pages. Instant publishing will not be done, when using this method.

Parameters

name description type default
nodeId channel id query

Request Body

element: multiPagePublishRequest
media types: */*
application/xml
application/json

publish request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/push2master

Mount Point: /CNPortletapp/rest/page/push2master

POST

Push a list of pages from a channel into a master

Request Body

element: multiPushToMasterRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/unlocalize

Mount Point: /CNPortletapp/rest/page/unlocalize

POST

Unlocalize pages in a channel

Request Body

element: multiUnlocalizeRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/cancel/{id}

Mount Point: /CNPortletapp/rest/page/cancel/{id}

POST

Cancel editing the page. The page will be rolled back to the last version (changes made since the last version will be lost). The edit lock on the page will be raised, so that other users may edit the page.

Parameters

name description type default
id id of the Page which is currently edited path
nodeId channel id query

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/delete/{id}

Mount Point: /CNPortletapp/rest/page/delete/{id}

POST

Delete the page denoted by id. Note that inherited or localized pages can't be deleted in a channel. However you can delete an inherited page in the master and unlocalize a localized page.

Parameters

name description type default
id id of the Page to delete. This can either be a local or global id path
nodeId channel id query

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/disinherit/{id}

Mount Point: /CNPortletapp/rest/page/disinherit/{id}

GET

Get the multichannelling exclusion and disinherit status of the page

Parameters

name description type default
id page ID path
nodeId node ID query

Response Body

element: disinheritResponse
media types: */*
application/xml
application/json

response containing the exclusion and disinherit status

POST

Set the multichannelling exclusion and disinherit status

Parameters

name description type default
id page ID path
nodeId node ID query
wait wait timeout in milliseconds query 0

Request Body

element: disinheritRequest
media types: */*
application/xml
application/json

request object

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/getTags/{id}

Mount Point: /CNPortletapp/rest/page/getTags/{id}

GET

Get the list of tags (contenttags and templatetags) for this page

Parameters

name description type default
id id of the page path
skipCount (no documentation provided) query 0
maxItems (no documentation provided) query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
search (no documentation provided) query

Response Body

element: tagListResponse
media types: */*
application/xml
application/json

response object

/page/load/{id}

Mount Point: /CNPortletapp/rest/page/load/{id}

GET

Loads a page from GCN. For now this page only contains meta data about the page and no contents. When using loading pages, it is important to note that the returned tag data may be loaded differently depending on whether or not the page is loaded for editing ("update" flag is set to true). Loading a page with the update flag set to false allows you to load the page without causing it to be locked for editing, but it means that any tags which have not been filled will be loaded without all their tag parts. Tags that have not been filled, and that do not have default values will be loaded with empty properties in this case. On the other hand, when loading pages for editing, any tags that have no been filled, will have their constituents part auto-generated. Consequently, when loading pages via the REST-API or GCNJSAPI, setting the update flag to true will cause all tags to be loaded with all parts data (auto-generated if necessary), whereas when loading a page with update set to false, any tags which have not had their parts filled will be loaded without their parts data.

Parameters

name description type default
id The id of the page to load. This can either be a localid or a globalid path
update true when the page shall be locked, false if not query false
template true if the template information shall be added query false
folder true if the folder information shall be added query false
langvars true if the language variants shall be added query false
pagevars (no documentation provided) query false
workflow true if the workflow information shall be added query false
translationstatus true if the translationstatus information shall be added query false
versioninfo true if version information shall be added query false
disinherited if true, disinherited channel nodes shall be added query false
nodeId channel id query

Response Body

element: pageLoadResponse
media types: */*
application/xml
application/json

PageLoadResponse Response with the loaded page

/page/localizationinfo/{id}

Mount Point: /CNPortletapp/rest/page/localizationinfo/{id}

GET

Get localization info for a page for a given channel and all master channels

Parameters

name description type default
id id of the page path
nodeId id of the node to start with query

Response Body

element: localizationInfo
media types: */*
application/xml
application/json

localization info

/page/localize/{id}

Mount Point: /CNPortletapp/rest/page/localize/{id}

POST

Localize the given page

Parameters

name description type default
id id of the page to localize path

Request Body

element: localizeRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/move/{id}

Mount Point: /CNPortletapp/rest/page/move/{id}

POST

Move the given page to another folder

Parameters

name description type default
id page id path

Request Body

element: objectMoveRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/newtag/{id}

Mount Point: /CNPortletapp/rest/page/newtag/{id}

POST

Create a new tag in the given page

Parameters

name description type default
id id of the page. This can either be a local or globalid path
constructId id of the tags construct query
keyword keyword of the construct query

Request Body

element: contentTagCreateRequest
media types: */*
application/xml
application/json

tag create request

Response Body

element: tagCreateResponse
media types: */*
application/xml
application/json

response containing the rendered tag

/page/newtags/{id}

Mount Point: /CNPortletapp/rest/page/newtags/{id}

POST

Create multiple tags in the given page

Parameters

name description type default
id id of the page path

Request Body

element: multiTagCreateRequest
media types: */*
application/xml
application/json

tag create request

Response Body

element: multiTagCreateResponse
media types: */*
application/xml
application/json

response containing the created tags

/page/publish/{id}

Mount Point: /CNPortletapp/rest/page/publish/{id}

POST

Publish the page denoted by id (or send it in the queue when the User has not permission to publish the page). If the page is published and the node publishes into a contentrepository with instant publishing, the page will immediately be written into the contentrepository

Parameters

name description type default
id id of the Page to publish. This can either be a local or globalid path
nodeId channel id query

Request Body

element: pagePublishRequest
media types: */*
application/xml
application/json

publish page request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/push2master/{id}

Mount Point: /CNPortletapp/rest/page/push2master/{id}

POST

Push a page from a channel into a master

Parameters

name description type default
id id of the page path

Request Body

element: pushToMasterRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/render/{id}

Mount Point: /CNPortletapp/rest/page/render/{id}

GET

Render the given page Info: This currently doesn't return tag render errors.

Parameters

name description type default
id id of the page path
nodeId node id (if rendering a page for a channel) query
template template to render (if not set, the page's template will be rendered) query
edit true for rendering in edit mode, false for preview mode query false
proxyprefix proxyprefix query
links type of links (frontend or backend) query backend
tagmap true to also render the tagmap entries query false
inherited true to render the inherited content and properties query false
publish True to render in publish mode query false

Response Body

element: pageRenderResponse
media types: */*
application/xml
application/json

response containing the rendered page and other important information

/page/restore/{id}

Mount Point: /CNPortletapp/rest/page/restore/{id}

POST

Restore the page version with the given version timestamp

Parameters

name description type default
id The id of the page that should be restored. This can either be a local or globalid path
version version timestamp query

Response Body

element: pageLoadResponse
media types: */*
application/xml
application/json

(no documentation provided)

/page/save/{id}

Mount Point: /CNPortletapp/rest/page/save/{id}

POST

Saves a page into GCN

Parameters

name description type default
id Id of the page to save. This can either be a local or global id path

Request Body

element: pageSaveRequest
media types: */*
application/xml
application/json

page save request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

GenericResponse

/page/takeOffline/{id}

Mount Point: /CNPortletapp/rest/page/takeOffline/{id}

POST

Take a specific page offline

Parameters

name description type default
id ID of the page path

Response Body

element: genericResponse
media types: */*
application/xml
application/json

Generic response

/page/translate/{id}

Mount Point: /CNPortletapp/rest/page/translate/{id}

POST

Translate the page into the given language. When the language variant of the page exists, it is just locked and returned, otherwise the page is copied into the language variant and returned. This method fails, if the requested language is not available for the node of the page or the user has no permission to create/edit the given language variant

Parameters

name description type default
id id of the page to translate path
language code of the language into which the page shall be translated query
locked true if the translation shall be locked, false if not query true
channelId for multichannelling, specify channel in which to create page (can be 0 or equal to node ID to be ignored) query

Response Body

element: pageLoadResponse
media types: */*
application/xml
application/json

page load response

/page/unlocalize/{id}

Mount Point: /CNPortletapp/rest/page/unlocalize/{id}

POST

Unlocalize the given page

Parameters

name description type default
id id of the page to unlocalize path

Request Body

element: unlocalizeRequest
media types: */*
application/xml
application/json

request

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/usage/page

Mount Point: /CNPortletapp/rest/page/usage/page

GET

Get the pages using one of the given pages

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of page ids, for which the usage shall be fetched query
nodeId id of the node query
pages true (default) if the pages shall be returned, false for only returning the counts query true
template true for adding template info to the pages, default is false query false
folder true for adding folder info to the pages, default is false query false
langvars true for adding the language variants to the pages, default is false query false

Response Body

element: pageUsageListResponse
media types: */*
application/xml
application/json

list of pages using the given pages

/page/usage/tag

Mount Point: /CNPortletapp/rest/page/usage/tag

GET

Get the pages containing pagetags pointing to one of the given pages

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of page ids query
nodeId id of the node query
pages true (default) if the pages shall be returned, false for only returning the counts query true
template true for adding template info to the pages, default is false query false
folder true for adding folder info to the pages, default is false query false
langvars true for adding the language variants to the pages, default is false query false

Response Body

element: pageUsageListResponse
media types: */*
application/xml
application/json

list of pages

/page/usage/template

Mount Point: /CNPortletapp/rest/page/usage/template

GET

Get the templates using one of the given pages

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of page ids, for which the usage shall be fetched query
nodeId id of the node query
templates true (default) if the templates shall be returned, false for only returning the counts query true

Response Body

element: templateUsageListResponse
media types: */*
application/xml
application/json

response

/page/usage/variant

Mount Point: /CNPortletapp/rest/page/usage/variant

GET

Get the page variants of the given pages

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of page ids query
nodeId id of the node query
pages true (default) if the pages shall be returned, false for only returning the counts query true
template true for adding template info to the pages, default is false query false
folder true for adding folder info to the pages, default is false query false
langvars true for adding the language variants to the pages, default is false query false

Response Body

element: pageUsageListResponse
media types: */*
application/xml
application/json

list of page variants

/page/wastebin/delete

Mount Point: /CNPortletapp/rest/page/wastebin/delete

POST

Remove the given pages from the wastebin

Parameters

name description type default
wait time in ms for the request to be done in foreground query 0

Request Body

element: pageIdSetRequest
media types: */*
application/xml
application/json

request containing the page IDs

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/wastebin/restore

Mount Point: /CNPortletapp/rest/page/wastebin/restore

POST

Restore the given pages from the wastebin

Parameters

name description type default
wait time in ms for the request to be done in foreground query 0

Request Body

element: pageIdSetRequest
media types: */*
application/xml
application/json

request containing the page IDs

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/restore/{pageid}/{tag}

Mount Point: /CNPortletapp/rest/page/restore/{pageid}/{tag}

POST

Restore a single tag in the page with the given version timestamp

Parameters

name description type default
pageid id of the page. This can either be a local or globalid path
tag id or name of the tag path
version version timestamp query

Response Body

element: tagListResponse
media types: */*
application/xml
application/json

restored tag

/page/wastebin/delete/{id}

Mount Point: /CNPortletapp/rest/page/wastebin/delete/{id}

POST

Remove the page denoted by the given id from the wastebin.

Parameters

name description type default
id id of the page to remove from the wastebin. This can either be a local or global id path
wait time in ms for the request to be done in foreground query 0

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/wastebin/restore/{id}

Mount Point: /CNPortletapp/rest/page/wastebin/restore/{id}

POST

Restore the given page from the wastebin

Parameters

name description type default
id id of the page to restore from the wastebin. This can either be a local or global id path
wait time in ms for the request to be done in foreground query 0

Response Body

element: genericResponse
media types: */*
application/xml
application/json

response object

/page/workflow/decline/{id}

Mount Point: /CNPortletapp/rest/page/workflow/decline/{id}

POST

Decline the workflow for the page (i.e. give it back to a lower group)

Parameters

name description type default
id id of the page. This can either be a local or globalid path

Request Body

element: workflowRequest
media types: */*
application/xml
application/json

request object containing what should be changed about the workflow

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response

/page/workflow/revoke/{id}

Mount Point: /CNPortletapp/rest/page/workflow/revoke/{id}

POST

Revoke the last step of the workflow

Parameters

name description type default
id id of the page path

Response Body

element: genericResponse
media types: */*
application/xml
application/json

generic response