ImageResource

Resource for loading and manipulating Images in GCN

The following resources are applicable:

/image/delete/{id}

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

POST

Delete the image denoted by id

Parameters

name description type default
id id of the image to delete path
nodeId id of the node (channel) of the image query

Response Body

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

response object

/image/disinherit

Mount Point: /CNPortletapp/rest/image/disinherit

GET

Get the multichannelling exclusion and disinherit status for a list of images

Parameters

name description type default
id list of image IDs query
nodeId node ID query

Response Body

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

response containing the exclusion and disinherit status

POST

Set the multichannelling exclusion and disinherit status for a list of images

Parameters

name description type default
id list of image IDs query
nodeId node ID query
wait wait timeout in milliseconds query 0

Request Body

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

request object

Response Body

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

generic response

/image/disinherit/{id}

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

GET

Get the multichannelling exclusion and disinherit status of the file

Parameters

name description type default
id file ID path
nodeId node ID query

Response Body

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

response containing the exclusion and disinherit status

POST

Set the multichannelling exclusion and disinherit status

Parameters

name description type default
id file ID path
nodeId node ID query
wait wait timeout in milliseconds query 0

Request Body

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

request object

Response Body

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

generic response

/image/load

Mount Point: /CNPortletapp/rest/image/load

POST

Load a list of images specified in the given request. Image ids for which no images exist, or the user does not have the necessary permissions, are silently ignored.

Request Body

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

The request with he list of image ids to load.

Response Body

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

The list of found images, for which the user has enough permissions.

/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
nodeId id of the node (channel) for which the image shall be loaded (when multichannelling is used). query

Response Body

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

response containing the image meta data

/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
media types: */*
application/xml
application/json

localization info

/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
media types: */*
application/xml
application/json

localization info

/image/localizations/{id}

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

GET

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

Parameters

name description type default
id The ID of the master image. path

Response Body

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

A map of folder IDs to node IDs of localized copies.

/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
media types: */*
application/xml
application/json

request

Response Body

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

generic response

/image/move

Mount Point: /CNPortletapp/rest/image/move

POST

Move multiple files to another folder

Request Body

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

request

Response Body

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

generic response

/image/move/{id}

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

POST

Mpve the given file to another folder

Parameters

name description type default
id file id path

Request Body

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

request

Response Body

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

generic response

/image/push2master

Mount Point: /CNPortletapp/rest/image/push2master

POST

Push a list of images 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

/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
media types: */*
application/xml
application/json

request

Response Body

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

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
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

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

(no documentation provided)

/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
media types: */*
application/xml
application/json

request with the image to be saved

Response Body

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

generic response

/image/unlocalize

Mount Point: /CNPortletapp/rest/image/unlocalize

POST

Unlocalize images 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

/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
media types: */*
application/xml
application/json

request

Response Body

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

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
media types: */*
application/xml
application/json

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
media types: */*
application/xml
application/json

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
media types: */*
application/xml
application/json

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
media types: */*
application/xml
application/json

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
media types: */*
application/xml
application/json

response

/image/usage/total

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

GET

Get the total usage info for the given images.

Parameters

name description type default
id list of image ids, for which the usage shall be fetched query
nodeId id of the node query

Response Body

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

Response which contains the total usage info

/image/wastebin/delete

Mount Point: /CNPortletapp/rest/image/wastebin/delete

POST

Remove the given images from the wastebin

Parameters

name description type default
wait time in ms for the request to be done in foreground query 0

Request Body

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

request containing the image IDs

Response Body

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

response object

/image/wastebin/delete/{id}

Mount Point: /CNPortletapp/rest/image/wastebin/delete/{id}

POST

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

Parameters

name description type default
id id of the image to remove from the wastebin. This can either be a local or global id path
wait time in ms for the request to be done in foreground query 0

Response Body

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

response object

/image/wastebin/restore

Mount Point: /CNPortletapp/rest/image/wastebin/restore

POST

Restore the given images from the wastebin

Parameters

name description type default
wait time in ms for the request to be done in foreground query 0

Request Body

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

request containing the image IDs

Response Body

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

response object

/image/wastebin/restore/{id}

Mount Point: /CNPortletapp/rest/image/wastebin/restore/{id}

POST

Restore the given image from the wastebin

Parameters

name description type default
id id of the image to restore from the wastebin. This can either be a local or global id path
wait time in ms for the request to be done in foreground query 0

Response Body

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

response object