/

/Studio Backend API

Changes Docs Sign in

Docs
History
Schema

Filter operations

Asset Grid9

Asset Thumbnails12

Assets41

get/pimcore-studio/api/assets/typesGet all asset types
delete/pimcore-studio/api/assets/batch-deleteBatch delete assets by IDs
post/pimcore-studio/api/assets/{id}/clone/{parentId}Clone a specific asset
get/pimcore-studio/api/assets/{id}/custom-settingsGet custom settings of an asset by ID
get/pimcore-studio/api/assets/{id}/textGet asset data in text UTF8 representation by ID
get/pimcore-studio/api/assets/{id}/document/download/customDownload custom document image by ID and configuration
get/pimcore-studio/api/assets/{id}/document/stream/customStream custom document image by ID and configuration
get/pimcore-studio/api/assets/{id}/document/stream/dynamicStream document image by ID and dynamic configuration
get/pimcore-studio/api/assets/{id}/document/stream/pdf-previewStream asset document PDF preview by ID
get/pimcore-studio/api/assets/{id}/document/download/thumbnail/{thumbnailName}Download document image by ID and thumbnail name
get/pimcore-studio/api/assets/{id}/document/stream/thumbnail/{thumbnailName}Stream document image by ID and thumbnail name
get/pimcore-studio/api/assets/download/zip/{jobRunId}Download ZIP archive for assets
delete/pimcore-studio/api/assets/download/zip/{jobRunId}Delete asset ZIP file based on jobRunId
get/pimcore-studio/api/assets/download/zip/{jobRunId}/availableCheck ZIP archive availability for job run id
get/pimcore-studio/api/assets/{id}/downloadDownload asset by ID
post/pimcore-studio/api/assets/export/zip/assetCreating ZIP file for assets
post/pimcore-studio/api/assets/export/zip/folderCreating ZIP file assets based on folder
get/pimcore-studio/api/assets/{id}Get asset by ID
put/pimcore-studio/api/assets/{id}Update an asset by ID
get/pimcore-studio/api/assets/{id}/image/download/customDownload custom image by ID and configuration
get/pimcore-studio/api/assets/{id}/image/stream/customStream custom image thumbnail by ID and configuration
get/pimcore-studio/api/assets/{id}/image/stream/dynamicStream image thumbnail by ID and dynamic configuration
get/pimcore-studio/api/assets/{id}/image/download/format/{format}Download image asset by ID and format
get/pimcore-studio/api/assets/{id}/image/stream/previewStream image asset preview by ID
get/pimcore-studio/api/assets/{id}/image/streamStream original image asset by ID
get/pimcore-studio/api/assets/{id}/image/download/thumbnail/{thumbnailName}Download image asset by ID and thumbnail name
get/pimcore-studio/api/assets/{id}/image/stream/thumbnail/{thumbnailName}Stream image asset by ID and thumbnail name
patch/pimcore-studio/api/assetsPatch assets by ID
patch/pimcore-studio/api/assets/folder/{id}Patch all assets based on folder ID and filters
delete/pimcore-studio/api/assets/{id}/thumbnail/clearClear image thumbnail by ID
get/pimcore-studio/api/assets/treeGet all asset data for the tree
post/pimcore-studio/api/assets/add/{parentId}Add a new asset
get/pimcore-studio/api/assets/exists/{parentId}Get information if asset already exists
post/pimcore-studio/api/assets/exists/{parentId}Get information which assets already exist
post/pimcore-studio/api/assets/{id}/replaceReplace existing asset binary
post/pimcore-studio/api/assets/add-zip/{parentId}Add new assets via ZIP archive
get/pimcore-studio/api/assets/{id}/video/stream/image-thumbnailStream video image thumbnail by ID and configuration
get/pimcore-studio/api/assets/{id}/video/download/{thumbnailName}Download video asset by ID and thumbnail name
get/pimcore-studio/api/assets/{id}/video/thumbnail/{thumbnailName}/statusGet video thumbnail conversion status by asset ID and thumbnail name
get/pimcore-studio/api/assets/{id}/video/stream/{thumbnailName}Stream video asset by ID and thumbnail name
get/pimcore-studio/api/assets/video/typesGet all video types

Authorization3

Bundle Application Logger4

Bundle Asset Metadata Class Definitions9

Bundle Backend Power Tools60

Bundle CMF53

Bundle Copilot37

Bundle Custom Reports11

Bundle Data Hub12

Bundle Data Hub File Export10

Bundle Data Hub Simple Rest6

Bundle Data Hub Webhooks3

Bundle Data Importer20

Bundle Data Quality Management4

Bundle Direct Edit5

Bundle Ecommerce26

Bundle Enterprise Subscription Tools1

Bundle Headless Documents17

Bundle OpenID Connect6

Bundle Personalization11

Bundle Portal Engine25

Bundle Seo12

Bundle Statistics Explorer3

Bundle Studio Dashboards18

Bundle Translations Provider Interfaces19

Bundle Web To Print10

Bundle Workflow Automation Integration5

Bundle Workflow Designer10

Cache3

Class Definition68

Classification Store29

Data Object Grid13

Data Objects13

Dependencies1

Documents28

E-Mails12

Elements14

Execution Engine3

Export10

GDPR Data Extractor3

Mercure1

Metadata6

Notes5

Notifications10

Ownership Management4

Perspectives11

Properties5

Recycle Bin4

Role Management12

Schedule5

Search14

Settings7

Settings Admin3

Tags5

Tags for Element4

Telemetry2

Translation11

Units9

User Management24

Versions9

Website Settings5

Workflows5

Assets

Changes to Patch all assets based on folder ID and filters

patch/pimcore-studio/api/assets/folder/{id}

Sep 2, 202681b097a1505f Revision changes
- info
  endpoint added