Images service API

Galleries

URL Method Params Description Example
api/galleries/list/{resourceType}/{resourceId} GET Get list of galleries for specified resource
Resource type:
Resource ID:
api/galleries/create POST resourceType - Resource type
resourceId - Resource ID
name - Gallery name
mainImageId - Main image ID (optional)
 Create gallery
Resource type:
Resource ID:
Name:
api/galleries/update/{id} POST name - Gallery name (optional)
mainImageId - Main image ID (optional)
 Update gallery
Gallery ID:
Name:
api/galleries/delete/{id} POST Delete gallery Gallery ID:
Delete

Images

URL Method Params Description Example
api/images/list/{resourceType}/{resourceId}/{galleryId} GET pipelineId - Pipeline ID (optional) Get all images for given resource.
galleryId is optional
Resource type:
Resource ID:
Gallery ID:
Pipeline ID:
api/images/image/{id} GET pipelineId - optional Get image info. If pipelineId is included, it will return all image sizes for that pipeline.
Image ID:
Pipeline ID:
api/images/exif/{id} GET Get image EXIF data (JPEG images only).
Image ID:
images/{pipelineId}/{size}/{imagePath} GET View resized image
Image path:
Pipeline ID:
Image size:
api/images/create POST imageUrl - Image URL
resourceType - Resource type
resourceId - Resource ID
galleryId - Gallery ID (optional)
 Create image from URL.
Image:
Gallery ID:
Resource type:
Resource ID:
api/images/upload POST resourceType - Resource type
resourceId - Resource ID
galleryId - Gallery ID (optional)
 Upload image for resource.
Image:
Gallery ID:
Resource type:
Resource ID:
api/images/main/{resourceType}/{resourceId} POST imageId - Image to set as main Set image as main (for parent resource)
Resource type:
Resource ID:
Image ID:
api/images/main/{resourceType}/{resourceId} GET Get main image for given resource
Resource type:
Resource ID:
Pipeline ID:
api/images/main_images POST resources - JSON list of resources [{resourceType:x,resourceId:y},{…}]
pipelineId - if specified, returns resized image urls
 Get main image for list of resources
Resources:
Pipeline ID:
api/images/delete/{id} POST Delete image
Image ID:
api/images/clear_cache/{pipelineId}/{size}
api/images/clear_cache/{pipelineId}
api/images/clear_cache 		POST Delete cached images
Allowed parameter combinations:
pipelineId + size - deletes images for specified pipeline and size
pipelineId - deletes all cached images for specified pipeline
(none) - deletes all cached images
Pipeline ID:
Image size:
api/images/clear/{resourceType}/{resourceId} POST Delete all images for given resource
Resource type:
Resource ID: