Gentics Content.Node - REST API Library: ImageResource

Resource for loading and manipulating Images in GCN

GET /image

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

id
name
description
niceUrl
alternateUrls

and sorted by

id
name
niceUrl
alternateUrls
fileSize
fileType

Request Parameters
name	type	description	default	constraints	multivalued
broken	query	true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both		boolean	no
createdbefore	query	Timestamp to search objects, which were created before a given time (0 for all objects)	0	int	no
createdsince	query	Timestamp to search objects, which were created since a given time (0 for all objects)	0	int	no
creator	query	Pattern for restricting objects by creator			no
creatorId	query	IDs for restricting objects by creator.		int	yes
editedbefore	query	Timestamp to search objects, which were edited before a given time (0 for all objects)	0	int	no
editedsince	query	Timestamp to search objects, which were edited since a given time (0 for all objects)	0	int	no
editor	query	Pattern for restricting objects by editor			no
editorId	query	IDs for restricting objects by editor.		int	yes
folder	query	True to add the folder information to the returned objects	false	boolean	no
folderId	query	Folder ID			no
inherited	query	true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files		boolean	no
iscreator	query	(optional) true when only the objects created by the user shall be returned	false	boolean	no
iseditor	query	(optional) true when only the objects last edited by the user shall be returned	false	boolean	no
niceurl	query	optional regular expression to get files with a nice URL.			no
nodeId	query	node id for this folder - for use with multichannelling		int	no
online	query	true to only return online files, false to only get offline files, null to get both online and offline files		boolean	no
package	query				no
page	query	Returned page, if paging is used. Paging starts with `1`	1	int	no
pageSize	query	Page size for paging. If this is set to `-1` no paging is used (all matching items are returned). Setting this to `0` will return no items.	-1	int	no
q	query	Query string for filtering			no
recursive	query	(optional) true when the items shall be fetched recursively, false if not. Defaults to false	false	boolean	no
sort	query	Comma separated list of sorted attributes. Each attribute name may be prefixed with `+` for sorting in ascending order or `-` for sorting in descending order	name		no
used	query	true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified, this filter will only check in the current channel		boolean	no
usedIn	query	optional list of channel IDs for extending the "used" filter to multiple channels.		int	yes
wastebin	query	"exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items	exclude	"exclude" or "include" or "only"	no

Response Body
media type	data type	description
application/json	ImageListResponse (JSON)	A list of images

Example

Request

