FolderResource

Resource for loading and manipulating folders in GCN

The following resources are applicable:

/folder/breadcrumb/{id}

Mount Point: /CNPortletapp/rest/folder/breadcrumb/{id}

GET

Load the breadcrumb to the given folder

Parameters

name description type default
id id of the folder. This can either be a localid or a globalid path
nodeId node id (for multichannelling) query
wastebin true to include folders from the wastebin, false (default) if not query false

Response Body

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

list of folders. the first entry is the root folder of the node, the last one the requested folder.

/folder/count/{id}

Mount Point: /CNPortletapp/rest/folder/count/{id}

GET

Get the object counts for objects in the specified folder

Parameters

name description type default
id id of the folder path
nodeId node id query
language language code query
recursive true to count objects recursively, false (default) if not query false
inherited true to only count inherited objects, false to count not inherited objects, null (default) to count both query
wastebin wastebin search option query exclude

Response Body

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

response containing the object counts

/folder/create

Mount Point: /CNPortletapp/rest/folder/create

POST

Request Body

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

(no documentation provided)

Response Body

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

(no documentation provided)

/folder/delete/{id}

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

POST

Delete a single folder. Note that inherited or localized folders can't be deleted in a channel. However you can delete an inherited folder in the master and unlocalize a localized folder.

Parameters

name description type default
id id of the folder to be deleted. This can either be local or global id path
nodeId (no documentation provided) query

Response Body

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

generic response

/folder/disinherit

Mount Point: /CNPortletapp/rest/folder/disinherit

GET

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

Parameters

name description type default
id list of folder 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 folders

Parameters

name description type default
id list of folder 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

/folder/disinherit/{id}

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

GET

Get the multichannelling exclusion and disinherit status of the folder

Parameters

name description type default
id folder 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 folder 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

/folder/findFiles

This resource has been deprecated.

Mount Point: /CNPortletapp/rest/folder/findFiles

GET

This operation has been deprecated. use #getFiles(String, int, int, Integer, String, boolean, String, String, String, String, int, int, Boolean) instead.

Find files by name, starting with the given folder id

Parameters

name description type default
folderId start folder id, if set to 0, the search is done over all folders query 0
query string to be searched (currently, only page names are searched) query
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 100
links type of the links to the file ("backend" for backend links, "frontend" for frontend links) query backend
recursive true when the search shall be done recursive, false if only flat in the given folder query true

Response Body

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

list of found files

/folder/findPages

This resource has been deprecated.

Mount Point: /CNPortletapp/rest/folder/findPages

GET

This operation has been deprecated. use #getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, boolean) instead

Find pages by name, eventually starting with the given folder id

Parameters

name description type default
folderId start folder id, if set to 0, the search is done over all folders query 0
query string to be searched (currently, only page names are searched) query
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 100
links type of the links to the page ("backend" for backend links, "frontend" for frontend links) query backend
recursive true when the search shall be done recursive, false if only flat in the given folder query true

Response Body

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

list of found pages

/folder/getExternalLinks/{folderId}

Mount Point: /CNPortletapp/rest/folder/getExternalLinks/{folderId}

GET

Get externals links from all the pages inside the folder with id `folderId`.

Parameters

name description type default
folderId Id of the folder. path
recursive If true, pages in subfolders will be included in the response. query false

Response Body

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

list of pages including its external links (see FolderExternalLinksResponse).

/folder/getFiles/{folderId}

Mount Point: /CNPortletapp/rest/folder/getFiles/{folderId}

GET

get a list of files for this folder

Parameters

