@Path(value="/image") public interface ImageResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
ImageLoadResponse |
create(ImageCreateRequest request)
Create a new image
|
GenericResponse |
delete(String id,
Integer nodeId)
Delete the image denoted by id
|
GenericResponse |
deleteFromWastebin(IdSetRequest request,
long waitMs)
Remove the given images from the wastebin
|
GenericResponse |
deleteFromWastebin(String id,
long waitMs)
Remove the image denoted by the given id from the wastebin.
|
MultiDisinheritResponse |
disinherit(List<String> ids,
Integer nodeId)
Get the multichannelling exclusion and disinherit status for a list of images
|
GenericResponse |
disinherit(List<String> ids,
Integer nodeId,
long waitMs,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status for a list of images
|
DisinheritResponse |
disinherit(String id,
Integer nodeId)
Get the multichannelling exclusion and disinherit status of the file
|
GenericResponse |
disinherit(String id,
Integer nodeId,
long waitMs,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status
|
FileUsageListResponse |
getFileUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> imageId,
Integer nodeId,
boolean returnFiles)
Get the files using one of the given images
|
FolderUsageListResponse |
getFolderUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> imageId,
Integer nodeId,
boolean returnFolders)
Get the folders using one of the given images.
|
FileUsageListResponse |
getImageUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> imageId,
Integer nodeId,
boolean returnImages)
Get the images using one of the given images
|
LocalizationInfo |
getLocalizationInfo(List<Integer> ids,
Integer nodeId)
Get localization info for a list of images for a given channel and all master channels
|
LocalizationInfo |
getLocalizationInfo(String id,
Integer nodeId)
Get localization info for an image for a given channel and all master channels
|
PageUsageListResponse |
getPageUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> imageId,
Integer nodeId,
boolean returnPages,
PageModelParameterBean pageModel)
Get the pages using one of the given images
|
PrivilegesResponse |
getPrivileges(Integer id)
Get the privileges of the current user on the given image
|
ReferencedSyncableObjectsListResponse |
getSyncableObjects(List<Integer> imageIds,
Integer srcNodeId,
Integer dstNodeId)
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.
|
TemplateUsageListResponse |
getTemplateUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> imageId,
Integer nodeId,
boolean returnTemplates)
Get the templates using one of the given images
|
TotalUsageResponse |
getTotalFileUsageInfo(List<Integer> imageId,
Integer nodeId)
Get the total usage info for the given images.
|
MultiImageLoadResponse |
load(MultiObjectLoadRequest request)
Load a list of images specified in the given
request . |
ImageLoadResponse |
load(String id,
boolean update,
Integer nodeId)
Load the image with given id
|
javax.ws.rs.core.Response |
loadContent(Integer id)
Get the content of the image with given id
|
LocalizationsResponse |
localizations(Integer id)
Get the IDs an their respective node IDs of localized copies of the
specified image.
|
GenericResponse |
localize(Integer id,
LocalizeRequest request)
Localize the given image
|
GenericResponse |
move(MultiObjectMoveRequest request)
Move multiple files to another folder
|
GenericResponse |
move(String id,
ObjectMoveRequest request)
Mpve the given file to another folder
|
GenericResponse |
pushToMaster(Integer id,
PushToMasterRequest request)
Push an image from a channel into a master
|
GenericResponse |
pushToMaster(MultiPushToMasterRequest request)
Push a list of images from a channel into a master
|
FileUploadResponse |
resize(ImageResizeRequest imageResizeRequest)
This method will once invoked resize the image and update its binary data
and properties.
|
GenericResponse |
restoreFromWastebin(IdSetRequest request,
long waitMs)
Restore the given images from the wastebin
|
GenericResponse |
restoreFromWastebin(String id,
long waitMs)
Restore the given image from the wastebin
|
GenericResponse |
save(Integer id,
ImageSaveRequest request)
Save the given image
|
GenericResponse |
saveContent(InputStream fileContent)
Save the posted content into the given image
|
GenericResponse |
unlocalize(Integer id,
UnlocalizeRequest request)
Unlocalize the given image
|
GenericResponse |
unlocalize(MultiUnlocalizeRequest request)
Unlocalize images in a channel
|
setSessionId
@GET @Path(value="/load/{id}") ImageLoadResponse load(@PathParam(value="id") String id, @DefaultValue(value="false") @QueryParam(value="update") boolean update, @QueryParam(value="nodeId") Integer nodeId)
id
- image id. This can either be a local or globalidupdate
- 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.nodeId
- id of the node (channel) for which the image shall be
loaded (when multichannelling is used).@POST @Path(value="/load") MultiImageLoadResponse load(MultiObjectLoadRequest request)
request
.
Image ids for which no images exist, or the user does not have the necessary
permissions, are silently ignored.request
- The request with he list of image ids to load.@POST @Path(value="/resize/") FileUploadResponse resize(ImageResizeRequest imageResizeRequest)
javax.ws.rs.core.Response loadContent(@PathParam(value="id") Integer id)
id
- image id to getImageLoadResponse create(ImageCreateRequest request)
request
- request with data for the image to be created@POST @Path(value="/move/{id}") GenericResponse move(@PathParam(value="id") String id, ObjectMoveRequest request)
id
- file idrequest
- request@POST @Path(value="/move") GenericResponse move(MultiObjectMoveRequest request)
request
- request@POST @Path(value="/save/{id}") GenericResponse save(@PathParam(value="id") Integer id, ImageSaveRequest request)
request
- request with the image to be savedGenericResponse saveContent(InputStream fileContent)
fileContent
- image content@POST @Path(value="/delete/{id}") GenericResponse delete(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId)
id
- id of the image to deletenodeId
- id of the node (channel) of the image@POST @Path(value="/wastebin/delete/{id}") GenericResponse deleteFromWastebin(@PathParam(value="id") String id, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
id
- id of the image to remove from the wastebin. This can either be
a local or global idwaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/delete") GenericResponse deleteFromWastebin(IdSetRequest request, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
request
- request containing the image IDswaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/restore/{id}") GenericResponse restoreFromWastebin(@PathParam(value="id") String id, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
id
- id of the image to restore from the wastebin. This can either
be a local or global idwaitMs
- time in ms for the request to be done in foreground@POST @Path(value="/wastebin/restore") GenericResponse restoreFromWastebin(IdSetRequest request, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs)
request
- request containing the image IDswaitMs
- time in ms for the request to be done in foregroundPrivilegesResponse getPrivileges(@PathParam(value="id") Integer id)
id
- id of the image@GET @Path(value="/usage/total") TotalUsageResponse getTotalFileUsageInfo(@QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId)
imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the node@GET @Path(value="/usage/folder") FolderUsageListResponse getFolderUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="folders") @DefaultValue(value="true") boolean returnFolders)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the nodereturnFolders
- true (default) if the folders shall be returned, false for only returning the counts@GET @Path(value="/usage/page") PageUsageListResponse getPageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="pages") @DefaultValue(value="true") boolean returnPages, @BeanParam PageModelParameterBean pageModel)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortBy
- (optional) attribute to sort by. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countspageModel
- page model parameters@GET @Path(value="/usage/template") TemplateUsageListResponse getTemplateUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="templates") @DefaultValue(value="true") boolean returnTemplates)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the nodereturnTemplates
- true (default) if the templates shall be returned, false for only returning the counts@GET @Path(value="/usage/image") FileUsageListResponse getImageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="images") @DefaultValue(value="true") boolean returnImages)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the nodereturnImages
- true (default) if the images shall be returned, false for only returning the counts@GET @Path(value="/usage/file") FileUsageListResponse getFileUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> imageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="files") @DefaultValue(value="true") boolean returnFiles)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".imageId
- list of image ids, for which the usage shall be fetchednodeId
- id of the nodereturnFiles
- true (default) if the files shall be returned, false for only returning the counts@POST @Path(value="/push2master/{id}") GenericResponse pushToMaster(@PathParam(value="id") Integer id, PushToMasterRequest request)
id
- id of the imagerequest
- request@GET @Path(value="/usage/syncableObjects") ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam(value="ids") List<Integer> imageIds, @QueryParam(value="srcNodeId") Integer srcNodeId, @QueryParam(value="dstNodeId") Integer dstNodeId)
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
.imageIds
- The IDs of the images to get linked objects forsrcNodeId
- The channel ID of the source channeldstNodeId
- The channel ID of the target channel@POST @Path(value="/push2master") GenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- request@POST @Path(value="/unlocalize/{id}") GenericResponse unlocalize(@PathParam(value="id") Integer id, UnlocalizeRequest request)
id
- id of the image to unlocalizerequest
- request@POST @Path(value="/unlocalize") GenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- request@POST @Path(value="/localize/{id}") GenericResponse localize(@PathParam(value="id") Integer id, LocalizeRequest request)
id
- id of the image to localizerequest
- request@GET @Path(value="/localizations/{id}") LocalizationsResponse localizations(@PathParam(value="id") Integer id)
id
- The ID of the master image.@GET @Path(value="/localizationinfo") LocalizationInfo getLocalizationInfo(@QueryParam(value="id") List<Integer> ids, @QueryParam(value="nodeId") Integer nodeId)
ids
- list of image idsnodeId
- id of the node to start with@GET @Path(value="/localizationinfo/{id}") LocalizationInfo getLocalizationInfo(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId)
id
- id of the image. The id can either be the local or global idnodeId
- id of the node to start with@GET @Path(value="/disinherit/{id}") DisinheritResponse disinherit(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId) throws Exception
id
- file IDnodeId
- node IDException
@POST @Path(value="/disinherit/{id}") GenericResponse disinherit(@PathParam(value="id") String id, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs, DisinheritRequest request) throws Exception
id
- file IDnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
@GET @Path(value="/disinherit") MultiDisinheritResponse disinherit(@QueryParam(value="id") List<String> ids, @QueryParam(value="nodeId") Integer nodeId) throws Exception
ids
- list of image IDsnodeId
- node IDException
@POST @Path(value="/disinherit") GenericResponse disinherit(@QueryParam(value="id") List<String> ids, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs, DisinheritRequest request) throws Exception
ids
- list of image IDsnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
Copyright © 2020 Gentics Software. All rights reserved.