com.gentics.contentnode.rest.resource

Interface FolderResource

All Superinterfaces:

AuthenticatedResource

@Path(value="/folder")
public interface FolderResource
extends AuthenticatedResource

Resource for loading and manipulating folders in GCN

Method Summary

Modifier and Type	Method and Description
FolderLoadResponse	create(FolderCreateRequest request)
GenericResponse	delete(String id, Integer nodeId) Delete a single folder.
GenericResponse	deleteFromWastebin(IdSetRequest request, long waitMs) Delete folders denoted by the set of IDs from the wastebin
GenericResponse	deleteFromWastebin(String id, long waitMs) Remove the folder denoted by the given id from the wastebin.
MultiDisinheritResponse	disinherit(List<String> ids, Integer nodeId) Get the multichannelling exclusion and disinherit status for a list of folders
GenericResponse	disinherit(List<String> ids, Integer nodeId, long waitMs, DisinheritRequest request) Set the multichannelling exclusion and disinherit status for a list of folders
DisinheritResponse	disinherit(String id, Integer nodeId) Get the multichannelling exclusion and disinherit status of the folder
GenericResponse	disinherit(String id, Integer nodeId, long waitMs, DisinheritRequest request) Set the multichannelling exclusion and disinherit status
FoundFilesListResponse	findFiles(Integer folderId, String query, Integer skipCount, Integer maxItems, LinksType links, boolean recursive) Deprecated. use FileResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead
LegacyPageListResponse	findPages(Integer folderId, String query, Integer skipCount, Integer maxItems, LinksType links, boolean recursive) Deprecated. use getPages(String, InFolderParameterBean, PageListParameterBean, LegacyFilterParameterBean, LegacySortParameterBean, LegacyPagingParameterBean, PublishableParameterBean, WastebinParameterBean) instead
LegacyFolderListResponse	getBreadcrumb(String id, Integer nodeId, boolean includeWastebin, boolean includeTags) Load the breadcrumb to the given folder
FolderExternalLinksResponse	getExternalLinks(Integer folderId, boolean recursive) Get externals links from all the pages inside the folder with id `folderId`.
LegacyFileListResponse	getFiles(String folderId, InFolderParameterBean inFolder, FileListParameterBean fileListParams, LegacyFilterParameterBean filterParams, LegacySortParameterBean sortingParams, LegacyPagingParameterBean pagingParams, EditableParameterBean editableParams, WastebinParameterBean wastebinParams) Deprecated. Use FileResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead
LegacyFolderListResponse	getFolders(FolderListRequest folderListRequest) Get the list of folders in this folder
LegacyFolderListResponse	getFolders(String id, List<String> recursiveIds, boolean addPrivileges, InFolderParameterBean inFolder, FolderListParameterBean folderListParams, LegacyFilterParameterBean filterParams, LegacySortParameterBean sortParams, LegacyPagingParameterBean pagingParams, EditableParameterBean editableParams, WastebinParameterBean wastebinParams) Deprecated. Use list(InFolderParameterBean, FolderListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead
LegacyFileListResponse	getImages(String folderId, InFolderParameterBean inFolder, FileListParameterBean fileListParams, LegacyFilterParameterBean filterParams, LegacySortParameterBean sortingParams, LegacyPagingParameterBean pagingParams, EditableParameterBean editableParams, WastebinParameterBean wastebinParams) Deprecated. Use ImageResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead
ItemListResponse	getItems(String folderId, List<ContentNodeItem.ItemType> types, Integer nodeId, boolean template, boolean languageVariants, String language, boolean langFallback, InFolderParameterBean inFolder, LegacyFilterParameterBean filter, LegacySortParameterBean sorting, LegacyPagingParameterBean paging, PublishableParameterBean publishParams) Get a list of items for this folder
LocalizationInfo	getLocalizationInfo(String id, Integer nodeId, boolean recursive) Get localization info for a folder and all subitems for a given channel and all master channels
FolderObjectCountResponse	getObjectCounts(Integer id, Integer nodeId, String language, Boolean inherited, InFolderParameterBean inFolder, WastebinParameterBean wastebinParams) Get the object counts for objects in the specified folder
LegacyPageListResponse	getPages(String id, InFolderParameterBean inFolder, PageListParameterBean pageListParams, LegacyFilterParameterBean filterParams, LegacySortParameterBean sortingParams, LegacyPagingParameterBean pagingParams, PublishableParameterBean publishParams, WastebinParameterBean wastebinParams) Deprecated. Use PageResource.list(InFolderParameterBean, PageListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, PublishableParameterBean, WastebinParameterBean) instead
PrivilegesResponse	getPrivileges(Integer id) Get the privileges of the current user on the given folder
ReferencedSyncableObjectsListResponse	getSyncableObjects(List<Integer> folderIds, Integer srcNodeId, Integer dstNodeId, Boolean recursive, List<PushToMasterRequest.Type> types) Get objects which are directly or indirectly linked by the specified folders, which can be synchronised to a master channel along with the folders themselves.
TemplateListResponse	getTemplates(String folderId, InFolderParameterBean inFolder, TemplateListParameterBean templateListParams, LegacyFilterParameterBean filterParams, LegacySortParameterBean sortingParams, LegacyPagingParameterBean pagingParams, EditableParameterBean editableParams, WastebinParameterBean wastebinParams) Get the templates which are linked into the given folder
FolderListResponse	list(InFolderParameterBean inFolder, FolderListParameterBean folderListParams, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, EditableParameterBean editable, WastebinParameterBean wastebin) Get the list of folders in this folder. The result can be filtered by id name description and sorted by id name description publishDir
MultiFolderLoadResponse	load(MultiFolderLoadRequest request, boolean fillWithNulls) Load a list of folders specified in the given request.
FolderLoadResponse	load(String folderId, boolean update, boolean addPrivileges, boolean construct, Integer nodeId, String stagingPackageName) Load a single folder
LocalizationsResponse	localizations(Integer id) Get the IDs an their respective node IDs of localized copies of the specified folder.
GenericResponse	localize(Integer id, LocalizeRequest request) Localize the given folder
GenericResponse	move(MultiFolderMoveRequest request) Move multiple folders to a different location
GenericResponse	move(String id, FolderMoveRequest request) Move the folder with id to a different location
GenericResponse	pushToMaster(Integer id, PushToMasterRequest request) Push a folder from a channel into a master
GenericResponse	pushToMaster(MultiPushToMasterRequest request) Push a list of folders from a channel into a master
GenericResponse	restoreFromWastebin(IdSetRequest request, long waitMs) Restore the denoted folders from the wastebin
GenericResponse	restoreFromWastebin(String id, long waitMs) Restore the given folder from the wastebin
FolderPublishDirSanitizeResponse	sanitizePubdir(FolderPublishDirSanitizeRequest request) Sanitize the given folder publish directory according to the configuration and settings of the given node
GenericResponse	save(String id, FolderSaveRequest request) Save a single folder
GenericResponse	setStartpage(String id, StartpageRequest request) Request to set a startpage for a page
GenericResponse	unlocalize(Integer id, UnlocalizeRequest request) Unlocalize the given folder
GenericResponse	unlocalize(MultiUnlocalizeRequest request) Unlocalize folders in a channel

Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource

setSessionId

Method Detail

create

@POST
 @Path(value="/create")
FolderLoadResponse create(FolderCreateRequest request)

load

@GET
 @Path(value="/load/{id}")
FolderLoadResponse load(@PathParam(value="id")
                                                        String folderId,
                                                        @DefaultValue(value="false") @QueryParam(value="update")
                                                        boolean update,
                                                        @QueryParam(value="privileges") @DefaultValue(value="false")
                                                        boolean addPrivileges,
                                                        @QueryParam(value="construct") @DefaultValue(value="false")
                                                        boolean construct,
                                                        @QueryParam(value="nodeId")
                                                        Integer nodeId,
                                                        @QueryParam(value="package")
                                                        String stagingPackageName)

Load a single folder

Parameters:

folderId - id of the folder to load. This can be either the localid or a globalid

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.

addPrivileges - flag whether the privileges should be added to the reponse

construct - if true, the construct information will be added to tags

nodeId - id of the node (channel) for which the folder shall be loaded (when multichannelling is used)

stagingPackageName - name of a content staging package, to check the folder status in it

Returns:

response containing the folder to load

load

@POST
 @Path(value="/load")
MultiFolderLoadResponse load(MultiFolderLoadRequest request,
                                                         @QueryParam(value="fillWithNulls") @DefaultValue(value="false")
                                                         boolean fillWithNulls)

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.

Parameters:

request - The request with he list of folder ids to load.

fillWithNulls - flag to have items, which cannot be loaded returned as "null" objects in the response (instead of just omitting them)

Returns:

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

getBreadcrumb

@GET
 @Path(value="/breadcrumb/{id}")
LegacyFolderListResponse getBreadcrumb(@PathParam(value="id")
                                                                             String id,
                                                                             @QueryParam(value="nodeId")
                                                                             Integer nodeId,
                                                                             @QueryParam(value="wastebin") @DefaultValue(value="false")
                                                                             boolean includeWastebin,
                                                                             @QueryParam(value="tags") @DefaultValue(value="false")
                                                                             boolean includeTags)

Load the breadcrumb to the given folder

Parameters:

id - id of the folder. This can either be a localid or a globalid

nodeId - node id (for multichannelling)

includeWastebin - true to include folders from the wastebin, false (default) if not

includeTags - true to include the folders tags, false (default)if not

Returns:

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

getPages

@GET
 @Path(value="/getPages/{id}")
LegacyPageListResponse getPages(@PathParam(value="id")
                                                                    String id,
                                                                    @BeanParam
                                                                    InFolderParameterBean inFolder,
                                                                    @BeanParam
                                                                    PageListParameterBean pageListParams,
                                                                    @BeanParam
                                                                    LegacyFilterParameterBean filterParams,
                                                                    @BeanParam
                                                                    LegacySortParameterBean sortingParams,
                                                                    @BeanParam
                                                                    LegacyPagingParameterBean pagingParams,
                                                                    @BeanParam
                                                                    PublishableParameterBean publishParams,
                                                                    @BeanParam
                                                                    WastebinParameterBean wastebinParams)

Deprecated. Use PageResource.list(InFolderParameterBean, PageListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, PublishableParameterBean, WastebinParameterBean) instead

get a list of pages for this folder

Parameters:

id - id of the folder. This can be the local or global id of the folder

inFolder - folder parameters

pageListParams - page list params

filterParams - filter parameters

sortingParams - sorting parameters

pagingParams - paging parameters

publishParams - publishable params

wastebinParams - wastebin params

Returns:

list of pages

getFiles

@GET
 @Path(value="/getFiles/{folderId}")
LegacyFileListResponse getFiles(@PathParam(value="folderId")
                                                                          String folderId,
                                                                          @BeanParam
                                                                          InFolderParameterBean inFolder,
                                                                          @BeanParam
                                                                          FileListParameterBean fileListParams,
                                                                          @BeanParam
                                                                          LegacyFilterParameterBean filterParams,
                                                                          @BeanParam
                                                                          LegacySortParameterBean sortingParams,
                                                                          @BeanParam
                                                                          LegacyPagingParameterBean pagingParams,
                                                                          @BeanParam
                                                                          EditableParameterBean editableParams,
                                                                          @BeanParam
                                                                          WastebinParameterBean wastebinParams)

Deprecated. Use FileResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead

get a list of files for this folder

Parameters:

folderId - id of the folder

inFolder - folder parameters

fileListParams - file list parameters

filterParams - filter parameters

sortingParams - sorting parameters

pagingParams - paging parameters

editableParams - editable parameters

wastebinParams - wastebin parameters

Returns:

list of files

getImages

@GET
 @Path(value="/getImages/{folderId}")
LegacyFileListResponse getImages(@PathParam(value="folderId")
                                                                            String folderId,
                                                                            @BeanParam
                                                                            InFolderParameterBean inFolder,
                                                                            @BeanParam
                                                                            FileListParameterBean fileListParams,
                                                                            @BeanParam
                                                                            LegacyFilterParameterBean filterParams,
                                                                            @BeanParam
                                                                            LegacySortParameterBean sortingParams,
                                                                            @BeanParam
                                                                            LegacyPagingParameterBean pagingParams,
                                                                            @BeanParam
                                                                            EditableParameterBean editableParams,
                                                                            @BeanParam
                                                                            WastebinParameterBean wastebinParams)

Deprecated. Use ImageResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead

get a list of images for this folder

Parameters:

folderId - id of the folder

inFolder - folder parameters

fileListParams - file list parameters

filterParams - filter parameters

sortingParams - sorting parameters

pagingParams - paging parameters * @param editableParams editable parameters

wastebinParams - wastebin parameters

Returns:

list of iamges

getFolders

@POST
 @Path(value="/getFolders/")
LegacyFolderListResponse getFolders(FolderListRequest folderListRequest)

Get the list of folders in this folder

Parameters:

folderListRequest -

Returns:

list of folders

getFolders

@GET
 @Path(value="/getFolders/{id}")
LegacyFolderListResponse getFolders(@PathParam(value="id")
                                                                          String id,
                                                                          @QueryParam(value="recId")
                                                                          List<String> recursiveIds,
                                                                          @QueryParam(value="privileges") @DefaultValue(value="false")
                                                                          boolean addPrivileges,
                                                                          @BeanParam
                                                                          InFolderParameterBean inFolder,
                                                                          @BeanParam
                                                                          FolderListParameterBean folderListParams,
                                                                          @BeanParam
                                                                          LegacyFilterParameterBean filterParams,
                                                                          @BeanParam
                                                                          LegacySortParameterBean sortParams,
                                                                          @BeanParam
                                                                          LegacyPagingParameterBean pagingParams,
                                                                          @BeanParam
                                                                          EditableParameterBean editableParams,
                                                                          @BeanParam
                                                                          WastebinParameterBean wastebinParams)

Deprecated. Use list(InFolderParameterBean, FolderListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead

Get the list of folders in this folder

Parameters:

id - local id of the folder. This can either be the local or globalid.

nodeId - node id (for multichannelling)

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

recursive - true when the folders shall be fetched recursively

sortBy - name of the sorted attribute. It is possible to sort by name, cdate, edate, masterNode, excluded, deletedat. defaults to "name"

sortOrder - sorting order, defaults to "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

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.

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.

recursiveIds - 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.

privilegeMap - true if the privileges shall be added to the folders as map, false if not

addPrivileges - true if the privileges shall be added to the folders, false if not

editableParams - filter params for creator/editor and created and edited timestamps

wastebinParams - exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects

Returns:

list of folders

list

@GET
FolderListResponse list(@BeanParam
                             InFolderParameterBean inFolder,
                             @BeanParam
                             FolderListParameterBean folderListParams,
                             @BeanParam
                             FilterParameterBean filter,
                             @BeanParam
                             SortParameterBean sorting,
                             @BeanParam
                             PagingParameterBean paging,
                             @BeanParam
                             EditableParameterBean editable,
                             @BeanParam
                             WastebinParameterBean wastebin)

Get the list of folders in this folder.
The result can be filtered by

• id
• name
• description

and sorted by

• id
• name
• description
• publishDir

Parameters:

inFolder - Folder ID and recursive parameters

folderListParams - further folder parameters

filter - Search parameters

sorting - Sorting parameters

paging - Paging parameters

editable - Editable parameters

wastebin - Wastebin parameters

Returns:

A list of folders

getTemplates

@GET
 @Path(value="/getTemplates/{folderId}")
TemplateListResponse getTemplates(@PathParam(value="folderId")
                                                                                String folderId,
                                                                                @BeanParam
                                                                                InFolderParameterBean inFolder,
                                                                                @BeanParam
                                                                                TemplateListParameterBean templateListParams,
                                                                                @BeanParam
                                                                                LegacyFilterParameterBean filterParams,
                                                                                @BeanParam
                                                                                LegacySortParameterBean sortingParams,
                                                                                @BeanParam
                                                                                LegacyPagingParameterBean pagingParams,
                                                                                @BeanParam
                                                                                EditableParameterBean editableParams,
                                                                                @BeanParam
                                                                                WastebinParameterBean wastebinParams)

Get the templates which are linked into the given folder

Parameters:

folderId - id of the folder. This can either be a localid or a globalid

inFolder - folder parameters

templateListParams - template-specific list parameters

filterParams - filter parameters

sortingParams - sorting parameters

pagingParams - paging parameters

editableParams - editable parameters

wastebinParams - wastebin parameters

Returns:

list of templates

getItems

@GET
 @Path(value="/getItems/{folderId}")
ItemListResponse getItems(@PathParam(value="folderId")
                                                                    String folderId,
                                                                    @QueryParam(value="type")
                                                                    List<ContentNodeItem.ItemType> types,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId,
                                                                    @QueryParam(value="template") @DefaultValue(value="false")
                                                                    boolean template,
                                                                    @QueryParam(value="langvars") @DefaultValue(value="false")
                                                                    boolean languageVariants,
                                                                    @QueryParam(value="language")
                                                                    String language,
                                                                    @QueryParam(value="langfallback") @DefaultValue(value="true")
                                                                    boolean langFallback,
                                                                    @BeanParam
                                                                    InFolderParameterBean inFolder,
                                                                    @BeanParam
                                                                    LegacyFilterParameterBean filter,
                                                                    @BeanParam
                                                                    LegacySortParameterBean sorting,
                                                                    @BeanParam
                                                                    LegacyPagingParameterBean paging,
                                                                    @BeanParam
                                                                    PublishableParameterBean publishParams)

Get a list of items for this folder

Parameters:

folderId - id of the folder

types - list of types to return, e.g. page, file and/or image

nodeId - node id for this folder - for use with multichanneling

languageVariants - true when the language variants should be added to the pages

language - code of the language in which the pages shall be fetched.

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

inFolder - (optional) folder parameters

filter - (optional) filter parameters

sorting - (optional) sorting parameters

paging - (optional) paging parameters

publishParams - (optional) editable/publishable parameters

Returns:

list of items

findPages

@GET
 @Path(value="/findPages")
LegacyPageListResponse findPages(@QueryParam(value="folderId") @DefaultValue(value="0")
                                                                 Integer folderId,
                                                                 @QueryParam(value="query")
                                                                 String query,
                                                                 @QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                 Integer skipCount,
                                                                 @QueryParam(value="maxItems") @DefaultValue(value="100")
                                                                 Integer maxItems,
                                                                 @QueryParam(value="links") @DefaultValue(value="backend")
                                                                 LinksType links,
                                                                 @QueryParam(value="recursive") @DefaultValue(value="true")
                                                                 boolean recursive)

Deprecated. use getPages(String, InFolderParameterBean, PageListParameterBean, LegacyFilterParameterBean, LegacySortParameterBean, LegacyPagingParameterBean, PublishableParameterBean, WastebinParameterBean) instead

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

Parameters:

folderId - start folder id, if set to 0, the search is done over all folders

query - string to be searched (currently, only page names are searched)

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

links - type of the links to the page ("backend" for backend links, "frontend" for frontend links)

recursive - true when the search shall be done recursive, false if only flat in the given folder

Returns:

list of found pages

findFiles

@GET
 @Path(value="/findFiles")
FoundFilesListResponse findFiles(@QueryParam(value="folderId") @DefaultValue(value="0")
                                                                 Integer folderId,
                                                                 @QueryParam(value="query")
                                                                 String query,
                                                                 @QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                 Integer skipCount,
                                                                 @QueryParam(value="maxItems") @DefaultValue(value="100")
                                                                 Integer maxItems,
                                                                 @QueryParam(value="links") @DefaultValue(value="backend")
                                                                 LinksType links,
                                                                 @QueryParam(value="recursive") @DefaultValue(value="true")
                                                                 boolean recursive)

Deprecated. use FileResource.list(InFolderParameterBean, FileListParameterBean, FilterParameterBean, SortParameterBean, PagingParameterBean, EditableParameterBean, WastebinParameterBean) instead

Find files by name, starting with the given folder id

Parameters:

folderId - start folder id, if set to 0, the search is done over all folders

query - string to be searched (currently, only page names are searched)

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

links - type of the links to the file ("backend" for backend links, "frontend" for frontend links)

recursive - true when the search shall be done recursive, false if only flat in the given folder

Returns:

list of found files

getExternalLinks

@GET
 @Path(value="/getExternalLinks/{folderId}")
FolderExternalLinksResponse getExternalLinks(@PathParam(value="folderId")
                                                                                               Integer folderId,
                                                                                               @QueryParam(value="recursive") @DefaultValue(value="false")
                                                                                               boolean recursive)

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

Parameters:

folderId - Id of the folder.

recursive - If true, pages in subfolders will be included in the response.

Returns:

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

save

@POST
 @Path(value="/save/{id}")
GenericResponse save(@PathParam(value="id")
                                                      String id,
                                                      FolderSaveRequest request)

Save a single folder

Parameters:

id - folder id. This can either be a local or globalid

request - folder save request

Returns:

generic response

delete

@POST
 @Path(value="/delete/{id}")
GenericResponse delete(@PathParam(value="id")
                                                          String id,
                                                          @QueryParam(value="nodeId")
                                                          Integer nodeId)

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:

id - id of the folder to be deleted. This can either be local or global id

Returns:

generic response

deleteFromWastebin

@POST
 @Path(value="/wastebin/delete/{id}")
GenericResponse deleteFromWastebin(@PathParam(value="id")
                                                                               String id,
                                                                               @QueryParam(value="wait") @DefaultValue(value="0")
                                                                               long waitMs)

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

Parameters:

id - id of the folder to remove from the wastebin. This can either be a local or global id

waitMs - time in ms for the request to be done in foreground

Returns:

response object

deleteFromWastebin

@POST
 @Path(value="/wastebin/delete")
GenericResponse deleteFromWastebin(IdSetRequest request,
                                                                          @QueryParam(value="wait") @DefaultValue(value="0")
                                                                          long waitMs)

Delete folders denoted by the set of IDs from the wastebin

Parameters:

request - request containing ID set

waitMs - time in ms for the request to be done in foreground

Returns:

response object

restoreFromWastebin

@POST
 @Path(value="/wastebin/restore/{id}")
GenericResponse restoreFromWastebin(@PathParam(value="id")
                                                                                 String id,
                                                                                 @QueryParam(value="wait") @DefaultValue(value="0")
                                                                                 long waitMs)

Restore the given folder from the wastebin

Parameters:

id - id of the folder to restore from the wastebin. This can either be a local or global id

waitMs - time in ms for the request to be done in foreground

Returns:

response object

restoreFromWastebin

@POST
 @Path(value="/wastebin/restore")
GenericResponse restoreFromWastebin(IdSetRequest request,
                                                                            @QueryParam(value="wait") @DefaultValue(value="0")
                                                                            long waitMs)

Restore the denoted folders from the wastebin

Parameters:

request - request containing ID set

waitMs - time in ms for the request to be done in foreground

Returns:

response object

getPrivileges

@GET
 @Path(value="/privileges/{id}")
PrivilegesResponse getPrivileges(@PathParam(value="id")
                                                                       Integer id)

Get the privileges of the current user on the given folder

Parameters:

id - id of the folder.

Returns:

privileges response

getObjectCounts

@GET
 @Path(value="/count/{id}")
FolderObjectCountResponse getObjectCounts(@PathParam(value="id")
                                                                           Integer id,
                                                                           @QueryParam(value="nodeId")
                                                                           Integer nodeId,
                                                                           @QueryParam(value="language")
                                                                           String language,
                                                                           @QueryParam(value="inherited")
                                                                           Boolean inherited,
                                                                           @BeanParam
                                                                           InFolderParameterBean inFolder,
                                                                           @BeanParam
                                                                           WastebinParameterBean wastebinParams)

Get the object counts for objects in the specified folder

Parameters:

id - id of the folder

nodeId - node id

language - language code

inherited - true to only count inherited objects, false to count not inherited objects, null (default) to count both

inFolder - folder parameters

wastebinParams - wastebin search option

Returns:

response containing the object counts

getSyncableObjects

@GET
 @Path(value="/usage/syncableObjects")
ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam(value="ids")
                                                                                                     List<Integer> folderIds,
                                                                                                     @QueryParam(value="srcNodeId")
                                                                                                     Integer srcNodeId,
                                                                                                     @QueryParam(value="dstNodeId")
                                                                                                     Integer dstNodeId,
                                                                                                     @QueryParam(value="recursive")
                                                                                                     Boolean recursive,
                                                                                                     @QueryParam(value="types")
                                                                                                     List<PushToMasterRequest.Type> types)

Get objects which are directly or indirectly linked by the specified folders, which can be synchronised to a master channel along with the folders themselves. Linked objects are pages, files and images specified in UrlPartTypes of content or object tags. Direct dependencies are in the pages, files and images files of the response. Indirect dependencies are mapped in dependencies.

Parameters:

folderIds - The IDs of the folders to get linked objects for

srcNodeId - The channel ID of the source channel

dstNodeId - The channel ID of the target channel

recursive - Whether objects in subfolders should be collected (optional, default: false)

types - The object types which should be synchronised (optional, default: all types)

pushToMaster

@POST
 @Path(value="/push2master/{id}")
GenericResponse pushToMaster(@PathParam(value="id")
                                                                     Integer id,
                                                                     PushToMasterRequest request)

Push a folder from a channel into a master

Parameters:

id - id of the folder

request - request

Returns:

generic response

pushToMaster

@POST
 @Path(value="/push2master")
GenericResponse pushToMaster(MultiPushToMasterRequest request)

Push a list of folders from a channel into a master

Parameters:

request - request

Returns:

generic response

unlocalize

@POST
 @Path(value="/unlocalize/{id}")
GenericResponse unlocalize(@PathParam(value="id")
                                                                  Integer id,
                                                                  UnlocalizeRequest request)

Unlocalize the given folder

Parameters:

id - id of the folder to unlocalize

request - request

Returns:

generic response

unlocalize

@POST
 @Path(value="/unlocalize")
GenericResponse unlocalize(MultiUnlocalizeRequest request)

Unlocalize folders in a channel

Parameters:

request - request

Returns:

generic response

localize

@POST
 @Path(value="/localize/{id}")
GenericResponse localize(@PathParam(value="id")
                                                              Integer id,
                                                              LocalizeRequest request)

Localize the given folder

Parameters:

id - id of the folder to localize

request - request

Returns:

generic response

localizations

@GET
 @Path(value="/localizations/{id}")
LocalizationsResponse localizations(@PathParam(value="id")
                                                                             Integer id)

Get the IDs an their respective node IDs of localized copies of the specified folder.

Parameters:

id - The ID of the master folder.

Returns:

A map of folder IDs to node IDs of localized copies.

getLocalizationInfo

@GET
 @Path(value="/localizationinfo/{id}")
LocalizationInfo getLocalizationInfo(@PathParam(value="id")
                                                                                 String id,
                                                                                 @QueryParam(value="nodeId")
                                                                                 Integer nodeId,
                                                                                 @QueryParam(value="recursive")
                                                                                 boolean recursive)

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

Parameters:

id - id of the folder. This can either be the local or global id

nodeId - id of the node to start with

recursive - true if the localization info shall be fetched recursively, false if not

Returns:

localization info

setStartpage

@POST
 @Path(value="/startpage/{id}")
GenericResponse setStartpage(@PathParam(value="id")
                                                                   String id,
                                                                   StartpageRequest request)

Request to set a startpage for a page

Parameters:

id - folder ID

request - request containing the requested startpage

Returns:

generic response

disinherit

@GET
 @Path(value="/disinherit/{id}")
DisinheritResponse disinherit(@PathParam(value="id")
                                                                    String id,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId)
                                                             throws Exception

Get the multichannelling exclusion and disinherit status of the folder

Parameters:

id - folder ID

nodeId - node ID

Returns:

response containing the exclusion and disinherit status

Throws:

Exception

disinherit

@POST
 @Path(value="/disinherit/{id}")
GenericResponse disinherit(@PathParam(value="id")
                                                                  String id,
                                                                  @QueryParam(value="nodeId")
                                                                  Integer nodeId,
                                                                  @QueryParam(value="wait") @DefaultValue(value="0")
                                                                  long waitMs,
                                                                  DisinheritRequest request)
                                                           throws Exception

Set the multichannelling exclusion and disinherit status

Parameters:

id - folder ID

nodeId - node ID

waitMs - wait timeout in milliseconds

request - request object

Returns:

generic response

Throws:

Exception

disinherit

@GET
 @Path(value="/disinherit")
MultiDisinheritResponse disinherit(@QueryParam(value="id")
                                                                    List<String> ids,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId)
                                                             throws Exception

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

Parameters:

ids - list of folder IDs

nodeId - node ID

Returns:

response containing the exclusion and disinherit status

Throws:

Exception

disinherit

@POST
 @Path(value="/disinherit")
GenericResponse disinherit(@QueryParam(value="id")
                                                             List<String> ids,
                                                             @QueryParam(value="nodeId")
                                                             Integer nodeId,
                                                             @QueryParam(value="wait") @DefaultValue(value="0")
                                                             long waitMs,
                                                             DisinheritRequest request)
                                                      throws Exception

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

Parameters:

ids - list of folder IDs

nodeId - node ID

waitMs - wait timeout in milliseconds

request - request object

Returns:

generic response

Throws:

Exception

move

@POST
 @Path(value="/move/{id}")
GenericResponse move(@PathParam(value="id")
                                                      String id,
                                                      FolderMoveRequest request)
                                               throws Exception

Move the folder with id to a different location

Parameters:

id - id of the folder to move

request - request containing target information

Returns:

generic response

Throws:

Exception - in case of errors

move

@POST
 @Path(value="/move")
GenericResponse move(MultiFolderMoveRequest request)
                                          throws Exception

Move multiple folders to a different location

Parameters:

request - request containing source and target information

Returns:

generic response

Throws:

Exception

sanitizePubdir

@POST
 @Path(value="/sanitize/publishDir")
FolderPublishDirSanitizeResponse sanitizePubdir(FolderPublishDirSanitizeRequest request)
                                                                                    throws Exception

Sanitize the given folder publish directory according to the configuration and settings of the given node

Parameters:

request - request

Returns:

response containing the sanitized publish directory

Throws:

Exception