TemplateResource

Resource used for loading, saving and manipulating GCN templates.

The following resources are applicable:

/template/getTags/{id}

Mount Point: /CNPortletapp/rest/template/getTags/{id}

GET

Get the list of templatetags for this template

Parameters

name description type default
id id of the template. The local or global id path
skipCount (no documentation provided) query 0
maxItems (no documentation provided) query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
search (no documentation provided) query

Response Body

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

response object

/template/link

Mount Point: /CNPortletapp/rest/template/link

POST

Link the given templates to the given folders. For linking templates to folders, the user must have the following permissions:

If at least on of these permissions is not granted to the user, the method will fail.

Request Body

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

request containing the list of folders and other data

Response Body

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

generic response

/template/link/{id}

Mount Point: /CNPortletapp/rest/template/link/{id}

POST

Link the given template to the given folders. For linking templates to folders, the user must have the following permissions:

If at least on of these permissions is not granted to the user, the method will fail.

Parameters

name description type default
id id of the template path

Request Body

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

request containing the list of folders and other data

Response Body

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

generic response

/template/load/{id}

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

GET

Load the template with the given id and return it.

Parameters

name description type default
id The template id path
nodeId channel id query

Response Body

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

(no documentation provided)

/template/localizationinfo

Mount Point: /CNPortletapp/rest/template/localizationinfo

GET

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

Parameters

name description type default
id list of template ids query
nodeId id of the node to start with query

Response Body

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

localization info

/template/localizationinfo/{id}

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

GET

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

Parameters

name description type default
id id of the template. This can either be the local or global id of the template. path
nodeId id of the node to start with query

Response Body

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

localization info

/template/push2master

Mount Point: /CNPortletapp/rest/template/push2master

POST

Push a list of templates from a channel into a master

Request Body

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

request

Response Body

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

generic response

/template/push2master/{id}

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

POST

Push a template from a channel into a master

Parameters

name description type default
id id of the template path

Request Body

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

request

Response Body

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

generic response

/template/unlink

Mount Point: /CNPortletapp/rest/template/unlink

POST

Unlink the given templates from the given folders. For unlinking templates from folders, the user must have the following permissions:

If at least on of these permissions is not granted to the user, the method will fail.

Request Body

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

request containing the list of folders and other data

Response Body

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

generic response

/template/unlink/{id}

Mount Point: /CNPortletapp/rest/template/unlink/{id}

POST

Unlink the given template from the given folders. For unlinking templates from folders, the user must have the following permissions:

If at least on of these permissions is not granted to the user, the method will fail.

Parameters

name description type default
id id of the template path

Request Body

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

request containing the list of folders and other data

Response Body

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

generic response

/template/unlocalize

Mount Point: /CNPortletapp/rest/template/unlocalize

POST

Unlocalize templates in a channel

Request Body

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

request

Response Body

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

generic response

/template/unlocalize/{id}

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

POST

Unlocalize the given template

Parameters

name description type default
id id of the template to unlocalize path

Request Body

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

request

Response Body

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

generic response