ImageResource

The following resources are part of this group:

/image/localizationinfo

Mount Point: /CNPortletapp/rest/image/localizationinfo

GET

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

Parameters

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

Response Body

element: localizationInfo

localization info

/image/push2master

Mount Point: /CNPortletapp/rest/image/push2master

POST

Push a list of images from a channel into a master

Request Body

element: multiPushToMasterRequest

request

Response Body

element: genericResponse

generic response

/image/resize

Mount Point: /CNPortletapp/rest/image/resize

POST

This method will once invoked resize the image and update its binary data and properties.

Request Body

element: imageResizeRequest

(no documentation provided)

Response Body

element: genericResponse

(no documentation provided)

/image/unlocalize

Mount Point: /CNPortletapp/rest/image/unlocalize

POST

Unlocalize images in a channel

Request Body

element: multiUnlocalizeRequest

request

Response Body

element: genericResponse

generic response

/image/load/{id}

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

GET

Load the image with given id

Parameters

name description type default
id image id. This can either be a local or globalid path
update true when the image is fetched for updating. Currently, images cannot be locked in the backend, but it is still recommended to set this parameter to true when the image shall be modified. query false

Response Body

element: imageLoadResponse

response containing the image meta data

/image/localizationinfo/{id}

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

GET

Get localization info for an image for a given channel and all master channels

Parameters

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

Response Body

element: localizationInfo

localization info

/image/localize/{id}

Mount Point: /CNPortletapp/rest/image/localize/{id}

POST

Localize the given image

Parameters

name description type default
id id of the image to localize path

Request Body

element: localizeRequest

request

Response Body

element: genericResponse

generic response

/image/push2master/{id}

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

POST

Push an image from a channel into a master

Parameters

name description type default
id id of the image path

Request Body

element: pushToMasterRequest

request

Response Body

element: genericResponse

generic response

/image/save/{id}

Mount Point: /CNPortletapp/rest/image/save/{id}

POST

Save the given image

Parameters

name description type default
id (no documentation provided) path

Request Body

element: imageSaveRequest

request with the image to be saved

Response Body

element: genericResponse

generic response

/image/unlocalize/{id}

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

POST

Unlocalize the given image

Parameters

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

Request Body

element: unlocalizeRequest

request

Response Body

element: genericResponse

generic response

/image/usage/file

Mount Point: /CNPortletapp/rest/image/usage/file

GET

Get the files using one of the given images

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query
files true (default) if the files shall be returned, false for only returning the counts query true

Response Body

element: fileUsageListResponse

response

/image/usage/folder

Mount Point: /CNPortletapp/rest/image/usage/folder

GET

Get the folders using one of the given images

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query
folders true (default) if the folders shall be returned, false for only returning the counts query true

Response Body

element: folderUsageListResponse

response

/image/usage/image

Mount Point: /CNPortletapp/rest/image/usage/image

GET

Get the images using one of the given images

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query
images true (default) if the images shall be returned, false for only returning the counts query true

Response Body

element: fileUsageListResponse

response

/image/usage/page

Mount Point: /CNPortletapp/rest/image/usage/page

GET

Get the pages using one of the given images

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query
pages true (default) if the pages shall be returned, false for only returning the counts query true
template true for adding template info to the pages, default is false query false
folder true for adding folder info to the pages, default is false query false
langvars true for adding the language variants to the pages, default is false query false

Response Body

element: pageUsageListResponse

response

/image/usage/template

Mount Point: /CNPortletapp/rest/image/usage/template

GET

Get the templates using one of the given images

Parameters

name description type default
skipCount number of items to be skipped, set to 0 for skipping no items query 0
maxItems maximum number of items to be returned, set to -1 for returning all items query -1
sortby (no documentation provided) query name
sortorder (no documentation provided) query asc
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query
templates true (default) if the templates shall be returned, false for only returning the counts query true

Response Body

element: templateUsageListResponse

response