PageResource (Gentics Content.Node - REST API Library 5.45.53 API)

All Superinterfaces:

AuthenticatedResource
```
@Path(value="/page")
public interface PageResource
extends AuthenticatedResource
```
Resource used for loading, saving and manipulating GCN pages.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GenericResponse`	`assign(MultiPageAssignRequest request)` Inform a list of users that the list of pages have been put back into revision.
`String`	`autocomplete(String q, int limit)` Do a quick search for pages that contain the given query string in their name or have it as ID.
`GenericResponse`	`cancel(Integer id, Integer nodeId)` Cancel editing the page.
`PageCopyResponse`	`copy(PageCopyRequest request, long waitMs)` Copy a batch of pages or a single copy using the `PageCopyRequest` options.
`PageLoadResponse`	`create(PageCreateRequest request)` Create a page based on the given pagecreaterequest
`TagCreateResponse`	`createTag(String id, Integer constructId, String keyword, ContentTagCreateRequest request)` Create a new tag in the given page
`MultiTagCreateResponse`	`createTags(String id, MultiTagCreateRequest request)` Create multiple tags in the given page
`GenericResponse`	`delete(String id, Integer nodeId)` Delete the page denoted by id.
`GenericResponse`	`deleteFromWastebin(PageIdSetRequest request, long waitMs)` Remove the given pages from the wastebin
`GenericResponse`	`deleteFromWastebin(String id, long waitMs)` Remove the page 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 pages
`GenericResponse`	`disinherit(List<String> ids, Integer nodeId, long waitMs, DisinheritRequest request)` Set the multichannelling exclusion and disinherit status for a list of pages
`DisinheritResponse`	`disinherit(String id, Integer nodeId)` Get the multichannelling exclusion and disinherit status of the page
`GenericResponse`	`disinherit(String id, Integer nodeId, long waitMs, DisinheritRequest request)` Set the multichannelling exclusion and disinherit status
`ReferencedFilesListResponse`	`getLinkedFiles(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId)` Get files, which are used by one of the given pages
`ReferencedFilesListResponse`	`getLinkedImages(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId)` Get images, which are used by one of the given pages
`ReferencedPagesListResponse`	`getLinkedPages(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId)` Get pages, which are used by one of the given pages
`LocalizationInfo`	`getLocalizationInfo(Integer id, Integer nodeId)` Get localization info for a page for a given channel and all master channels
`LocalizationInfo`	`getLocalizationInfo(List<Integer> ids, Integer nodeId)` Get localization info for a list of pages for a given channel and all master channels
`PageUsageListResponse`	`getPagetagUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, PageModelParameterBean pageModel)` Get the pages containing pagetags pointing to one of the given pages.
`PageUsageListResponse`	`getPageUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, PageModelParameterBean pageModel)` Get the pages using one of the given pages
`PrivilegesResponse`	`getPrivileges(Integer id)` Get the privileges of the current user on the given page
`ReferencedSyncableObjectsListResponse`	`getSyncableObjects(List<Integer> pageIds, Integer srcNodeId, Integer dstNodeId)`
`TagListResponse`	`getTags(Integer id, Integer skipCount, Integer maxItems, TagSortAttribute sortBy, SortOrder sortOrder, String search)` Get the list of tags (contenttags and templatetags) for this page
`TemplateUsageListResponse`	`getTemplateUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnTemplates)` Get the templates using one of the given pages
`TotalUsageResponse`	`getTotalPageUsage(List<Integer> pageId, Integer nodeId)` Get the total usage information of the given pages.
`PageUsageListResponse`	`getVariantsUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, PageModelParameterBean pageModel)` Get the page variants of the given pages
`PageListResponse`	`list(InFolderParameterBean inFolder, PageListParameterBean pageListParams, FilterParameterBean filterParams, SortParameterBean sortingParams, PagingParameterBean pagingParams, PublishableParameterBean publishParams, WastebinParameterBean wastebinParams)` Get a list of pages in the specified folder. The result can be filtered by `id` `name` `fileName` `description` `niceUrl` `alternateUrls` and sorted by `id` `name` `fileName` `niceUrl` `alternateUrls`
`MultiPageLoadResponse`	`load(MultiPageLoadRequest request, boolean fillWithNulls)` Load a list of pages specified in the given `request`.
`PageLoadResponse`	`load(String id, boolean update, boolean template, boolean folder, boolean languageVariants, boolean pageVariants, boolean workflow, boolean translationStatus, boolean versionInfo, boolean disinherited, boolean construct, Integer nodeId, String stagingPackageName)` Loads a page from GCN.
`LocalizationsResponse`	`localizations(Integer id, boolean addStatus)` Get the IDs an their respective node IDs of localized copies of the specified page.
`GenericResponse`	`localize(Integer id, LocalizeRequest request)` Localize the given page
`GenericResponse`	`move(MultiObjectMoveRequest request)` Move multiple pages to another folder
`GenericResponse`	`move(String id, ObjectMoveRequest request)` Move the given page to another folder
`PagePreviewResponse`	`preview(PagePreviewRequest request)` Render given page in a preview (before actually saving it)
`GenericResponse`	`publish(Integer nodeId, MultiPagePublishRequest request)` Publish a list of pages.
`GenericResponse`	`publish(String id, Integer nodeId, PagePublishRequest request)` Publish the page denoted by id (or send it in the queue when the User has not permission to publish the page).
`LegacyPageListResponse`	`pubqueue(Integer skipCount, Integer maxItems, String search, String sortBy, String sortOrder)` Get all pages (for all nodes) in the publish queue
`GenericResponse`	`pubqueueApprove(MultiPubqueueApproveRequest request, long waitMs)` Approved queued changes to online status of pages
`GenericResponse`	`pushToMaster(Integer id, PushToMasterRequest request)` Push a page from a channel into a master
`GenericResponse`	`pushToMaster(MultiPushToMasterRequest request)` Push a list of pages from a channel into a master
`PageRenderResponse`	`render(Integer nodeId, String template, boolean editMode, String proxyprefix, LinksType linksType, boolean tagmap, boolean inherited, boolean publish, Page page)` Render a preview of the posted page
`PageRenderResponse`	`render(String id, Integer nodeId, String template, boolean editMode, String proxyprefix, LinksType linksType, boolean tagmap, boolean inherited, boolean publish)` Render the given page Info: This currently doesn't return tag render errors.
`PageRenderResponse`	`renderTag(String tag, Integer nodeId, String proxyprefix, LinksType linksType, Page page)` Render a tag preview for the posted page
`PageRenderResponse`	`renderTag(String id, String tag, Integer nodeId, String proxyprefix, LinksType linksType)` Render a tag of the given page
`GenericResponse`	`restoreFromWastebin(PageIdSetRequest request, long waitMs)` Restore the given pages from the wastebin
`GenericResponse`	`restoreFromWastebin(String id, long waitMs)` Restore the given page from the wastebin
`TagListResponse`	`restoreTag(String pageId, String tag, Integer versionTimestamp)` Restore a single tag in the page with the given version timestamp
`PageLoadResponse`	`restoreVersion(String id, Integer versionTimestamp)` Restore the page version with the given version timestamp
`GenericResponse`	`save(String id, PageSaveRequest request)` Saves a page into GCN
`PageLoadResponse`	`search(boolean update, boolean template, boolean folder, boolean languageVariants, boolean pageVariants, boolean workflow, boolean translationStatus, boolean versionInfo, boolean disinherited, Integer nodeId, String liveUrl)` NOTE: This endpoint is currently under construction and will be changed in the future.
`PageFilenameSuggestResponse`	`suggestFilename(PageFilenameSuggestRequest request)` Suggest the filename to be used for a (new) page, based on other metadata
`GenericResponse`	`takeOffline(String id, PageOfflineRequest request)` Take a specific page offline
`PageLoadResponse`	`translate(Integer id, String languageCode, boolean locked, Integer channelId)` Translate the page into the given language.
`GenericResponse`	`unlocalize(Integer id, UnlocalizeRequest request)` Unlocalize the given page
`GenericResponse`	`unlocalize(MultiUnlocalizeRequest request)` Unlocalize pages in a channel
`GenericResponse`	`workflowDecline(String id, WorkflowRequest request)` Decline the workflow for the page (i.e.
`GenericResponse`	`workflowRevoke(Integer id)` Revoke the last step of the workflow

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

Method Detail

list

@GET
PageListResponse list(@BeanParam
                           InFolderParameterBean inFolder,
                           @BeanParam
                           PageListParameterBean pageListParams,
                           @BeanParam
                           FilterParameterBean filterParams,
                           @BeanParam
                           SortParameterBean sortingParams,
                           @BeanParam
                           PagingParameterBean pagingParams,
                           @BeanParam
                           PublishableParameterBean publishParams,
                           @BeanParam
                           WastebinParameterBean wastebinParams)

Get a list of pages in the specified folder.
The result can be filtered by

id
name
fileName
description
niceUrl
alternateUrls

and sorted by

id
name
fileName
niceUrl
alternateUrls

Parameters:: inFolder - Folder ID and recursive parameters; pageListParams - Further page parameters; filterParams - Filter parameters; sortingParams - Sorting parameters; pagingParams - Paging parameters; publishParams - Publishable parameters; wastebinParams - Wastebin parameters
Returns:: A list of pages

create
```
@POST
 @Path(value="/create")
 @Produces(value="application/json")
