PageResource

The following resources are part of this group:

/page/create

Mount Point: /CNPortletapp/rest/page/create

POST

Create a page based on the given pagecreaterequest

Request Body

element: pageCreateRequest

containing data for creating the page

Response Body

element: pageLoadResponse

PageLoadResponse with the created page

/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

localization info

/page/preview

Mount Point: /CNPortletapp/rest/page/preview

POST

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

Request Body

element: pagePreviewRequest

(no documentation provided)

Response Body

element: pagePreviewResponse

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.

Request Body

element: multiPagePublishRequest

publish request

Response Body

element: genericResponse

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

request

Response Body

element: genericResponse

generic response

/page/unlocalize

Mount Point: /CNPortletapp/rest/page/unlocalize

POST

Unlocalize pages in a channel

Request Body

element: multiUnlocalizeRequest

request

Response Body

element: genericResponse

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

Response Body

element: genericResponse

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

response object

/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

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.

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
nodeId channel id query

Response Body

element: pageLoadResponse

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

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

request

Response Body

element: genericResponse

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

tag create request

Response Body

element: tagCreateResponse

response containing the rendered tag

/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

Request Body

element: pagePublishRequest

publish page request

Response Body

element: genericResponse

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

request

Response Body

element: genericResponse

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

Response Body

element: pageRenderResponse

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 (no documentation provided) query

Response Body

element: pageLoadResponse

(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

page save request

Response Body

element: genericResponse

GenericResponse

/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 edit the given page

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

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

request

Response Body

element: genericResponse

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

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

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

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

list of page variants

/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

request object containing what should be changed about the workflow

Response Body

element: genericResponse

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

generic response