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

```
@Path(value="/template")
public interface TemplateResource
```
Resource used for loading, saving and manipulating GCN templates.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`TemplateLoadResponse`	`copy(String id, TemplateCopyRequest request)` Create a copy of the template
`TemplateLoadResponse`	`create(TemplateCreateRequest request)` Create a new template
`javax.ws.rs.core.Response`	`delete(String id)` Delete the template with given id
`PagedFolderListResponse`	`folders(String id, SortParameterBean sort, FilterParameterBean filter, PagingParameterBean paging)` Get the folders to which the template is assigned. The result can be filtered by `id` `name` `description` and sorted by `id` `name` `description`
`TemplateLoadResponse`	`get(String id, Integer nodeId, boolean update, boolean construct)` Load the template with the given id and return it.
`LocalizationInfo`	`getLocalizationInfo(List<Integer> ids, Integer nodeId)` Get localization info for a list of templates for a given channel and all master channels
`LocalizationInfo`	`getLocalizationInfo(String id, Integer nodeId)` Get localization info for a template for a given channel and all master channels
`ReferencedSyncableObjectsListResponse`	`getSyncableObjects(List<Integer> templateIds, Integer srcNodeId, Integer dstNodeId)` Get objects which are directly or indirectly linked by the specified templates, which can be synchronised to a master channel along with the templates themselves.
`TagListResponse`	`getTags(String id, Integer skipCount, Integer maxItems, TagSortAttribute sortBy, SortOrder sortOrder, String search)` Get the list of templatetags for this template
`ImplementationHashResponse`	`implementationHash(String id)` Get the implementation hash for a template
`GenericResponse`	`link(MultiLinkRequest request)` Link the given templates to the given folders.
`GenericResponse`	`link(String id, LinkRequest request)` Link the given template to the given folders.
`TemplateInNodeResponse`	`list(List<String> nodeIds, FilterParameterBean filterParams, SortParameterBean sortingParams, PagingParameterBean pagingParams, PermsParameterBean perms)` List templates assigned to the given list of nodes. The result can be filtered by `id` `name` `description` and sorted by `id` `name` `description` `cdate` `edate`
`TemplateLoadResponse`	`load(String id, Integer nodeId)` Deprecated. Use `GET /template/{id}` instead
`LocalizationsResponse`	`localizations(Integer id)` Get the IDs an their respective node IDs of localized copies of the specified template.
`GenericResponse`	`localize(String id, LocalizeRequest request)` Localize the given template
`NodeList`	`nodes(String id, SortParameterBean sort, FilterParameterBean filter, PagingParameterBean paging)` Get the nodes to which the template is assigned. The result can be filtered by `id` `name` and sorted by `id` `name`
`GenericResponse`	`pushToMaster(Integer id, PushToMasterRequest request)` Push a template from a channel into a master
`GenericResponse`	`pushToMaster(MultiPushToMasterRequest request)` Push a list of templates from a channel into a master
`TagStatusResponse`	`tagStatus(String id, SortParameterBean sort, FilterParameterBean filter, PagingParameterBean paging)` Get the tag status for a template.
`GenericResponse`	`unlink(MultiLinkRequest request)` Unlink the given templates from the given folders.
`GenericResponse`	`unlink(String id, LinkRequest request)` Unlink the given template from the given folders.
`GenericResponse`	`unlocalize(Integer id, UnlocalizeRequest request)` Unlocalize the given template
`GenericResponse`	`unlocalize(MultiUnlocalizeRequest request)` Unlocalize templates in a channel
`TemplateLoadResponse`	`unlock(String id)` Unlock a template
`GenericResponse`	`update(String id, TemplateSaveRequest request)` Update the template with given id

Method Detail

list

@GET
TemplateInNodeResponse list(@QueryParam(value="nodeId")
                                 List<String> nodeIds,
                                 @BeanParam
                                 FilterParameterBean filterParams,
                                 @BeanParam
                                 SortParameterBean sortingParams,
                                 @BeanParam
                                 PagingParameterBean pagingParams,
                                 @BeanParam
                                 PermsParameterBean perms)
                          throws Exception