PageLoadResponse create(PageCreateRequest request)
```
Create a page based on the given pagecreaterequest

Parameters:

request - containing data for creating the page

Returns:

PageLoadResponse with the created page

copy

@POST
 @Path(value="/copy")
PageCopyResponse copy(PageCopyRequest request,
                                                  @QueryParam(value="wait") @DefaultValue(value="0")
                                                  long waitMs)

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

Parameters:: request - Request containing data for the batch copy; waitMs - wait timeout in milliseconds
Returns:: GenericResponse

move

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

Move the given page to another folder

Parameters:: id - page id; request - request
Returns:: generic response

move
```
@POST
 @Path(value="/move")
GenericResponse move(MultiObjectMoveRequest request)
```
Move multiple pages to another folder

Parameters:

request - request

Returns:

generic response

save

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

Saves a page into GCN

Parameters:: id - Id of the page to save. This can either be a local or global id; request - page save request
Returns:: GenericResponse

load

@GET
 @Path(value="/load/{id}")
PageLoadResponse load(@PathParam(value="id")
                                                      String id,
                                                      @DefaultValue(value="false") @QueryParam(value="update")
                                                      boolean update,
                                                      @QueryParam(value="template") @DefaultValue(value="false")
                                                      boolean template,
                                                      @QueryParam(value="folder") @DefaultValue(value="false")
                                                      boolean folder,
                                                      @QueryParam(value="langvars") @DefaultValue(value="false")
                                                      boolean languageVariants,
                                                      @QueryParam(value="pagevars") @DefaultValue(value="false")
                                                      boolean pageVariants,
                                                      @QueryParam(value="workflow") @DefaultValue(value="false")
                                                      boolean workflow,
                                                      @QueryParam(value="translationstatus") @DefaultValue(value="false")
                                                      boolean translationStatus,
                                                      @QueryParam(value="versioninfo") @DefaultValue(value="false")
                                                      boolean versionInfo,
                                                      @QueryParam(value="disinherited") @DefaultValue(value="false")
                                                      boolean disinherited,
                                                      @QueryParam(value="construct") @DefaultValue(value="false")
                                                      boolean construct,
                                                      @QueryParam(value="nodeId")
                                                      Integer nodeId,
                                                      @QueryParam(value="package")
                                                      String stagingPackageName)

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

Parameters:: id - The id of the page to load. This can either be a localid or a globalid; update - true when the page shall be locked, false if not; template - true if the template information shall be added; folder - true if the folder information shall be added; languageVariants - true if the language variants shall be added; workflow - true if the workflow information shall be added; translationStatus - true if the translationstatus information shall be added; versionInfo - true if version information shall be added; disinherited - if true, disinherited channel nodes shall be added; construct - if true, the construct info will be added to tags; nodeId - channel id; stagingPackageName - name of a content staging package, to check the page status in it
Returns:: PageLoadResponse Response with the loaded page

load
```
@POST
 @Path(value="/load")