name description type default
folderId id of the folder path
skipCount number of items to skip from the start of the list (paging). 0 to not skip items (default) query 0
maxItems maximum number of items to be returned (paging). -1 to return all items (default) query -1
nodeId node id for this folder - for use with multichannelling query
search (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
recursive (optional) true, if subfolders should be integrated into search query
sortby (optional) attribute to sort by. defaults to name query name
sortorder (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". query asc
editor (optional) pattern for searching images by editor query
creator (optional) pattern for searching images by creator query
editedbefore (optional) timestamp for searching images edited before a specific time query 0
editedsince (optional) timestamp for searching images edited after a specific time query 0
createdbefore (optional) timestamp for searching images created before a specific time query 0
createdsince (optional) timestamp for searching images created after a specific time query 0
inherited true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files query
online true to only return online files, false to only get offline files, null to get both online and offline files query
broken true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both query
used true if only used files that are referenced somewhere shall be fetched, false for unused files query
wastebin exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects query exclude

Response Body

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

list of files

/folder/getFolders

Mount Point: /CNPortletapp/rest/folder/getFolders

POST

Get the list of folders in this folder

Request Body

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

(no documentation provided)

Response Body

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

list of folders

/folder/getFolders/{id}

Mount Point: /CNPortletapp/rest/folder/getFolders/{id}

GET

Get the list of folders in this folder

Parameters

name description type default
id local id of the folder. This can either be the local or globalid. path
nodeId node id (for multichannelling) query
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
recursive true when the folders shall be fetched recursively query false
sortby name of the sorted attribute, defaults to "name" query name
sortorder sorting order, defaults to "asc" query asc
inherited true to only return inherited folders in the given node, false to only get local/localized folders, null to get local and inherited folders query
search search string to search for in name, null if not searching - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
editor pattern for restricting folders by editor query
creator pattern for restricting folders by creator query
editedbefore timestamp for restricting to folders that were edited before a given time, 0 for all folders query 0
editedsince timestamp for restricting to folders that were edited since a given time, 0 for all folders query 0
createdbefore timestamp for restricting to folders that were created before a given time, 0 for all folders query 0
createdsince timestamp for restricting to folders that were created since a given time, 0 for all folders query 0
tree true when folders shall be returned as tree(s). Subfolders will be attached to their mothers. This only makes sense, when recursive is true. query false
recId optional list of folder ids, for which the children shall be fetched. if recursive is true (ignored if recursive is false). The ids might be composed as nodeId/folderId to get children for folders in specific channels only. query
privileges true if the privileges shall be added to the folders, false if not query false
wastebin exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects query exclude

Response Body

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

list of folders

/folder/getImages/{folderId}

Mount Point: /CNPortletapp/rest/folder/getImages/{folderId}

GET

get a list of images for this folder

Parameters

name description type default
folderId id of the folder path
skipCount number of items to skip from the start of the list (paging). 0 to not skip items (default) query 0
maxItems maximum number of items to be returned (paging). -1 to return all items (default) query -1
nodeId node id for this folder - for use with multichannelling query
search (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
recursive (optional) true, if subfolders should be integrated into search query
sortby (optional) attribute to sort by. defaults to name query name
sortorder (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". query asc
editor (optional) pattern for searching images by editor query
creator (optional) pattern for searching images by creator query
editedbefore (optional) timestamp for searching images edited before a specific time query 0
editedsince (optional) timestamp for searching images edited after a specific time query 0
createdbefore (optional) timestamp for searching images created before a specific time query 0
createdsince (optional) timestamp for searching images created after a specific time query 0
inherited true to only return inherited images in the given node, false to only get local/localized images, null to get local and inherited images query
online true to only return online files, false to only get offline files, null to get both online and offline files query
broken true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both query
used true if only used files that are referenced somewhere shall be fetched, false for unused files query
wastebin exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects query exclude

Response Body

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

list of iamges

/folder/getItems/{folderId}

Mount Point: /CNPortletapp/rest/folder/getItems/{folderId}

GET

Get a list of items for this folder

Parameters

name description type default
folderId id of the folder path
type (no documentation provided) query
skipCount number of items to skip from the start of the list (paging). 0 to not skip items (default) query 0
maxItems maximum number of items to be returned (paging). -1 to return all items (default) query -1
nodeId node id for this folder - for use with multichanneling query
template (no documentation provided) query false
langvars (no documentation provided) query false
language code of the language in which the pages shall be fetched. query
langfallback true if the language fallback shall be done when getting pages in a language, false if not. If a page is not present in the given language and langFallback is true, the language variant with highest priority in the node is used instead, otherwise the page will not be present in the list query true
search (optional) string to search items for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
recursive (optional) true, if subfolders should be integrated into search query
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
editor (optional) pattern for searching images by editor query
creator (optional) pattern for searching images by creator query
editedbefore (optional) timestamp for searching images edited before a specific time query 0
editedsince (optional) timestamp for searching images edited after a specific time query 0
createdbefore (optional) timestamp for searching images created before a specific time query 0
createdsince (optional) timestamp for searching images created after a specific time query 0

Response Body

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

list of items

/folder/getPages/{id}

Mount Point: /CNPortletapp/rest/folder/getPages/{id}

GET

get a list of pages for this folder

Parameters

name description type default
id id of the folder. This can be the local or global id of the folder path
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
nodeId node id of the channel when used in multichannelling query
template true when the template information should be added to the pages query false
folder true when the folder information should be added to the pages query false
langvars true when the language variants should be added to the pages query false
language code of the language in which the pages shall be fetched. query
langfallback true if the language fallback shall be done when getting pages in a language, false if not. If a page is not present in the given language and langFallback is true, the language variant with highest priority in the node is used instead, otherwise the page will not be present in the list query true
contenttags true if the contenttags shall be attached to all returned pages. Default is false query false
objecttags true if the objecttags shall be attached to all returned pages. Default is false query false
search (optional) search string (may be empty for no search) - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
searchcontent (optional) true, if also the content shall be searched, false if not query false
filename (optional) search string for filenames (may be empty) query
recursive (optional) true when the pages shall be fetched recursively, false if not. Defaults to false query false
sortby (optional) attribute to sort by. defaults to name query name
sortorder (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". query asc
iseditor (optional) true when only the pages last edited by the user shall be returned query false
iscreator (optional) true when only the pages created by the user shall be returned query false
ispublisher (optional) true when only the pages which were last published by the user shall be returned query false
editor pattern for restricting pages by editor query
creator pattern for restricting pages by creator query
publisher pattern for restricting pages by publisher query
timedue (optional) difference in seconds for searching pages, that will change their status due to timemanagement within the given timespan. When set to 0 (default), the timemanagement will not be considered. query 0
wfown (optional) true to restrict to pages owned by the user in a workflow. Defaults to false. query false
wfwatch (optional) true to restrict to pages watched by the user in a workflow. Defaults to false. query false
insync (optional) Boolean#TRUE to restrict to pages that are currently in sync with their translation masters, Boolean#FALSE to restrict to pages that are currently not in sync with their translation masters, and NULL to not consider the translation status information at all. Setting this flag (to either true or false) will also add the translation status information. query
translationstatus true if the translationstatus information shall be added for every page, false if not. query false
status list of page stati query
priority priority of the page query 0
template_id list of template ids query
editedbefore timestamp to search pages, which were edited before a given time (0 for all pages) query 0
editedsince timestamp to search pages, which were edited since a given time (0 for all pages) query 0
createdbefore timestamp to search pages, which were created before a given time (0 for all pages) query 0
createdsince timestamp to search pages, which were created since a given time (0 for all pages) query 0
publishedbefore timestamp to search pages, which were published before a given time (0 for all pages) query 0
publishedsince timestamp to search pages, which were published since a given time (0 for all pages) query 0
inherited true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pages query
wastebin exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects query exclude

Response Body

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

list of pages

/folder/getTemplates/{folderId}

Mount Point: /CNPortletapp/rest/folder/getTemplates/{folderId}

GET

Get the templates which are linked into the given folder

Parameters

name description type default
folderId id of the folder. This can either be a localid or a globalid path
nodeId id of the channel, if the list shall be fetched for a channel query
search (optional) search string (may be empty for no search), defaults to null - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. query
recursive (optional) true when the search shall be done recursively, false if not, defaults to false query false
reduce (optional) true when each template shall only be returned once, even when searching recursively, defaults to false query false
sortby (optional) attribute to sort by. defaults to name query name
sortorder (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". query asc
editor (optional) pattern for searching images by editor query
creator (optional) pattern for searching images by creator query
editedbefore (optional) timestamp for searching images edited before a specific time query 0
editedsince (optional) timestamp for searching images edited after a specific time query 0
createdsince (optional) timestamp for searching images created before a specific time query 0
createdbefore (optional) timestamp for searching images created after a specific time query 0
checkPermission (optional) flag to check for permissions. Optional, defaults to true query true
inherited true to only return inherited templates in the given node, false to only get local/localized templates, null to get local and inherited templates query
skipCount (no documentation provided) query 0
maxItems (no documentation provided) query -1

Response Body

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

list of templates

/folder/load

Mount Point: /CNPortletapp/rest/folder/load

POST

Load a list of folders specified in the given request. Folder ids for which no folders exist, or the user does not have the necessary permissions, are silently ignored.

Request Body

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

The request with he list of folder ids to load.

Response Body

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

The list of found folders, for which the user has enough permissions.

/folder/load/{id}

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

GET

Load a single folder

Parameters

name description type default
id (no documentation provided) path
update true when the folder is fetched for updating. Currently, folders cannot be locked in the backend, but it is still recommended to set this parameter to true when the folder shall be modified. query false
privileges flag whether the privileges should be added to the reponse query false
nodeId id of the node (channel) for which the folder shall be loaded (when multichannelling is used) query

Response Body

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

response containing the folder to load

/folder/localizationinfo/{id}

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

GET

Get localization info for a folder and all subitems for a given channel and all master channels

Parameters

name description type default
id id of the folder. This can either be the local or global id path
nodeId id of the node to start with query
recursive true if the localization info shall be fetched recursively, false if not query

Response Body

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

localization info

/folder/localize/{id}

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

POST

Localize the given folder

Parameters

name description type default
id id of the folder 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

/folder/move

Mount Point: /CNPortletapp/rest/folder/move

POST

Move multiple folders to a different location

Request Body

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

request containing source and target information

Response Body

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

generic response

/folder/move/{id}

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

POST

Move the folder with id to a different location

Parameters

name description type default
id id of the folder to move path

Request Body

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

request containing target information

Response Body

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

generic response

/folder/privileges/{id}

Mount Point: /CNPortletapp/rest/folder/privileges/{id}

GET

Get the privileges of the current user on the given folder

Parameters

name description type default
id id of the folder. path

Response Body

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

privileges response

/folder/push2master

Mount Point: /CNPortletapp/rest/folder/push2master

POST

Push a list of folders 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

/folder/push2master/{id}

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

POST

Push a folder from a channel into a master

Parameters

name description type default
id id of the folder path

Request Body

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

request

Response Body

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

generic response

/folder/save/{id}

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

POST

Save a single folder

Parameters

name description type default
id folder id. This can either be a local or globalid path

Request Body

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

folder save request

Response Body

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

generic response

/folder/startpage/{id}

Mount Point: /CNPortletapp/rest/folder/startpage/{id}

POST

Request to set a startpage for a page

Parameters

name description type default
id id of the page path

Request Body

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

request containing the requested startpage

Response Body

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

generic response

/folder/unlocalize

Mount Point: /CNPortletapp/rest/folder/unlocalize

POST

Unlocalize folders 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

/folder/unlocalize/{id}

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

POST

Unlocalize the given folder

Parameters

name description type default
id id of the folder 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

/folder/wastebin/delete

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

POST

Delete folders denoted by the set of IDs 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: idSetRequest
media types: */*
application/xml
application/json

request containing ID set

Response Body

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

response object

/folder/wastebin/delete/{id}

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

POST

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

Parameters

name description type default
id id of the folder 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

/folder/wastebin/restore

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

POST

Restore the denoted folders 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: idSetRequest
media types: */*
application/xml
application/json

request containing ID set

Response Body

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

response object

/folder/wastebin/restore/{id}

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

POST

Restore the given folder from the wastebin

Parameters

name description type default
id id of the folder 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