GET /image
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "importitems", "updatetemplates" ],
    "property2" : [ "wastebin", "createitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/disinherit

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

Request Parameters
name	type	description	constraints	multivalued
id	query	list of image IDs		yes
nodeId	query	node ID	int	no

Response Body
media type	data type	description
application/json	MultiDisinheritResponse (JSON)	response containing the exclusion and disinherit status

Example

Request

GET /image/disinherit
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "exclude" : true,
  "disinherit" : [ 12345, 12345 ],
  "partialDisinherit" : [ 12345, 12345 ],
  "inheritable" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/disinherit

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

Request Parameters
name	type	description	default	constraints	multivalued
id	query	list of image IDs			yes
nodeId	query	node ID		int	no
wait	query	wait timeout in milliseconds	0	long	no

Request Body
media type	data type	description
application/json	DisinheritRequest (JSON)	request object

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/disinherit
Content-Type: application/json
Accept: application/json

                
{
  "exclude" : true,
  "disinherit" : [ 12345, 12345 ],
  "reinherit" : [ 12345, 12345 ],
  "recursive" : true,
  "disinheritDefault" : true
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/load

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
media type	data type	description
application/json	MultiObjectLoadRequest (JSON)	The request with he list of image ids to load.

Response Body
media type	data type	description
application/json	MultiImageLoadResponse (JSON)	The list of found images, for which the user has enough permissions.

Example

Request

POST /image/load
Content-Type: application/json
Accept: application/json

                
{
  "package" : "...",
  "ids" : [ 12345, 12345 ],
  "forUpdate" : true,
  "nodeId" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "images" : [ {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "deletefolder", "createtemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "viewpage", "deletefile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/localizationinfo

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

Request Parameters
name	type	description	constraints	multivalued
id	query	list of image ids	int	yes
nodeId	query	id of the node to start with	int	no

Response Body
media type	data type	description
application/json	LocalizationInfo (JSON)	localization info

Example

Request

GET /image/localizationinfo
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "channels" : [ {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  }, {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/move

Move multiple files to another folder

Request Body
media type	data type	description
application/json	MultiObjectMoveRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/move
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ],
  "folderId" : 12345,
  "nodeId" : 12345,
  "allLanguages" : true
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/push2master

Push a list of images from a channel into a master

Request Body
media type	data type	description
application/json	MultiPushToMasterRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/push2master
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "folder", "page" ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/resize

Rotate by 90° (optionally), crop (optionally) and resize an image (in this order).

Request Body
media type	data type	description
application/json	ImageResizeRequest (JSON)	resize request

Response Body
media type	data type	description
application/json	FileUploadResponse (JSON)	response

Example

Request

POST /image/resize
Content-Type: application/json
Accept: application/json

                
{
  "copyFile" : true,
  "targetFormat" : "...",
  "image" : {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "createpage", "linktemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "folder",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "cropHeight" : 12345,
  "cropWidth" : 12345,
  "cropStartX" : 12345,
  "cropStartY" : 12345,
  "width" : 12345,
  "height" : 12345,
  "mode" : "...",
  "resizeMode" : "...",
  "fpX" : 12345.0,
  "fpY" : 12345.0,
  "rotate" : "cw"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "updatetagtypes", "updatefolder" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/rotate

Rotate an image by 90°

Request Body
media type	data type	description
application/json	ImageRotateRequest (JSON)	rotate request

Response Body
media type	data type	description
application/json	ImageLoadResponse (JSON)	response

Example

Request

POST /image/rotate
Content-Type: application/json
Accept: application/json

                
{
  "image" : {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "deletepage", "synchronizechannel" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "image",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "copyFile" : true,
  "rotate" : "ccw",
  "targetFormat" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "image" : {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "linktemplate", "createfolder" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "stagingStatus" : {
    "packageName" : "...",
    "included" : true
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/unlocalize

Unlocalize images in a channel

Request Body
media type	data type	description
application/json	MultiUnlocalizeRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/unlocalize
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "image", "file" ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/delete/{id}

Delete the image denoted by id

Request Parameters
name	type	description	constraints
id	path	id of the image to delete
nodeId	query	id of the node (channel) of the image	int

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	response object

Example

Request

POST /image/delete/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/disinherit/{id}

Get the multichannelling exclusion and disinherit status of the file

Request Parameters
name	type	description	constraints
id	path	file ID
nodeId	query	node ID	int

Response Body
media type	data type	description
application/json	DisinheritResponse (JSON)	response containing the exclusion and disinherit status

Example

Request

GET /image/disinherit/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "exclude" : true,
  "disinheritDefault" : true,
  "disinherit" : [ 12345, 12345 ],
  "inheritable" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/disinherit/{id}

Set the multichannelling exclusion and disinherit status

Request Parameters
name	type	description	default	constraints
id	path	file ID
nodeId	query	node ID		int
wait	query	wait timeout in milliseconds	0	long

Request Body
media type	data type	description
application/json	DisinheritRequest (JSON)	request object

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/disinherit/{id}
Content-Type: application/json
Accept: application/json

                
{
  "exclude" : true,
  "disinherit" : [ 12345, 12345 ],
  "reinherit" : [ 12345, 12345 ],
  "recursive" : true,
  "disinheritDefault" : true
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/load/{id}

Load the image with given id

Request Parameters
name	type	description	default	constraints
id	path	image id. This can either be a local or globalid
construct	query	if true, the construct information will be added to tags	false	boolean
nodeId	query	id of the node (channel) for which the image shall be loaded (when multichannelling is used).		int
package	query	name of a content staging package, to check the image status in it
update	query	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.	false	boolean

Response Body
media type	data type	description
application/json	ImageLoadResponse (JSON)	response containing the image meta data

Example

Request

GET /image/load/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "image" : {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "viewfile", "publishpage" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "image",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "stagingStatus" : {
    "packageName" : "...",
    "included" : true
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/localizationinfo/{id}

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

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

Response Body
media type	data type	description
application/json	LocalizationInfo (JSON)	localization info

Example

Request

GET /image/localizationinfo/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "channels" : [ {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  }, {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/localizations/{id}

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

Request Parameters
name	type	description	constraints
id	path	The ID of the master image.	int

Response Body
media type	data type	description
application/json	LocalizationsResponse (JSON)	A map of folder IDs to node IDs of localized copies.

Example

Request

GET /image/localizations/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "masterId" : 12345,
  "masterNodeId" : 12345,
  "nodeIds" : {
    "property1" : 12345,
    "property2" : 12345
  },
  "total" : 12345,
  "hidden" : 12345,
  "online" : [ 12345, 12345 ],
  "offline" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/localize/{id}

Localize the given image

Request Parameters
name	type	description	constraints
id	path	id of the image to localize	int

Request Body
media type	data type	description
application/json	LocalizeRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/localize/{id}
Content-Type: application/json
Accept: application/json

                
{
  "channelId" : 12345,
  "foregroundTime" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/move/{id}

Mpve the given file to another folder

Request Parameters
name	type	description
id	path	file id

Request Body
media type	data type	description
application/json	ObjectMoveRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/move/{id}
Content-Type: application/json
Accept: application/json

                
{
  "folderId" : 12345,
  "nodeId" : 12345,
  "allLanguages" : true
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/push2master/{id}

Push an image from a channel into a master

Request Parameters
name	type	description	constraints
id	path	id of the image	int

Request Body
media type	data type	description
application/json	PushToMasterRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/push2master/{id}
Content-Type: application/json
Accept: application/json

                
{
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "folder", "folder" ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/save/{id}

Save the given image

Request Parameters
name	type	description	constraints
id	path		int

Request Body
media type	data type	description
application/json	ImageSaveRequest (JSON)	request with the image to be saved

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/save/{id}
Content-Type: application/json
Accept: application/json

                
{
  "image" : {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "assignpermissions", "updatefile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/unlocalize/{id}

Unlocalize the given image

Request Parameters
name	type	description	constraints
id	path	id of the image to unlocalize	int

Request Body
media type	data type	description
application/json	UnlocalizeRequest (JSON)	request

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	generic response

Example

Request

POST /image/unlocalize/{id}
Content-Type: application/json
Accept: application/json

                
{
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "page", "page" ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/file

Get the files using one of the given images

Request Parameters
name	type	description	default	constraints	multivalued
files	query	true (default) if the files shall be returned, false for only returning the counts	true	boolean	no
id	query	list of image ids, for which the usage shall be fetched		int	yes
maxItems	query	maximum number of items to be returned, set to -1 for returning all items	-1	int	no
nodeId	query	id of the node		int	no
skipCount	query	number of items to be skipped, set to 0 for skipping no items	0	int	no
sortby	query	(optional) attribute to sort by. defaults to name	name		no
sortorder	query	(optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".	asc		no

Response Body
media type	data type	description
application/json	FileUsageListResponse (JSON)	response

Example

Request

GET /image/usage/file
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "files" : [ {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "updatefile", "viewtemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "createfolder", "viewfolder" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/folder

Get the folders using one of the given images.

Request Parameters
name	type	description	default	constraints	multivalued
folders	query	true (default) if the folders shall be returned, false for only returning the counts	true	boolean	no
id	query	list of image ids, for which the usage shall be fetched		int	yes
maxItems	query	maximum number of items to be returned, set to -1 for returning all items	-1	int	no
nodeId	query	id of the node		int	no
skipCount	query	number of items to be skipped, set to 0 for skipping no items	0	int	no
sortby	query	(optional) attribute to sort by. defaults to name	name		no
sortorder	query	(optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".	asc		no

Response Body
media type	data type	description
application/json	FolderUsageListResponse (JSON)	response

Example

Request

GET /image/usage/folder
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "folders" : [ {
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "motherId" : 12345,
    "publishDir" : "...",
    "description" : "...",
    "nodeId" : 12345,
    "inherited" : true,
    "atposidx" : "...",
    "startPageId" : { },
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "synchronizechannel", "viewpage" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "meshProject" : "...",
    "breadcrumbs" : [ {
      "id" : 12345,
      "globalId" : "...",
      "name" : "..."
    }, {
      "id" : 12345,
      "globalId" : "...",
      "name" : "..."
    } ],
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "publishDirI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "image",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "motherId" : 12345,
    "publishDir" : "...",
    "description" : "...",
    "nodeId" : 12345,
    "inherited" : true,
    "atposidx" : "...",
    "startPageId" : { },
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "viewtemplate", "inheritance" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "meshProject" : "...",
    "breadcrumbs" : [ {
      "id" : 12345,
      "globalId" : "...",
      "name" : "..."
    }, {
      "id" : 12345,
      "globalId" : "...",
      "name" : "..."
    } ],
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "publishDirI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "deleted" : [ "...", "..." ],
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/image

Get the images using one of the given images

Request Parameters
name	type	description	default	constraints	multivalued
id	query	list of image ids, for which the usage shall be fetched		int	yes
images	query	true (default) if the images shall be returned, false for only returning the counts	true	boolean	no
maxItems	query	maximum number of items to be returned, set to -1 for returning all items	-1	int	no
nodeId	query	id of the node		int	no
skipCount	query	number of items to be skipped, set to 0 for skipping no items	0	int	no
sortby	query	(optional) attribute to sort by. defaults to name	name		no
sortorder	query	(optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".	asc		no

Response Body
media type	data type	description
application/json	FileUsageListResponse (JSON)	response

Example

Request

GET /image/usage/image
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "files" : [ {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "viewpage", "updatetemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "form",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "translatepage", "viewpage" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "form",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/page

Get the pages using one of the given images

Request Parameters
name	type	description	default	constraints	multivalued
contenttags	query	True if the contenttags shall be attached to all returned pages. Default is false	false	boolean	no
folder	query	True for adding folder info to the pages. Default is false.	false	boolean	no
id	query	list of image ids, for which the usage shall be fetched		int	yes
langvars	query	True for adding the language variants to the pages. Default is false.	false	boolean	no
maxItems	query	maximum number of items to be returned, set to -1 for returning all items	-1	int	no
nodeId	query	id of the node		int	no
objecttags	query	True if the objecttags shall be attached to all returned pages. Default is false.	false	boolean	no
pages	query	true (default) if the pages shall be returned, false for only returning the counts	true	boolean	no
skipCount	query	number of items to be skipped, set to 0 for skipping no items	0	int	no
sortby	query	(optional) attribute to sort by. defaults to name	name		no
sortorder	query	(optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".	asc		no
template	query	True for adding template info to the pages. Default is false.	false	boolean	no
translationstatus	query	True if the translationstatus information shall be added for every page. Default is false.	false	boolean	no

Response Body
media type	data type	description
application/json	PageUsageListResponse (JSON)	response

Example

Request

GET /image/usage/page
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "pages" : [ {
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "at" : 12345,
      "version" : { },
      "offlineAt" : 12345,
      "queuedPublish" : { },
      "queuedOffline" : { }
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "online" : true,
    "modified" : true,
    "queued" : true,
    "planned" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "linkworkflow", "viewpage" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "customCdate" : 12345,
    "customEdate" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "at" : 12345,
      "version" : { },
      "offlineAt" : 12345,
      "queuedPublish" : { },
      "queuedOffline" : { }
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "online" : true,
    "modified" : true,
    "queued" : true,
    "planned" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "updatefolder", "createtemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "customCdate" : 12345,
    "customEdate" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/syncableObjects

Get objects which are directly or indirectly linked by the specified images, which can be synchronised to a master channel along with the images 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.

Request Parameters
name	type	description	constraints	multivalued
dstNodeId	query	The channel ID of the target channel	int	no
ids	query	The IDs of the images to get linked objects for	int	yes
srcNodeId	query	The channel ID of the source channel	int	no

Response Body
media type	data type	description
application/json	ReferencedSyncableObjectsListResponse (JSON)

Example

Request

GET /image/usage/syncableObjects
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "haveDependencies" : true,
  "dependencies" : {
    "property1" : {
      "property1" : { },
      "property2" : { }
    },
    "property2" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "pages" : [ {
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "at" : 12345,
      "version" : { },
      "offlineAt" : 12345,
      "queuedPublish" : { },
      "queuedOffline" : { }
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "online" : true,
    "modified" : true,
    "queued" : true,
    "planned" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "publishpage", "deletefolder" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "customCdate" : 12345,
    "customEdate" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "at" : 12345,
      "version" : { },
      "offlineAt" : 12345,
      "queuedPublish" : { },
      "queuedOffline" : { }
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "online" : true,
    "modified" : true,
    "queued" : true,
    "planned" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "linktemplate", "createfile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "customCdate" : 12345,
    "customEdate" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "pagesTotal" : 12345,
  "pagesWithoutPermission" : 12345,
  "files" : [ {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "deletepage", "updatetemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "folder",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "viewtemplate", "updatetemplate" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "filesTotal" : 12345,
  "filesWithoutPermission" : 12345,
  "images" : [ {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "FILENAME",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "updatepage", "deletefile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "iconCls" : "...",
    "sizeX" : 12345,
    "sizeY" : 12345,
    "typeId" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "publishPath" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "insecurePreviewUrl" : true,
      "meshProject" : "...",
      "omitPageExtension" : true,
      "pageLanguageCode" : "NONE",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "form",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "linkworkflow", "deletefile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "breadcrumbs" : [ { }, { } ],
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "publishDirI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "niceUrl" : "...",
    "alternateUrls" : [ "...", "..." ],
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "form",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "imagesTotal" : 12345,
  "imagesWithoutPermission" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/template

Get the templates using one of the given images

Request Parameters
name	type	description	default	constraints	multivalued
id	query	list of image ids, for which the usage shall be fetched		int	yes
maxItems	query	maximum number of items to be returned, set to -1 for returning all items	-1	int	no
nodeId	query	id of the node		int	no
skipCount	query	number of items to be skipped, set to 0 for skipping no items	0	int	no
sortby	query	(optional) attribute to sort by. defaults to name	name		no
sortorder	query	(optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".	asc		no
templates	query	true (default) if the templates shall be returned, false for only returning the counts	true	boolean	no

Response Body
media type	data type	description
application/json	TemplateUsageListResponse (JSON)	response

Example

Request

GET /image/usage/template
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "templates" : [ {
    "inheritedFrom" : "...",
    "masterNode" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "description" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "locked" : true,
    "markupLanguage" : {
      "id" : 12345,
      "name" : "...",
      "extension" : "...",
      "contentType" : "...",
      "feature" : "...",
      "excludeFromPublishing" : true
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  }, {
    "inheritedFrom" : "...",
    "masterNode" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "description" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "locked" : true,
    "markupLanguage" : {
      "id" : 12345,
      "name" : "...",
      "extension" : "...",
      "contentType" : "...",
      "feature" : "...",
      "excludeFromPublishing" : true
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /image/usage/total

Get the total usage info for the given images.

Request Parameters
name	type	description	constraints	multivalued
id	query	list of image ids, for which the usage shall be fetched	int	yes
nodeId	query	id of the node	int	no

Response Body
media type	data type	description
application/json	TotalUsageResponse (JSON)	Response which contains the total usage info

Example

Request

GET /image/usage/total
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "infos" : {
    "property1" : {
      "total" : 12345,
      "pages" : 12345,
      "folders" : 12345,
      "templates" : 12345,
      "files" : 12345,
      "images" : 12345
    },
    "property2" : {
      "total" : 12345,
      "pages" : 12345,
      "folders" : 12345,
      "templates" : 12345,
      "files" : 12345,
      "images" : 12345
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/wastebin/delete

Remove the given images from the wastebin

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

Request Body
media type	data type	description
application/json	IdSetRequest (JSON)	request containing the image IDs

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	response object

Example

Request

POST /image/wastebin/delete
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/wastebin/restore

Restore the given images from the wastebin

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

Request Body
media type	data type	description
application/json	IdSetRequest (JSON)	request containing the image IDs

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	response object

Example

Request

POST /image/wastebin/restore
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/wastebin/delete/{id}

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

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

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	response object

Example

Request

POST /image/wastebin/delete/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /image/wastebin/restore/{id}

Restore the given image from the wastebin

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

Response Body
media type	data type	description
application/json	GenericResponse (JSON)	response object

Example

Request

POST /image/wastebin/restore/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}