MultiPageLoadResponse load(MultiPageLoadRequest request,
                                                       @QueryParam(value="fillWithNulls") @DefaultValue(value="false")
                                                       boolean fillWithNulls)
```
Load a list of pages specified in the given request. Page ids for which no pages exist, or the user does not have the necessary permissions, are silently ignored.

Parameters:

request - The request with he list of page 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 pages, for which the user has enough permissions.

preview
```
@POST
 @Path(value="/preview")
PagePreviewResponse preview(PagePreviewRequest request)
```
Render given page in a preview (before actually saving it)

Returns:

preview of the page

Throws:

NodeException

assign
```
@POST
 @Path(value="/assign")
GenericResponse assign(MultiPageAssignRequest request)
```
Inform a list of users that the list of pages have been put back into revision.

Parameters:

request -

Returns:

response

publish

@POST
 @Path(value="/publish")
GenericResponse publish(@QueryParam(value="nodeId")
                                                       Integer nodeId,
                                                       MultiPagePublishRequest request)

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

Parameters:: nodeId - channel id; request - publish request
Returns:: response object

publish

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

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

Parameters:: id - id of the Page to publish. This can either be a local or globalid; nodeId - channel id; request - publish page request
Returns:: response object

delete

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

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

Parameters:: id - id of the Page to delete. This can either be a local or global id; nodeId - channel id
Returns:: response object

deleteFromWastebin

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

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

Parameters:: id - id of the page 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(PageIdSetRequest request,
                                                                          @QueryParam(value="wait") @DefaultValue(value="0")
                                                                          long waitMs)

Remove the given pages from the wastebin

Parameters:: request - request containing the page IDs; 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 page from the wastebin

Parameters:: id - id of the page 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(PageIdSetRequest request,
                                                                            @QueryParam(value="wait") @DefaultValue(value="0")
                                                                            long waitMs)

Restore the given pages from the wastebin

Parameters:: request - request containing the page IDs; waitMs - time in ms for the request to be done in foreground
Returns:: response object

cancel

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

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

Parameters:: id - id of the Page which is currently edited; nodeId - channel id
Returns:: response object

render

@POST
 @Path(value="/render")
PageRenderResponse render(@QueryParam(value="nodeId")
                                                        Integer nodeId,
                                                        @QueryParam(value="template")
                                                        String template,
                                                        @QueryParam(value="edit") @DefaultValue(value="false")
                                                        boolean editMode,
                                                        @QueryParam(value="proxyprefix")
                                                        String proxyprefix,
                                                        @QueryParam(value="links") @DefaultValue(value="backend")
                                                        LinksType linksType,
                                                        @QueryParam(value="tagmap") @DefaultValue(value="false")
                                                        boolean tagmap,
                                                        @QueryParam(value="inherited") @DefaultValue(value="false")
                                                        boolean inherited,
                                                        @QueryParam(value="publish") @DefaultValue(value="false")
                                                        boolean publish,
                                                        Page page)

Render a preview of the posted page

Parameters:: nodeId - node id (if rendering a page for a channel); template - template to render (if not set, the page's template will be rendered); editMode - true for rendering in edit mode, false for preview mode; proxyprefix - proxyprefix; linksType - type of links (frontend or backend); tagmap - true to also render the tagmap entries; inherited - true to render the inherited content and properties; publish - True to render in publish mode
Returns:: response containing the rendered page and other important information

render

@GET
 @Path(value="/render/{id}")
PageRenderResponse render(@PathParam(value="id")
                                                            String id,
                                                            @QueryParam(value="nodeId")
                                                            Integer nodeId,
                                                            @QueryParam(value="template")
                                                            String template,
                                                            @QueryParam(value="edit") @DefaultValue(value="false")
                                                            boolean editMode,
                                                            @QueryParam(value="proxyprefix")
                                                            String proxyprefix,
                                                            @QueryParam(value="links") @DefaultValue(value="backend")
                                                            LinksType linksType,
                                                            @QueryParam(value="tagmap") @DefaultValue(value="false")
                                                            boolean tagmap,
                                                            @QueryParam(value="inherited") @DefaultValue(value="false")
                                                            boolean inherited,
                                                            @QueryParam(value="publish") @DefaultValue(value="false")
                                                            boolean publish)

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

Parameters:: id - id of the page; nodeId - node id (if rendering a page for a channel); template - template to render (if not set, the page's template will be rendered); editMode - true for rendering in edit mode, false for preview mode; proxyprefix - proxyprefix; linksType - type of links (frontend or backend); tagmap - true to also render the tagmap entries; inherited - true to render the inherited content and properties; publish - True to render in publish mode
Returns:: response containing the rendered page and other important information

renderTag

@POST
 @Path(value="/renderTag/{tag}")
PageRenderResponse renderTag(@PathParam(value="tag")
                                                                    String tag,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId,
                                                                    @QueryParam(value="proxyprefix")
                                                                    String proxyprefix,
                                                                    @QueryParam(value="links") @DefaultValue(value="backend")
                                                                    LinksType linksType,
                                                                    Page page)

Render a tag preview for the posted page

Parameters:: tag - name of the tag to render; nodeId - node id (if rendering a page for a channel); proxyprefix - proxyprefix; linksType - type of links (frontend or backend); page - posted page
Returns:: response containing the rendered tag and other important information

renderTag

@GET
 @Path(value="/renderTag/{id}/{tag}")
PageRenderResponse renderTag(@PathParam(value="id")
                                                                        String id,
                                                                        @PathParam(value="tag")
                                                                        String tag,
                                                                        @QueryParam(value="nodeId")
                                                                        Integer nodeId,
                                                                        @QueryParam(value="proxyprefix")
                                                                        String proxyprefix,
                                                                        @QueryParam(value="links") @DefaultValue(value="backend")
                                                                        LinksType linksType)

Render a tag of the given page

Parameters:: id - id of the page; tag - name of the tag to render; nodeId - node id (if rendering a page for a channel); proxyprefix - proxyprefix; linksType - type of links (frontend or backend)
Returns:: response containing the rendered tag and other important information

getTags

@GET
 @Path(value="/getTags/{id}")
TagListResponse getTags(@PathParam(value="id")
                                                           Integer id,
                                                           @QueryParam(value="skipCount") @DefaultValue(value="0")
                                                           Integer skipCount,
                                                           @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                           Integer maxItems,
                                                           @QueryParam(value="sortby") @DefaultValue(value="name")
                                                           TagSortAttribute sortBy,
                                                           @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                           SortOrder sortOrder,
                                                           @QueryParam(value="search")
                                                           String search)

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

Parameters:: id - id of the page
Returns:: response object

getPrivileges

PrivilegesResponse getPrivileges(@PathParam(value="id")
                                 Integer id)

Get the privileges of the current user on the given page

Parameters:: id - id of the page
Returns:: privileges response

createTag

@POST
 @Path(value="/newtag/{id}")
TagCreateResponse createTag(@PathParam(value="id")
                                                               String id,
                                                               @QueryParam(value="constructId")
                                                               Integer constructId,
                                                               @QueryParam(value="keyword")
                                                               String keyword,
                                                               ContentTagCreateRequest request)

Create a new tag in the given page

Parameters:: id - id of the page. This can either be a local or globalid; constructId - id of the tags construct; keyword - keyword of the construct; request - tag create request
Returns:: response containing the rendered tag

createTags

@POST
 @Path(value="/newtags/{id}")
MultiTagCreateResponse createTags(@PathParam(value="id")
                                                                      String id,
                                                                      MultiTagCreateRequest request)

Create multiple tags in the given page

Parameters:: id - id of the page; request - tag create request
Returns:: response containing the created tags

restoreVersion

@POST
 @Path(value="/restore/{id}")
PageLoadResponse restoreVersion(@PathParam(value="id")
                                                                    String id,
                                                                    @QueryParam(value="version")
                                                                    Integer versionTimestamp)

Restore the page version with the given version timestamp

Parameters:: id - The id of the page that should be restored. This can either be a local or globalid; versionTimestamp - version timestamp

restoreTag

@POST
 @Path(value="/restore/{pageid}/{tag}")
TagListResponse restoreTag(@PathParam(value="pageid")
                                                                         String pageId,
                                                                         @PathParam(value="tag")
                                                                         String tag,
                                                                         @QueryParam(value="version")
                                                                         Integer versionTimestamp)

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

Parameters:: pageId - id of the page. This can either be a local or globalid; tag - id or name of the tag; versionTimestamp - version timestamp
Returns:: restored tag

translate

@POST
 @Path(value="/translate/{id}")
PageLoadResponse translate(@PathParam(value="id")
                                                                 Integer id,
                                                                 @QueryParam(value="language")
                                                                 String languageCode,
                                                                 @QueryParam(value="locked") @DefaultValue(value="true")
                                                                 boolean locked,
                                                                 @QueryParam(value="channelId")
                                                                 Integer channelId)

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

Parameters:: id - id of the page to translate; languageCode - code of the language into which the page shall be translated; locked - true if the translation shall be locked, false if not; channelId - for multichannelling, specify channel in which to create page (can be 0 or equal to node ID to be ignored)
Returns:: page load response

workflowRevoke

@POST
 @Path(value="/workflow/revoke/{id}")
GenericResponse workflowRevoke(@PathParam(value="id")
                                                                           Integer id)

Revoke the last step of the workflow

Parameters:: id - id of the page
Returns:: generic response

workflowDecline

@POST
 @Path(value="/workflow/decline/{id}")
GenericResponse workflowDecline(@PathParam(value="id")
                                                                             String id,
                                                                             WorkflowRequest request)

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

Parameters:: id - id of the page. This can either be a local or globalid; request - request object containing what should be changed about the workflow
Returns:: generic response

getTotalPageUsage

@GET
 @Path(value="/usage/total")
TotalUsageResponse getTotalPageUsage(@QueryParam(value="id")
                                                                       List<Integer> pageId,
                                                                       @QueryParam(value="nodeId")
                                                                       Integer nodeId)

Get the total usage information of the given pages.

Parameters:: pageId - list of page ids; nodeId - id of the node
Returns:: Total usage response

getPagetagUsageInfo

@GET
 @Path(value="/usage/tag")
PageUsageListResponse getPagetagUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                          Integer skipCount,
                                                                          @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                          Integer maxItems,
                                                                          @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                          String sortBy,
                                                                          @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                          String sortOrder,
                                                                          @QueryParam(value="id")
                                                                          List<Integer> pageId,
                                                                          @QueryParam(value="nodeId")
                                                                          Integer nodeId,
                                                                          @QueryParam(value="pages") @DefaultValue(value="true")
                                                                          boolean returnPages,
                                                                          @BeanParam
                                                                          PageModelParameterBean pageModel)

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

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids; nodeId - id of the node; returnPages - true (default) if the pages shall be returned, false for only returning the counts; pageModel - page model parameters
Returns:: list of pages

getVariantsUsageInfo

@GET
 @Path(value="/usage/variant")
PageUsageListResponse getVariantsUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                               Integer skipCount,
                                                                               @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                               Integer maxItems,
                                                                               @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                               String sortBy,
                                                                               @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                               String sortOrder,
                                                                               @QueryParam(value="id")
                                                                               List<Integer> pageId,
                                                                               @QueryParam(value="nodeId")
                                                                               Integer nodeId,
                                                                               @QueryParam(value="pages") @DefaultValue(value="true")
                                                                               boolean returnPages,
                                                                               @BeanParam
                                                                               PageModelParameterBean pageModel)

Get the page variants of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids; nodeId - id of the node; returnPages - true (default) if the pages shall be returned, false for only returning the counts; pageModel - page model parameters
Returns:: list of page variants

getPageUsageInfo

@GET
 @Path(value="/usage/page")
PageUsageListResponse getPageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                        Integer skipCount,
                                                                        @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                        Integer maxItems,
                                                                        @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                        String sortBy,
                                                                        @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                        String sortOrder,
                                                                        @QueryParam(value="id")
                                                                        List<Integer> pageId,
                                                                        @QueryParam(value="nodeId")
                                                                        Integer nodeId,
                                                                        @QueryParam(value="pages") @DefaultValue(value="true")
                                                                        boolean returnPages,
                                                                        @BeanParam
                                                                        PageModelParameterBean pageModel)

Get the pages using one of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids, for which the usage shall be fetched; nodeId - id of the node; returnPages - true (default) if the pages shall be returned, false for only returning the counts; pageModel - page model parameters
Returns:: list of pages using the given pages

getTemplateUsageInfo

@GET
 @Path(value="/usage/template")
TemplateUsageListResponse getTemplateUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                                    Integer skipCount,
                                                                                    @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                                    Integer maxItems,
                                                                                    @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                                    String sortBy,
                                                                                    @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                                    String sortOrder,
                                                                                    @QueryParam(value="id")
                                                                                    List<Integer> pageId,
                                                                                    @QueryParam(value="nodeId")
                                                                                    Integer nodeId,
                                                                                    @QueryParam(value="templates") @DefaultValue(value="true")
                                                                                    boolean returnTemplates)

Get the templates using one of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids, for which the usage shall be fetched; nodeId - id of the node; returnTemplates - true (default) if the templates shall be returned, false for only returning the counts
Returns:: response

getSyncableObjects

@GET
 @Path(value="/usage/syncableObjects")
ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam(value="ids")
                                                                                                     List<Integer> pageIds,
                                                                                                     @QueryParam(value="srcNodeId")
                                                                                                     Integer srcNodeId,
                                                                                                     @QueryParam(value="dstNodeId")
                                                                                                     Integer dstNodeId)

getLinkedPages

@GET
 @Path(value="/usage/linkedPage")
ReferencedPagesListResponse getLinkedPages(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                                  Integer skipCount,
                                                                                  @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                                  Integer maxItems,
                                                                                  @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                                  String sortBy,
                                                                                  @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                                  String sortOrder,
                                                                                  @QueryParam(value="id")
                                                                                  List<Integer> pageId,
                                                                                  @QueryParam(value="nodeId")
                                                                                  Integer nodeId)

Get pages, which are used by one of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids, for which the usage shall be fetched; nodeId - id of the node
Returns:: response

getLinkedFiles

@GET
 @Path(value="/usage/linkedFile")
ReferencedFilesListResponse getLinkedFiles(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                                  Integer skipCount,
                                                                                  @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                                  Integer maxItems,
                                                                                  @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                                  String sortBy,
                                                                                  @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                                  String sortOrder,
                                                                                  @QueryParam(value="id")
                                                                                  List<Integer> pageId,
                                                                                  @QueryParam(value="nodeId")
                                                                                  Integer nodeId)

Get files, which are used by one of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids, for which the usage shall be fetched; nodeId - id of the node
Returns:: response

getLinkedImages

@GET
 @Path(value="/usage/linkedImage")
ReferencedFilesListResponse getLinkedImages(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                                    Integer skipCount,
                                                                                    @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                                    Integer maxItems,
                                                                                    @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                                    String sortBy,
                                                                                    @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                                    String sortOrder,
                                                                                    @QueryParam(value="id")
                                                                                    List<Integer> pageId,
                                                                                    @QueryParam(value="nodeId")
                                                                                    Integer nodeId)

Get images, which are used by one of the given pages

Parameters:: 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; sortBy - (optional) attribute to sort by. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".; pageId - list of page ids, for which the usage shall be fetched; nodeId - id of the node
Returns:: response

pushToMaster

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

Push a page from a channel into a master

Parameters:: id - id of the page; request - request
Returns:: generic response

pushToMaster
```
@POST
 @Path(value="/push2master")