List templates assigned to the given list of nodes.
The result can be filtered by

id
name
description

and sorted by

id
name
description
cdate
edate

Parameters:: nodeIds - list of node IDs; filterParams - filter parameters; sortingParams - sorting parameters; pagingParams - paging parameters; perms - permissions parameters
Returns:: response containing the list of assigned templates
Throws:: Exception

create

@POST
TemplateLoadResponse create(TemplateCreateRequest request)
                           throws Exception

Create a new template

Parameters:: request - create request
Returns:: created template
Throws:: Exception

get

@GET
 @Path(value="/{id}")
TemplateLoadResponse get(@PathParam(value="id")
                                                    String id,
                                                    @QueryParam(value="nodeId")
                                                    Integer nodeId,
                                                    @QueryParam(value="update") @DefaultValue(value="false")
                                                    boolean update,
                                                    @QueryParam(value="construct") @DefaultValue(value="false")
                                                    boolean construct)
                                             throws Exception

Load the template with the given id and return it.

Parameters:: id - The template id (either local or global); nodeId - channel id; update - true when the template shall be locked, false if not; construct - if true, the construct info will be added to tags
Returns:: template load response
Throws:: Exception

implementationHash

@GET
 @Path(value="/{id}/hash")
ImplementationHashResponse implementationHash(@PathParam(value="id")
                                                                              String id)
                                                                       throws Exception

Get the implementation hash for a template

Parameters:: id - template ID
Returns:: response with implementation hash
Throws:: Exception

update

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

Update the template with given id

Parameters:: id - The template id (either local or global); request - template update request
Returns:: generic response
Throws:: Exception

unlock

@POST
 @Path(value="/{id}/unlock")
TemplateLoadResponse unlock(@PathParam(value="id")
                                                               String id)
                                                        throws Exception

Unlock a template

Parameters:: id - template id (either local or global)
Returns:: template load response
Throws:: Exception

delete

@DELETE
 @Path(value="/{id}")
javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                               String id)
                                                        throws Exception

Delete the template with given id

Parameters:: id - The template id (either local or global)
Returns:: generic response
Throws:: Exception

folders

@GET
 @Path(value="/{id}/folders")
PagedFolderListResponse folders(@PathParam(value="id")
                                                                   String id,
                                                                   @BeanParam
                                                                   SortParameterBean sort,
                                                                   @BeanParam
                                                                   FilterParameterBean filter,
                                                                   @BeanParam
                                                                   PagingParameterBean paging)
                                                            throws Exception

Get the folders to which the template is assigned.
The result can be filtered by

id
name
description

and sorted by

id
name
description

Parameters:: id - template ID; sort - sort parameters; filter - filter parameters; paging - paging parameters
Returns:: response containing a list of folders
Throws:: Exception

nodes

@GET
 @Path(value="/{id}/nodes")
NodeList nodes(@PathParam(value="id")
                                                String id,
                                                @BeanParam
                                                SortParameterBean sort,
                                                @BeanParam
                                                FilterParameterBean filter,
                                                @BeanParam
                                                PagingParameterBean paging)
                                         throws Exception

Get the nodes to which the template is assigned.
The result can be filtered by

id
name

and sorted by

id
name

Parameters:: id - template ID; sort - sort parameters; filter - filter parameters; paging - paging parameters
Returns:: response containing a list of nodes
Throws:: Exception

load

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

Deprecated. Use GET /template/{id} instead

Load the template with the given id and return it.

Parameters:: id - The template id; nodeId - channel id
Returns:
Throws:: Exception

getTags

@GET
 @Path(value="/getTags/{id}")
TagListResponse getTags(@PathParam(value="id")
                                                           String 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)
                                                    throws Exception

Get the list of templatetags for this template

Parameters:: id - id of the template. The local or global id
Returns:: response object
Throws:: Exception

getSyncableObjects

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

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

