@Path(value="/folder") public interface FolderResource extends AuthenticatedResource
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
#getFiles(String, int, int, Integer, String, boolean, String, String, String, String, int, int, Boolean) instead. |
PageListResponse |
findPages(Integer folderId,
String query,
Integer skipCount,
Integer maxItems,
LinksType links,
boolean recursive)
Deprecated.
use
#getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, boolean) instead |
FolderListResponse |
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`.
|
FileListResponse |
getFiles(String folderId,
int skipCount,
int maxItems,
Integer nodeId,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
Boolean inherited,
Boolean online,
Boolean broken,
Boolean used,
List<Integer> usedIn,
WastebinSearch wastebinSearch)
get a list of files for this folder
|
FolderListResponse |
getFolders(FolderListRequest folderListRequest)
Get the list of folders in this folder
|
FolderListResponse |
getFolders(String id,
Integer nodeId,
int skipCount,
int maxItems,
boolean recursive,
String sortBy,
String sortOrder,
Boolean inherited,
String search,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
boolean tree,
List<String> recursiveIds,
boolean addPrivileges,
boolean privilegeMap,
WastebinSearch wastebinSearch)
Get the list of folders in this folder
|
FileListResponse |
getImages(String folderId,
int skipCount,
int maxItems,
Integer nodeId,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
Boolean inherited,
Boolean online,
Boolean broken,
Boolean used,
List<Integer> usedIn,
WastebinSearch wastebinSearch)
get a list of images for this folder
|
ItemListResponse |
getItems(String folderId,
List<ContentNodeItem.ItemType> types,
int skipCount,
int maxItems,
Integer nodeId,
boolean template,
boolean languageVariants,
String language,
boolean langFallback,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince)
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 recursive,
Boolean inherited,
WastebinSearch wastebinSearch)
Get the object counts for objects in the specified folder
|
PageListResponse |
getPages(String id,
PageListParameterBean params)
get a list of pages for this folder
|
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,
Integer nodeId,
String search,
boolean recursive,
boolean reduce,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
boolean checkPermission,
Boolean inherited,
Integer skipCount,
Integer maxItems)
Get the templates which are linked into the given folder
|
MultiFolderLoadResponse |
load(MultiFolderLoadRequest request)
Load a list of folders specified in the given
request . |
FolderLoadResponse |
load(String folderId,
boolean update,
boolean addPrivileges,
Integer nodeId)
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
|
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
|
setSessionId
@POST @Path(value="/create") FolderLoadResponse create(FolderCreateRequest request)
@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="nodeId") Integer nodeId)
id
- id of the folder to load. This can be either the localid or a globalidupdate
- 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 reponsenodeId
- id of the node (channel) for which the folder shall be loaded (when multichannelling is used)@POST @Path(value="/load") MultiFolderLoadResponse load(MultiFolderLoadRequest request)
request
.
Folder ids for which no folders exist, or the user does not have the necessary
permissions, are silently ignored.request
- The request with he list of folder ids to load.@GET @Path(value="/breadcrumb/{id}") FolderListResponse 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)
id
- id of the folder. This can either be a localid or a globalidnodeId
- node id (for multichannelling)includeWastebin
- true to include folders from the wastebin, false (default) if notincludeTags
- true to include the folders tags, false (default)if not@GET @Path(value="/getPages/{id}") PageListResponse getPages(@PathParam(value="id") String id, @BeanParam PageListParameterBean params)
id
- id of the folder. This can be the local or global id of the folderparams
- parameter bean@GET @Path(value="/getFiles/{folderId}") FileListResponse getFiles(@PathParam(value="folderId") String folderId, @QueryParam(value="skipCount") @DefaultValue(value="0") int skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") int maxItems, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="search") String search, @QueryParam(value="recursive") boolean recursive, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="editor") String editor, @QueryParam(value="creator") String creator, @QueryParam(value="editedbefore") @DefaultValue(value="0") int editedBefore, @QueryParam(value="editedsince") @DefaultValue(value="0") int editedSince, @QueryParam(value="createdbefore") @DefaultValue(value="0") int createdBefore, @QueryParam(value="createdsince") @DefaultValue(value="0") int createdSince, @QueryParam(value="inherited") Boolean inherited, @QueryParam(value="online") Boolean online, @QueryParam(value="broken") Boolean broken, @QueryParam(value="used") Boolean used, @QueryParam(value="usedIn") List<Integer> usedIn, @QueryParam(value="wastebin") @DefaultValue(value="exclude") WastebinSearch wastebinSearch)
folderId
- id of the folderskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannellingsearch
- (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.recursive
- (optional) true, if subfolders should be integrated into searchsortBy
- (optional) attribute to sort by. It is possible to sort by name, cdate,
edate, type, filesize, folder, masterNode, excluded. deletedat, defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timeinherited
- true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited filesonline
- true to only return online files, false to only get offline files, null to get both online and offline filesbroken
- true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get bothused
- true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified,
this filter will only check in the current channelusedIn
- optional list of channel IDs for extending the "used" filter to multiple channels.wastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objects@GET @Path(value="/getImages/{folderId}") FileListResponse getImages(@PathParam(value="folderId") String folderId, @QueryParam(value="skipCount") @DefaultValue(value="0") int skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") int maxItems, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="search") String search, @QueryParam(value="recursive") boolean recursive, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="editor") String editor, @QueryParam(value="creator") String creator, @QueryParam(value="editedbefore") @DefaultValue(value="0") int editedBefore, @QueryParam(value="editedsince") @DefaultValue(value="0") int editedSince, @QueryParam(value="createdbefore") @DefaultValue(value="0") int createdBefore, @QueryParam(value="createdsince") @DefaultValue(value="0") int createdSince, @QueryParam(value="inherited") Boolean inherited, @QueryParam(value="online") Boolean online, @QueryParam(value="broken") Boolean broken, @QueryParam(value="used") Boolean used, @QueryParam(value="usedIn") List<Integer> usedIn, @QueryParam(value="wastebin") @DefaultValue(value="exclude") WastebinSearch wastebinSearch)
folderId
- id of the folderskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannellingsearch
- (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.recursive
- (optional) true, if subfolders should be integrated into searchsortBy
- (optional) attribute to sort by. It is possible to sort by name, cdate,
edate, type, filesize, folder, masterNode, excluded, deletedat.
defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timeinherited
- true to only return inherited images in the given node, false to only get local/localized images, null to get local and inherited imagesonline
- true to only return online files, false to only get offline files, null to get both online and offline filesbroken
- true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get bothused
- true if only used images that are referenced somewhere shall be fetched, false for unused images. If "usedIn" is not specified,
this filter will only check in the current channelusedIn
- optional list of channel IDs for extending the "used" filter to multiple channels.wastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objects@POST @Path(value="/getFolders/") FolderListResponse getFolders(FolderListRequest folderListRequest)
folderListRequest
- @GET @Path(value="/getFolders/{id}") FolderListResponse getFolders(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="skipCount") @DefaultValue(value="0") int skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") int maxItems, @QueryParam(value="recursive") @DefaultValue(value="false") boolean recursive, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="inherited") Boolean inherited, @QueryParam(value="search") String search, @QueryParam(value="editor") String editor, @QueryParam(value="creator") String creator, @QueryParam(value="editedbefore") @DefaultValue(value="0") int editedBefore, @QueryParam(value="editedsince") @DefaultValue(value="0") int editedSince, @QueryParam(value="createdbefore") @DefaultValue(value="0") int createdBefore, @QueryParam(value="createdsince") @DefaultValue(value="0") int createdSince, @QueryParam(value="tree") @DefaultValue(value="false") boolean tree, @QueryParam(value="recId") List<String> recursiveIds, @QueryParam(value="privileges") @DefaultValue(value="false") boolean addPrivileges, @QueryParam(value="privilegeMap") @DefaultValue(value="false") boolean privilegeMap, @QueryParam(value="wastebin") @DefaultValue(value="exclude") WastebinSearch wastebinSearch)
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 itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemsrecursive
- true when the folders shall be fetched recursivelysortBy
- 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 folderssearch
- 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.editor
- pattern for restricting folders by editorcreator
- pattern for restricting folders by creatoreditedBefore
- timestamp for restricting to folders that were edited before a
given time, 0 for all folderseditedSince
- timestamp for restricting to folders that were edited since a
given time, 0 for all folderscreatedBefore
- timestamp for restricting to folders that were created before a
given time, 0 for all folderscreatedSince
- timestamp for restricting to folders that were created since a
given time, 0 for all folderstree
- 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 notaddPrivileges
- true if the privileges shall be added to the folders, false if notwastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objectsNodeException
@GET @Path(value="/getTemplates/{folderId}") TemplateListResponse getTemplates(@PathParam(value="folderId") String folderId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="search") String search, @QueryParam(value="recursive") @DefaultValue(value="false") boolean recursive, @QueryParam(value="reduce") @DefaultValue(value="false") boolean reduce, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="editor") String editor, @QueryParam(value="creator") String creator, @QueryParam(value="editedbefore") @DefaultValue(value="0") int editedBefore, @QueryParam(value="editedsince") @DefaultValue(value="0") int editedSince, @QueryParam(value="createdsince") @DefaultValue(value="0") int createdBefore, @QueryParam(value="createdbefore") @DefaultValue(value="0") int createdSince, @QueryParam(value="checkPermission") @DefaultValue(value="true") boolean checkPermission, @QueryParam(value="inherited") Boolean inherited, @QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems)
folderId
- id of the folder. This can either be a localid or a globalidnodeId
- id of the channel, if the list shall be fetched for a
channelsearch
- (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.recursive
- (optional) true when the search shall be done recursively, false if not, defaults to falsereduce
- (optional) true when each template shall only be returned once, even when searching recursively, defaults to falsesortBy
- (optional) attribute to sort by. It is possible to sort by name, masterNode. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timecheckPermission
- (optional) flag to check for permissions. Optional, defaults to trueinherited
- true to only return inherited templates in the given node, false to only get local/localized templates, null to get local and inherited templatesNodeException
@GET @Path(value="/getItems/{folderId}") ItemListResponse getItems(@PathParam(value="folderId") String folderId, @QueryParam(value="type") List<ContentNodeItem.ItemType> types, @QueryParam(value="skipCount") @DefaultValue(value="0") int skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") int maxItems, @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, @QueryParam(value="search") String search, @QueryParam(value="recursive") boolean recursive, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="editor") String editor, @QueryParam(value="creator") String creator, @QueryParam(value="editedbefore") @DefaultValue(value="0") int editedBefore, @QueryParam(value="editedsince") @DefaultValue(value="0") int editedSince, @QueryParam(value="createdbefore") @DefaultValue(value="0") int createdBefore, @QueryParam(value="createdsince") @DefaultValue(value="0") int createdSince)
folderId
- id of the foldertypes
- list of types to return, e.g. page, file and/or imageskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannelinglanguageVariants
- true when the language variants should be added to the pageslanguage
- 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 listsearch
- (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.recursive
- (optional) true, if subfolders should be integrated into searchsortBy
- (optional) attribute to sort by. It is possible to sort by name,
cdate, edate, type, fileSize, template, deletedat. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific time@GET @Path(value="/findPages") PageListResponse 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)
#getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, boolean)
insteadfolderId
- start folder id, if set to 0, the search is done over all foldersquery
- string to be searched (currently, only page names are searched)skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for returning all itemslinks
- 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@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)
#getFiles(String, int, int, Integer, String, boolean, String, String, String, String, int, int, Boolean)
instead.folderId
- start folder id, if set to 0, the search is done over all foldersquery
- string to be searched (currently, only page names are searched)skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for returning all itemslinks
- 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@GET @Path(value="/getExternalLinks/{folderId}") FolderExternalLinksResponse getExternalLinks(@PathParam(value="folderId") Integer folderId, @QueryParam(value="recursive") @DefaultValue(value="false") boolean recursive)
folderId
- Id of the folder.recursive
- If true, pages in subfolders will be included in the response.FolderExternalLinksResponse
).@POST @Path(value="/save/{id}") GenericResponse save(@PathParam(value="id") String id, FolderSaveRequest request)
id
- folder id. This can either be a local or globalidrequest
- folder save request@POST @Path(value="/delete/{id}") GenericResponse delete(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId)
id
- id of the folder to be deleted. This can either be local or global id@POST @Path(value="/wastebin/delete/{id}") GenericResponse deleteFromWastebin(@PathParam(value="id") String id, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
id
- id of the folder to remove from the wastebin. This can either be
a local or global idwaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/delete") GenericResponse deleteFromWastebin(IdSetRequest request, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
request
- request containing ID setwaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/restore/{id}") GenericResponse restoreFromWastebin(@PathParam(value="id") String id, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
id
- id of the folder to restore from the wastebin. This can either
be a local or global idwaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/restore") GenericResponse restoreFromWastebin(IdSetRequest request, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
request
- request containing ID setwaitMs
- time in ms for the request to be done in foreground@GET @Path(value="/privileges/{id}") PrivilegesResponse getPrivileges(@PathParam(value="id") Integer id)
id
- id of the folder.@GET @Path(value="/count/{id}") FolderObjectCountResponse getObjectCounts(@PathParam(value="id") Integer id, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="language") String language, @QueryParam(value="recursive") @DefaultValue(value="false") boolean recursive, @QueryParam(value="inherited") Boolean inherited, @QueryParam(value="wastebin") @DefaultValue(value="exclude") WastebinSearch wastebinSearch)
id
- id of the foldernodeId
- node idlanguage
- language coderecursive
- true to count objects recursively, false (default) if notinherited
- true to only count inherited objects, false to count not inherited objects, null (default) to count bothwastebinSearch
- wastebin search option@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)
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
.folderIds
- The IDs of the folders to get linked objects forsrcNodeId
- The channel ID of the source channeldstNodeId
- The channel ID of the target channelrecursive
- Whether objects in subfolders should be collected (optional, default: false
)types
- The object types which should be synchronised (optional, default: all types)@POST @Path(value="/push2master/{id}") GenericResponse pushToMaster(@PathParam(value="id") Integer id, PushToMasterRequest request)
id
- id of the folderrequest
- request@POST @Path(value="/push2master") GenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- request@POST @Path(value="/unlocalize/{id}") GenericResponse unlocalize(@PathParam(value="id") Integer id, UnlocalizeRequest request)
id
- id of the folder to unlocalizerequest
- request@POST @Path(value="/unlocalize") GenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- request@POST @Path(value="/localize/{id}") GenericResponse localize(@PathParam(value="id") Integer id, LocalizeRequest request)
id
- id of the folder to localizerequest
- request@GET @Path(value="/localizations/{id}") LocalizationsResponse localizations(@PathParam(value="id") Integer id)
id
- The ID of the master folder.@GET @Path(value="/localizationinfo/{id}") LocalizationInfo getLocalizationInfo(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="recursive") boolean recursive)
id
- id of the folder. This can either be the local or global idnodeId
- id of the node to start withrecursive
- true if the localization info shall be fetched recursively, false if not@POST @Path(value="/startpage/{id}") GenericResponse setStartpage(@PathParam(value="id") String id, StartpageRequest request)
id
- folder IDrequest
- request containing the requested startpage@GET @Path(value="/disinherit/{id}") DisinheritResponse disinherit(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId) throws Exception
id
- folder IDnodeId
- node IDException
@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
id
- folder IDnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
@GET @Path(value="/disinherit") MultiDisinheritResponse disinherit(@QueryParam(value="id") List<String> ids, @QueryParam(value="nodeId") Integer nodeId) throws Exception
ids
- list of folder IDsnodeId
- node IDException
@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
ids
- list of folder IDsnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
@POST @Path(value="/move/{id}") GenericResponse move(@PathParam(value="id") String id, FolderMoveRequest request) throws Exception
id
- id of the folder to moverequest
- request containing target informationException
- in case of errors@POST @Path(value="/move") GenericResponse move(MultiFolderMoveRequest request) throws Exception
request
- request containing source and target informationException
Copyright © 2018 Gentics Software. All rights reserved.