GenericResponse pushToMaster(MultiPushToMasterRequest request)
```
Push a list of pages 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 page

Parameters:: id - id of the page to unlocalize; request - request
Returns:: generic response

unlocalize

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

Unlocalize pages 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 page

Parameters:: id - id of the page to localize; request - request
Returns:: generic response

getLocalizationInfo

@GET
 @Path(value="/localizationinfo")
LocalizationInfo getLocalizationInfo(@QueryParam(value="id")
                                                                            List<Integer> ids,
                                                                            @QueryParam(value="nodeId")
                                                                            Integer nodeId)

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

Parameters:: ids - list of page ids; nodeId - id of the node to start with
Returns:: localization info

getLocalizationInfo

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

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

Parameters:: id - id of the page; nodeId - id of the node to start with
Returns:: localization info

localizations

@GET
 @Path(value="/localizations/{id}")
LocalizationsResponse localizations(@PathParam(value="id")
                                                                             Integer id,
                                                                             @QueryParam(value="status") @DefaultValue(value="false")
                                                                             boolean addStatus)

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

Parameters:: id - The ID of the master page.; addStatus - When true information about the pages statuses will be added to the response.
Returns:: A map of page IDs to node IDs of localized copies, with optional status information.

takeOffline

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

Take a specific page offline

Parameters:: id - ID of the page
Returns:: Generic response

autocomplete

@GET
 @Path(value="/autocomplete")
 @Produces(value="text/html")
String autocomplete(@QueryParam(value="q")
                                                                                     String q,
                                                                                     @QueryParam(value="limit")
                                                                                     int limit)

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

Parameters:: q - query string, must contain at least three characters (otherwise an empty result is returned).; limit - maximum number of results returned. Default is 15
Returns:: html representation of matching pages

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 page

Parameters:: id - page 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 - page 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 pages

Parameters:: ids - list of page 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 pages

Parameters:: ids - list of page IDs; nodeId - node ID; waitMs - wait timeout in milliseconds; request - request object
Returns:: generic response
Throws:: Exception

search
```
@GET
 @Path(value="/search")