Parameters:: templateIds - The IDs of the templates to get linked objects for; srcNodeId - The channel ID of the source channel; dstNodeId - The channel ID of the target channel
Throws:: Exception

pushToMaster

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

Push a template from a channel into a master

Parameters:: id - id of the template; request - request
Returns:: generic response
Throws:: Exception

pushToMaster

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

Push a list of templates from a channel into a master

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

localize

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

Localize the given template

Parameters:: id - ID of the template; request - request
Returns:: generic response
Throws:: Exception

unlocalize

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

Unlocalize the given template

Parameters:: id - id of the template to unlocalize; request - request
Returns:: generic response
Throws:: Exception

unlocalize

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

Unlocalize templates in a channel

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

getLocalizationInfo

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

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

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

getLocalizationInfo

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

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

Parameters:: id - id of the template. This can either be the local or global id of the template.; nodeId - id of the node to start with
Returns:: localization info
Throws:: Exception

localizations

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

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

Parameters:: id - The ID of the master template.
Returns:: A map of template IDs to node IDs of localized copies.
Throws:: Exception

link
```
@POST
 @Path(value="/link/{id}")
GenericResponse link(@PathParam(value="id")
                                                      String id,
                                                      LinkRequest request)
                                               throws Exception
```
Link the given template to the given folders. For linking templates to folders, the user must have the following permissions:
- edit the template (which includes viewing the template)
- link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.
Parameters:

id - id of the template

request - request containing the list of folders and other data

Returns:

generic response

Throws:

Exception

link
```
@POST
 @Path(value="/link")
GenericResponse link(MultiLinkRequest request)
                                          throws Exception
```
Link the given templates to the given folders. For linking templates to folders, the user must have the following permissions:
- edit the template (which includes viewing the template)
- link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.
Parameters:

request - request containing the list of folders and other data

Returns:

generic response

Throws:

Exception

unlink
```
@POST
 @Path(value="/unlink/{id}")
GenericResponse unlink(@PathParam(value="id")
                                                          String id,
                                                          LinkRequest request)
                                                   throws Exception
```
Unlink the given template from the given folders. For unlinking templates from folders, the user must have the following permissions:
- edit the template (which includes viewing the template)
- link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.
Parameters:

id - id of the template

request - request containing the list of folders and other data

Returns:

generic response

Throws:

Exception

unlink
```
@POST
 @Path(value="/unlink")
GenericResponse unlink(MultiLinkRequest request)
                                              throws Exception
```
Unlink the given templates from the given folders. For unlinking templates from folders, the user must have the following permissions:
- edit the template (which includes viewing the template)
- link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.
Parameters:

request - request containing the list of folders and other data

Returns:

generic response

Throws:

Exception

tagStatus

@GET
 @Path(value="/{id}/tagstatus")
TagStatusResponse tagStatus(@PathParam(value="id")
                                                                 String id,
                                                                 @BeanParam
                                                                 SortParameterBean sort,
                                                                 @BeanParam
                                                                 FilterParameterBean filter,
                                                                 @BeanParam
                                                                 PagingParameterBean paging)
                                                          throws Exception

Get the tag status for a template. The tag status will contain a list of all template tags, which are editable in pages together with the count of pages in sync, out of sync, incompatible or missing.
The result can be filtered by

name

and sorted by

name

Parameters:: id - template ID; sort - sort parameters; filter - filter parameters; paging - paging parameters
Returns:: response
Throws:: Exception

copy

@POST
 @Path(value="/{id}/copy")
TemplateLoadResponse copy(@PathParam(value="id")
                                                           String id,
                                                           TemplateCopyRequest request)
                                                    throws Exception

Create a copy of the template

Parameters:: id - template id; request - copy request
Returns:: response containing the generated copy
Throws:: Exception

Interface TemplateResource

Method Summary

Method Detail

list

create

get

implementationHash

update

unlock

delete

folders

nodes

load

getTags

getSyncableObjects

pushToMaster

pushToMaster

localize

unlocalize

unlocalize

getLocalizationInfo

getLocalizationInfo

localizations

link

link

unlink

unlink

tagStatus

copy