PageLoadResponse search(@DefaultValue(value="false") @QueryParam(value="update")
                                                     boolean update,
                                                     @QueryParam(value="template") @DefaultValue(value="false")
                                                     boolean template,
                                                     @QueryParam(value="folder") @DefaultValue(value="false")
                                                     boolean folder,
                                                     @QueryParam(value="langvars") @DefaultValue(value="false")
                                                     boolean languageVariants,
                                                     @QueryParam(value="pagevars") @DefaultValue(value="false")
                                                     boolean pageVariants,
                                                     @QueryParam(value="workflow") @DefaultValue(value="false")
                                                     boolean workflow,
                                                     @QueryParam(value="translationstatus") @DefaultValue(value="false")
                                                     boolean translationStatus,
                                                     @QueryParam(value="versioninfo") @DefaultValue(value="false")
                                                     boolean versionInfo,
                                                     @QueryParam(value="disinherited") @DefaultValue(value="false")
                                                     boolean disinherited,
                                                     @QueryParam(value="nodeId")
                                                     Integer nodeId,
                                                     @QueryParam(value="liveUrl")
                                                     String liveUrl)
```
NOTE: This endpoint is currently under construction and will be changed in the future. Load a page with which resolves to the given liveUrl Please note that the page can only be resolved to a liveUrl if the was already published once. The resolving of liveUrls is always coupled to the publish state of the page. Local changes which have not been published will not be incorporated in the resolving process. Loads a page from GCN. For now this page only contains meta data about the page and no contents. When using loading pages, it is important to note that the returned tag data may be loaded differently depending on whether or not the page is loaded for editing ("update" flag is set to true). Loading a page with the update flag set to false allows you to load the page without causing it to be locked for editing, but it means that any tags which have not been filled will be loaded without all their tag parts. Tags that have not been filled, and that do not have default values will be loaded with empty properties in this case. On the other hand, when loading pages for editing, any tags that have no been filled, will have their constituents part auto-generated. Consequently, when loading pages via the REST-API or GCNJSAPI, setting the update flag to true will cause all tags to be loaded with all parts data (auto-generated if necessary), whereas when loading a page with update set to false, any tags which have not had their parts filled will be loaded without their parts data.

Parameters:

update - true when the page shall be locked, false if not

template - true if the template information shall be added

folder - true if the folder information shall be added

languageVariants - true if the language variants shall be added

workflow - true if the workflow information shall be added

translationStatus - true if the translationstatus information shall be added

versionInfo - true if version information shall be added

disinherited - if true, disinherited channel nodes shall be added

nodeId - Optional channel id which can be specified to restrict search to a specific channel. Adding the channel id will speed up the search process.

liveUrl - Live url to search for. (e.g.: hostname.tld/folderA/index.html)

Returns:

PageLoadResponse Response with the loaded page

pubqueue

@GET
 @Path(value="/pubqueue")
LegacyPageListResponse pubqueue(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                               Integer skipCount,
                                                               @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                               Integer maxItems,
                                                               @QueryParam(value="search")
                                                               String search,
                                                               @QueryParam(value="sortby") @DefaultValue(value="name")
                                                               String sortBy,
                                                               @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                               String sortOrder)

Get all pages (for all nodes) in the publish queue

Parameters:: 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; 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.; sortBy - (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name; sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".
Returns:: list of pages in the publish queue

pubqueueApprove

@POST
 @Path(value="/pubqueue/approve")
GenericResponse pubqueueApprove(MultiPubqueueApproveRequest request,
                                                                        @QueryParam(value="wait") @DefaultValue(value="0")
                                                                        long waitMs)
                                                                 throws Exception

Approved queued changes to online status of pages

Parameters:: request - request containing page IDs; waitMs - wait timeout in milliseconds
Returns:: generic response
Throws:: Exception

suggestFilename

@POST
 @Path(value="/suggest/filename")
PageFilenameSuggestResponse suggestFilename(PageFilenameSuggestRequest request)
                                                                             throws Exception

Suggest the filename to be used for a (new) page, based on other metadata

Parameters:: request - request
Returns:: response
Throws:: Exception

Interface PageResource

Method Summary

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

Method Detail

list

create

copy

move

move

save

load

load

preview

assign

publish

publish

delete

deleteFromWastebin

deleteFromWastebin

restoreFromWastebin

restoreFromWastebin

cancel

render

render

renderTag

renderTag

getTags

getPrivileges

createTag

createTags

restoreVersion

restoreTag

translate

workflowRevoke

workflowDecline

getTotalPageUsage

getPagetagUsageInfo

getVariantsUsageInfo

getPageUsageInfo

getTemplateUsageInfo

getSyncableObjects

getLinkedPages

getLinkedFiles

getLinkedImages

pushToMaster

pushToMaster

unlocalize

unlocalize

localize

getLocalizationInfo

getLocalizationInfo

localizations

takeOffline

autocomplete

disinherit

disinherit

disinherit

disinherit

search

pubqueue

pubqueueApprove

suggestFilename