{"openapi":"3.1.0","info":{"title":"Studio Backend API","description":"API for Studio generated by OpenApi Generator via zircote\/swagger-php","license":{"name":"Pimcore Open Core License (POCL)","url":"https:\/\/github.com\/pimcore\/pimcore\/blob\/12.x\/LICENSE.md"},"version":"0.13.20"},"servers":[{"url":"\/","description":"Pimcore Studio Backend API"}],"paths":{"\/pimcore-studio\/api\/assets\/types":{"get":{"tags":["Assets"],"summary":"Get all asset types","description":"Retrieves all available asset types in the system.\n","operationId":"asset_get_types","responses":{"200":{"description":"Successfully retrieved all available asset types","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/AssetType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/batch-delete":{"delete":{"tags":["Assets"],"summary":"Batch delete assets by IDs","description":"Batch delete assets based on the given \u003Cstrong\u003E{ids}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{ids}\u003C\/strong\u003E must be a list of IDs of existing assets. \u003Cbr\u003E\nDeletion is done asynchronously and the jobRun ID is returned in the response\n","operationId":"asset_batch_delete","requestBody":{"content":{"application\/json":{"schema":{"properties":{"ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for batch delete","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/clone\/{parentId}":{"post":{"tags":["Assets"],"summary":"Clone a specific asset","description":"Clones a specific asset with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be a folder\n","operationId":"asset_clone","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}},{"name":"parentId","in":"path","description":"ParentId of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully copied asset"},"201":{"description":"Successfully copied parent asset and created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for copying child assets","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/custom-settings":{"get":{"tags":["Assets"],"summary":"Get custom settings of an asset by ID","description":"Retrieves custom settings based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset\n","operationId":"asset_custom_settings_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved custom settings as JSON","content":{"application\/json":{"schema":{"properties":{"items":{"$ref":"#\/components\/schemas\/CustomSettings"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/text":{"get":{"tags":["Assets"],"summary":"Get asset data in text UTF8 representation by ID","description":"Retrieves the text data in UTF8 representation of the asset based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset.\n","operationId":"asset_get_text_data_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved UTF8 encoded text data of asset","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"UTF 8 encoded text data","type":"string","example":"Test content"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/download\/custom":{"get":{"tags":["Assets"],"summary":"Download custom document image by ID and configuration","description":"Download the custom document image based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and configuration parameters. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document\n","operationId":"asset_document_download_custom","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":false,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}}],"responses":{"200":{"description":"Custom document image binary file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"image\/jpeg":{"schema":{"type":"string","format":"binary"}},"image\/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/stream\/custom":{"get":{"tags":["Assets"],"summary":"Stream custom document image by ID and configuration","description":"Stream the custom document image based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and configuration parameters. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document\n","operationId":"asset_document_stream_custom","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":false,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"Custom document image stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/jpeg":{"schema":{"type":"string","format":"binary"}},"image\/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/stream\/dynamic":{"get":{"tags":["Assets"],"summary":"Stream document image by ID and dynamic configuration","description":"Stream the custom image based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and dynamic config data. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document\n","operationId":"asset_document_stream_dynamic","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"config","in":"query","description":"A JSON encoded thumbnail configuration.","required":true,"schema":{"type":"string","example":"{\u0022alt\u0022: \u0022\u0022,\u0022cropPercent\u0022: false,\u0022cropWidth\u0022: 0,\u0022cropHeight\u0022: 0,\u0022cropTop\u0022: 0,\u0022cropLeft\u0022: 0,\u0022thumbnail\u0022: {\u0022width\u0022: 200,\u0022height\u0022: 200,\u0022interlace\u0022: true,\u0022quality\u0022: 90}}"}}],"responses":{"200":{"description":"Document image stream based on dynamic thumbnail configuration","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/stream\/pdf-preview":{"get":{"tags":["Assets"],"summary":"Stream asset document PDF preview by ID","description":"Stream asset document PDF preview based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document\n","operationId":"asset_document_stream_preview","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Asset PDF preview stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"202 - Not Completed\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/download\/thumbnail\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Download document image by ID and thumbnail name","description":"Download the asset document based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document \u003Cbr\u003E\nList of downloadable \u003Cb\u003Ethumbnail names\u003C\/b\u003E can be obtained via the thumbnail image collection endpoint\n","operationId":"asset_document_download_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}}],"responses":{"200":{"description":"Document image binary file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/document\/stream\/thumbnail\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Stream document image by ID and thumbnail name","description":"Stream the asset document based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset document\n","operationId":"asset_document_stream_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"Stream of document image","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"application\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/download\/zip\/{jobRunId}":{"get":{"tags":["Assets"],"summary":"Download ZIP archive for assets","description":"Download the ZIP archive with assets based on the given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create zip endpoint\n","operationId":"asset_download_zip","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"ZIP archive as attachment","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/zip":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Assets"],"summary":"Delete asset ZIP file based on jobRunId","description":"Delete the ZIP file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create zip endpoint\n","operationId":"asset_delete_zip","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/download":{"get":{"tags":["Assets"],"summary":"Download asset by ID","description":"Download the original asset stream based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"asset_download_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Original asset binary file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/export\/zip\/asset":{"post":{"tags":["Assets"],"summary":"Creating ZIP file for assets","description":"Creating a ZIP file for assets based on the provided asset IDs in \u003Cstrong\u003E{assets}\u003C\/strong\u003E parameter. \u003Cbr\u003E\nDownload has to be triggered separately via the zip download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"asset_export_zip_asset","requestBody":{"content":{"application\/json":{"schema":{"properties":{"assets":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for zip export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E413 - Max File Size Exceeded\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/export\/zip\/folder":{"post":{"tags":["Assets"],"summary":"Creating ZIP file assets based on folder","description":"Creating a ZIP file for assets based on the provided folder IDs in \u003Cstrong\u003E{folders}\u003C\/strong\u003E parameter. \u003Cbr\u003E\nFilter assets from folder based on the grid filter schema. \u003Cbr\u003E\nDownload has to be triggered separately via the zip download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"asset_export_zip_folder","requestBody":{"content":{"application\/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[83]},"filters":{"$ref":"#\/components\/schemas\/ExportAllFilter"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for zip export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E413 - Max File Size Exceeded\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}":{"get":{"tags":["Assets"],"summary":"Get asset by ID","description":"Retrieves a specific asset data based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset.\n","operationId":"asset_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved one of asset type data as JSON","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/Image"},{"$ref":"#\/components\/schemas\/AssetDocument"},{"$ref":"#\/components\/schemas\/Audio"},{"$ref":"#\/components\/schemas\/Video"},{"$ref":"#\/components\/schemas\/Archive"},{"$ref":"#\/components\/schemas\/Text"},{"$ref":"#\/components\/schemas\/AssetFolder"},{"$ref":"#\/components\/schemas\/Unknown"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Assets"],"summary":"Update an asset by ID","description":"Update needs to have the complete data present. \u003Cbr\u003E You can create\/update\/delete list entries like metadata, custom settings and properties. \u003Cbr\u003E  E.g. if you want to remove an entry from metadata simply do not include this entry in the update. \u003Cbr\u003E  If you want to update only a single field, use the PATCH method.\n","operationId":"asset_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"data":{"type":["string","null"]},"dataUri":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/UpdateCustomMetadata"}},"customSettings":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/UpdateCustomSettings"}},"properties":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"}},"image":{"oneOf":[{"$ref":"#\/components\/schemas\/ImageData"},{"type":"null"}],"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"One of asset types","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/Image"},{"$ref":"#\/components\/schemas\/AssetDocument"},{"$ref":"#\/components\/schemas\/Audio"},{"$ref":"#\/components\/schemas\/Video"},{"$ref":"#\/components\/schemas\/Archive"},{"$ref":"#\/components\/schemas\/Text"},{"$ref":"#\/components\/schemas\/AssetFolder"},{"$ref":"#\/components\/schemas\/Unknown"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/{configurationId}\/delete":{"delete":{"tags":["Asset Grid"],"summary":"Delete grid configuration for a specific folder and given configuration ID","description":"Delete grid configuration for a specific folder and given configuration ID \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E\n","operationId":"asset_delete_grid_configuration_by_configurationId","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/available-columns":{"get":{"tags":["Asset Grid"],"summary":"Get available grid column configurations","description":"Get all available grid columns for assets\n","operationId":"asset_get_available_grid_columns","responses":{"200":{"description":"All available grid column configurations for assets","content":{"application\/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/{folderId}":{"get":{"tags":["Asset Grid"],"summary":"Get asset grid configuration for a specific folder","description":"Get asset saved grid configuration by \u003Cstrong\u003E{folderId}\u003C\/strong\u003E if a configuration-id is set, otherwise get the default configuration will be returned.\n","operationId":"asset_get_grid_configuration_by_folderId","parameters":[{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"configurationId","in":"query","description":"Configuration ID","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Asset grid configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configurations":{"get":{"tags":["Asset Grid"],"summary":"Get all saved grid configurations for assets of the given folder","description":"Get all saved grid configurations for assets of the given folder for the current user and shared configurations for this user\n","operationId":"asset_get_saved_grid_configurations","responses":{"200":{"description":"List of saved grid configurations for the given folder","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Configuration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/save":{"post":{"tags":["Asset Grid"],"summary":"Save asset grid configuration for a specific folder\n","description":"Save asset grid configuration for a specific folder\n","operationId":"asset_save_grid_configuration","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnSchema"}},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Asset grid configuration saved successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Configuration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/set-as-favorite\/{configurationId}\/{folderId}":{"post":{"tags":["Asset Grid"],"summary":"Set asset grid configuration as favorite for a specific folder","description":"Set asset grid configuration as favorite for the current user for a specific folder\n","operationId":"asset_set_grid_configuration_as_favorite","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}},{"name":"folderId","in":"path","description":"FolderId of the folderId","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"asset_set_grid_configuration_as_favorite_response"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/update\/{configurationId}":{"put":{"tags":["Asset Grid"],"summary":"Update asset grid configuration for a specific folder","description":"Update asset grid configuration for a specific folder and given configuration ID \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E\n","operationId":"asset_update_grid_configuration","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnSchema"}},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Asset grid configuration updated successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid":{"post":{"tags":["Asset Grid"],"summary":"Get asset data for grid","description":"Retrieve assets data for grid. \u003Cbr\u003E\nYou can use different query parameters to filter the asset data: \u003Cbr\u003E\n\u003Cul\u003E\n\u003Cli\u003E\u003Cstrong\u003EfolderId\u003C\/strong\u003E: ID of parent folder\u003C\/li\u003E\n\u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: To see the full description of request fields see the schema \u003Cstrong\u003EGrid Column Request\u003C\/strong\u003E\u003C\/li\u003E\n\u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: To see the full description of request fields see the schema \u003Cstrong\u003EGrid Filter\u003C\/strong\u003E\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"asset_get_grid","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId"],"properties":{"folderId":{"type":"integer","example":1},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"Asset grid data","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#\/components\/schemas\/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/download\/custom":{"get":{"tags":["Assets"],"summary":"Download custom image by ID and configuration","description":"Download the custom image based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and configuration parameters. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_download_custom","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":true,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}}],"responses":{"200":{"description":"Custom image binary file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"image\/jpeg":{"schema":{"type":"string","format":"binary"}},"image\/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/stream\/custom":{"get":{"tags":["Assets"],"summary":"Stream custom image thumbnail by ID and configuration","description":"Stream image asset thumbnail based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and configuration parameters. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_stream_custom","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"PNG"}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":true,"schema":{"type":"string","enum":["scaleByHeight","scaleByWidth","resize","none"],"example":"none"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":85}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":72}},{"name":"contain","in":"query","description":"Contain","required":false,"schema":{"type":"boolean","example":false}},{"name":"frame","in":"query","description":"Frame","required":false,"schema":{"type":"boolean","example":false}},{"name":"cover","in":"query","description":"Cover","required":false,"schema":{"type":"boolean","example":false}},{"name":"forceResize","in":"query","description":"Force resize","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"Image asset stream based on custom thumbnail configuration","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/stream\/dynamic":{"get":{"tags":["Assets"],"summary":"Stream image thumbnail by ID and dynamic configuration","description":"Stream image asset thumbnail based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and dynamic config data. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_stream_dynamic","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}},{"name":"config","in":"query","description":"A JSON encoded thumbnail configuration.","required":true,"schema":{"type":"string","example":"{\u0022alt\u0022: \u0022\u0022,\u0022cropPercent\u0022: false,\u0022cropWidth\u0022: 0,\u0022cropHeight\u0022: 0,\u0022cropTop\u0022: 0,\u0022cropLeft\u0022: 0,\u0022thumbnail\u0022: {\u0022width\u0022: 200,\u0022height\u0022: 200,\u0022interlace\u0022: true,\u0022quality\u0022: 90}}"}}],"responses":{"200":{"description":"Image asset stream based on dynamic thumbnail configuration","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/download\/format\/{format}":{"get":{"tags":["Assets"],"summary":"Download image asset by ID and format","description":"asset_image_download_by_format_description","operationId":"asset_image_download_by_format","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"format","in":"path","description":"Find asset by matching format type.","required":true,"schema":{"type":"string","enum":["office","print","web"],"example":"web"}}],"responses":{"200":{"description":"Image asset binary file based on format","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"image\/jpeg":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/stream\/preview":{"get":{"tags":["Assets"],"summary":"Stream image asset preview by ID","description":"Stream image asset preview based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_stream_preview","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Image preview stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/stream":{"get":{"tags":["Assets"],"summary":"Stream original image asset by ID","description":"Stream original image asset based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_stream","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Stream of an original image asset","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/download\/thumbnail\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Download image asset by ID and thumbnail name","description":"Download the image asset based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image \u003Cbr\u003E\nList of downloadable \u003Cb\u003Ethumbnail names\u003C\/b\u003E can be obtained via the thumbnail image collection endpoint\n","operationId":"asset_image_download_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}}],"responses":{"200":{"description":"Image asset binary file based on thumbnail name","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/image\/stream\/thumbnail\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Stream image asset by ID and thumbnail name","description":"Stream the image asset based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset image\n","operationId":"asset_image_stream_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"mimeType","in":"query","description":"Mime type of steamed image.","required":false,"schema":{"type":"string","enum":["JPEG","PNG","source","original","print"],"example":"JPEG"}}],"responses":{"200":{"description":"Stream of image asset based on thumbnail name","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets":{"patch":{"tags":["Assets"],"summary":"Patch assets by ID","description":"Patching assets based on the given ID and data. \u003Cbr\u003E Patching can be used for updating single or multiple fields. \u003Cbr\u003E If single element is being patched, operation is executed synchronously. Multiple elements are patched asynchronously.\n","operationId":"asset_patch_by_id","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["id"],"properties":{"id":{"description":"Asset ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"}}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully patched asset"},"201":{"description":"Successfully created jobRun for patching multiple assets","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/folder":{"patch":{"tags":["Assets"],"summary":"Patch all assets based on folder ID and filters","description":"Patching assets based on the given folder ID and data. \u003Cbr\u003E Patching on folders will be done asynchronously. \u003Cbr\u003E\nYou can also use filters and sorting. Filter assets from folder based on the grid filter schema\n","operationId":"asset_patch_folder_by_id","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["folderId"],"properties":{"folderId":{"description":"Folder ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"}}},"type":"object"}},"filters":{"$ref":"#\/components\/schemas\/ExportAllFilter"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created jobRun for patching multiple assets","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/thumbnail\/clear":{"delete":{"tags":["Assets"],"summary":"Clear image thumbnail by ID","description":"Clear the image thumbnail based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing asset image, video or pdf\n","operationId":"asset_clear_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/tree":{"get":{"tags":["Assets"],"summary":"Get all asset data for the tree","description":"Listing of all assets and asset folders in the system. \u003Cbr\u003E\nReturns only data which are relevant for the tree \u003Cbr\u003E\nYou can use different query parameters to filter the assets and it is possible to exclude folders from the result completely\n","operationId":"asset_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter assets by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"id = 69"}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"\/path\/to\/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"asset_get_tree_success_description","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/Image"},{"$ref":"#\/components\/schemas\/AssetDocument"},{"$ref":"#\/components\/schemas\/Audio"},{"$ref":"#\/components\/schemas\/Video"},{"$ref":"#\/components\/schemas\/Archive"},{"$ref":"#\/components\/schemas\/Text"},{"$ref":"#\/components\/schemas\/AssetFolder"},{"$ref":"#\/components\/schemas\/Unknown"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/add\/{parentId}":{"post":{"tags":["Assets"],"summary":"Add a new asset","description":"Add a new asset based on the binary \u003Cstrong\u003E{file}\u003C\/strong\u003E to the given \u003Cstrong\u003E{parentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be an ID of existing folder.\n","operationId":"asset_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"File to upload","type":"string","format":"binary"},"assetType":{"description":"Type of the asset to create","type":["string","null"]}},"type":"object"}}}},"responses":{"200":{"description":"ID of successfully uploaded new asset","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of created asset","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/exists\/{parentId}":{"get":{"tags":["Assets"],"summary":"Get information if asset already exists","description":"Get information if asset already exists based on the given \u003Cstrong\u003E{parentId}\u003C\/strong\u003E and \u003Cstrong\u003E{fileName}\u003C\/strong\u003E query parameter.\n","operationId":"asset_upload_info","parameters":[{"name":"parentId","in":"path","description":"ParentId of the asset","required":true,"schema":{"type":"integer","example":83}},{"name":"fileName","in":"query","description":"Name of the file to upload","required":true,"schema":{"type":"string","example":"file.jpg"}}],"responses":{"200":{"description":"Returns true and existing asset ID, if asset with the same name and in the same path already exists, false otherwise","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AssetUploadInfo"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/replace":{"post":{"tags":["Assets"],"summary":"Replace existing asset binary","description":"Replace the existing asset binary based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E with the provided {file} binary. \u003Cbr\u003E \nThe new asset binary mime type must be the same as the existing asset binary mime type.\n","operationId":"asset_replace","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"File to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"File name of the successfully replaced asset","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"new file name of the asset","type":"string","example":"image.jpg"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/add-zip\/{parentId}":{"post":{"tags":["Assets"],"summary":"Add new assets via ZIP archive","description":"Upload a ZIP archive with assets to the given \u003Cstrong\u003E{parentId}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be an ID of existing folder.\nZip archive is extracted and assets are uploaded on the background. \u003Cbr\u003E The jobRun ID is returned in the response\n","operationId":"asset_upload_zip","parameters":[{"name":"parentId","in":"path","description":"ParentId of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["zipFile"],"properties":{"zipFile":{"description":"Zip file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created jobRun ID to upload multiple assets","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/video\/stream\/image-thumbnail":{"get":{"tags":["Assets"],"summary":"Stream video image thumbnail by ID and configuration","description":"Stream the video image thumbnail based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and configuration parameters. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset video \u003Cbr\u003E\n","operationId":"asset_video_image_thumbnail_stream","parameters":[{"name":"id","in":"path","description":"Id of the video","required":true,"schema":{"type":"integer","example":83}},{"name":"width","in":"query","description":"Width of the video image thumbnail","schema":{"type":"integer","example":265}},{"name":"height","in":"query","description":"Height of the video image thumbnail","schema":{"type":"integer","example":265}},{"name":"aspectRatio","in":"query","description":"Aspect ratio of the video image thumbnail","required":false,"schema":{"type":"boolean","example":false}},{"name":"frame","in":"query","description":"Frame of the video image thumbnail","required":false,"schema":{"type":"boolean","example":false}},{"name":"async","in":"query","description":"Generate the asset asynchronously","schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"Video image thumbnail stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/video\/download\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Download video asset by ID and thumbnail name","description":"Download the video asset based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset video \u003Cbr\u003E\nList of \u003Cb\u003Ethumbnail names\u003C\/b\u003E can be obtained via the thumbnail video collection endpoint\n","operationId":"asset_video_download_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the video","required":true,"schema":{"type":"integer","example":83}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}}],"responses":{"200":{"description":"Video binary file based on thumbnail name","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"video\/mp4":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/video\/stream\/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"Stream video asset by ID and thumbnail name","description":"Stream the video asset based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{thumbnailName}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset video \u003Cbr\u003E\nList of \u003Cb\u003Ethumbnail names\u003C\/b\u003E can be obtained via the thumbnail video collection endpoint\n","operationId":"asset_video_stream_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the video","required":true,"schema":{"type":"integer","example":83}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}}],"responses":{"200":{"description":"Video stream based on thumbnail name","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"video\/mp4":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/video\/types":{"get":{"tags":["Assets"],"summary":"Get all video types","description":"Retrieves all available video types in the system.\n","operationId":"asset_get_video_types","responses":{"200":{"description":"Successfully retrieved all available video types","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/VideoType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/login":{"post":{"tags":["Authorization"],"summary":"Session-based login with user credentials.","description":"Logs in a user with the provided credentials and returns the user information.","operationId":"login","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Credentials"}}}},"responses":{"200":{"description":"Login successful."},"401":{"description":"Invalid credentials Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidCredentials"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/logout":{"post":{"tags":["Authorization"],"summary":"Logout and invalidate current session for active user.","description":"Logout and invalidate current session for active user.","operationId":"logout","responses":{"200":{"description":"Logout successful."}}}},"\/pimcore-studio\/api\/login\/token":{"post":{"tags":["Authorization"],"summary":"Session-based login with user token.","description":"Logs in a user based on the provided token and returns the user information.\n","operationId":"login_token","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AuthenticationToken"}}}},"responses":{"200":{"description":"Login successful."},"401":{"description":"Invalid credentials Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidCredentials"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/application-logger\/list":{"post":{"tags":["Bundle Application Logger"],"summary":"Get all log entries","description":"Get all paginated log entries. \u003Cbr\u003E \nYou can specify different filters in your request body. Available filters are: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\n    \u003Cstrong\u003Elike and equals\u003C\/strong\u003E: Filter by key and value. Allowed keys:\n    \u003Cul\u003E\n      \u003Cli\u003E\u003Cstrong\u003Epriority\u003C\/strong\u003E\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003Ecomponent\u003C\/strong\u003E\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003Erelatedobject\u003C\/strong\u003E\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003Emessage\u003C\/strong\u003E\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003Epid\u003C\/strong\u003E\u003C\/li\u003E\n    \u003C\/ul\u003E\n  \u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EdateFrom and dateTo\u003C\/strong\u003E: Filter by date (from, to)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the pageSize\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"bundle_application_logger_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022dateFrom\u0022,\u0022type\u0022:\u0022date\u0022,\u0022filterValue\u0022:{\u0022operator\u0022: \u0022from\u0022, \u0022value\u0022: \u00222025-06-25T10:00:00+02:00\u0022}},{\u0022key\u0022:\u0022dateTo\u0022,\u0022type\u0022:\u0022date\u0022,\u0022filterValue\u0022:{\u0022operator\u0022: \u0022to\u0022, \u0022value\u0022: \u00222025-06-30T24:00:00+02:00\u0022}},{\u0022key\u0022:\u0022priority\u0022, \u0022type\u0022:\u0022equals\u0022, \u0022filterValue\u0022: 2},{\u0022key\u0022:\u0022pid\u0022, \u0022type\u0022:\u0022like\u0022, \u0022filterValue\u0022: 44}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022id\u0022, \u0022direction\u0022:\u0022DESC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated log entries with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleApplicationLoggerLogEntry"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/application-logger\/components":{"get":{"tags":["Bundle Application Logger"],"summary":"List application logger components","description":"List all available components used for filtering for the application logger.\n","operationId":"bundle_application_logger_list_components","responses":{"200":{"description":"List of available components","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"title":"Components","description":"Log components used in the ApplicationLogger.","type":"array","items":{"type":"string","example":"application"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/application-logger\/priorities":{"get":{"tags":["Bundle Application Logger"],"summary":"List application logger priorities","description":"List all available priorities for the application logger.\n","operationId":"bundle_application_logger_list_priorities","responses":{"200":{"description":"List of available priorities","content":{"application\/json":{"schema":{"required":["priorities"],"properties":{"priorities":{"title":"Log priority levels","description":"Log priority levels used in the ApplicationLogger.","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/drill-down-options":{"post":{"tags":["Bundle Custom Reports"],"summary":"Get all drill down options for a specific report by name and field","description":"Get all drill down options for a specific report by name and field. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing report and \u003Cstrong\u003E{field}\u003C\/strong\u003E must be a field of the report.\nIt is possible to use the \u003Cstrong\u003Efilters\u003C\/strong\u003E to further narrow down the options.\n","operationId":"custom_reports_list_drill_down_options","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name","field"],"properties":{"name":{"type":["string","null"]},"field":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\u0022property\u0022: \u0022count(*)\u0022, \u0022type\u0022:\u0022numeric\u0022,\u0022operator\u0022:\u0022lt\u0022,\u0022value\u0022:\u002215\u0022}]"},"drillDownFilters":{"type":"object","example":"{\u0022field\u0022:\u0022value\u0022,\u0022anotherField\u0022:\u0022anotherValue\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"List of drill down options for the report","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsDrillDownOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/chart":{"post":{"tags":["Bundle Custom Reports"],"summary":"Get chart data for a specific report","description":"Get paginated chart data for a specific report by name. \u003Cbr\u003E Parameters are: \n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ename (required)\u003C\/strong\u003E: Name of existing custom report\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: Array of filters to filter the data\u003C\/li\u003E\n    \u003Cul\u003E\n      \u003Cli\u003E\u003Cstrong\u003EcolumnFilters\u003C\/strong\u003E: Allow filtering based on the columns and their values\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003EdrillDownFilters\u003C\/strong\u003E: Filter based on pre-defined drill down filters\u003C\/li\u003E\n    \u003C\/ul\u003E\n  \u003Cli\u003E\u003Cstrong\u003EsortBy\u003C\/strong\u003E: Column name to sort the data by\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EsortOrder\u003C\/strong\u003E: Sort order (ASC\/DESC)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Offset, can be used in combination with pageSize\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Limit returned data\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efields\u003C\/strong\u003E: Array of fields to be included in the data. If not provided, all fields will be included\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"custom_reports_chart","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\u0022property\u0022: \u0022count(*)\u0022, \u0022type\u0022:\u0022numeric\u0022,\u0022operator\u0022:\u0022lt\u0022,\u0022value\u0022:\u002215\u0022}]"},"drillDownFilters":{"type":"object","example":"{\u0022field\u0022:\u0022value\u0022,\u0022anotherField\u0022:\u0022anotherValue\u0022}"}},"type":"object"},"sortBy":{"description":"Sort by field.","type":"string","example":"id"},"sortOrder":{"description":"Sort order (ASC or DESC).","type":"string","example":"DESC"},"page":{"description":"Page of the report data","type":"integer","minimum":1,"example":1},"pageSize":{"description":"Page size of the report data","type":"integer","minimum":1,"example":"50"},"fields":{"description":"Fields to be included in the chart data. If not provided, all fields will be included.","type":"array","items":{"type":"string","example":"field1"}}},"type":"object"}}}},"responses":{"200":{"description":"Chart data as JSON. The actual data depends on the selected adapter in the report configuration.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsChartData"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/config\/add":{"post":{"tags":["Bundle Custom Reports"],"summary":"Add a new custom reports configuration","description":"Add a new custom reports configuration with the provided name.\n","operationId":"custom_reports_config_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportAdd"}}}},"responses":{"200":{"description":"Successfully added custom report configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/config\/clone\/{name}":{"post":{"tags":["Bundle Custom Reports"],"summary":"Clone an existing custom reports configuration","description":"Clone an existing custom reports configuration with the provided new name by existing report name \u003Cstrong\u003E{reportName}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{reportName}\u003C\/strong\u003E must be a name of an existing custom report. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E of the new report must be a unique valid name.\n","operationId":"custom_reports_config_clone","parameters":[{"name":"name","in":"path","description":"Name of the report to clone","required":true,"schema":{"type":"string","example":"myOriginalReport"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportClone"}}}},"responses":{"200":{"description":"Successfully cloned custom report configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/column-config\/{name}":{"post":{"tags":["Bundle Custom Reports"],"summary":"Get all available column configurations for custom report","description":"Get all available column configurations for custom report by \u003Cstrong\u003E{name}\u003C\/strong\u003E and \u003Cstrong\u003E{configuration}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing custom report and \u003Cstrong\u003E{configuration}\u003C\/strong\u003E must be a valid data source configuration of that report.\n","operationId":"custom_reports_column_config_list","parameters":[{"name":"name","in":"path","description":"Name of the report","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportsDataSourceConfig"}}}},"responses":{"200":{"description":"List of column configurations for the custom report","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsColumnInformation"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/config\/{name}":{"put":{"tags":["Bundle Custom Reports"],"summary":"Update an existing custom reports configuration","description":"Update an existing custom reports configuration with the provided name and parameters. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing custom report. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"custom_reports_config_update","parameters":[{"name":"name","in":"path","description":"Name of the report","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportUpdate"}}}},"responses":{"200":{"description":"Successfully updated custom report configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Custom Reports"],"summary":"Delete a custom reports configuration","description":"Delete a custom reports configuration with the given \u003Cstrong\u003E{name}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing custom report.\n","operationId":"custom_reports_config_delete","parameters":[{"name":"name","in":"path","description":"Name of the custom report to delete","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"responses":{"200":{"description":"Successfully deleted custom report configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/report\/{name}":{"get":{"tags":["Bundle Custom Reports"],"summary":"Get detailed configuration for a specific report by name","operationId":"custom_reports_report","parameters":[{"name":"name","in":"path","description":"Name of the report","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"responses":{"200":{"description":"Report data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/tree\/config":{"get":{"tags":["Bundle Custom Reports"],"summary":"All reports for the current user to display in configuration tree.","description":"Get all reports for the current user to display in configuration tree.","operationId":"custom_reports_config_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"Get all reports for the current user to display in configuration tree.","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsConfigurationTreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/export\/csv":{"post":{"tags":["Bundle Custom Reports"],"summary":"Export report data as CSV","description":"Creating the CSV export file for custom reports. \u003Cbr\u003E Parameters are: \n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ename (required)\u003C\/strong\u003E: Name of custom report\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: Array of filters to filter the data\u003C\/li\u003E\n    \u003Cul\u003E\n      \u003Cli\u003E\u003Cstrong\u003EcolumnFilters\u003C\/strong\u003E: Allow filtering based on the columns and their values\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003EdrillDownFilters\u003C\/strong\u003E: Filter based on pre-defined drill down filters\u003C\/li\u003E\n    \u003C\/ul\u003E\n  \u003Cli\u003E\u003Cstrong\u003EsortBy\u003C\/strong\u003E: Column name to sort the data by\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EsortOrder\u003C\/strong\u003E: Sort order (ASC\/DESC)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Offset, can be used in combination with pageSize\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Limit returned data\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EincludeHeaders\u003C\/strong\u003E: Include headers in the export\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Edelimiter\u003C\/strong\u003E: Delimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E\/li\u003E\n\u003C\/ul\u003E\nDownload has to be triggered separately via the csv download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"custom_report_export_csv","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\u0022property\u0022: \u0022count(*)\u0022, \u0022type\u0022:\u0022numeric\u0022,\u0022operator\u0022:\u0022lt\u0022,\u0022value\u0022:\u002215\u0022}]"},"drillDownFilters":{"type":"object","example":"{\u0022field\u0022:\u0022value\u0022,\u0022anotherField\u0022:\u0022anotherValue\u0022}"}},"type":"object"},"sortBy":{"description":"Sort by field.","type":"string","example":"id"},"sortOrder":{"description":"Sort order (ASC or DESC).","type":"string","example":"DESC"},"page":{"description":"Page of the report data","type":"integer","minimum":1,"example":1},"pageSize":{"description":"Page size of the report data","type":"integer","minimum":1,"example":"50"},"includeHeaders":{"type":"boolean","example":false},"delimiter":{"type":"string","example":";"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for csv export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/custom-reports\/tree":{"get":{"tags":["Bundle Custom Reports"],"summary":"All reports for the current user to display in tree.","description":"Get all reports for the current user to display in tree.","operationId":"custom_reports_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"Get all reports for the current user to display in tree.","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsTreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/add":{"post":{"tags":["Bundle Seo"],"summary":"Add a new redirect","description":"Add a new redirect entry. \u003Cbr\u003E See the full description of request fields with the schema \u003Cstrong\u003EBundleSeoRedirectAdd\u003C\/strong\u003E\n","operationId":"bundle_seo_redirect_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleSeoRedirectAdd"}}}},"responses":{"200":{"description":"New redirect data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleSeoRedirect"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/cleanup":{"delete":{"tags":["Bundle Seo"],"summary":"Cleanup expired redirects","description":"Cleanup all expired redirects. \u003Cbr\u003E This will delete all redirects which are expired based on the \u003Cstrong\u003Eexpiry\u003C\/strong\u003E field.\n","operationId":"bundle_seo_redirect_cleanup","responses":{"200":{"description":"Successfully cleaned up expired redirects"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects":{"post":{"tags":["Bundle Seo"],"summary":"Get all redirects","description":"Get all paginated redirects entries. \u003Cbr\u003E You can specify different filters in your request body. Example filters are: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the page.size\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eurl\u003C\/strong\u003E: Filter by redirect source URL\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Etype\u003C\/strong\u003E: Filter by redirect type (entire_uri, path_query, path, auto_create)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Edate\u003C\/strong\u003E: Filter for example by expiry (on, from, to)\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"bundle_seo_redirects_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022type\u0022:\u0022search\u0022, \u0022filterValue\u0022: \u0022https:\/\/www.some-site\/old-url\u0022},{\u0022key\u0022:\u0022source\u0022, \u0022type\u0022:\u0022url\u0022, \u0022filterValue\u0022: \u0022https:\/\/www.some-example\u0022},{\u0022key\u0022:\u0022source\u0022, \u0022type\u0022:\u0022like\u0022, \u0022filterValue\u0022: \u0022en\/news\u0022},{\u0022key\u0022:\u0022target\u0022, \u0022type\u0022:\u0022equals\u0022, \u0022filterValue\u0022: \u0022en\/news\/new\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022priority\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated redirects with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleSeoRedirect"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/{id}":{"put":{"tags":["Bundle Seo"],"summary":"Update a redirect by ID","description":"Update the redirect with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing redirect. \u003Cbr\u003E\nSee the full description of updatable fields with the schema \u003Cstrong\u003EBundleSeoRedirectUpdate\u003C\/strong\u003E \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"bundle_seo_redirect_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the redirect","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleSeoRedirectUpdate"}}}},"responses":{"200":{"description":"Successfully updated redirect","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleSeoRedirect"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Seo"],"summary":"Delete a redirect by ID","description":"Delete the redirect with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing redirect.\n","operationId":"bundle_seo_redirect_delete","parameters":[{"name":"id","in":"path","description":"Id of the redirect","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted redirect"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/export":{"get":{"tags":["Bundle Seo"],"summary":"Export all redirects as CSV","description":"Export all redirects as CSV file.\n","operationId":"bundle_seo_redirects_export","responses":{"200":{"description":"CSV file with redirects as attachment","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022redirects.csv\u0022"}}},"content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/import":{"post":{"tags":["Bundle Seo"],"summary":"Import redirects from CSV","description":"Import all redirects using a previously exported a CSV file.\n","operationId":"bundle_seo_redirects_import","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Import statistics data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleSeoRedirectImportStats"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/priorities":{"get":{"tags":["Bundle Seo"],"summary":"List redirect priorities","description":"List all available priorities for the redirects. Priority 1 is the lowest, 10 highest and 99 is to overwrite all other redirects.\n","operationId":"bundle_seo_redirect_list_priorities","responses":{"200":{"description":"List of available redirect priorities","content":{"application\/json":{"schema":{"required":["priorities"],"properties":{"priorities":{"title":"Redirect priority","description":"Redirect priority used in the PimcoreSeoBundle.","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/statuses":{"get":{"tags":["Bundle Seo"],"summary":"List redirect statuses","description":"List all available statuses for the redirects.\n","operationId":"bundle_seo_redirect_list_statuses","responses":{"200":{"description":"List of available redirect statuses","content":{"application\/json":{"schema":{"required":["statuses"],"properties":{"statuses":{"title":"Redirect statuses","description":"List of redirect statuses used in the PimcoreSeoBundle.","type":"array","items":{"$ref":"#\/components\/schemas\/BundleSeoRedirectStatus"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/seo\/redirects\/types":{"get":{"tags":["Bundle Seo"],"summary":"List redirect types","description":"List all available types for the redirects.\n","operationId":"bundle_seo_redirect_list_types","responses":{"200":{"description":"List of available redirect types","content":{"application\/json":{"schema":{"required":["types"],"properties":{"types":{"title":"Redirect types","description":"List of redirect types used in the PimcoreSeoBundle.","type":"array","items":{"type":"string","example":"path"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/available-visible-fields":{"get":{"tags":["Class Definition"],"summary":"Get available visible fields for classes","description":"Get available visible fields for the specified data object classes. \u003Cbr\u003E\nReturns system columns and common fields across all provided class names. \u003Cbr\u003E\nThe \u003Cstrong\u003E{classNames}\u003C\/strong\u003E must be a comma separated list of existing data object class names.\n","operationId":"class_get_available_visible_fields","parameters":[{"name":"classNames","in":"query","description":"Comma-separated list of class names","required":false,"schema":{"type":"string","example":"Car,Manufacturer,News"}}],"responses":{"200":{"description":"Successfully retrieved available visible fields","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/AvailableVisibleField"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/collection":{"get":{"tags":["Class Definition"],"summary":"Get class definitions collection","description":"Get collection of all class definitions","operationId":"class_definition_collection","responses":{"200":{"description":"List of class definitions","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ClassDefinitionList"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/collection\/creatable":{"get":{"tags":["Class Definition"],"summary":"Get collection of all class definitions that can be created.","description":"Get collection of all class definitions that can be created.","operationId":"class_definition_collection_creatable","responses":{"200":{"description":"List of class definitions that can be created.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ClassDefinitionList"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/collection\/{dataObjectClass}":{"get":{"tags":["Class Definition"],"summary":"Get custom layout collection for data object class","description":"Get custom layout collection for the given data object class.","operationId":"class_custom_layout_collection","parameters":[{"name":"dataObjectClass","in":"path","description":"Data object class","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"List of custom layouts for the given data object class in a simple and compact format for listings.\n","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/CustomLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/all-layouts":{"get":{"tags":["Class Definition"],"summary":"Get all available class layouts","description":"Get all available layouts for classes.\n","operationId":"class_all_layout_collection","responses":{"200":{"description":"List of all available class layouts","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ClassLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/{customLayoutId}":{"get":{"tags":["Class Definition"],"summary":"Get custom layout by given id","description":"Get custom layout by given id","operationId":"pimcore_studio_api_class_custom_layout_get","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"Custom layout data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Class Definition"],"summary":"Update custom layout by given ID","description":"Update custom layout by the given \u003Cstrong\u003E{customLayoutId}\u003C\/strong\u003E and parameters. \u003Cbr\u003E\nThe \u003Cstrong\u003E{customLayoutId}\u003C\/strong\u003E must be an ID of an existing custom layout. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"pimcore_studio_api_class_custom_layout_update","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayoutUpdate"}}}},"responses":{"200":{"description":"Custom layout updated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Class Definition"],"summary":"Create custom layout","description":"Create custom layout","operationId":"pimcore_studio_api_class_custom_layout_create","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayoutNew"}}}},"responses":{"200":{"description":"Custom layout created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"Delete custom layout by given id","description":"Delete custom layout by given id","operationId":"pimcore_studio_api_class_custom_layout_delete","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"Custom layout deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/editor\/collection\/{objectId}":{"get":{"tags":["Class Definition"],"summary":"Get custom layout collection for the data object","description":"Get custom layout collection based on the \u003Cstrong\u003E{objectId}\u003C\/strong\u003E and current user permissions. \u003Cbr\u003E\nThe \u003Cstrong\u003E{objectId}\u003C\/strong\u003E must be an ID of an existing object.\n","operationId":"class_custom_layout_editor_collection","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of custom layouts for the given data object ID","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/CustomLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/export\/{customLayoutId}":{"get":{"tags":["Class Definition"],"summary":"Export custom layout by given id as JSON","description":"Export custom layout by given id as JSON","operationId":"pimcore_studio_api_class_custom_layout_export","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"Custom layout data as JSON","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022custom_definition_CarToDo_export.json\u0022"}}},"content":{"application\/json":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/identifier-data\/{classDefinitionId}":{"get":{"tags":["Class Definition"],"summary":"Get identifier data for new custom layout","description":"Get identifier data for new custom layout. \u003Cbr\u003E\nResults consist of suggested unique ID, existing layout IDs and existing layout names for provided \u003Cstrong\u003E{classDefinitionId}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{classDefinitionId}\u003C\/strong\u003E must be an ID of an existing class definition.\n","operationId":"class_custom_layout_get_identifier_data","parameters":[{"name":"classDefinitionId","in":"path","description":"Class definition unique identifier for custom layouts","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Identifier data for new custom layout as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayoutIdentifierData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/custom-layout\/import\/{customLayoutId}":{"post":{"tags":["Class Definition"],"summary":"Import custom layout","description":"Import custom layout using a previously exported JSON.","operationId":"class_custom_layout_import","parameters":[{"name":"customLayoutId","in":"path","description":"Id of custom layout","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully imported custom layout configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}\/bricks":{"get":{"tags":["Class Definition"],"summary":"Get object bricks usage data for the class definition","description":"Get usage data of object bricks for the given class definition ID \u003Cstrong\u003E{id}\u003C\/strong\u003E \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing class definition.\n","operationId":"class_definition_get_bricks_usages","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Object bricks usage data","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/ClassDefinitionObjectBrickData"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/create":{"post":{"tags":["Class Definition"],"summary":"Create a new class definition configuration","description":"Create a new class definition configuration with the given \u003Cstrong\u003E{name}\u003C\/strong\u003E and unique ID \u003Cstrong\u003E{uid}\u003C\/strong\u003E \u003Cbr\u003E\nThe \u003Cstrong\u003E{uid}\u003C\/strong\u003E must be unique and not already exist.\n","operationId":"class_definition_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateClassDefinition"}}}},"responses":{"200":{"description":"Successfully created class definition configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}":{"get":{"tags":["Class Definition"],"summary":"Get class definition data by ID","description":"Get class definition data by ID","operationId":"class_definition_get_by_id","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Class definition data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinition"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Class Definition"],"summary":"Update class definition configuration by given ID","description":"Update an existing class definition configuration with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and parameters. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing class definition. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"class_definition_update","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinitionUpdate"}}}},"responses":{"200":{"description":"Successfully updated class definition configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinition"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"Delete a class definition configuration","description":"Delete a class definition configuration with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing class definition.\n","operationId":"class_definition_delete","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Successfully deleted class definition configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}\/export":{"get":{"tags":["Class Definition"],"summary":"Export a class definition configuration as JSON","description":"Export a class definition configuration as JSON for the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing class definition.\n","operationId":"class_definition_export","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Exported class definition configuration as JSON","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022class_Car_export.json\u0022"}}},"content":{"application\/json":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/identifier-data":{"get":{"tags":["Class Definition"],"summary":"Get identifier data for new class","description":"Get identifier data for new class. Results consist of suggested unique ID and existing class IDs.\n","operationId":"class_definition_get_identifier_data","responses":{"200":{"description":"Suggested unique ID and existing class IDs","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinitionIdentifierData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}\/import":{"post":{"tags":["Class Definition"],"summary":"Import a class definition configuration from JSON file","description":"Import a class definition configuration from a previously exported JSON file for the given class definition \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing class definition.\n","operationId":"class_definition_import","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file with JSON encoded class definition configuration","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully imported class definition configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinition"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}\/layout":{"get":{"tags":["Class Definition"],"summary":"Get layout definitions for the class definition","description":"Get layout definition for the given class definition ID \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"class_definition_get_layout_by_id","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Layout definition data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Layout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/detail\/{id}\/selected-visible-fields":{"get":{"tags":["Class Definition"],"summary":"Get selected visible fields for a class relation field","description":"Get selected visible fields for the specified data object class and relation field. \u003Cbr\u003E\nThe \u003Cstrong\u003E{classId}\u003C\/strong\u003E must be an ID of existing data object class. \u003Cbr\u003E\nThe \u003Cstrong\u003E{relationField}\u003C\/strong\u003E must be the name of an existing relation field in the specified class.\n","operationId":"class_get_selected_visible_fields","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}},{"name":"relationField","in":"query","description":"Relation field name for which the selected fields should be retrieved as dot notation.","required":false,"schema":{"type":"string","example":"myRelationField"}}],"responses":{"200":{"description":"Successfully retrieved selected visible fields","content":{"application\/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/text-layout\/preview":{"get":{"tags":["Class Definition"],"summary":"Get text layout preview for the class definition","description":"Get text layout preview for the given class definition based on the provided request data. \u003Cbr\u003E\nThe \u003Cstrong\u003E{className}\u003C\/strong\u003E must be a name of an existing class definition.\n","operationId":"class_definition_get_text_layout_preview","parameters":[{"name":"className","in":"query","description":"Class definition name where layout is defined","required":true,"schema":{"type":"string","example":"Car"}},{"name":"path","in":"query","description":"Path to optional object to render the layout with","required":false,"schema":{"type":"string","example":"\/cars\/my-car"}},{"name":"renderingData","in":"query","description":"Optional dynamic data to be used for rendering the layout","required":false,"schema":{"type":"string","example":"\u003Cdiv\u003ESome HTML data\u003C\/div\u003E"}},{"name":"renderingClass","in":"query","description":"Optional rendering class to be used for rendering the layout","required":false,"schema":{"type":"string","example":"My\\Custom\\Class"}},{"name":"html","in":"query","description":"Optional static HTML to be used for rendering the layout","required":false,"schema":{"type":"string","example":"\u003Cdiv\u003ESome HTML data\u003C\/div\u003E"}}],"responses":{"200":{"description":"Text layout preview as HTML","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022text-layout-preview.html\u0022"}}},"content":{"text\/html":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/configuration-view\/tree":{"get":{"tags":["Class Definition"],"summary":"Get class definition tree data","description":"Get class definition tree for all classes. Results can be grouped based on the \u003Cstrong\u003E{withGroup}\u003C\/strong\u003E parameter.\n","operationId":"class_definition_get_tree","parameters":[{"name":"withGroup","in":"query","description":"Whether to group the results.","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"Class definition data for the tree view","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/ClassDefinitionTreeNode"},{"$ref":"#\/components\/schemas\/ClassDefinitionTreeNodeFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/field-collection\/collection":{"get":{"tags":["Class Definition"],"summary":"Get all field collection configurations","description":"Get all available field collection configurations in the system\n","operationId":"class_field_collection_collection","responses":{"200":{"description":"List of field collection configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/FieldCollectionConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/field-collection\/{objectId}\/object\/layout":{"get":{"tags":["Class Definition"],"summary":"Get all layouts from the field collection for an given object","description":"Get all layouts from the field collection for an given object\n","operationId":"class_field_collection_object_layout","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of layouts","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/FieldCollectionLayoutDefinition"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/folder\/{folderId}":{"get":{"tags":["Class Definition"],"summary":"Get list of all data object classes in a folder","description":"Get list of all data object classes in a folder","operationId":"class_definition_folder_collection","parameters":[{"name":"folderId","in":"path","description":"FolderId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of all data object classes in a folder","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ClassDefinitionFolderItem"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/definition\/{dataObjectClass}":{"get":{"tags":["Class Definition"],"summary":"Get class definition for data object class","description":"Get class definition for the given data object class","operationId":"class_definition_get","parameters":[{"name":"dataObjectClass","in":"path","description":"Data object class","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Class definition","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClassDefinition"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/object-brick\/{objectId}\/object\/layout":{"get":{"tags":["Class Definition"],"summary":"Get all layouts from the object bricks for an given object","description":"Get all layouts from the object bricks for an given object\n","operationId":"class_object_brick_object_layout","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of layouts","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ObjectBrickLayoutDefinition"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/class\/select-option\/tree":{"get":{"tags":["Class Definition"],"summary":"Get select options tree data","description":"Get select options tree data. Results can be grouped based on the \u003Cstrong\u003E{withGroup}\u003C\/strong\u003E parameter.\n","operationId":"class_select_option_get_tree","parameters":[{"name":"withGroup","in":"query","description":"Whether to group the results.","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"Select options data for the tree view","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/SelectOptionTree"},{"$ref":"#\/components\/schemas\/SelectOptionTreeFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/collections":{"get":{"tags":["Classification Store"],"summary":"Get all classification store collections for given fieldName","description":"Get all classification store collections for given fieldName","operationId":"classification_store_get_collections","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}}],"responses":{"200":{"description":"List of classification store collections","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Collection"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/groups":{"get":{"tags":["Classification Store"],"summary":"Get all classification store groups for given fieldName","description":"Get all classification store groups for given fieldName","operationId":"classification_store_get_groups","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"List of classification store groups","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Group"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/key-group-relations":{"get":{"tags":["Classification Store"],"summary":"Get all classification store key group relations for given fieldName","description":"Get all classification store key group relations for given fieldName","operationId":"classification_store_get_key_group_relations","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"List of classification store key group relations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/KeyGroupRelation"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/layout-by-collection\/{collectionId}":{"get":{"tags":["Classification Store"],"summary":"Get Layout definition for given collection","description":"Get Layout definition for given collection","operationId":"classification_store_get_layout_by_collection","parameters":[{"name":"objectId","in":"query","description":"object ID","required":true,"schema":{"type":"integer","example":83}},{"name":"collectionId","in":"path","description":"CollectionId of the Collection ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"Layout definition","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CollectionLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/layout-by-group\/{groupId}":{"get":{"tags":["Classification Store"],"summary":"Get Layout definition for given group","description":"Get Layout definition for given group","operationId":"classification_store_get_layout_by_group","parameters":[{"name":"objectId","in":"query","description":"object ID","required":true,"schema":{"type":"integer","example":83}},{"name":"groupId","in":"path","description":"GroupId of the Group ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"Layout definition","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GroupLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/layout-by-key\/{keyId}":{"get":{"tags":["Classification Store"],"summary":"Get Layout definition for given key","description":"Get Layout definition for given key","operationId":"classification_store_get_layout_by_key","parameters":[{"name":"objectId","in":"query","description":"object ID","required":false,"schema":{"type":"integer","example":83}},{"name":"keyId","in":"path","description":"KeyId of the Key ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"Layout definition","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/KeyLayout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/classification-store\/config\/collection":{"get":{"tags":["Classification Store"],"summary":"Get all classification store configurations","description":"Get all available classification stores","operationId":"classification_store_get_config_collection","responses":{"200":{"description":"List of classification store configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/ClassificationStoreStoreConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/add\/{parentId}":{"post":{"tags":["Data Objects"],"summary":"Successfully added a new data object","description":"Add a new data object to the given \u003Cstrong\u003E{parentId}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be an ID of a folder or another data object. See the full description of request fields with the schema \u003Cstrong\u003EDataObjectAdd\u003C\/strong\u003E\n","operationId":"data_object_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DataObjectAddParameters"}}}},"responses":{"200":{"description":"ID of added data object","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of created data object","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/batch-delete":{"delete":{"tags":["Data Objects"],"summary":"Batch delete data objects by IDs","description":"Batch delete data objects based on the given \u003Cstrong\u003E{ids}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{ids}\u003C\/strong\u003E must be a list of IDs of existing data objects. \u003Cbr\u003E\nDeletion is done asynchronously and the jobRun ID is returned in the response\n","operationId":"data_object_batch_delete","requestBody":{"content":{"application\/json":{"schema":{"properties":{"ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for batch delete","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/{id}\/clone\/{parentId}":{"post":{"tags":["Data Objects"],"summary":"Clone a specific data object","description":"Clones a specific data object with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be a folder or another data object\n","operationId":"data_object_clone","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"parentId","in":"path","description":"ParentId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CloneParameters"}}}},"responses":{"200":{"description":"Successfully copied data object"},"201":{"description":"Successfully copied parent data object and created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for copying child objects","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/{id}":{"get":{"tags":["Data Objects"],"summary":"Get a specific data object by ID","description":"Retrieves a specific data object based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing data object or folder.\n","operationId":"data_object_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved data object data as JSON","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/DataObjectDetail"},{"$ref":"#\/components\/schemas\/DataObjectFolder"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Data Objects"],"summary":"Update a data object by ID","description":"You can create\/update\/delete list entries like properties or data object editable fields. \u003Cbr\u003E  If you want to update (add\/remove) only some data of a field (e.g data of multi-relation fields), use the PATCH method.\n","operationId":"data_object_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"useDraftData":{"type":["boolean","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }"},"properties":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated data object","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/DataObjectDetail"},{"$ref":"#\/components\/schemas\/DataObjectFolder"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/grid\/preview":{"post":{"tags":["Data Object Grid"],"summary":"Get a preview of an Advanced Column Grid for a given Data Object.","description":"Gives you a preview of an Advanced Column Grid for a given Data Object.","operationId":"data_object_get_grid_preview","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["objectId","column"],"properties":{"objectId":{"type":"integer","example":1},"column":{"$ref":"#\/components\/schemas\/Column"}},"type":"object"}}}},"responses":{"200":{"description":"Preview of an Advanced Column Grid for a given Data Object.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ColumnData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configuration\/{configurationId}":{"delete":{"tags":["Data Object Grid"],"summary":"Delete grid configuration for a given configuration ID","description":"Delete grid configuration for a given configuration ID \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E\n","operationId":"data_object_delete_grid_configuration_by_configurationId","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configuration\/{folderId}\/{classId}":{"get":{"tags":["Data Object Grid"],"summary":"Get data object grid configuration for a specific folder and class-id","description":"Get data object saved grid configuration by \u003Cstrong\u003E{folderId}\u003C\/strong\u003E \u003Cstrong\u003E{classId}\u003C\/strong\u003E if a configuration-id is set, otherwise get the default configuration will be returned.\n","operationId":"data_object_get_grid_configuration","parameters":[{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}},{"name":"configurationId","in":"query","description":"Configuration ID","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_get_grid_configuration_success_response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configurations\/{classId}":{"get":{"tags":["Data Object Grid"],"summary":"List all saved grid configurations for data objects","description":"List all saved grid configurations for data objects for given class ID\n","operationId":"data_object_list_saved_grid_configurations","parameters":[{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}}],"responses":{"200":{"description":"List of saved grid configurations for data objects","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Configuration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configuration\/save\/{classId}":{"post":{"tags":["Data Object Grid"],"summary":"Save Data Object grid configuration for a specific folder","description":"Save Data Object grid configuration for a specific Class ID \u003Cstrong\u003E{classId}\u003C\/strong\u003E\n","operationId":"data_object_save_grid_configuration","parameters":[{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Data Object grid configuration saved successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Configuration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configuration\/set-as-favorite\/{configurationId}\/{folderId}":{"post":{"tags":["Data Object Grid"],"summary":"Set data object grid configuration as favorite for a specific folder","description":"Set data object grid configuration as favorite for the current user for a specific folder\n","operationId":"data_object_set_grid_configuration_as_favorite","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}},{"name":"folderId","in":"path","description":"FolderId of the folderId","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_set_grid_configuration_as_favorite_response"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/configuration\/update\/{configurationId}":{"put":{"tags":["Data Object Grid"],"summary":"Update data object grid configuration for a specific folder","description":"Update data object grid configuration for a specific folder and given configuration ID \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E\n","operationId":"data_object_update_grid_configuration","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Data Object grid configuration updated successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/available-columns":{"get":{"tags":["Data Object Grid"],"summary":"Get all available grid columns for data objects","description":"Get all available grid columns for data objects\n","operationId":"data_object_get_available_grid_columns","parameters":[{"name":"classId","in":"query","description":"Identifies the class name for which the columns should be retrieved.","required":false,"schema":{"type":"string","example":"EV"}},{"name":"folderId","in":"query","description":"folderId","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of available grid columns for data objects","content":{"application\/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/available-columns-for-relation":{"get":{"tags":["Data Object Grid"],"summary":"Get all available grid columns for data objects Many to many relation field","description":"Get all available grid columns for data objects Many to many relation field (defined in the visible columns)","operationId":"data_object_get_available_grid_columns_for_relation","parameters":[{"name":"classId","in":"query","description":"Identifies the class name for which the columns should be retrieved.","required":false,"schema":{"type":"string","example":"EV"}},{"name":"relationField","in":"query","description":"relationField as dot notation, e.g. \u0022myBlock.mySubRelationField\u0022","required":false,"schema":{"type":"string","example":"myRelationField"}}],"responses":{"200":{"description":"List of available grid columns for data objects Many to many relation field","content":{"application\/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/grid\/{classId}":{"post":{"tags":["Data Object Grid"],"summary":"Get data object data for grid","description":"Retrieve data objects data for grid. \u003Cbr\u003E\nYou can use different query parameters to filter the data objects data: \u003Cbr\u003E\n\u003Cul\u003E\n\u003Cli\u003E\u003Cstrong\u003EfolderId\u003C\/strong\u003E: ID of parent folder\u003C\/li\u003E\n\u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: To see the full description of request fields see the schema \u003Cstrong\u003EGrid Column Request\u003C\/strong\u003E\u003C\/li\u003E\n\u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: To see the full description of request fields see the schema \u003Cstrong\u003EGrid Filter\u003C\/strong\u003E\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"data_object_get_grid","parameters":[{"name":"classId","in":"path","description":"Identifies the class name for which the the grid should be build.","required":true,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId"],"properties":{"folderId":{"type":"integer","example":1},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"Data object grid data","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#\/components\/schemas\/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/grid\/transformers\/services\/phpcode":{"get":{"tags":["Data Object Grid"],"summary":"List PHPCode transformers","description":"Returns a list of available PHPCode transformers used in grid rendering.  \nThese transformers can be applied to grid columns to dynamically modify or format values using PHP logic.\n","operationId":"data_object_get_phpcode_transformers","responses":{"200":{"description":"List of available PHPCode transformers","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PhpCodeTransformer"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/{id}\/layout":{"get":{"tags":["Data Objects"],"summary":"Get layout of a data object by ID","description":"Retrieves the layout of a specific data object based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing data object.\n","operationId":"data_object_get_layout_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"layoutId","in":"query","description":"ID to get specific layout","required":false,"schema":{"type":"string","example":"Todo"}}],"responses":{"200":{"description":"Successfully retrieved data object layout data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Layout"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects":{"patch":{"tags":["Data Objects"],"summary":"Patch data objects by ID","description":"Patching data objects based on the given ID and data. \u003Cbr\u003E Patching can be used for updating single or multiple fields. \u003Cbr\u003E If single element is being patched, operation is executed synchronously. Multiple elements are patched asynchronously.\n","operationId":"data_object_patch_by_id","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["id"],"properties":{"id":{"description":"Data Object ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }"}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully patched data object"},"201":{"description":"Successfully created jobRun for patching multiple data objects","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/folder":{"patch":{"tags":["Data Objects"],"summary":"Patch all data objects based on folder ID and filters","description":"Patching data objects based on the given folder ID, filters and data. \u003Cbr\u003E Patching on folders will be done asynchronously. \u003Cbr\u003E\nYou can also use filters and sorting. Filter data objects from folder based on the grid filter schema\n","operationId":"data_object_patch_folder_by_id","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data","classId"],"properties":{"data":{"type":"array","items":{"required":["folderId"],"properties":{"folderId":{"description":"Folder ID","type":"integer","example":2},"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }"}},"type":"object"}},"filters":{"$ref":"#\/components\/schemas\/ExportAllFilter"},"classId":{"type":"string","example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created jobRun for patching multiple data objects","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/format-path":{"post":{"tags":["Data Objects"],"summary":"Format the path of the data","description":"Format the path of the data given by the \u003Cstrong\u003E{targets}\u003C\/strong\u003E option.\n","operationId":"data_object_format_path","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["objectId","targets"],"properties":{"objectId":{"type":"integer","example":1},"targets":{"type":"object","example":"{\u0022object_10\u0022:{\u0022id\u0022:10,\u0022type\u0022:\u0022object\u0022,\u0022label\u0022:\u0022\/Product\n                        Data\/Cars\/jaguar\/E-Type\/coup\u00e9\u0022,\u0022path\u0022:\u0022\/Product Data\/Cars\/jaguar\/E-Type\/coup\u00e9\u0022,\n                        \u0022nicePathKey\u0022:\u0022object_10\u0022}}"},"fieldName":{"description":"Fieldname for the PathFormatter. Given as Dot Notation","type":"string","example":"attributes.Bodywork.numberOfDoors"}},"type":"object"}}}},"responses":{"200":{"description":"Formatted path of the objects","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/FormatedPath"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/preview\/{id}":{"get":{"tags":["Data Objects"],"summary":"Preview data object by ID and site","description":"Preview data object by ID and site. Data Object must be stored in the session first to be able to preview it.\n","operationId":"data_object_preview_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data object","required":true,"schema":{"type":"integer","example":83}},{"name":"site","in":"query","description":"Site ID","required":false,"schema":{"type":"integer","example":42}}],"responses":{"302":{"description":"Redirect to preview URL","headers":{"Location":{"description":"Redirect location","required":true,"schema":{"type":"string","format":"uri"}}}},"default":{"description":"302 - Redirect\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/{sourceId}\/replace\/{targetId}":{"post":{"tags":["Data Objects"],"summary":"Replace content of a data object","description":"Replace the content of the data object with the given \u003Cstrong\u003E{targetId}\u003C\/strong\u003E with the content of the data object matching the \u003Cstrong\u003E{sourceId}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{targetId}\u003C\/strong\u003E and \u003Cstrong\u003E{sourceId}\u003C\/strong\u003E must be an ID of existing data objects\n","operationId":"data_object_replace_content","parameters":[{"name":"sourceId","in":"path","description":"SourceId of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"targetId","in":"path","description":"TargetId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully replaced content of data object"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/select-options":{"post":{"tags":["Data Objects"],"summary":"Get all dynamic select options for data objects","description":"Get all dynamic select options for data objects for given field\n","operationId":"data_object_get_select_options","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["objectId","fieldName","context"],"properties":{"objectId":{"type":"integer","example":1},"fieldName":{"type":"string"},"changedData":{"type":"object","example":"{\u0022Input\u0022:\u0022new value\u0022}"},"context":{"type":"object","example":"{\u0022containerType\u0022:\u0022object\u0022,\u0022fieldname\u0022:\u0022select\u0022,\u0022objectId\u0022:40,\u0022layoutId\u0022:\u00220\u0022}"}},"type":"object"}}}},"responses":{"200":{"description":"List of dynamic select options","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SelectOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/data-objects\/tree":{"get":{"tags":["Data Objects"],"summary":"Get all data object data for the tree","description":"Listing of all data objects and data object folders in the system. \u003Cbr\u003E\nReturns only data which are relevant for the tree \u003Cbr\u003E\nYou can use different query parameters to filter the data objects and it is possible to exclude folders from the result completely\n","operationId":"data_object_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter data objects by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"series = empty AND color=\u0022red\u0022"}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"\/path\/to\/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"className","in":"query","description":"When provided, the search is executed on the specific data object class index.","required":false,"schema":{"type":"string","example":"Car"}},{"name":"classIds","in":"query","description":"Filter results based on the provided class IDs.","required":false,"schema":{"type":"string","example":"[\u0022Car\u0022]"}}],"responses":{"200":{"description":"Paginated data objects with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"$ref":"#\/components\/schemas\/DataObjectFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/dependencies\/{elementType}\/{id}":{"get":{"tags":["Dependencies"],"summary":"Get all dependencies for provided element.","description":"Get paginated dependencies.\n        Pass dependency mode to get either all elements that depend on the provided element\n        or all dependencies for the provided element.","operationId":"dependency_get_collection_by_element_type","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"dependencyMode","in":"query","description":"Dependency mode","required":true,"schema":{"type":"string","enum":["required_by","requires"],"example":"required_by"}}],"responses":{"200":{"description":"Paginated dependencies with total count as header param","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/Dependency"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/add\/{parentId}":{"post":{"tags":["Documents"],"summary":"Add a new document","description":"Add a new data object to the given \u003Cstrong\u003E{parentId}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be an ID of a folder or another data object. See the full description of request fields with the schema \u003Cstrong\u003EDocumentAdd\u003C\/strong\u003E\n","operationId":"document_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentAddParameters"}}}},"responses":{"200":{"description":"ID of added document","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of created document element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}\/clone\/{parentId}":{"post":{"tags":["Documents"],"summary":"Clone a specific document","description":"Clones a specific document with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be a folder or another document. See the full description of request fields with the schema \u003Cstrong\u003EDocument Clone Parameters\u003C\/strong\u003E\n","operationId":"document_clone","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"parentId","in":"path","description":"ParentId of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentCloneParameters"}}}},"responses":{"200":{"description":"Successfully copied documents"},"201":{"description":"Successfully copied parent document and created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for copying children","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}\/convert\/{type}":{"post":{"tags":["Documents"],"summary":"Change document type","description":"Change the \u003Cstrong\u003E{type}\u003C\/strong\u003E of a specific document with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \n\u003Cbr\u003EThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document or folder and the \u003Cstrong\u003E{type}\u003C\/strong\u003E must be an existing Document Type type.\n","operationId":"document_convert","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"type","in":"path","description":"Document type to convert to","required":true,"schema":{"type":"string","example":"page"}}],"responses":{"200":{"description":"Successfully changed document type"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/doc-types\/add":{"post":{"tags":["Documents"],"summary":"Add a new document DocType","description":"Add a new document \u003Cstrong\u003EDocType\u003C\/string\u003E. \u003Cbr\u003E See the full description of request fields with the schema \u003Cstrong\u003EDocTypeAdd\u003C\/strong\u003E\n","operationId":"document_doc_type_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocTypeAddParameters"}}}},"responses":{"200":{"description":"New DocType data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocType"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/doc-types\/{id}":{"put":{"tags":["Documents"],"summary":"Update a document DocType by ID","description":"Update the DocType with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing DocType. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"document_doc_type_update_by_id","parameters":[{"name":"id","in":"path","description":"The Id of the DocType to update","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocTypeUpdateParameters"}}}},"responses":{"200":{"description":"Successfully updated DocType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocType"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Documents"],"summary":"Delete an existing document DocType by ID","description":"Delete the existing document \u003Cstrong\u003EDocType\u003C\/strong\u003E with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing DocType.\n","operationId":"document_doc_type_delete","parameters":[{"name":"id","in":"path","description":"The Id of the DocType to delete","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Successfully deleted document DocType"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/doc-types\/types":{"get":{"tags":["Documents"],"summary":"List DocType types","description":"List all available types for DocType.\n","operationId":"document_doc_type_type_list","responses":{"200":{"description":"List of available DocType types","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/DocTypeType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/doc-types":{"get":{"tags":["Documents"],"summary":"List all document DocTypes","description":"List all DocTypes. Results can be filtered based on the given \u003Cstrong\u003E{type}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{type}\u003C\/strong\u003E must be an existing DocType type.\n","operationId":"document_doc_type_list","parameters":[{"name":"type","in":"query","description":"Filter results by docType type","required":false,"schema":{"type":"string","example":"page"}}],"responses":{"200":{"description":"List of all DocTypes","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/DocType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/types":{"get":{"tags":["Documents"],"summary":"Get all available document types","description":"Retrieves all available document types in the system.\n","operationId":"document_get_types","responses":{"200":{"description":"Successfully retrieved all available document types","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/DocumentType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}":{"get":{"tags":["Documents"],"summary":"Get a specific document by ID","description":"Retrieves a specific document based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document or folder.\n","operationId":"document_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved document data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Documents"],"summary":"Update a document by ID","description":"You can create\/update\/delete list entries like properties, settings or editable fields.\n","operationId":"document_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }"},"settingsData":{"type":["object","null"],"example":{"title":"Some Title","description":"Some Description","prettyUrl":"pretty\/url","controller":"App\\Controller\\PageController","template":"@app\/template.html.twig","contentMainDocumentId":123,"contentMainDocumentPath":"\/path\/to\/main\/document","supportsContentMain":false,"missingRequiredEditable":false,"staticGeneratorEnabled":false,"staticGeneratorLifetime":123456,"staticLastGenerated":1700000000,"url":"https:\/\/example.com\/"}},"missingRequiredEditable":{"type":["boolean","null"]},"appendEditables":{"type":["boolean","null"]},"properties":{"type":["array","null"],"items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}\/page\/check-pretty-url":{"post":{"tags":["Documents"],"summary":"Check if pretty URL is available and valid","description":"Check if the given \u003Cstrong\u003E{prettyUrl}\u003C\/strong\u003E is available and valid for the document with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \n\u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document.\n","operationId":"document_page_check_pretty_url","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CheckPrettyUrl"}}}},"responses":{"200":{"description":"Returns success if pretty URL is available and valid"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}\/page\/stream\/preview":{"get":{"tags":["Documents"],"summary":"Stream page document preview by ID","description":"Stream page document PDF preview based on the provided \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing page\n","operationId":"document_page_stream_preview","parameters":[{"name":"id","in":"path","description":"Id of the page","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Page preview stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/jpeg":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/get-available-controllers":{"get":{"tags":["Documents"],"summary":"List document controllers","description":"List all available controllers for documents.\n","operationId":"document_available_controllers_list","responses":{"200":{"description":"document_available_controllers_list_success_response","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/DocumentController"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/get-available-templates":{"get":{"tags":["Documents"],"summary":"List document templates","description":"List all available templates for documents.\n","operationId":"document_available_templates_list","responses":{"200":{"description":"document_available_templates_list_success_response","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/DocumentTemplate"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{id}\/page-snippet\/change-main-document":{"put":{"tags":["Documents"],"summary":"Change main document of a page snippet","description":"Set the main document of a page snippet with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E based on the the given \u003Cstrong\u003E{mainDocumentPath}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing page snippet. \u003Cbr\u003E\nThe \u003Cstrong\u003E{mainDocumentPath}\u003C\/strong\u003E must be a valid path of an existing document or null.\n","operationId":"document_page_snippet_change_main_document","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChangeMainDocument"}}}},"responses":{"200":{"description":"Successfully changed main document of page snippet"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/page-snippet\/{id}\/area-block\/render":{"post":{"tags":["Documents"],"summary":"Render area brick for editmode","description":"Generate the editmode HTML and editable definitions based on the document \u003Cstrong\u003E{id}\u003C\/strong\u003E and data provided. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing page snippet document. \u003Cbr\u003E \nFollowing fields are required in the request body:\n  \u003Cul\u003E\n      \u003Cli\u003E\u003Cstrong\u003Ename\u003C\/strong\u003E: Name of the areablock\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003ErealName\u003C\/strong\u003E: Real name of the areaBlock\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003Eindex\u003C\/strong\u003E: Index of the areablock within the document\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003EblockStateStack\u003C\/strong\u003E: State stack of the areaBlock\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003EareaBlockConfig\u003C\/strong\u003E: areaBlock config\u003C\/li\u003E\n      \u003Cli\u003E\u003Cstrong\u003EareaBlockData\u003C\/strong\u003E: Data of the areaBlock\u003C\/li\u003E\n  \u003C\/ul\u003E\n","operationId":"document_page_snippet_area_block_render","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name","realName","index","blockStateStack","areablockConfig","areablockData"],"properties":{"name":{"type":["string","null"]},"realName":{"type":["string","null"]},"index":{"type":["integer","null"],"minimum":0},"blockStateStack":{"type":["object","null"],"example":"[{\u0022blocks\u0022: [], \u0022indexes\u0022: []}]"},"areaBlockConfig":{"type":["object","null"],"example":"[]"},"areaBlockData":{"type":["object","null"],"example":"[]"}},"type":"object"}}}},"responses":{"200":{"description":"Rendered HTML and editable definitions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RenderAreaBlockData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/renderlet\/render":{"get":{"tags":["Documents"],"summary":"Render a specific renderlet","description":"Render a specific renderlet based on the provided parameters.\n","operationId":"document_renderlet_render","parameters":[{"name":"id","in":"query","description":"ElementId of the renderlet element","required":true,"schema":{"type":"integer","example":83}},{"name":"type","in":"query","description":"Type of the renderlet element.","required":true,"schema":{"type":"string","example":"data-object"}},{"name":"controller","in":"query","description":"Renderlet controller action","required":true,"schema":{"type":"string","example":"App\/Controller\\Renderlet\\MyRenderletController::renderAction"}},{"name":"parentDocumentId","in":"query","description":"Parent document id of the renderlet","required":false,"schema":{"type":"integer","example":83}},{"name":"template","in":"query","description":"Renderlet template","required":false,"schema":{"type":"string","example":"App\/Template\/Renderlet\/my_template.html.twig"}}],"responses":{"200":{"description":"Rendered renderlet","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022renderlet.html.twig\u0022"}}},"content":{"text\/html":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/{sourceId}\/replace\/{targetId}":{"post":{"tags":["Documents"],"summary":"Replace content of a document","description":"Replace the content of the document with the given \u003Cstrong\u003E{targetId}\u003C\/strong\u003E with the content of the document matching the \u003Cstrong\u003E{sourceId}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{targetId}\u003C\/strong\u003E and \u003Cstrong\u003E{sourceId}\u003C\/strong\u003E must be an ID of existing document\n","operationId":"document_replace_content","parameters":[{"name":"sourceId","in":"path","description":"SourceId of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"targetId","in":"path","description":"TargetId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully replaced contents of the document"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/sites\/list-available":{"get":{"tags":["Documents"],"summary":"List all available sites","description":"List all available sites\n","operationId":"documents_list_available_sites","parameters":[{"name":"excludeMainSite","in":"query","description":"Exclude main site from the list","schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"List of available sites","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Site"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/site\/{id}":{"post":{"tags":["Documents"],"summary":"Use document as a site or update the existing site","description":"Use document as a site or update the existing site by the given document \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document\n","operationId":"document_update_site","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateSite"}}}},"responses":{"200":{"description":"Successfully created\/updated site"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Documents"],"summary":"Delete the existing site by its document ID","description":"Delete the existing site by the given document \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document\n","operationId":"document_delete_site","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted site"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/site\/{documentId}":{"get":{"tags":["Documents"],"summary":"Get the site detail data by its document ID","description":"Get the site detail data by the given document \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing root document of the site\n","operationId":"document_get_site","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Site detail data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SiteDetailData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/translations\/{id}\/add\/{translationId}":{"post":{"tags":["Documents"],"summary":"Link a new translation document to the existing document","description":"Link a new translation document (by \u003Cstrong\u003E{translationId}\u003C\/strong\u003E) to the given document with \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{translationId}\u003C\/strong\u003E must be an ID of existing documents.\n","operationId":"document_add_translation","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"translationId","in":"path","description":"TranslationId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully linked translation document"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/translations\/{id}\/delete\/{translationId}":{"delete":{"tags":["Documents"],"summary":"Delete a translation document from the existing document","description":"Delete the translation document with the given \u003Cstrong\u003E{translationId}\u003C\/strong\u003E from the given document with \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{translationId}\u003C\/strong\u003E must be an ID of existing documents.\n","operationId":"document_delete_translation","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"translationId","in":"path","description":"TranslationId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted translation document"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/translations\/{id}":{"get":{"tags":["Documents"],"summary":"Get all existing translations of the document","description":"Get all existing translations of the document with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document.\n","operationId":"document_get_translations","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Get all existing translations","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentTranslationLinks"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/translations\/{id}\/get-parent\/{language}":{"get":{"tags":["Documents"],"summary":"Get the parent translation document data by language","description":"Get the parent translation document of the document with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E by \u003Cstrong\u003E{language}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing document and the \u003Cstrong\u003E{language}\u003C\/strong\u003E must be a valid language code.\n","operationId":"document_get_translation_parent_by_language","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"language","in":"path","description":"Language code for the translation parent","required":true,"schema":{"type":"string","example":"en"}}],"responses":{"200":{"description":"Parent translation document data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentTranslationParent"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/documents\/tree":{"get":{"tags":["Documents"],"summary":"Get all document data for the tree","description":"Listing of all documents and document folders in the system. \u003Cbr\u003E\nReturns only data which are relevant for the tree \u003Cbr\u003E\nYou can use different query parameters to filter the assets and it is possible to exclude folders from the result completely\n","operationId":"document_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter documents by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"id = 69"}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"\/path\/to\/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"Paginated documents with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Document"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/delete\/{id}":{"delete":{"tags":["Elements"],"summary":"Delete a specific element and its children","description":"Deletes a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E. \u003Cbr\u003E If element is a folder, all child elements will be deleted as well. Elements are moved into the Recycle Bin before deletion.\n","operationId":"element_delete","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Successfully deleted element"},"201":{"description":"Successfully created jobRun for deleting element and its children","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/delete-info\/{id}":{"get":{"tags":["Elements"],"summary":"Get delete info of the element by id and element type path parameter","description":"Get delete info for a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an existing ID of an element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"element_get_delete_info","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Get delete info for an element","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DeleteInfo"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/folder\/{parentId}":{"post":{"tags":["Elements"],"summary":"Create a new element folder","description":"Creating a new folder by \u003Cstrong\u003E{parentId}\u003C\/strong\u003E and \u003Cstrong\u003E{elementType}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{parentId}\u003C\/strong\u003E must be an ID of an existing folder or element. \u003Cbr\u003E\nFor additional body parameters see the schema \u003Cstrong\u003EFolderData\u003C\/strong\u003E\n","operationId":"element_folder_create","parameters":[{"name":"parentId","in":"path","description":"ParentId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FolderData"}}}},"responses":{"200":{"description":"Successfully created folder"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/context-permissions\/":{"get":{"tags":["Elements"],"summary":"Get context permissions for the element type path parameter","description":"Get the context permission list relevant for the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"element_get_context_permissions","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Context permission list","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"}},"example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/location\/{id}\/{perspectiveId}":{"get":{"tags":["Elements"],"summary":"Get location data of the element by id, element type and perspective id path parameter","description":"Get the location data of the element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E, \u003Cstrong\u003E{id}\u003C\/strong\u003E and \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{ids}\u003C\/strong\u003E must be an existing ID of an element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and existing perspective ID.\n","operationId":"element_get_tree_location","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"Location data of the element","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/LocationData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/path":{"get":{"tags":["Elements"],"summary":"Get ID of the element by path query parameter and element type path parameter","description":"Get the element ID based on the given \u003Cstrong\u003E{path}\u003C\/strong\u003E and \u003Cstrong\u003E{elementType}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{path}\u003C\/strong\u003E must be a valid path of an existing element with provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E\n","operationId":"element_get_id_by_path","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"elementPath","in":"query","description":"Filter elements by matching element path.","required":true,"schema":{"type":"string","example":"path\/to\/element"}}],"responses":{"200":{"description":"element_get_id_by_path_response_description","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of the element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/subtype\/{id}":{"get":{"tags":["Elements"],"summary":"Get subtype of the element by id and element type path parameter","description":"Get the subtype of the element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an existing ID of an element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"element_get_subtype","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Subtype of the element","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Subtype"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/usage\/{elementType}\/{id}":{"get":{"tags":["Elements"],"summary":"Get usage of element","description":"Get usage of element. Use \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E to specify the element.","operationId":"element_get_usage","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"sortBy","in":"query","description":"Sort by field.","required":false,"schema":{"type":"string","enum":["id","path","type"],"example":null}}],"responses":{"200":{"description":"Where the element is referenced","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ElementUsage"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/usage\/replace\/{elementType}\/{id}":{"post":{"tags":["Elements"],"summary":"Replace all references to an element with another element","description":"Replace all references to an element with another element using generic execution engine.\nUse \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E to specify the source element, \u003Cstrong\u003EtargetElementType\u003C\/strong\u003E and \u003Cstrong\u003EtargetId\u003C\/strong\u003E in the request body to specify the target element.\nUse \u003Cstrong\u003Eelements\u003C\/strong\u003E array in the request body to specify the elements to be replaced.\n\u003Cstrong\u003ENote:\u003C\/strong\u003E If no elements are passed, all elements will be replaced.\n","operationId":"element_usage_replace","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"requestBody":{"content":{"application\/json":{"schema":{"properties":{"targetType":{"type":"string","enum":["data-object","object","asset","document"],"example":"data-object"},"targetId":{"type":"integer","example":"8"},"elements":{"type":"array","items":{"$ref":"#\/components\/schemas\/ElementUsageBaseItem"}}},"type":"object"}}}},"responses":{"200":{"description":"Id of the created job run","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"201 - Created\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/elements\/{elementType}\/resolve":{"get":{"tags":["Elements"],"summary":"Get ID of the element with given search term","description":"Get the element ID based on the given \u003Cstrong\u003E{searchTerm}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{searchTerm}\u003C\/strong\u003E must be a valid ID or Path of an existing element. \u003Cbr\u003E The \u003Cstrong\u003E{searchTerm}\u003C\/strong\u003E can be modified via the \u003Cstrong\u003EElementResolveEvent\u003C\/strong\u003E.\n","operationId":"element_resolve_by_search_term","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"searchTerm","in":"query","description":"Search term to filter elements by.","required":true,"schema":{"type":"string","example":"83"}}],"responses":{"200":{"description":"ID of the element with given search term","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of the element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/blocklist":{"get":{"tags":["E-Mails"],"summary":"Get paginated collection of blocklist entries","description":"Get paginated E-Mail blocklist entries. \u003Cbr\u003E\nYou can use different query parameters to filter the E-Mail blocklist\n","operationId":"email_blocklist_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"email","in":"query","description":"Email address to be filtered by","required":false,"schema":{"type":"string","example":"mail@mail.com"}}],"responses":{"200":{"description":"Paginated E-Mail blocklist entries with total count as header param","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BlocklistEntry"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["E-Mails"],"summary":"Add an E-mail address to the blocklist","description":"Add an E-mail address to the blocklist. \u003Cbr\u003E The E-mail address has to be compliant with the PHP validate filter.\n","operationId":"email_blocklist_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailAddressParameter"}}}},"responses":{"200":{"description":"Successfully added E-mail address to blocklist"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["E-Mails"],"summary":"Delete an E-mail address from the blocklist","description":"Delete an E-mail address from the blocklist with the given \u003Cstrong\u003E{email}\u003C\/strong\u003E \u003Cbr\u003E The E-mail address has to be present in the blocklist.\n","operationId":"email_blocklist_delete","parameters":[{"name":"email","in":"query","description":"Email address to be deleted from blocklist","required":false,"schema":{"type":"string","example":"mail@mail.com"}}],"responses":{"200":{"description":"Successfully deleted E-mail address from blocklist"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails":{"get":{"tags":["E-Mails"],"summary":"Get paginated collection of E-Mail log entries","description":"Get paginated E-Mail log entries. \u003Cbr\u003E\nYou can use different query parameters to filter the E-Mail logs\n","operationId":"email_log_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"Paginated E-Mail log entries with total count as header param","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/EmailLogEntry"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}":{"get":{"tags":["E-Mails"],"summary":"Get an E-Mail log entry by ID","description":"Get the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"E-Mail log entry data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailLogEntryDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["E-Mails"],"summary":"Delete E-Mail log entry","description":"Delete the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_delete","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted E-Mail log entry"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}\/html":{"get":{"tags":["E-Mails"],"summary":"Get HTML content of an E-Mail log entry by ID","description":"Get the HTML content of the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_get_html","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"HTML content of the E-Mail log entry","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry HTML data.","type":"string","example":"\u003Cp\u003ESome email HTML content\u003C\/p\u003E"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}\/params":{"get":{"tags":["E-Mails"],"summary":"Get parameters of an E-Mail log entry by ID","description":"Get the parameters of the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_get_params","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Parameters of the E-Mail log entry","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry parameters","type":"array","items":{"$ref":"#\/components\/schemas\/EmailLogEntryParameter"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}\/text":{"get":{"tags":["E-Mails"],"summary":"Get text content of an E-Mail log entry by ID","description":"Get the text content of the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_get_text","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Text content of the E-Mail log entry","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry text data.","type":"string","example":"Some email text content"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}\/forward":{"post":{"tags":["E-Mails"],"summary":"Forward and existing E-Mail log entry","description":"Forward the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E to the given \u003Cstrong\u003E{email}\u003C\/strong\u003E\n","operationId":"email_log_forward_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmailAddressParameter"}}}},"responses":{"200":{"description":"E-Mail was successfully forwarded"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/{id}\/resend":{"post":{"tags":["E-Mails"],"summary":"Resend an existing E-Mail log entry","description":"Resend the E-Mail log entry with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"email_log_resend_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"E-Mail was successfully resent"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/emails\/test":{"post":{"tags":["E-Mails"],"summary":"Send a test E-Mail","description":"Send a test E-Mail based on the provided query parameters. \u003Cbr\u003E See the full description of request fields with the schema \u003Cstrong\u003ESendEmailParameters\u003C\/strong\u003E\n","operationId":"email_send_test","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SendEmailParameters"}}}},"responses":{"200":{"description":"E-Mail was successfully sent"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/execution-engine\/abort\/{jobRunId}":{"post":{"tags":["Execution Engine"],"summary":"Abort Job Run by Id","description":"Abort Job Run","operationId":"execution_engine_abort_job_run_by_id","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/execution-engine\/hide":{"post":{"tags":["Execution Engine"],"summary":"Hide Job Runs by IDs","description":"Hide Job Runs based on the given \u003Cstrong\u003E{jobRunIds}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{jobRunIds}\u003C\/strong\u003E must be an array of existing Job Run IDs.\n","operationId":"execution_engine_hide_job_runs","requestBody":{"content":{"application\/json":{"schema":{"properties":{"jobRunIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/execution-engine\/running-jobs":{"post":{"tags":["Execution Engine"],"summary":"List studio jobs","description":"List all studio jobs for the current user which are not hidden","operationId":"execution_engine_list_jobs","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022type\u0022:\u0022state\u0022, \u0022filterValue\u0022: \u0022running\u0022},{\u0022type\u0022:\u0022id\u0022, \u0022filterValue\u0022: 5}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022id\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"List of studio jobs","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/JobRun"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/download\/csv\/{jobRunId}":{"get":{"tags":["Export"],"summary":"Download CSV file for job run id","description":"Download the CSV file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create csv endpoint\n","operationId":"export_download_csv","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"CSV File as attachment","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/csv":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Export"],"summary":"Delete CSV export file based on jobRunId","description":"Delete the CSV file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create csv endpoint\n","operationId":"export_delete_csv","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/csv":{"post":{"tags":["Export"],"summary":"Creating CSV file for elements","description":"Creating the CSV file for elements. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eelements\u003C\/strong\u003E: Array of element ids\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: Describes the columns that should be exported. Can be obtained via the grid endpoint\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Econfig\u003C\/strong\u003E: Delimiter and header options\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EelementType\u003C\/strong\u003E: Type of element that should be exported\u003C\/li\u003E\n\u003C\/ul\u003E \nDelimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E \nHeader options are: \u003Cstrong\u003Eno_header\u003C\/strong\u003E, \u003Cstrong\u003Etitle\u003C\/strong\u003E and \u003Cstrong\u003Ename\u003C\/strong\u003E\u003Cbr\u003E\nDownload has to be triggered separately via the csv download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"export_csv","requestBody":{"content":{"application\/json":{"schema":{"properties":{"elements":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"},"delimiter":{"type":"string","example":";"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for csv export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/csv\/folder":{"post":{"tags":["Export"],"summary":"Creating CSV file for elements based on folder","description":"Creating the CSV file for elements based on the folder. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efolders\u003C\/strong\u003E: Array of folder ids\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: Describes the columns that should be exported. Can be obtained via the grid endpoint. For folders you can also use filters and sorting\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: Filter elements from folder based on the grid filter schema\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Econfig\u003C\/strong\u003E: Delimiter and header options\u003C\/li\u003E\n\u003C\/ul\u003E \nDelimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E \nHeader options are: \u003Cstrong\u003Eno_header\u003C\/strong\u003E, \u003Cstrong\u003Etitle\u003C\/strong\u003E and \u003Cstrong\u003Ename\u003C\/strong\u003E\u003Cbr\u003E\nDownload has to be triggered separately via the csv download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"export_csv_folder","requestBody":{"content":{"application\/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[1]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/ExportAllFilter"},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"},"delimiter":{"type":"string","example":";"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"},"classId":{"type":["string","null"],"example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for csv export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/download\/xlsx\/{jobRunId}":{"get":{"tags":["Export"],"summary":"Download XLSX file for job run id","description":"Download the XLSX file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create export endpoint\n","operationId":"export_download_xlsx","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"XLSX File as attachment","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Export"],"summary":"Delete XLSX export file based on jobRunId","description":"Delete the XLSX file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create export endpoint\n","operationId":"export_delete_xlsx","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/xlsx":{"post":{"tags":["Export"],"summary":"Creating XLSX file export for elements","description":"Creating the XLSX file for elements. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eelements\u003C\/strong\u003E: Array of element ids\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: Describes the columns that should be exported. Can be obtained via the grid endpoint\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Econfig\u003C\/strong\u003E: Header options\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EelementType\u003C\/strong\u003E: Type of element that should be exported\u003C\/li\u003E\n\u003C\/ul\u003E\nHeader options are: \u003Cstrong\u003Eno_header\u003C\/strong\u003E, \u003Cstrong\u003Etitle\u003C\/strong\u003E and \u003Cstrong\u003Ename\u003C\/strong\u003E\u003Cbr\u003E\nDownload has to be triggered separately via the xlsx download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"export_xlsx","requestBody":{"content":{"application\/json":{"schema":{"properties":{"elements":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for XLSX export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/export\/xlsx\/folder":{"post":{"tags":["Export"],"summary":"Creating XLSX file for elements based on folder","description":"Creating the XLSX file for elements based on the folder. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efolders\u003C\/strong\u003E: Array of folder ids\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ecolumns\u003C\/strong\u003E: Describes the columns that should be exported. Can be obtained via the grid endpoint. For folders you can also use filters and sorting\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Efilters\u003C\/strong\u003E: Filter elements from folder based on the grid filter schema\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Econfig\u003C\/strong\u003E: Header options\u003C\/li\u003E\n\u003C\/ul\u003E \nHeader options are: \u003Cstrong\u003Eno_header\u003C\/strong\u003E, \u003Cstrong\u003Etitle\u003C\/strong\u003E and \u003Cstrong\u003Ename\u003C\/strong\u003E\u003Cbr\u003E\nDownload has to be triggered separately via the xlsx download route with the \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response\n","operationId":"export_xlsx_folder","requestBody":{"content":{"application\/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[1]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/ExportAllFilter"},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"},"classId":{"type":["string","null"],"example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E for XLSX export","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/gdpr\/export-data\/{id}":{"get":{"tags":["GDPR Data Extractor"],"summary":"Export a single GDPR data provider item","description":"Fetches the data for a single data provider item (by ID) and returns it as a downloadable JSON file.","operationId":"gdpr_export","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"providerKey","in":"query","description":"The key of the single provider to export","required":true,"schema":{"type":"string","example":"pimcore_users"}}],"responses":{"200":{"description":"Successfully retrieved the data export as a downloadable JSON file.","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"*\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/gdpr\/providers":{"get":{"tags":["GDPR Data Extractor"],"summary":"List of available GDPR providers","description":"Returns a list of all configured GDPR providers that can be used for data compliance operations.","operationId":"gdpr_list_providers","responses":{"200":{"description":"Successfully retrieved the list of GDPR providers","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/GdprDataProvider"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/gdpr\/search":{"post":{"tags":["GDPR Data Extractor"],"summary":"Search for GDPR data from all the available data providers","description":"Searches for GDPR data using the provided search terms and returns a list of results grouped by each provider name.","operationId":"gdpr_search_data","parameters":[{"name":"provider","in":"query","description":"Define the data provider to search in.","required":false,"schema":{"type":"string","example":"assets"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022type\u0022:\u0022firstname\u0022, \u0022filterValue\u0022: \u0022John\u0022},{\u0022type\u0022:\u0022lastname\u0022, \u0022filterValue\u0022: \u0022Doe\u0022},{\u0022type\u0022:\u0022email\u0022, \u0022filterValue\u0022: \u0022john.doe@mail.com\u0022},{\u0022type\u0022:\u0022id\u0022, \u0022filterValue\u0022: 1}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022id\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully retrieved the list of matching data from all searched providers.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/GdprDataRow"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/mercure\/auth":{"post":{"tags":["Mercure"],"summary":"Retrieve JWT token for Mercure hub as cookie","description":"Retrieve JWT token for Mercure hub as cookie","operationId":"mercure_create_cookie","responses":{"200":{"description":"Retrieve JWT token for Mercure hub as cookie"},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/{id}\/custom-metadata":{"get":{"tags":["Metadata"],"summary":"Get custom metadata of an asset by ID","description":"Retrieves custom metadata based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing asset\n","operationId":"asset_custom_metadata_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved custom metadata as JSON","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/CustomMetadata"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/metadata":{"post":{"tags":["Metadata"],"summary":"Get predefined metadata collection","description":"Get predefined metadata collection with basic filter options","operationId":"metadata_get_collection","requestBody":{"required":false,"content":{"application\/json":{"schema":{"properties":{"filter":{"type":["string","null"],"example":"author"}},"type":"object"}}}},"responses":{"200":{"description":"Predefined metadata collection","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/PredefinedMetadata"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notes":{"post":{"tags":["Notes"],"summary":"Get paginated notes","description":"Get paginated notes. \u003Cbr\u003E\nYou can use different query parameters to filter the notes\n","operationId":"note_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["page","pageSize"],"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"sortOrder":{"description":"Sort order (asc or desc).","type":"string","enum":["ASC","DESC"],"example":"ASC"},"sortBy":{"description":"Sort by field. Only works in combination with sortOrder.","type":"string","enum":["id","type","cId","cType","cPath","date","title","description","locked"],"example":"id"},"filter":{"description":"Filter for notes","type":"string","example":""},"fieldFilters":{"description":"Filter for specific fields, will be json decoded to an array. e.g.\n                        [{\u0022operator\u0022:\u0022like\u0022,\u0022value\u0022:\u0022John\u0022,\u0022field\u0022:\u0022name\u0022,\u0022type\u0022:\u0022string\u0022}]","type":"object","example":"[{\u0022operator\u0022:\u0022like\u0022,\u0022value\u0022:\u0022consent-given\u0022,\u0022field\u0022:\u0022type\u0022,\u0022type\u0022:\u0022string\u0022}]"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated notes with total count","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Note"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notes\/{id}":{"delete":{"tags":["Notes"],"summary":"Delete note with given id","description":"Delete the note with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"note_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"note_delete_by_id_success_description"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notes\/{elementType}\/{id}":{"get":{"tags":["Notes"],"summary":"Get paginated notes for an element by id","description":"Get paginated notes for a specific element by its \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nYou can use different query parameters to filter the notes\n","operationId":"note_element_get_collection","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":50}},{"name":"sortBy","in":"query","description":"Sort by field. Only works in combination with sortOrder.","required":false,"schema":{"type":"string","enum":["id","type","cId","cType","cPath","date","title","description","locked"],"example":"id"}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":"notes"}},{"name":"fieldFilters","in":"query","description":"Filter for specific fields, will be json decoded to an array. e.g.\n            [{\u0022operator\u0022:\u0022like\u0022,\u0022value\u0022:\u0022John\u0022,\u0022field\u0022:\u0022name\u0022,\u0022type\u0022:\u0022string\u0022}]","required":false,"schema":{"type":"string","example":"[{\u0022operator\u0022:\u0022like\u0022,\u0022value\u0022:\u0022John\u0022,\u0022field\u0022:\u0022name\u0022, \u0022type\u0022:\u0022string\u0022}]"}}],"responses":{"200":{"description":"Paginated notes with total count","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Note"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Notes"],"summary":"Create a new note for element with given id","description":"Create a new note for the element with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe note will be created for the current user.\n","operationId":"note_element_create","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateNote"}}}},"responses":{"200":{"description":"Created note for element","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Note"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notes\/type\/{elementType}":{"get":{"tags":["Notes"],"summary":"Get note types","description":"Get note types collection by \u003Cstrong\u003E{elementType}\u003C\/strong\u003E","operationId":"note_element_get_type_collection","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Note types collection","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/NoteType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notifications":{"post":{"tags":["Notifications"],"summary":"Get paginated notifications","description":"Get all paginated notifications for current user. \u003Cbr\u003E You can specify different filters in your request body. Available filters are: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Etitle\u003C\/strong\u003E: Filter by title string\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EcreationDate\u003C\/strong\u003E: Filter by creation date (on, from, to)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the page.size\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage.size\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"notification_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022creationDate\u0022, \u0022type\u0022:\u0022date\u0022, \u0022filterValue\u0022:{\u0022operator\u0022: \u0022on\u0022, \u0022value\u0022: \u002208\/20\/2024\u0022}},{\u0022key\u0022:\u0022title\u0022, \u0022type\u0022:\u0022like\u0022, \u0022filterValue\u0022: \u0022notification\u0022},{\u0022key\u0022:\u0022type\u0022, \u0022type\u0022:\u0022equals\u0022, \u0022filterValue\u0022: \u0022info\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022creationDate\u0022, \u0022direction\u0022:\u0022DESC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated notifications with total count","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/NotificationListItem"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Notifications"],"summary":"Delete all user notifications","description":"Delete all notifications for the current user","operationId":"notification_delete_all","responses":{"200":{"description":"Successfully deleted all notifications"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notifications\/{id}":{"get":{"tags":["Notifications"],"summary":"Get notification by ID","description":"Get the notification with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E Current user can only get notifications, where he is the recipient.\n","operationId":"notification_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Notification data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Notification"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Notifications"],"summary":"Mark notification as read","description":"Mark the notification with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E as read. \u003Cbr\u003E Current user can only mark notifications as read, where he is the recipient.\n","operationId":"notification_read_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully marked notification as read"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Notifications"],"summary":"Delete notification with given id","description":"Delete the notification with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E Current user can only delete notifications, where he is the recipient.\n","operationId":"notification_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted notification"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notifications\/unread-count":{"get":{"tags":["Notifications"],"summary":"Count of unread notifications for the current user","description":"Count of unread notifications for the current user","operationId":"notification_get_unread_count","responses":{"200":{"description":"Count of unread notifications for the current user","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnreadCount"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notifications\/recipients":{"get":{"tags":["Notifications"],"summary":"Get all notification recipients for the current user","description":"Get all notification recipients for the current user","operationId":"notification_get_recipients","responses":{"200":{"description":"List of notification recipients for the current user","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Recipient"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/notifications\/send":{"post":{"tags":["Notifications"],"summary":"Send a notification","description":"Send a notification to the given \u003Cstrong\u003E{recipientId}\u003C\/strong\u003E. \u003Cbr\u003E See the full description of request fields with the schema \u003Cstrong\u003ESendNotificationParameters\u003C\/strong\u003E\n","operationId":"notification_send","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SendNotificationParameters"}}}},"responses":{"200":{"description":"Successfully sent notification"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/configuration":{"post":{"tags":["Perspectives"],"summary":"Create a new perspective","description":"Create a new perspective with default values.\n","operationId":"perspective_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AddPerspectiveConfig"}}}},"responses":{"200":{"description":"Id of the new perspective"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/configurations":{"get":{"tags":["Perspectives"],"summary":"Get all perspective configurations","description":"Listing of all available perspectives","operationId":"perspective_get_config_collection","responses":{"200":{"description":"List of perspective configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PerspectiveConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/configuration\/{perspectiveId}":{"get":{"tags":["Perspectives"],"summary":"Get perspective configuration by ID","description":"Get the perspective configuration with the given \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E must be an ID of an existing perspective.\n","operationId":"perspective_get_config_by_id","parameters":[{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"studio_default_perspective"}}],"responses":{"200":{"description":"Perspective configuration data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PerspectiveConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Perspectives"],"summary":"Update widget configuration by id and type","description":"Update the perspective configuration with the given \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E must be an ID of an existing perspective. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall configuration fields\u003Cstrong\u003E have to be provided.\n","operationId":"perspective_update_config_by_id","parameters":[{"name":"perspectiveId","in":"path","description":"Update perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SavePerspectiveConfig"}}}},"responses":{"200":{"description":"Successfully updated perspective configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Perspectives"],"summary":"Delete perspective by given id","description":"Delete the perspective with the given \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{perspectiveId}\u003C\/strong\u003E must be an ID of an existing perspective.\n","operationId":"perspective_delete","parameters":[{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"Successfully deleted perspective"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/widgets\/{widgetType}\/configuration":{"post":{"tags":["Perspectives"],"summary":"Create a new widget","description":"Create a new widget with default values based on the provided \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E.\n\u003Cbr\u003E The widget type has to be registered via Symfony Configuration.\n\u003Cbr\u003E Please note that \u003Cstrong\u003E{name}\u003C\/strong\u003E has to be provided.\n","operationId":"perspective_widget_create","parameters":[{"name":"widgetType","in":"path","description":"Create widget by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Id of the new widget"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/widgets\/configurations":{"get":{"tags":["Perspectives"],"summary":"Get all widget configurations","description":"Listing of all available widget configurations","operationId":"perspective_widget_get_config_collection","parameters":[{"name":"skipWrapperWidgets","in":"query","description":"Skip wrapper widget configurations","required":false,"schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"List of widget configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/WidgetConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/widgets\/{widgetType}\/configuration\/{widgetId}":{"get":{"tags":["Perspectives"],"summary":"Get widget configuration by id and type","description":"Get the widget configuration with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration.\n","operationId":"perspective_widget_get_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"responses":{"200":{"description":"Widget configuration data as JSON","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Data of the widget configuration","type":"string","example":"Test content"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Perspectives"],"summary":"Update widget configuration by id and type","description":"Update the widget configuration with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall configuration fields\u003Cstrong\u003E have to be provided.\n","operationId":"perspective_widget_update_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Update widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Update widget by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated widget configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Perspectives"],"summary":"Delete widget with given id and type","description":"Delete the widget with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration.\n","operationId":"perspective_widget_delete","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"responses":{"200":{"description":"Successfully deleted widget"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/perspectives\/widgets\/types":{"get":{"tags":["Perspectives"],"summary":"Get widget types","description":"Get widget types collection","operationId":"perspective_widget_get_type_collection","responses":{"200":{"description":"List of widget types","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/WidgetType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/properties":{"get":{"tags":["Properties"],"summary":"Get all predefined properties. You can filter by type and query","description":"Listing all the predefined properties that are currently stored in the system. \u003Cbr\u003E\nTo list specific properties for a type you can use the \u003Cstrong\u003EelementType\u003C\/strong\u003E query parameter.\u003Cbr\u003E\nYou can also created element type specific listings for this, to show in the context of the element. \u003Cbr\u003E\nThe \u003Cstrong\u003Efilter\u003C\/strong\u003E query parameter is applied on the string properties. \u003Cbr\u003E\nKeep in mind that the name is language specific.\n","operationId":"property_get_collection","parameters":[{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":false,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":"properties"}}],"responses":{"200":{"description":"Predefined properties filtered based on type and query parameters","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/PredefinedProperty"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/property":{"post":{"tags":["Properties"],"summary":"Creating new property with default values","description":"Creating the property with default values. \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003EName: New Property\u003C\/li\u003E\n  \u003Cli\u003EKey: new_key\u003C\/li\u003E\n  \u003Cli\u003EType: Text\u003C\/li\u003E\n  \u003Cli\u003EElement Type: Document (Ctype)\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"property_create","responses":{"200":{"description":"Created predefined property with default values","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PredefinedProperty"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/properties\/{id}":{"put":{"tags":["Properties"],"summary":"Updating a property","description":"Updating the property with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nSee the full description of updatable fields with the schema \u003Cstrong\u003EUpdatePredefinedProperty\u003C\/strong\u003E\n","operationId":"property_update","parameters":[{"name":"id","in":"path","description":"Id of the property","required":true,"schema":{"type":"string","example":"alpha-numerical"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdatePredefinedProperty"}}}},"responses":{"200":{"description":"Updated predefined property","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PredefinedProperty"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Properties"],"summary":"Delete property with given id","description":"Deleting the property with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nIf the property is used in any element, it will not be deleted.\n","operationId":"property_delete","parameters":[{"name":"id","in":"path","description":"Id of the property","required":true,"schema":{"type":"string","example":"alpha-numerical"}}],"responses":{"200":{"description":"Successfully deleted property with given id"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/properties\/{elementType}\/{id}":{"get":{"tags":["Properties"],"summary":"Get properties for an element based on the element type and the element id","description":"List all the saved properties of the element. \u003Cbr\u003E\nKeep in mind  that inherited properties should not be send back in an update request. \u003Cbr\u003E\nThis will result in the loss of the inheritance. \u003Cbr\u003E\n","operationId":"property_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Element Properties data as json","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/ElementProperty"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/recycle-bin\/items":{"post":{"tags":["Recycle Bin"],"summary":"Get paginated recycle bin items","description":"Get all paginated recycle bin items. \u003Cbr\u003E You can specify different filters in your request body. Example filters are: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the page.size\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Edate\u003C\/strong\u003E: Filter by deletion date (on, from, to)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epath\u003C\/strong\u003E: Filter by element path\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Etype\u003C\/strong\u003E: Filter by element type (asset, document, object)\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"recycle_bin_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022date\u0022, \u0022type\u0022:\u0022date\u0022, \u0022filterValue\u0022:{\u0022operator\u0022: \u0022on\u0022, \u0022value\u0022: \u002208\/20\/2024\u0022}},{\u0022key\u0022:\u0022path\u0022, \u0022type\u0022:\u0022like\u0022, \u0022filterValue\u0022: \u0022\/path\/to\/element\u0022},{\u0022key\u0022:\u0022type\u0022, \u0022type\u0022:\u0022equals\u0022, \u0022filterValue\u0022: \u0022asset\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022date\u0022, \u0022direction\u0022:\u0022DESC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated recycle bin items with total count","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/RecycleBin"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/recycle-bin\/delete":{"delete":{"tags":["Recycle Bin"],"summary":"Delete items from the recycle bin","description":"Delete items from the recycle bin based on the given \u003Cstrong\u003E{items}\u003C\/strong\u003E array. \u003Cbr\u003E \nThe \u003Cstrong\u003E{items}\u003C\/strong\u003E array must contain IDs of existing recycle bin items. \u003Cbr\u003E \nIf multiple items are being deleted, the operation is executed asynchronously.\n","operationId":"recycle_bin_delete_items","requestBody":{"content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully deleted recycle bin item"},"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E to delete recycle bin items","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/recycle-bin\/flush":{"delete":{"tags":["Recycle Bin"],"summary":"Flush the recycle bin","description":"Flush the recycle bin. \u003Cbr\u003E This will delete all items in the recycle bin.\n","operationId":"recycle_bin_flush","responses":{"200":{"description":"Successfully flushed recycle bin"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/recycle-bin\/restore":{"post":{"tags":["Recycle Bin"],"summary":"Restore items from the recycle bin","description":"Restores items from the recycle bin based on the given \u003Cstrong\u003E{items}\u003C\/strong\u003E array. \u003Cbr\u003E \nThe \u003Cstrong\u003E{items}\u003C\/strong\u003E array must contain IDs of existing recycle bin items. \u003Cbr\u003E \nIf multiple items are being restored, the operation is executed asynchronously.\n","operationId":"recycle_bin_restore_items","requestBody":{"content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully restored recycle bin item"},"201":{"description":"Successfully created \u003Cstrong\u003EjobRun\u003C\/strong\u003E to restore recycle bin items","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role\/clone\/{id}":{"post":{"tags":["Role Management"],"summary":"Clone a specific Role.","operationId":"role_clone_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"name":{"type":"string","example":"Cloned Role"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the cloned Role.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role\/folder":{"post":{"tags":["Role Management"],"summary":"Create a new role folder.","operationId":"role_folder_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the new created Folder","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role":{"post":{"tags":["Role Management"],"summary":"Create a new role.","operationId":"role_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the new created Role.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role\/folder\/{id}":{"delete":{"tags":["Role Management"],"summary":"Delete a specific folder with all sub roles.","operationId":"role_folder_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the folder","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role\/{id}":{"get":{"tags":["Role Management"],"summary":"Get all available user roles.","operationId":"role_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of available user roles.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedRole"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Role Management"],"summary":"Update role by id.","operationId":"role_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the Role","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateRole"}}}},"responses":{"200":{"description":"Updated data.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedRole"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Role Management"],"summary":"Delete a specific role.","operationId":"role_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/roles":{"get":{"tags":["Role Management"],"summary":"Get all available roles.","description":"Get all available roles with basic information","operationId":"role_get_collection","responses":{"200":{"description":"List of available roles.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleRole"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/roles\/with-permission":{"get":{"tags":["Role Management"],"summary":"Get all roles with a specific permission","description":"Get all roles with the given permission \u003Cstrong\u003E{permission}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{permission}\u003C\/strong\u003E must be an existing user permission.\n","operationId":"role_list_with_permission","parameters":[{"name":"permission","in":"query","description":"List roles with this permission","required":true,"schema":{"type":"string","example":"assets"}}],"responses":{"200":{"description":"List of roles with the given permission","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleRole"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/roles\/tree":{"get":{"tags":["Role Management"],"summary":"Get collection of roles for tree view.","operationId":"role_get_tree","parameters":[{"name":"parentId","in":"query","description":"Filter roles by parent id.","required":true,"schema":{"type":"integer","minimum":0,"example":0}}],"responses":{"200":{"description":"Collection of roles including folders for the given parent id.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/TreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/role\/search":{"get":{"tags":["Role Management"],"summary":"Search for roles by query.","description":"Search for roles by query. The query can be a part of the role name or ID.","operationId":"role_search","parameters":[{"name":"searchQuery","in":"query","description":"Query to search for a role. This can be a part of role name or ID.","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"List of roles","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleRole"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/schedules\/{id}":{"delete":{"tags":["Schedule"],"summary":"Delete schedule with given id","description":"Deletes a specific schedule based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E.\n","operationId":"schedule_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the schedule","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"Successfully deleted schedule"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/schedules\/{elementType}\/{id}":{"get":{"tags":["Schedule"],"summary":"Get schedules for an element","description":"Get all schedules for a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\n","operationId":"schedule_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of schedules for element","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Schedule"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Schedule"],"summary":"Update schedules for an element","description":"Update schedules for a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nSee the full description of updatable fields with the schema \u003Cstrong\u003EUpdateSchedule\u003C\/strong\u003E\n","operationId":"schedule_update_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateSchedule"}}},"type":"object"}}}},"responses":{"200":{"description":"List of updated schedules","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Schedule"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Schedule"],"summary":"Create a schedule for element","description":"Create a new schedule with default values for the element with the given type \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe schedule will be created for the current user.\n","operationId":"schedule_create_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Created schedule for element","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Schedule"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/configuration\/assets":{"get":{"tags":["Search"],"summary":"Get asset search configuration","description":"Get asset configuration","operationId":"asset_get_search_configuration","responses":{"200":{"description":"Asset search configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/assets":{"post":{"tags":["Search"],"summary":"Get asset data for search","description":"Asset grid for search","operationId":"asset_get_search","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"Assets for search grid","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#\/components\/schemas\/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/configuration\/data-objects":{"get":{"tags":["Search"],"summary":"Get data object search configuration","description":"Get data object search configuration","operationId":"data_object_get_search_configuration","parameters":[{"name":"classId","in":"query","description":"Class Id of the data object","required":false,"schema":{"type":"string","example":"EV"}}],"responses":{"200":{"description":"Data object search configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/data-objects":{"post":{"tags":["Search"],"summary":"Get data object search results","description":"Get data object search results","operationId":"data_object_get_search","parameters":[{"name":"classId","in":"query","description":"Class Id of the data object","required":false,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"Data object search results","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#\/components\/schemas\/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/documents":{"post":{"tags":["Search"],"summary":"Get document data for search","description":"Document grid for search","operationId":"document_get_search","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"dcocument_get_search_success_response","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#\/components\/schemas\/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search\/preview\/{elementType}\/{id}":{"get":{"tags":["Search"],"summary":"Preview for element search result","description":"Returns search preview for elements based on the given type \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"simple_search_preview_get","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Simple search results preview for elements","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/AssetSearchPreview"},{"$ref":"#\/components\/schemas\/DataObjectSearchPreview"},{"$ref":"#\/components\/schemas\/DocumentSearchPreview"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/search":{"get":{"tags":["Search"],"summary":"Search for elements","description":"Search for elements based on the given \u003Cstrong\u003E{search term}\u003C\/strong\u003E. \u003Cbr\u003E\nElements are searched with the fulltext filter applied via Generic Data Index. \u003Cbr\u003E\n","operationId":"simple_search_get","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"searchTerm","in":"query","description":"Search term","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"Search results for elements","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleSearchResult"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/admin":{"get":{"tags":["Settings Admin"],"summary":"Get admin appearance settings","description":"Get admin appearance system settings. \u003Cbr\u003E\nIncludes branding and asset configuration options.\n","operationId":"admin_settings_get","responses":{"200":{"description":"Admin system settings data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminSettings"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/admin\/save":{"post":{"tags":["Settings Admin"],"summary":"Update admin appearance settings","description":"Update admin appearance system settings. \u003Cbr\u003E\nAllows updating branding and asset configuration options.\n","operationId":"admin_settings_update","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateAdminSettings"}}}},"responses":{"200":{"description":"Admin system settings updated successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/setting\/admin\/thumbnail":{"get":{"tags":["Settings Admin"],"summary":"Get thumbnail for images in admin settings","operationId":"setting_admin_thumbnail","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminSettingsThumbnailPath"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E429 - Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/available-countries":{"get":{"tags":["Settings"],"summary":"Get all available countries","description":"Get all available countries in the system. \u003Cbr\u003E\nReturns a list of countries with their codes and names\n","operationId":"settings_country_collection","responses":{"200":{"description":"List of available countries","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/AvailableCountry"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings":{"get":{"tags":["Settings"],"summary":"Get system settings","description":"Get system settings from different providers. \u003Cbr\u003E\nSystem settings are public and need no login.\n","operationId":"system_settings_get","responses":{"200":{"description":"System settings data","content":{"application\/json":{"schema":{"type":"object","additionalProperties":true}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Settings"],"summary":"Update system settings","description":"Update system settings. \u003Cbr\u003E\nThis endpoint allows you to update various system configuration parameters including: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Egeneral\u003C\/strong\u003E: Language settings (valid languages, fallback languages, required languages, default language), domain configuration, and translation debugging\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eobjects\u003C\/strong\u003E: Object versioning settings (days and steps to keep)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eassets\u003C\/strong\u003E: Asset versioning settings (days and steps to keep)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Edocuments\u003C\/strong\u003E: Document versioning settings and localized error pages\u003C\/li\u003E\n\u003C\/ul\u003E\n\u003Cstrong\u003ENote:\u003C\/strong\u003E Only the settings provided in the request body will be updated.\n","operationId":"settings_update","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"general":{"properties":{"valid_languages":{"description":"Valid language codes (ISO 639-1)","type":"array","items":{"type":"string"},"example":["en","de","fr"]},"fallback_languages":{"description":"Language fallback mapping (e.g., {\u0022de\u0022: \u0022en\u0022, \u0022fr\u0022: \u0022en\u0022})","type":"object","example":{"de":"en","fr":"en"}},"required_languages":{"description":"Required language codes (ISO 639-1)","type":"array","items":{"type":"string"},"example":["en"]},"default_language":{"description":"Default system language","type":"string","example":"en"},"domain":{"description":"Main domain for the system","type":"string","example":""},"redirect_to_maindomain":{"description":"Redirect to main domain","type":"boolean","example":false},"debug_admin_translations":{"description":"Enable translation debugging","type":"boolean","example":false}},"type":"object"},"objects":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep object versions","type":"integer"},"steps":{"description":"Number of version steps to keep for objects","type":"integer","example":10}},"type":"object"}},"type":"object"},"assets":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep asset versions","type":"integer"},"steps":{"description":"Number of version steps to keep for assets","type":"integer","example":10}},"type":"object"}},"type":"object"},"documents":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep document versions","type":"integer"},"steps":{"description":"Number of version steps to keep for documents","type":"integer","example":10}},"type":"object"},"error_pages":{"properties":{"default":{"description":"Default error page","type":"string","example":""},"localized":{"description":"Localized error page IDs (e.g., {\u0022en\u0022: \u00221\u0022, \u0022de\u0022: \u00222\u0022})","type":"object","example":{"en":"","de":""}}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Updated system settings"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/adapter\/image":{"get":{"tags":["Settings"],"summary":"Check image adapter","description":"Check what image adapter is used. \u003Cbr\u003E\nReturns \u003Cstrong\u003Etrue\u003C\/strong\u003E if Imagick extension is used for image processing. \u003Cbr\u003E\nReturns \u003Cstrong\u003Efalse\u003C\/strong\u003E if the GD library fallback is used, which provides lower quality image processing.\n","operationId":"settings_image_adapter_check","responses":{"200":{"description":"Image adapter availability"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/active-bundles":{"get":{"tags":["Settings"],"summary":"List all active bundles","description":"List all active and installed bundles in the system.\n","operationId":"active_bundles_get","responses":{"200":{"description":"List of active bundles","content":{"application\/json":{"schema":{"required":["bundles"],"properties":{"bundles":{"title":"Active Bundles","description":"List of active and installed bundles in the system.","type":"array","items":{"$ref":"#\/components\/schemas\/ActiveBundle"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/settings\/ping":{"get":{"tags":["Settings"],"summary":"Ping action","description":"Ping action to check if the API is reachable","operationId":"ping_action","responses":{"200":{"description":"API is reachable"},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/settings\/adapter\/video":{"get":{"tags":["Settings"],"summary":"Check video adapter validity","description":"Check if the video adapter is valid. \u003Cbr\u003E \nReturns \u003Cstrong\u003Etrue\u003C\/strong\u003E if FFmpeg is properly configured for video processing. \u003Cbr\u003E\nReturns \u003Cstrong\u003Efalse\u003C\/strong\u003E if video processing is not available due to missing PHP CLI binary or FFmpeg binary configuration.\n","operationId":"settings_video_adapter_check","responses":{"200":{"description":"Video adapter validity status"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags":{"get":{"tags":["Tags"],"summary":"Get all tags for a parent","description":"Get all tags for a \u003Cstrong\u003E{parentId}\u003C\/strong\u003E. \u003Cbr\u003E\nYou can use different query parameters to filter the tags\n","operationId":"tag_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":false,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":"properties"}},{"name":"parentId","in":"query","description":"Filter tags by parent id.","required":false,"schema":{"type":"integer","minimum":0,"example":1}}],"responses":{"200":{"description":"All tags for a parent filtered based on type and query parameters","content":{"application\/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tag":{"post":{"tags":["Tags"],"summary":"Create a new tag","description":"Create a new tag. \u003Cbr\u003E See the full description of request fields with the schema \u003Cstrong\u003ECreate Tag Parameters\u003C\/strong\u003E\n","operationId":"tag_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateTagParameters"}}}},"responses":{"200":{"description":"tag_create_success_description","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Tag"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags\/{id}":{"get":{"tags":["Tags"],"summary":"Get a tag by ID","description":"Retrieves a specific tag data based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"tag_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved tag data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Tag"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Tags"],"summary":"Update a tag by ID","description":"Update a specific tag based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nSee the full description of updatable fields with the schema \u003Cstrong\u003EChange Tag Parameters\u003C\/strong\u003E\n","operationId":"tag_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateTagParameters"}}}},"responses":{"200":{"description":"Successfully updated tag data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Tag"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Tags"],"summary":"Delete a specific tag","description":"Delete a specific tag based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"tag_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":10}}],"responses":{"200":{"description":"ID of successfully deleted tag","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of deleted tag","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags\/assign\/{elementType}\/{id}\/{tagId}":{"post":{"tags":["Tags for Element"],"summary":"Assign a tag to an element","description":"Assign a specific tag based on the given \u003Cstrong\u003E{tagId}\u003C\/strong\u003E to an element based on \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"tag_assign_to_element","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"tagId","in":"path","description":"TagId of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags\/batch\/{operation}\/{elementType}\/{id}":{"post":{"tags":["Tags for Element"],"summary":"Batch assign\/replace tags for children elements","description":"Batch assign\/replace multiple tags of the given parent based on the \u003Cstrong\u003E{elementId}\u003C\/strong\u003E and \u003Cstrong\u003E{elementType}\u003C\/strong\u003E to the children. \u003Cbr\u003E\nOperation parameter \u003Cstrong\u003E{operation}\u003C\/strong\u003E must be one of the \u003Cstrong\u003Eassign\u003C\/strong or \u003Cstrong\u003Ereplace\u003C\/strong\u003E.\n","operationId":"tag_batch_operation_to_elements_by_type_and_id","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"operation","in":"path","description":"Execute operation based on provided type.","required":true,"schema":{"type":"string","enum":["assign","replace"],"example":"assign"}}],"responses":{"201":{"description":"Successfully created jobRun for batch tag assignment\/replacement","content":{"application\/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags\/{elementType}\/{id}":{"get":{"tags":["Tags for Element"],"summary":"Get tags for an element","description":"Get paginated tag collection for a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E\n","operationId":"tag_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Paginated tags for element","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/tags\/{elementType}\/{id}\/{tagId}":{"delete":{"tags":["Tags for Element"],"summary":"Unassign a tag from an element","description":"Unassign a specific tag based on the given \u003Cstrong\u003E{tagId}\u003C\/strong\u003E from an element based on \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"tag_unassign_from_element","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"tagId","in":"path","description":"TagId of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/image":{"get":{"tags":["Asset Thumbnails"],"summary":"Get collection of thumbnails for images","description":"Get collection of thumbnails for images. \u003Cbr\u003E\nThe thumbnails have to be defined as downloadable in order to be listed in the collection.\n","operationId":"thumbnail_image_get_collection","responses":{"200":{"description":"All downloadable image thumbnails","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Thumbnail"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/image\/config":{"post":{"tags":["Asset Thumbnails"],"summary":"Create a new image thumbnail configuration","description":"Create a new image thumbnail configuration with the specified name. \u003Cbr\u003E\nThe name must be unique and not already used by an existing thumbnail configuration.\n","operationId":"thumbnail_image_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateThumbnailConfig"}}}},"responses":{"200":{"description":"Created image thumbnail configuration as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ImageThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/image\/config\/{name}":{"get":{"tags":["Asset Thumbnails"],"summary":"Get image thumbnail configuration","description":"Get a specific image thumbnail configuration by its name including settings and media transformations.\n","operationId":"thumbnail_image_get_by_name","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"Image thumbnail configuration as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ImageThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Asset Thumbnails"],"summary":"Update image thumbnail configuration","description":"Update a specific image thumbnail configuration by its name with new settings and media transformations.\n","operationId":"thumbnail_image_update","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateThumbnailConfig"}}}},"responses":{"200":{"description":"Updated image thumbnail configuration as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ImageThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Asset Thumbnails"],"summary":"Delete image thumbnail configuration","description":"Delete a specific image thumbnail configuration by its name.\n","operationId":"thumbnail_image_delete","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"Image thumbnail configuration successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/image\/tree":{"get":{"tags":["Asset Thumbnails"],"summary":"Get image thumbnails tree","description":"Get image thumbnail configuration tree with thumbnails organized by groups. \u003Cbr\u003E\nThumbnails without a group are listed directly, while grouped thumbnails are organized into folder nodes.\n","operationId":"thumbnail_image_get_tree","responses":{"200":{"description":"Image thumbnail configuration tree as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/ThumbnailConfigurationData"},{"$ref":"#\/components\/schemas\/ThumbnailConfigurationFolderData"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/video":{"get":{"tags":["Asset Thumbnails"],"summary":"Get collection of thumbnails for videos","description":"Get collection of all thumbnails for videos.\n","operationId":"thumbnail_video_get_collection","responses":{"200":{"description":"All video thumbnails","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Thumbnail"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/video\/config":{"post":{"tags":["Asset Thumbnails"],"summary":"Create a new video thumbnail configuration","description":"Creates a new video thumbnail configuration with the given \u003Cstrong\u003E{name}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be unique.\n","operationId":"thumbnail_video_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateThumbnailConfig"}}}},"responses":{"200":{"description":"Successfully created video thumbnail configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/VideoThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/video\/config\/{name}":{"get":{"tags":["Asset Thumbnails"],"summary":"Get video thumbnail configuration by name","description":"Retrieves a specific video thumbnail configuration based on the given \u003Cstrong\u003E{name}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing video thumbnail configuration.\n","operationId":"thumbnail_video_get_by_name","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"Successfully retrieved video thumbnail configuration details","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/VideoThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Asset Thumbnails"],"summary":"Update video thumbnail configuration by name","description":"Updates a specific video thumbnail configuration based on the given \u003Cstrong\u003E{name}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing video thumbnail configuration.\n","operationId":"thumbnail_video_update","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateThumbnailConfig"}}}},"responses":{"200":{"description":"Successfully updated video thumbnail configuration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/VideoThumbnailConfigDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Asset Thumbnails"],"summary":"Delete video thumbnail configuration by name","description":"Deletes a specific video thumbnail configuration based on the given \u003Cstrong\u003E{name}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{name}\u003C\/strong\u003E must be a name of an existing video thumbnail configuration.\n","operationId":"thumbnail_video_delete","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"Successfully deleted video thumbnail configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/thumbnails\/video\/tree":{"get":{"tags":["Asset Thumbnails"],"summary":"Get video thumbnail configuration tree","description":"Retrieves a tree structure of all video thumbnail configurations. \u003Cbr\u003E\nThumbnails are grouped by their group property.\n","operationId":"thumbnail_video_get_tree","responses":{"200":{"description":"Successfully retrieved video thumbnail configuration tree","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/ThumbnailConfigurationData"},{"$ref":"#\/components\/schemas\/ThumbnailConfigurationFolderData"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/available-locales":{"get":{"tags":["Translation"],"summary":"Get all available locales in the system","description":"Get all available locales in the system","operationId":"translation_get_available_locales","responses":{"200":{"description":"List of available locales in the system","content":{"application\/json":{"schema":{"type":"array","items":{"required":["local","displayName"],"properties":{"locale":{"title":"locale","description":"Locale code.","type":"string","example":"de_de"},"displayName":{"title":"Display Name","description":"The display name of the locale.","type":"string","example":"Deutsch (Deutschland)"}},"type":"object"}}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/{domain}\/cleanup":{"delete":{"tags":["Translation"],"summary":"Cleanup translations for the given domain","description":"Cleanup translations for the given domain","operationId":"translation_cleanup_by_domain","parameters":[{"name":"domain","in":"path","description":"Domain of the translation, to be cleaned up","required":true,"schema":{"type":"string","example":"admin"}}],"responses":{"200":{"description":"Translation cleaned up successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/create":{"post":{"tags":["Translation"],"summary":"Create translations","description":"Add new translation entries for given translation key\n","operationId":"translation_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateTranslation"}}}},"responses":{"200":{"description":"Successfully created translations"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/csv-settings":{"post":{"tags":["Translation"],"summary":"Determine CSV dialect settings for import","description":"Determine CSV dialect settings for import from a sample string.\n","operationId":"translation_determine_csv_settings_for_import","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["sample"],"properties":{"sample":{"description":"Sample CSV content (first few lines)","type":"string","example":"name,value\\n\u0022John Doe\u0022,123\\n\u0022Jane Smith\u0022,456"}},"type":"object"}}}},"responses":{"200":{"description":"Detected CSV dialect settings","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CsvSettings"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/{key}":{"delete":{"tags":["Translation"],"summary":"Delete translations","description":"Delete translations for given translation key","operationId":"translation_delete_by_key","parameters":[{"name":"key","in":"path","description":"Delete translations by matching key","required":true,"schema":{"type":"string","example":"some_key"}},{"name":"domain","in":"query","description":"Domain of the translation, defaults to \u0022studio\u0022","required":false,"schema":{"type":"string","example":"studio"}}],"responses":{"200":{"description":"translation_delete_by_key_success_description"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/domains":{"get":{"tags":["Translation"],"summary":"Get all available translation domains","description":"Get all available translation domains","operationId":"translation_get_domains","responses":{"200":{"description":"List of available translation domains","content":{"application\/json":{"schema":{"type":"array","items":{"required":["domain","isFrontendDomain"],"properties":{"domain":{"title":"Domain","description":"The domain name.","type":"string","example":"admin"},"isFrontendDomain":{"title":"Is Frontend Domain","description":"If the domain is a frontend or admin domain.","type":"boolean","example":false}},"type":"object"}}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/export":{"post":{"tags":["Translation"],"summary":"Export translations for the given domain","description":"Export translations for the given domain. \u003Cbr\u003E \nYou can specify different filters in your request body. Example filters are: \u003Cbr\u003E\n  \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003EtranslationLike\u003C\/strong\u003E: Filter by value\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Esearch\u003C\/strong\u003E: Filter by search term\u003C\/li\u003E\n  \u003C\/ul\u003E\n","operationId":"translation_export_list","parameters":[{"name":"domain","in":"query","description":"Domain to filter translations by","required":false,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022de\u0022, \u0022type\u0022:\u0022translationLike\u0022, \u0022filterValue\u0022: \u0022%car%\u0022},{\u0022type\u0022:\u0022search\u0022, \u0022filterValue\u0022: \u0022search term\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022key\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"CSV export file for the given domain","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022studio_translations.csv\u0022"}}},"content":{"text\/csv":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/{domain}\/import":{"post":{"tags":["Translation"],"summary":"Import translations from a CSV file","description":"Import translations from a CSV file for the given domain. \u003Cbr\u003E\nSee the full description of request fields with the schema \u003Cstrong\u003ECsvSettings\u003C\/strong\u003E\n","operationId":"translation_import_csv","parameters":[{"name":"domain","in":"path","description":"Domain of the translation for import","required":true,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file","csvSettings"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"},"csvSettings":{"description":"Settings for CSV import","properties":{"delimiter":{"type":"string","example":";"},"quoteChar":{"type":"string","example":"\u0022"},"escapeChar":{"type":"string","example":"\\"},"lineTerminator":{"type":"string","example":""}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Translation delta based on imported data","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/DeltaItem"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/list":{"post":{"tags":["Translation"],"summary":"Get all translations for the given domain","description":"Get all paginated translations for the given domain. \u003Cbr\u003E\nYou can specify different filters in your request body. Example filters are: \u003Cbr\u003E\n  \u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the pageSize\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EtranslationLike\u003C\/strong\u003E: Filter by value\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Esearch\u003C\/strong\u003E: Filter by search term\u003C\/li\u003E\n  \u003C\/ul\u003E\n","operationId":"translation_get_list","parameters":[{"name":"domain","in":"query","description":"Domain to filter translations by","required":false,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022de\u0022, \u0022type\u0022:\u0022translationLike\u0022, \u0022filterValue\u0022: \u0022%car%\u0022},{\u0022type\u0022:\u0022search\u0022, \u0022filterValue\u0022: \u0022search term\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022de\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"List of translations for the given domain including all languages","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Translations"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations":{"post":{"tags":["Translation"],"summary":"Get translations","description":"Get translations for given keys and locale","operationId":"translation_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Translation"}}}},"responses":{"200":{"description":"Key value pairs for given keys and locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Translation"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/translations\/{domain}":{"put":{"tags":["Translation"],"summary":"Update translations","description":"Update translations for given translation data and locale.The \u003Cstrong\u003E{key}\u003C\/strong\u003E must be an existing translation key. \u003Cbr\u003E \nSee the full description of updatable translation data fields with the schema \u003Cstrong\u003ETranslationData\u003C\/strong\u003E\n","operationId":"translation_update","parameters":[{"name":"domain","in":"path","description":"Domain of the translation, to be updated","required":true,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateTranslation"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated translations"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/unit\/quantity-value\/convert-all":{"get":{"tags":["Units"],"summary":"Convert quantity value from one unit to all other related units","description":"Convert quantity \u003Cstrong\u003E{value}\u003C\/strong\u003E from one unit to all other available units based on the given \u003Cstrong\u003E{fromUnitId}\u003C\/strong\u003E. \u003Cbr\u003E\nUnits have to have \u003Cstrong\u003E{fromUnitId}\u003C\/strong\u003E defined as base unit to be considered for conversion.\n","operationId":"unit_quantity_value_convert_all","parameters":[{"name":"fromUnitId","in":"query","description":"Id of the unit to convert from","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"type":"number","format":"number","example":3.14},"example":5}],"responses":{"200":{"description":"Converted quantity value","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConvertedQuantityValues"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/unit\/quantity-value\/convert":{"get":{"tags":["Units"],"summary":"Convert quantity value from one unit to another","description":"Convert quantity \u003Cstrong\u003E{value}\u003C\/strong\u003E from one unit to another based on the given \u003Cstrong\u003E{fromUnitId}\u003C\/strong\u003E and \u003Cstrong\u003E{toUnitId}\u003C\/strong\u003E\n","operationId":"unit_quantity_value_convert","parameters":[{"name":"fromUnitId","in":"query","description":"Id of the unit to convert from","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"toUnitId","in":"query","description":"Id of the unit to convert to","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"type":"number","format":"number","example":3.14},"example":5}],"responses":{"200":{"description":"Converted quantity value","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Converted value","example":2,"anyOf":[{"type":"number"},{"type":"integer"}]}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/unit\/quantity-value\/unit-list":{"get":{"tags":["Units"],"summary":"List of available quantity value units","description":"List of available quantity value units\n","operationId":"unit_quantity_value_list","responses":{"200":{"description":"List of quantity value units","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/QuantityValueUnit"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/clone\/{id}":{"post":{"tags":["User Management"],"summary":"Clone a specific user.","operationId":"user_clone_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"name":{"type":"string","example":"Cloned User"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the cloned user.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/":{"post":{"tags":["User Management"],"summary":"Create a new user.","operationId":"user_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the new created User.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/folder":{"post":{"tags":["User Management"],"summary":"Create a new user folder.","operationId":"user_folder_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Node of the new created Folder.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TreeNode"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/current-user-information":{"get":{"tags":["User Management"],"summary":"Retrieve information\u0027s about the current logged in user.","operationId":"user_get_current_information","responses":{"200":{"description":"Current user information\u0027s.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserInformation"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/{id}":{"get":{"tags":["User Management"],"summary":"Retrieve a specific user by ID.","operationId":"user_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Node of the requested user.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["User Management"],"summary":"Update user by id.","operationId":"user_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateUser"}}}},"responses":{"200":{"description":"Updated data.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["User Management"],"summary":"Delete a specific user.","operationId":"user_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/folder\/{id}":{"delete":{"tags":["User Management"],"summary":"Delete a specific user folder with all users in this folder.","operationId":"user_folder_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user-folder","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/image\/{id}":{"get":{"tags":["User Management"],"summary":"Get user profile image","operationId":"user_get_image","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"User profile image","content":{"image\/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["User Management"],"summary":"Delete user image by ID","description":"Delete the image of a specific user based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing user.\n","operationId":"user_image_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted user image"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/users\/default-key-bindings":{"get":{"tags":["User Management"],"summary":"Get default key bindings","description":"Get default key bindings for user management\n","operationId":"user_default_key_bindings","responses":{"200":{"description":"List of default key bindings","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/KeyBinding"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/available-permissions":{"get":{"tags":["User Management"],"summary":"Get all available user permissions.","operationId":"user_get_available_permissions","responses":{"200":{"description":"List of available user permissions.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/UserPermission"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/users":{"get":{"tags":["User Management"],"summary":"Get all users","description":"Get all users with basic information","operationId":"user_get_collection","responses":{"200":{"description":"List of users","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleUser"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/users\/with-permission":{"get":{"tags":["User Management"],"summary":"Get all users with a specific permission","description":"Get all users with the given permission \u003Cstrong\u003E{permission}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{permission}\u003C\/strong\u003E must be an existing user permission.\n","operationId":"user_list_with_permission","parameters":[{"name":"permission","in":"query","description":"List users with this permission","required":true,"schema":{"type":"string","example":"assets"}},{"name":"includeCurrentUser","in":"query","description":"Include current user in the list","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"List of users with the given permission","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleUser"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/reset-password":{"post":{"tags":["User Management"],"summary":"Sending username to reset password.","operationId":"user_reset_password","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResetPassword"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E429 - Too Many Requests","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/search":{"get":{"tags":["User Management"],"summary":"Search for users by query.","description":"Search for users by query. The query can be a part of the username, first name, last name, email or user ID.","operationId":"pimcore_studio_api_user_search","parameters":[{"name":"searchQuery","in":"query","description":"Query to search for an user. This can be a part of username, firstname, lastname, email or ID.","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"List of users","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleUser"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/token-link\/{id}":{"post":{"tags":["User Management"],"summary":"Generate login link and token for a user by ID","description":"Generate a login link with a token for a user based on the provided user \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing user.\n","operationId":"user_token_link_get","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TokenLink"}}}},"responses":{"200":{"description":"Token login link for the user","content":{"application\/json":{"schema":{"required":["link"],"properties":{"link":{"title":"Token link URL","description":"Token link URL including the generated token as parameter.","type":"string","example":"https:\/\/example.com\/login?token=abcdef"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/active-perspective\/{perspectiveId}":{"put":{"tags":["User Management"],"summary":"Update the active perspective for the current user.","operationId":"user_update_active_perspective","parameters":[{"name":"perspectiveId","in":"path","description":"Set active perspective by Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"Updated active perspective for the current user."},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/{id}\/password":{"put":{"tags":["User Management"],"summary":"Update password for a User by the User id.","operationId":"user_update_password_by_id","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["password","passwordConfirmation"],"properties":{"password":{"type":"string"},"passwordConfirmation":{"type":"string"},"oldPassword":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/update-profile":{"put":{"tags":["User Management"],"summary":"Update the current user profile","description":"Update the current user profile. \u003Cbr\u003E See the full description of updatable fields with the schema \u003Cstrong\u003EUpdateUserProfile\u003C\/strong\u003E\n","operationId":"user_update_profile","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateUserProfile"}}}},"responses":{"200":{"description":"Successfully updated user profile","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserInformation"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/user\/upload-image\/{id}":{"post":{"tags":["User Management"],"summary":"Upload user image","operationId":"user_upload_image","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["userImage"],"properties":{"userImage":{"description":"User image to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/users\/tree":{"get":{"tags":["User Management"],"summary":"Get collection of users for tree view.","operationId":"user_get_tree","parameters":[{"name":"parentId","in":"query","description":"Filter users by parent id.","required":true,"schema":{"type":"integer","minimum":0,"example":0}}],"responses":{"200":{"description":"Collection of users including folders for the given parent id.","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/TreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/versions\/{id}\/asset\/download":{"get":{"tags":["Versions"],"summary":"Download asset version by ID","description":"Download the asset version based on the provided version \u003Cstrong\u003E{id}\u003C\/strong\u003E.\n","operationId":"version_asset_download_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Asset version binary file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/versions\/{id}\/image\/stream":{"get":{"tags":["Versions"],"summary":"Stream image version thumbnail by ID","description":"Stream the image version thumbnail based on the provided version \u003Cstrong\u003E{id}\u003C\/strong\u003E.\n","operationId":"version_image_stream_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Image thumbnail version stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"image\/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/versions\/{id}\/pdf\/stream":{"get":{"tags":["Versions"],"summary":"Stream PDF version by ID","description":"Stream the PDF version based on the provided version \u003Cstrong\u003E{id}\u003C\/strong\u003E.\n","operationId":"version_pdf_stream_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"PDF version stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022example.jpg\u0022"}}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"202 - Not Completed\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/versions\/{id}":{"get":{"tags":["Versions"],"summary":"Get a specific version by ID","description":"Retrieves a specific version data based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an id of existing version.\n","operationId":"version_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved version data as JSON","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/AssetVersion"},{"$ref":"#\/components\/schemas\/DataObjectVersion"},{"$ref":"#\/components\/schemas\/DocumentVersion"}]}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Versions"],"summary":"Update a version by ID","description":"Updates a version based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an id of existing version. \u003Cbr\u003E See the full description of updatable fields with the schema \u003Cstrong\u003EUpdateVersion\u003C\/strong\u003E\n","operationId":"version_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateVersion"}}}},"responses":{"200":{"description":"Successfully updated version"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Versions"],"summary":"Publish a specific version by ID","description":"Publishes a specific version based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an id of existing version.\n","operationId":"version_publish_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"ID of the published version","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of published version","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Versions"],"summary":"Delete a specific version","description":"Deletes a specific version based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an id of existing version.\n","operationId":"version_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted version"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/versions\/{elementType}\/{id}":{"get":{"tags":["Versions"],"summary":"Get versions for an element","description":"List all the versions of the element. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"version_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"Paginated element Versions data as JSON with total count as header param","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Version"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Versions"],"summary":"Cleanup all versions for an element","description":"Cleans up all versions for a specific element based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E The \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an existing element of the provided \u003Cstrong\u003E{elementType}\u003C\/strong\u003E.\n","operationId":"version_cleanup_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the ID of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"IDs of the removed versions","content":{"application\/json":{"schema":{"required":["ids"],"properties":{"ids":{"title":"IDs","description":"IDs of deleted versions","type":"array","items":{"type":"integer","example":420}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/website-settings\/add":{"post":{"tags":["Website Settings"],"summary":"Add a new website setting","description":"Add a new website setting with the provided name and type.\nThe following types are supported: \u003Cstrong\u003Etext\u003C\/strong\u003E, \u003Cstrong\u003Edocument\u003C\/strong\u003E, \u003Cstrong\u003Easset\u003C\/strong\u003E, \u003Cstrong\u003Eobject\u003C\/strong\u003E, \u003Cstrong\u003Ebool\u003C\/strong\u003E. \u003Cbr\u003E\n","operationId":"website_settings_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebsiteSettingsAdd"}}}},"responses":{"200":{"description":"Successfully added website setting","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebsiteSetting"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/website-settings":{"post":{"tags":["Website Settings"],"summary":"Get paginated website settings","description":"Get all paginated website settings. \u003Cbr\u003E You can specify different filters in your request body. Example filters are: \u003Cbr\u003E\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003Epage\u003C\/strong\u003E: Used for offset calculation in pagination. To be used, needs to be defined together with the page.size\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EpageSize\u003C\/strong\u003E: Used for limiting the result numbers per page. To be used, needs to be defined together with the page\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Ename\u003C\/strong\u003E: Filter by settings name\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Etype\u003C\/strong\u003E: Filter by settings type (text, document, asset, object, bool)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EcreationDate\u003C\/strong\u003E: Filter by creation date (on, from, to)\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"website_settings_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022key\u0022:\u0022creationDate\u0022, \u0022type\u0022:\u0022date\u0022, \u0022filterValue\u0022:{\u0022operator\u0022: \u0022on\u0022, \u0022value\u0022: \u002208\/20\/2024\u0022}},{\u0022key\u0022:\u0022name\u0022, \u0022type\u0022:\u0022like\u0022, \u0022filterValue\u0022: \u0022SettingsName\u0022},{\u0022key\u0022:\u0022type\u0022, \u0022type\u0022:\u0022equals\u0022, \u0022filterValue\u0022: \u0022text\u0022}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022name\u0022, \u0022direction\u0022:\u0022DESC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated website settings with total count","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/WebsiteSetting"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/website-settings\/{id}":{"put":{"tags":["Website Settings"],"summary":"Update a website setting","description":"Update a website setting with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E.\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing website setting. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall fields\u003Cstrong\u003E have to be provided.\n","operationId":"website_settings_update","parameters":[{"name":"id","in":"path","description":"Id of the website setting","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebsiteSettingsUpdate"}}}},"responses":{"200":{"description":"Successfully updated website setting","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebsiteSetting"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Website Settings"],"summary":"Delete a website setting","description":"Delete a website setting with the given \u003Cstrong\u003E{id}\u003C\/strong\u003E.\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of an existing DocType. \u003Cbr\u003E\n","operationId":"website_settings_delete","parameters":[{"name":"id","in":"path","description":"Id of the website setting","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted website setting"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/website-settings\/types":{"get":{"tags":["Website Settings"],"summary":"List all website setting types","description":"List all available website setting types.\nReturns an array of website setting types with their keys and titles.\n","operationId":"website_settings_list_types","responses":{"200":{"description":"List of all available website setting types","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/WebsiteSettingsType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/workflows\/details":{"get":{"tags":["Workflows"],"summary":"Get all workflow details of an element","description":"Get details of the element workflows based on the given \u003Cstrong\u003E{elementType}\u003C\/strong\u003E and \u003Cstrong\u003E{elementId}\u003C\/strong\u003E.\n","operationId":"workflow_get_details","parameters":[{"name":"elementId","in":"query","description":"ID of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"Detail data of element workflows","content":{"application\/json":{"schema":{"required":["items","layoutId"],"properties":{"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowDetails"}},"layoutId":{"title":"layoutId","type":"string"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/workflows\/action":{"post":{"tags":["Workflows"],"summary":"Submit workflow action","description":"Submit action based on the workflow name, action name and action type.","operationId":"workflow_action_submit","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SubmitAction"}}}},"responses":{"200":{"description":"Json encoded name of workflow, name and type of submitted action.","content":{"application\/json":{"schema":{"properties":{"workflowName":{"title":"workflowName","type":"string","example":"MyAwesomeWorkflow"},"actionName":{"title":"actionName","type":"string","example":"MyAwesomeAction"},"actionType":{"title":"actionType","type":"string","example":"transition"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/add":{"post":{"tags":["Bundle Data Hub"],"summary":"Add Data Hub Configuration","description":"Create a new Data Hub configuration","operationId":"bundle_data_hub_config_add","parameters":[{"name":"name","in":"query","description":"The name of the configuration","required":true,"schema":{"type":"string","example":"assets"}},{"name":"type","in":"query","description":"Type of the adapter","required":true,"schema":{"type":"string","example":"graphql"}},{"name":"path","in":"query","description":"Configuration path","required":false,"schema":{"type":"string","example":""}}],"responses":{"201":{"description":"Data Hub configuration successfully created"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/clone":{"post":{"tags":["Bundle Data Hub"],"summary":"Clone Data Hub Configuration","description":"Clone an existing Data Hub configuration with a new name","operationId":"bundle_data_hub_config_clone","parameters":[{"name":"name","in":"query","description":"The name of the new configuration","required":true,"schema":{"type":"string","example":"assets_copy"}},{"name":"originalName","in":"query","description":"The name of the configuration to clone","required":true,"schema":{"type":"string","example":"assets"}}],"responses":{"201":{"description":"Data Hub configuration successfully cloned"},"default":{"description":"201 - Created\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config":{"get":{"tags":["Bundle Data Hub"],"summary":"Data Hub Config Collection","description":"Data Hub Config Collection","operationId":"bundle_data_hub_config_collection","responses":{"200":{"description":"bundle_copilot_actions_success_response","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataHubConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/delete\/{name}":{"delete":{"tags":["Bundle Data Hub"],"summary":"Delete Data Hub Configuration","description":"Delete a Data Hub configuration by name","operationId":"bundle_data_hub_config_delete","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Hub configuration successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/{name}\/export":{"get":{"tags":["Bundle Data Hub"],"summary":"Export Data Hub Configuration","description":"Export a Data Hub configuration as a JSON file","operationId":"bundle_data_hub_config_export","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Hub configuration successfully exported"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/{name}":{"get":{"tags":["Bundle Data Hub"],"summary":"Get Data Hub Configuration","description":"Get a Data Hub configuration by name","operationId":"bundle_data_hub_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Hub configuration details","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataHubConfigurationDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Data Hub"],"summary":"Update Data Hub Configuration","description":"Update an existing Data Hub configuration with validation for concurrent modifications","operationId":"bundle_data_hub_config_update","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataHubUpdateConfiguration"}}}},"responses":{"200":{"description":"Data Hub configuration successfully updated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataHubUpdateConfigurationResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/config\/import":{"post":{"tags":["Bundle Data Hub"],"summary":"Import Data Hub Configuration","description":"Import a Data Hub configuration from a JSON file","operationId":"bundle_data_hub_config_import","requestBody":{"description":"Configuration file to import","required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"JSON configuration file","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Data Hub configuration successfully imported"},"default":{"description":"201 - Created\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/graphql\/explorer\/{clientname}":{"get":{"tags":["Bundle Data Hub"],"summary":"Get GraphQL Explorer","description":"Get the GraphQL Explorer interface for testing and exploring GraphQL endpoints","operationId":"bundle_data_hub_graphql_explorer","parameters":[{"name":"clientname","in":"path","description":"Clientname of the client","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"GraphQL Explorer HTML interface","content":{"text\/html":{"schema":{"description":"GraphQL Explorer HTML interface","type":"string","example":"\u003C!DOCTYPE html\u003E\u003Chtml lang=\u0022en\u0022\u003E\u003Cbody\u003E...\u003C\/body\u003E\u003C\/html\u003E"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/graphql\/explorer-url\/{name}":{"get":{"tags":["Bundle Data Hub"],"summary":"Get GraphQL Explorer URL","description":"Get the URL for the GraphQL Explorer interface for a specific configuration","operationId":"bundle_data_hub_graphql_explorer_url","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"GraphQL Explorer URL","content":{"application\/json":{"schema":{"required":["explorerUrl"],"properties":{"explorerUrl":{"title":"explorerUrl","description":"The GraphQL Explorer URL for the specified configuration","type":"string","example":"\/pimcore-datahub-webservices\/explorer\/my-config"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/thumbnails":{"get":{"tags":["Bundle Data Hub"],"summary":"Get Data Hub Thumbnails Collection","description":"Get a list of available image thumbnail configurations for Data Hub","operationId":"bundle_data_hub_thumbnails_collection","responses":{"200":{"description":"List of available thumbnail configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataHubThumbnail"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-hub\/users":{"get":{"tags":["Bundle Data Hub"],"summary":"Get Data Hub Users Collection","description":"Get a list of users and roles that can be assigned permissions in Data Hub configurations","operationId":"bundle_data_hub_users_collection","parameters":[{"name":"type","in":"query","description":"Filter by user type (user or role)","required":false,"schema":{"type":"string","default":"user","enum":["user","role"]}}],"responses":{"200":{"description":"List of users and roles available for Data Hub permissions","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataHubPermissionUser"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/personalization\/target-groups":{"get":{"tags":["Bundle Personalization"],"summary":"Get target group list","description":"Get list of target groups. If the \u003Cstrong\u003E{includeDefault}\u003C\/strong\u003E parameter is true, the default target group will be included in the response.\n","operationId":"bundle_personalization_target_group_list","parameters":[{"name":"includeDefault","in":"query","description":"If true, default target group is included in the response","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"Target group list as JSON","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetGroup"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Bundle Personalization"],"summary":"Create a new target group","description":"Create a new target group with the specified name.\n","operationId":"bundle_personalization_target_group_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationCreateTargetingGroup"}}}},"responses":{"200":{"description":"Created target group details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingGroupDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/personalization\/target-groups\/{id}":{"get":{"tags":["Bundle Personalization"],"summary":"Get target group by ID","description":"Get detailed information about a specific target group by its ID.\n","operationId":"bundle_personalization_target_group_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the target group","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Detailed target group information as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingGroupDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Personalization"],"summary":"Update target group","description":"Update a specific target group by its ID with the provided configuration data.\n","operationId":"bundle_personalization_target_group_update","parameters":[{"name":"id","in":"path","description":"Id of the target group","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationUpdateTargetingGroup"}}}},"responses":{"200":{"description":"Updated target group details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingGroupDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Personalization"],"summary":"Delete target group","description":"Delete a specific target group by its ID.\n","operationId":"bundle_personalization_target_group_delete","parameters":[{"name":"id","in":"path","description":"Id of the target group","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Target group successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/personalization\/targeting-rules":{"get":{"tags":["Bundle Personalization"],"summary":"Get targeting rule list","description":"Get list of targeting rules order by priority.\n","operationId":"bundle_personalization_targeting_rule_collection","responses":{"200":{"description":"Targeting rule list as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRule"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Bundle Personalization"],"summary":"Create a new targeting rule","description":"Create a new targeting rule with the specified name.\n","operationId":"bundle_personalization_targeting_rule_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationCreateTargetingRule"}}}},"responses":{"200":{"description":"Created targeting rule details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRuleDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/personalization\/targeting-rules\/{id}":{"get":{"tags":["Bundle Personalization"],"summary":"Get targeting rule by ID","description":"Get detailed information about a specific targeting rule by its ID including conditions and actions.\n","operationId":"bundle_personalization_targeting_rule_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the targeting rule","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Detailed targeting rule information as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRuleDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Personalization"],"summary":"Update targeting rule","description":"Update a specific targeting rule by its ID and provided configuration data.\n","operationId":"bundle_personalization_targeting_rule_update","parameters":[{"name":"id","in":"path","description":"Id of the targeting rule","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationUpdateTargeting"}}}},"responses":{"200":{"description":"Updated targeting rule details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRuleDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Personalization"],"summary":"Delete targeting rule","description":"Delete a specific targeting rule by its ID.\n","operationId":"bundle_personalization_targeting_rule_delete","parameters":[{"name":"id","in":"path","description":"Id of the targeting rule","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Targeting rule successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/personalization\/targeting-rules\/priority":{"put":{"tags":["Bundle Personalization"],"summary":"Update targeting rule priorities","description":"Update the priorities of multiple targeting rules. Rules will be reordered based on the provided priority values.\n","operationId":"bundle_personalization_targeting_rule_priority_update","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundlePersonalizationUpdateTargetingPriority"}}}},"responses":{"200":{"description":"Updated targeting rule list ordered by new priorities","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRule"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/statistics-explorer\/custom-reports\/data-sources\/{dataSource}\/fields":{"get":{"tags":["Bundle Statistics Explorer"],"summary":"Get custom reports data sources fields","description":"Get custom reports data sources fields. Use {dataSource} to specify data source name.","operationId":"bundle_statistics_explorer_custom_reports_data_sources_fields","parameters":[{"name":"dataSource","in":"path","description":"The data source to retrieve the fields for","required":true,"schema":{"type":"string","example":"db_assets"}}],"responses":{"200":{"description":"Custom Reports Data Sources Fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFields"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/statistics-explorer\/custom-reports\/data-sources\/{dataSource}\/fields\/settings":{"post":{"tags":["Bundle Statistics Explorer"],"summary":"Get custom reports data sources fields settings","description":"Get custom reports data sources fields settings.  Use {dataSource} to specify data source name.","operationId":"bundle_statistics_explorer_custom_reports_data_sources_fields_settings","parameters":[{"name":"dataSource","in":"path","description":"The data source to retrieve the fields for","required":true,"schema":{"type":"string","example":"db_assets"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["statisticsMode","aggregations","columns"],"properties":{"statisticsMode":{"description":"The statistics mode to be used.","type":"string","example":"list"},"aggregations":{"description":"The aggregations to be applied.","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}},"columns":{"description":"The columns to be included in the result.","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}}},"type":"object"}}}},"responses":{"200":{"description":"Custom Reports Data Sources Fields Settings","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFieldsDefinition"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/statistics-explorer\/custom-reports\/data-sources":{"get":{"tags":["Bundle Statistics Explorer"],"summary":"Get custom reports data sources","description":"Get custom reports data sources","operationId":"bundle_statistics_explorer_custom_reports_data_sources","responses":{"200":{"description":"Custom Reports Data Sources","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSource"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/enterprise-subscription-tools\/license\/":{"get":{"tags":["Bundle Enterprise Subscription Tools"],"summary":"Check license and get environment information","description":"Check license and get environment information","operationId":"bundle_enterprise_subscription_tools_license","responses":{"200":{"description":"License check result and environment information","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleEnterpriseSubscriptionToolsLicenseInformation"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection":{"post":{"tags":["Bundle Portal Engine"],"summary":"Add Collection","description":"Create a new collection in Portal Engine","operationId":"bundle_portal_engine_collection_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name","portalId"],"properties":{"name":{"type":"string"},"portalId":{"type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Collection created successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineCollection"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}":{"delete":{"tags":["Bundle Portal Engine"],"summary":"Delete Collection","description":"Delete a collection by its ID","operationId":"bundle_portal_engine_delete_collection","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"translation_delete_by_key_success_description"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"patch":{"tags":["Bundle Portal Engine"],"summary":"Update Collection","description":"Update an existing collection in Portal Engine","operationId":"bundle_portal_engine_collection_update","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Collection updated successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineCollection"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/list":{"post":{"tags":["Bundle Portal Engine"],"summary":"List Collections","description":"List all collections available for Portal Engine","operationId":"bundle_portal_engine_collection_list","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022type\u0022:\u0022search\u0022, \u0022filterValue\u0022: \u0022search term\u0022},{\u0022type\u0022:\u0022showAll\u0022, \u0022filterValue\u0022: true}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022portal\u0022, \u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collection_success_response","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineCollection"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/list-portals":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Portals","description":"List portals available for collection management","operationId":"bundle_portal_engine_collection_list_portals","responses":{"200":{"description":"Collection of available portals","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineCollectionPortal"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/share-list":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Collection Sharing","description":"List sharing assignments for a collection","operationId":"bundle_portal_engine_collection_share_list","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"List of sharing assignments for the collection","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineCollectionShareListItem"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Bundle Portal Engine"],"summary":"Update Collection Sharing","description":"Update sharing assignments for a collection","operationId":"bundle_portal_engine_collection_share_list_update","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["shareListItems"],"properties":{"shareListItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineCollectionShareListItem"}}},"type":"object"}}}},"responses":{"200":{"description":"Collection sharing updated successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/tree\/add\/{rootNodeId}":{"post":{"tags":["Bundle Portal Engine"],"summary":"Add Tree Item","description":"Add a new tree item to a collection","operationId":"bundle_portal_engine_collections_tree_add","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"rootNodeId","in":"path","description":"RootNodeId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["elementIds"],"properties":{"elementIds":{"type":"object","example":[123,456]}},"type":"object"}}}},"responses":{"200":{"description":"Tree item added successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/tree\/delete\/{rootNodeId}":{"post":{"tags":["Bundle Portal Engine"],"summary":"Delete Tree Items","description":"Delete tree items from a collection","operationId":"bundle_portal_engine_collections_tree_delete_elements","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"rootNodeId","in":"path","description":"RootNodeId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["elementIds"],"properties":{"elementIds":{"type":"object","example":[123,456]}},"type":"object"}}}},"responses":{"200":{"description":"Tree items deleted successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/tree-information":{"get":{"tags":["Bundle Portal Engine"],"summary":"Get Tree Information","description":"Retrieve tree information for Portal Engine collections","operationId":"bundle_portal_engine_collections_tree_information","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Tree information entry","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineTreeInformation"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/tree-items":{"get":{"tags":["Bundle Portal Engine"],"summary":"Get Tree Items","description":"Retrieve tree items for the requested collection","operationId":"bundle_portal_engine_collections_tree_items","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","example":1}},{"name":"pageSize","in":"query","description":"How many results to return","required":true,"schema":{"type":"integer","example":30}},{"name":"node","in":"query","description":"Node is for items to list","required":true,"schema":{"type":"integer","example":30}},{"name":"filter","in":"query","description":"When provided, the items are filtered by value.","required":false,"schema":{"type":"string","example":"some-search-term"}}],"responses":{"200":{"description":"Tree items for the requested collection","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/BundlePortalEngineDataObject"},{"$ref":"#\/components\/schemas\/BundlePortalEngineAsset"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/tree-root-nodes":{"get":{"tags":["Bundle Portal Engine"],"summary":"Get Tree Root Nodes","description":"Retrieve root nodes for the collection tree","operationId":"bundle_portal_engine_collections_tree_root_nodes","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Root nodes for the requested collection tree","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineTreeFolder"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collections\/check-user-assignment":{"get":{"tags":["Bundle Portal Engine"],"summary":"Check Admin User Assignment","description":"Check whether the current Pimcore user is assigned to a portal user for collections access","operationId":"bundle_portal_engine_collections_user_assignment_check","responses":{"200":{"description":"Assignment status for the current Pimcore user","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineAdminUserAssignment"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/collection\/{collectionId}\/user-search":{"get":{"tags":["Bundle Portal Engine"],"summary":"Search User Groups","description":"Search user groups within a collection by query","operationId":"bundle_portal_engine_collection_user_search","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"searchQuery","in":"query","description":"Term to filter user groups","required":false,"schema":{"type":"string","example":"deal"}},{"name":"excludeIds","in":"query","description":"Comma-separated list of IDs excluded from the search result","required":false,"schema":{"type":"string","example":"1,2,3"}}],"responses":{"200":{"description":"Collection of matching user groups","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineCollectionUserGroup"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/index-management":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Indices","description":"List all indices available for Portal Engine","operationId":"bundle_portal_engine_index_management_list","responses":{"200":{"description":"List of indices","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/IndexStat"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/index-management\/queue-item-count":{"get":{"tags":["Bundle Portal Engine"],"summary":"Get Indexing Queue Count","description":"Get count of items in the indexing queue","operationId":"bundle_portal_engine_index_management_queue_count","responses":{"200":{"description":"Count of items in the indexing queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/QueueItemCount"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/index-management\/re-index":{"post":{"tags":["Bundle Portal Engine"],"summary":"Re-index Indices","description":"Re-index all indices for Portal Engine","operationId":"bundle_portal_engine_index_management_re_index","responses":{"200":{"description":"Re-index started"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/index-management\/update-index":{"post":{"tags":["Bundle Portal Engine"],"summary":"Update Index Mapping","description":"Update index mapping for Portal Engine","operationId":"bundle_portal_engine_index_management_update_index","responses":{"200":{"description":"Update index mapping started"},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/create-portal":{"post":{"tags":["Bundle Portal Engine"],"summary":"Create Portal","description":"Create a new portal using the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_create_portal","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["portalName","domain","availableLanguages"],"properties":{"portalName":{"type":"string"},"domain":{"type":"string"},"availableLanguages":{"type":"array","items":{"type":"string"},"example":["de","en"]},"logo":{"type":"string"},"loginBackgroundImage":{"type":"string"},"objectPools":{"type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineWizardObjectPool"}},"assetPools":{"type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineWizardAssetPool"}}},"type":"object"}}}},"responses":{"200":{"description":"Portal tmpStoreKey to check the status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineWizardStartResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/custom-layouts\/{classId}":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Custom Layouts for Class","description":"List available custom layouts for the given class in the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_class_custom_layouts","parameters":[{"name":"classId","in":"path","description":"Class ID","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"Collection of available custom layouts for the class","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineWizardCustomLayout"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/available-formats":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Formats","description":"List available download formats for the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_available_formats","responses":{"200":{"description":"Collection of available download formats","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineWizardFormat"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/icons":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Icons","description":"List available icons for the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_icons","responses":{"200":{"description":"Collection of available icons","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineIcon"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/available-thumbnails":{"get":{"tags":["Bundle Portal Engine"],"summary":"List Thumbnails","description":"List available thumbnails for the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_available_thumbnails","responses":{"200":{"description":"Collection of available thumbnails","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/PortalEngineWizardThumbnail"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/portal-engine\/wizard\/{tmpStoreKey}\/status":{"get":{"tags":["Bundle Portal Engine"],"summary":"Check Portal Creation Status","description":"Check the status of the portal creation process in the Portal Engine wizard","operationId":"bundle_portal_engine_wizard_status","parameters":[{"name":"tmpStoreKey","in":"path","description":"Temporary store key returned by the wizard start endpoint.","required":true,"schema":{"type":"string","example":"portal-engine_wizard_650a9242c8b1d"}}],"responses":{"200":{"description":"Status of the portal creation process","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PortalEngineWizardStatusResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/classificationstore\/attributes":{"get":{"tags":["Bundle Data Importer"],"summary":"Load Classification Store Attributes","description":"Load available classification store field definitions for a given data object class","operationId":"bundle_data_importer_classificationstore_load_attributes","parameters":[{"name":"classId","in":"query","description":"The ID of the data object class to load classification store attributes for","required":true,"schema":{"type":"string","example":"Product"}}],"responses":{"200":{"description":"List of classification store attributes for the class","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterClassAttributesResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/classificationstore\/key-name":{"get":{"tags":["Bundle Data Importer"],"summary":"Load Classification Store Key Name","description":"Resolve the group name and key name for a classification store key by its combined group-key ID","operationId":"bundle_data_importer_classificationstore_load_key_name","parameters":[{"name":"keyId","in":"query","description":"The classification store key ID in group-key format (e.g., \u00221-5\u0022)","required":true,"schema":{"type":"string","example":"1-5"}}],"responses":{"200":{"description":"The resolved group name and key name, or the key ID as fallback","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterClassificationStoreKeyNameResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/classificationstore\/keys":{"get":{"tags":["Bundle Data Importer"],"summary":"Load Classification Store Keys","description":"Load paginated classification store key-group relations for a given class and field, with sorting, filtering, and search support","operationId":"bundle_data_importer_classificationstore_load_keys","parameters":[{"name":"classId","in":"query","description":"The ID of the data object class","required":true,"schema":{"type":"string","example":"Product"}},{"name":"fieldName","in":"query","description":"The classification store field name","required":true,"schema":{"type":"string","example":"classificationStore"}},{"name":"transformationResultType","in":"query","description":"Filter keys by transformation result data type","required":true,"schema":{"type":"string","example":"default"}},{"name":"sort","in":"query","description":"JSON-encoded sort configuration","required":false,"schema":{"type":"string","example":null}},{"name":"start","in":"query","description":"Pagination offset","required":false,"schema":{"type":"integer","example":0}},{"name":"limit","in":"query","description":"Maximum number of results","required":false,"schema":{"type":"integer","example":15}},{"name":"searchfilter","in":"query","description":"Search string to filter keys by name, group name, or description","required":false,"schema":{"type":"string","example":null}},{"name":"filter","in":"query","description":"JSON-encoded column filter configuration","required":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Paginated list of classification store key-group relations with total count","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterClassificationStoreKeysResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/transformation-result-type":{"post":{"tags":["Bundle Data Importer"],"summary":"Calculate Transformation Result Type","description":"Calculate the expected data type of a transformation result for a single mapping configuration entry","operationId":"bundle_data_importer_config_calculate_transformation_result_type","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterCalculateTransformationResultTypeParameters"}}}},"responses":{"200":{"description":"The evaluated transformation result data type","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterTransformationResultTypeResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/cancel-execution":{"put":{"tags":["Bundle Data Importer"],"summary":"Cancel Import Execution","description":"Cancel a running import execution and clean up the processing queue for a Data Importer configuration","operationId":"bundle_data_importer_config_cancel_execution","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Import execution cancelled and queue cleaned up successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/check-import-progress":{"get":{"tags":["Bundle Data Importer"],"summary":"Check Import Progress","description":"Check the progress of a running batch import for a Data Importer configuration, returning status, total items, processed items, and progress percentage","operationId":"bundle_data_importer_config_check_import_progress","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Import progress status with running state and item counts","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterImportProgressResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/copy-preview":{"post":{"tags":["Bundle Data Importer"],"summary":"Copy Preview Data","description":"Copy data from the configured data source into preview storage for a Data Importer configuration","operationId":"bundle_data_importer_config_copy_preview","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterCopyPreviewParameters"}}}},"responses":{"200":{"description":"Preview data copied successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E413 - Max File Size Exceeded\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}":{"get":{"tags":["Bundle Data Importer"],"summary":"Get Data Importer Configuration","description":"Get a Data Importer configuration by name with full details including loader, interpreter, resolver, mapping, and execution settings","operationId":"bundle_data_importer_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Importer configuration details with column headers","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterConfigurationDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Data Importer"],"summary":"Save Data Importer Configuration","description":"Save\/update a Data Importer configuration by name with full settings including loader, interpreter, resolver, mapping, and execution config","operationId":"bundle_data_importer_config_save","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterConfigurationSaveParameters"}}}},"responses":{"200":{"description":"Successfully saved configuration with updated details","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterConfigurationDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/has-import-file-uploaded":{"get":{"tags":["Bundle Data Importer"],"summary":"Check Import File Status","description":"Check whether an import file has been uploaded for a Data Importer configuration","operationId":"bundle_data_importer_config_has_import_file_uploaded","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Import file existence status with file path and translated message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterImportFileStatusResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/column-headers":{"post":{"tags":["Bundle Data Importer"],"summary":"Load Column Headers","description":"Load available column headers from preview data for a Data Importer configuration","operationId":"bundle_data_importer_config_load_column_headers","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterCopyPreviewParameters"}}}},"responses":{"200":{"description":"Available column headers from the preview data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterColumnHeadersResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/load-preview":{"post":{"tags":["Bundle Data Importer"],"summary":"Load Preview Data","description":"Load and interpret preview data for a Data Importer configuration, returning column-level preview with mapping information","operationId":"bundle_data_importer_config_load_preview","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterLoadPreviewParameters"}}}},"responses":{"200":{"description":"Preview data with column details and record index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterDataPreviewResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/transformation-result":{"post":{"tags":["Bundle Data Importer"],"summary":"Load Transformation Result Previews","description":"Generate transformation result previews for each mapping entry of a Data Importer configuration using preview data","operationId":"bundle_data_importer_config_load_transformation_result","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterLoadPreviewParameters"}}}},"responses":{"200":{"description":"Transformation result preview strings for each mapping entry","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterTransformationResultPreviewsResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/start-import":{"put":{"tags":["Bundle Data Importer"],"summary":"Start Batch Import","description":"Prepare and start a batch import for a Data Importer configuration, ignoring the active flag","operationId":"bundle_data_importer_config_start_import","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the import was successfully prepared and started","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterImportStartResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/upload-import-file":{"post":{"tags":["Bundle Data Importer"],"summary":"Upload Import File","description":"Upload a data file for import into the configured Flysystem storage for a Data Importer configuration","operationId":"bundle_data_importer_config_upload_import_file","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import data file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Import file uploaded successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/config\/{name}\/upload-preview":{"post":{"tags":["Bundle Data Importer"],"summary":"Upload Preview Data","description":"Upload a preview data file for a Data Importer configuration","operationId":"bundle_data_importer_config_upload_preview","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Preview data file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Preview data uploaded successfully"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E413 - Max File Size Exceeded\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/connection\/list":{"get":{"tags":["Bundle Data Importer"],"summary":"List Database Connections","description":"List all available Doctrine database connections for use in Data Importer configuration","operationId":"bundle_data_importer_connection_list","responses":{"200":{"description":"List of available database connections with names and service identifiers","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterConnectionsResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/data-type\/class-attributes":{"get":{"tags":["Bundle Data Importer"],"summary":"Load Class Attributes","description":"Load available data object attributes for a given class, filtered by transformation result data type","operationId":"bundle_data_importer_data_type_load_class_attributes","parameters":[{"name":"classId","in":"query","description":"The ID of the data object class to load attributes for","required":true,"schema":{"type":"string","example":"Product"}},{"name":"loadAdvancedRelations","in":"query","description":"Whether to include advanced relation field types","required":false,"schema":{"type":"boolean","example":false}},{"name":"systemRead","in":"query","description":"Whether to include system read fields","required":false,"schema":{"type":"boolean","example":false}},{"name":"systemWrite","in":"query","description":"Whether to include system write fields","required":false,"schema":{"type":"boolean","example":false}},{"name":"transformationResultType","in":"query","description":"Filter attributes by transformation result data type. If not provided, defaults to DEFAULT and NUMERIC types.","required":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"List of available data object attributes for the class","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterClassAttributesResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/data-type\/unit-data":{"get":{"tags":["Bundle Data Importer"],"summary":"Load Unit Data","description":"Load all available quantity value units ordered by abbreviation, for use in Data Importer mapping configuration","operationId":"bundle_data_importer_data_type_load_unit_data","responses":{"200":{"description":"List of available quantity value units with IDs and abbreviations","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterUnitDataResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-importer\/utility\/check-crontab":{"get":{"tags":["Bundle Data Importer"],"summary":"Validate Cron Expression","description":"Validate a cron expression for use in Data Importer scheduling configuration","operationId":"bundle_data_importer_utility_check_crontab","parameters":[{"name":"cronExpression","in":"query","description":"The cron expression to validate","required":false,"schema":{"type":"string","example":"*\/5 * * * *"}}],"responses":{"200":{"description":"Cron expression validation result with validity flag and error message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleDataImporterCronValidationResponse"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/bricks":{"post":{"tags":["Bundle Headless Documents"],"summary":"Create a new brick","description":"Create a new brick with the specified name. \u003Cbr\u003E\nThe name must be unique and not already used by an existing brick.\n","operationId":"bundle_headless_documents_brick_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsCreateConfig"}}}},"responses":{"200":{"description":"Created brick details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrickDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/bricks\/detail\/{name}":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get brick","description":"Get a specific brick data by its name including the YAML-formatted content.\n","operationId":"bundle_headless_documents_brick_get_by_name","parameters":[{"name":"name","in":"path","description":"Brick unique name","required":true,"schema":{"type":"string","example":"simple"}}],"responses":{"200":{"description":"Brick as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrickDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Headless Documents"],"summary":"Update brick","description":"Update a specific brick by its name with new YAML-formatted content.\n","operationId":"bundle_headless_documents_brick_update","parameters":[{"name":"name","in":"path","description":"Brick unique name","required":true,"schema":{"type":"string","example":"simple"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsUpdateConfig"}}}},"responses":{"200":{"description":"Updated brick details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrickDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Headless Documents"],"summary":"Delete brick","description":"Delete a specific brick by its name.\n","operationId":"bundle_headless_documents_brick_delete","parameters":[{"name":"name","in":"path","description":"Brick unique name","required":true,"schema":{"type":"string","example":"simple"}}],"responses":{"200":{"description":"Brick successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/bricks\/help-info":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get brick help info","description":"Get brick help information including available editables with their YAML configuration examples.\n","operationId":"bundle_headless_documents_brick_help_info","responses":{"200":{"description":"Brick help information as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrickHelp"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/bricks\/list":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get bricks list","description":"Get a list of all brick configuration IDs.\n","operationId":"bundle_headless_documents_brick_list","responses":{"200":{"description":"Brick list as JSON","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsConfigList"}}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/bricks\/tree":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get bricks tree","description":"Get brick tree with bricks organized by groups. \u003Cbr\u003E\nBricks without a group are listed directly, while grouped bricks are organized into folder nodes.\n","operationId":"bundle_headless_documents_brick_tree","responses":{"200":{"description":"Brick tree as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrick"},{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrickFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/templates":{"post":{"tags":["Bundle Headless Documents"],"summary":"Create a new template","description":"Create a new template with the specified name. \u003Cbr\u003E\nThe name must be unique and not already used by an existing template.\n","operationId":"bundle_headless_documents_template_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsCreateConfig"}}}},"responses":{"200":{"description":"Created template details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplateDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/templates\/detail\/{name}":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get template","description":"Get a specific template data by its name including the YAML-formatted content.\n","operationId":"bundle_headless_documents_template_get_by_name","parameters":[{"name":"name","in":"path","description":"Template unique name","required":true,"schema":{"type":"string","example":"simple"}}],"responses":{"200":{"description":"Template as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplateDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Headless Documents"],"summary":"Update template","description":"Update a specific template by its name with new YAML-formatted content.\n","operationId":"bundle_headless_documents_template_update","parameters":[{"name":"name","in":"path","description":"Template unique name","required":true,"schema":{"type":"string","example":"simple"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsUpdateConfig"}}}},"responses":{"200":{"description":"Updated template details as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplateDetail"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Headless Documents"],"summary":"Delete template","description":"Delete a specific template by its name.\n","operationId":"bundle_headless_documents_template_delete","parameters":[{"name":"name","in":"path","description":"Template unique name","required":true,"schema":{"type":"string","example":"simple"}}],"responses":{"200":{"description":"Template successfully deleted"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/templates\/help-info":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get template help info","description":"Get template help information including available layouts and editables with their YAML configuration examples.\n","operationId":"bundle_headless_documents_template_help_info","responses":{"200":{"description":"Template help information as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplateHelp"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/templates\/list":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get templates list","description":"Get a list of all template configuration IDs.\n","operationId":"bundle_headless_documents_template_list","responses":{"200":{"description":"Template list as JSON","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsConfigList"}}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/headless-documents\/templates\/tree":{"get":{"tags":["Bundle Headless Documents"],"summary":"Get templates tree","description":"Get template tree with templates organized by groups. \u003Cbr\u003E\nTemplates without a group are listed directly, while grouped templates are organized into folder nodes.\n","operationId":"bundle_headless_documents_template_tree","responses":{"200":{"description":"Template tree as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplate"},{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplateFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/cancel-generation":{"post":{"tags":["Bundle Web To Print"],"summary":"Cancel Web to Print PDF generation process","description":"Cancel an ongoing PDF generation process based on the provided web to print \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document\n","operationId":"bundle_web_to_print_cancel_generation_process","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully canceled Web to Print PDF generation process"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/check-pdf-dirty":{"get":{"tags":["Bundle Web To Print"],"summary":"Check if Web to Print document is dirty","description":"Check if the document based on the provided web to print \u003Cstrong\u003E{documentId}\u003C\/strong\u003E has unsaved changes since the last PDF generation. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document\n","operationId":"bundle_web_to_print_get_pdf_dirty","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Web to Print document dirty status","content":{"application\/json":{"schema":{"required":["isDirty"],"properties":{"isDirty":{"title":"isDirty","description":"True if document changed since the last PDF generation","type":"boolean","example":true}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/pdf-download":{"get":{"tags":["Bundle Web To Print"],"summary":"Download Web to Print generated PDF file","description":"Download the generated PDF file for a Web to Print document based on the provided web to print \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document and the PDF must have been generated successfully\n","operationId":"bundle_web_to_print_pdf_download","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Web to Print generated PDF file","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022someGeneratedDocument.pdf\u0022"}}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/generation-process-data":{"get":{"tags":["Bundle Web To Print"],"summary":"Get Web to Print PDF generation process data","description":"Retrieve the status and details of a Web to Print PDF generation process based on the provided web to print \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document\n","operationId":"bundle_web_to_print_get_generation_process_data","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Web to Print PDF generation process data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleWebToPrintGenerateProcessData"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/processing-options":{"get":{"tags":["Bundle Web To Print"],"summary":"Get Web to Print PDF generation processing options","description":"Retrieve the available PDF generation processing options for a Web to Print document based on the provided \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document\n","operationId":"bundle_web_to_print_get_processing_options","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Web to Print PDF generation processing options as JSON","content":{"application\/json":{"schema":{"required":["options"],"properties":{"options":{"title":"Processing Options","description":"Processing options used for PDF generation.","type":"array","items":{"$ref":"#\/components\/schemas\/BundleWebToPrintProcessingOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/start-generation":{"post":{"tags":["Bundle Web To Print"],"summary":"Start Web to Print PDF generation process","description":"Initiate the PDF generation process for a Web to Print document based on the provided \u003Cstrong\u003E{documentId}\u003C\/strong\u003E and processing options. \u003Cbr\u003E\nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document\n","operationId":"bundle_web_to_print_start_generation_process","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"author":{"type":["string","null"]},"title":{"type":["string","null"]},"printermarks":{"type":["boolean","null"]},"addOverprint":{"type":["boolean","null"]},"links":{"type":["boolean","null"]},"bookmarks":{"type":["boolean","null"]},"tags":{"type":["boolean","null"]},"javaScriptMode":{"type":["string","null"]},"viewerPreference":{"type":["string","null"]},"colorspace":{"type":["string","null"]},"encryption":{"type":["string","null"]},"loglevel":{"type":["string","null"]},"enableDebugMode":{"type":["boolean","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully started Web to Print PDF generation process"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/web-to-print\/{documentId}\/pdf-stream":{"get":{"tags":["Bundle Web To Print"],"summary":"Stream Web to Print generated PDF file","description":"Stream the generated PDF file for a Web to Print document based on the provided web to print \u003Cstrong\u003E{documentId}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{documentId}\u003C\/strong\u003E must be an ID of existing web to print document and the PDF must have been generated successfully\n","operationId":"bundle_web_to_print_pdf_stream","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Web to Print generated PDF file stream","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\u0022someGeneratedDocument.pdf\u0022"}}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-quality-management\/color-settings":{"get":{"tags":["Bundle Data Quality Management"],"summary":"List data quality color settings","description":"List all available color settings used for data quality score design.\n","operationId":"bundle_data_quality_management_color_settings_list","responses":{"200":{"description":"List of color settings","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataQualityManagementColorSettings"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/data-quality-management\/detail-widget\/{id}\/{locale}":{"get":{"tags":["Bundle Data Quality Management"],"summary":"Get data quality detail widget data","description":"Get detail data quality widget data for a specific data object including data quality information and rule definitions.\n","operationId":"bundle_data_quality_management_detail_widget_get","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"locale","in":"path","description":"Local used for detail translations","required":true,"schema":{"type":"string","example":"en"}}],"responses":{"200":{"description":"Detail data quality widget data","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataQualityManagementDetailWidget"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/aet\/tree\/{configurationId}\/update\/{objectId}":{"patch":{"tags":["Bundle Backend Power Tools"],"summary":"Patch a data object via the alternative element tree","description":"Patching data object based on the given \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E, \u003Cstrong\u003E{objectId}\u003C\/strong\u003E and data. \u003Cbr\u003E \nPatching can be used for updating single or multiple fields. \u003Cbr\u003E\nThe \u003Cstrong\u003E{objectId}\u003C\/strong\u003E must be an ID of existing data object and the \u003Cstrong\u003E{configurationId}\u003C\/strong\u003E must be an ID of existing alternative element tree configuration.\n","operationId":"bundle_backend_power_tools_aet_patch_data_object","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}},{"name":"objectId","in":"path","description":"ObjectId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","example":["Super car","red"]}},"type":"object"}}}},"responses":{"200":{"description":"Successfully patched data object"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/aet\/tree\/{configurationId}\/calculation-status":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get the calculation status of the alternative element tree","description":"Returns true if the Alternative element tree status is being calculated\n","operationId":"bundle_backend_power_tools_aet_get_tree_calculation_status","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_get_tree_calculation_status_response_description","content":{"application\/json":{"schema":{"required":["inProgress"],"properties":{"inProgress":{"title":"inProgress","description":"True if a tree calculation is currently in progress","type":"boolean","example":true}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/aet\/tree":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get all items for the alternative element tree","description":"Listing of all alternative element tree items of the configuration. \u003Cbr\u003E\nYou can use different query parameters to filter the items\n","operationId":"bundle_backend_power_tools_aet_get_tree","parameters":[{"name":"configurationId","in":"query","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}},{"name":"path","in":"query","description":"Path of the current level","required":true,"schema":{"type":"string","example":"\/"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"start","in":"query","description":"From which result to start","required":true,"schema":{"type":"integer","example":0}},{"name":"limit","in":"query","description":"How many results to return","required":true,"schema":{"type":"integer","example":30}},{"name":"level","in":"query","description":"Current tree level.","required":false,"schema":{"type":"integer","example":0}},{"name":"filter","in":"query","description":"When provided, the items are filtered by value.","required":false,"schema":{"type":"string","example":"some-search-term"}}],"responses":{"200":{"description":"Paginated items with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsAETDataObject"},{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsAETVirtualFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/add":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"Add a new bookmark list","description":"Create a new bookmark list item based on the given data. \u003Cbr\u003E\nThe data must contain a valid \u003Cstrong\u003Ename\u003C\/strong\u003E\n","operationId":"bundle_backend_power_tools_bl_add","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string","example":"My bookmark list"},"sortBy":{"type":["string","null"],"example":"name"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully created bookmark list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBookmarkList"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"Get bookmark list collection","description":"Get paginated bookmark list items. \u003Cbr\u003E\nYou can use different query parameters for filtering.\n","operationId":"bundle_backend_power_tools_bl_get_collection","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\u0022type\u0022:\u0022search\u0022, \u0022filterValue\u0022: \u0022search term\u0022},{\u0022type\u0022:\u0022showAll\u0022, \u0022filterValue\u0022: true}]"},"sortFilter":{"type":"object","example":"{\u0022key\u0022:\u0022id\u0022,\u0022direction\u0022:\u0022ASC\u0022}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Paginated bookmark list items with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBookmarkList"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get bookmark list by ID","description":"Retrieves a specific bookmark list data based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list.\n","operationId":"bundle_backend_power_tools_bl_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully retrieved bookmark list data as JSON","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBookmarkList"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Backend Power Tools"],"summary":"Delete bookmark list by ID","description":"Delete a specific bookmark list based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list.\n","operationId":"bundle_backend_power_tools_bl_delete","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Successfully deleted bookmark list"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}\/share\/recipients":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get bookmark list share recipients collection","description":"Get collection of recipients with whom the bookmark list is shared.\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing bookmark list.\n","operationId":"bundle_backend_power_tools_bl_get_share_collection","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Collection of share recipients as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsShareRecipient"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"patch":{"tags":["Bundle Backend Power Tools"],"summary":"Patch bookmark list share recipients by ID","description":"Patch the share recipients of a specific bookmark list based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. \u003Cbr\u003E\nThe data must contain at least one of the following fields: \u003Cstrong\u003Eshares\u003C\/strong\u003E or \u003Cstrong\u003EdeletedShares\u003C\/strong\u003E.\n","operationId":"bundle_backend_power_tools_bl_patch_share_list","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["shares","deletedShares"],"properties":{"shares":{"type":"array","items":{"required":["userId","permission"],"properties":{"userId":{"description":"User ID","type":"integer","example":1},"permission":{"description":"User permission for share","type":"string","example":"edit"}},"type":"object"}},"deletedShares":{"description":"Array of user IDs whose shares are to be removed from the bookmark list.","type":"object","example":[5,7]}},"type":"object"}}}},"responses":{"200":{"description":"Successfully patched bookmark list share recipients","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsShareRecipient"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}\/share\/users":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get bookmark list shareable users collection","description":"Get collection of users with whom can be the bookmark list shared. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of existing bookmark list.\nYou can use \u003Cstrong\u003E{searchTerm}\u003C\/strong\u003E query parameter to filter users by their name.\n","operationId":"bundle_backend_power_tools_bl_get_user_collection","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}},{"name":"searchTerm","in":"query","description":"Filter results by name","required":false,"schema":{"type":"string","example":"admin"}}],"responses":{"200":{"description":"Collection of users as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsShareRecipient"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}\/tree\/folder":{"put":{"tags":["Bundle Backend Power Tools"],"summary":"Rename folder in bookmark list tree","description":"Rename a folder in the bookmark list tree based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. \u003Cbr\u003E\nThe data must contain a valid \u003Cstrong\u003E{folderId}\u003C\/strong\u003E of existing folder and new \u003Cstrong\u003E{folderName}\u003C\/strong\u003E\n","operationId":"bundle_backend_power_tools_bl_tree_rename_folder","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderName","folderId"],"properties":{"folderName":{"type":"string","example":"Bookmark Folder"},"folderId":{"type":"integer","example":83}},"type":"object"}}}},"responses":{"200":{"description":"Successfully renamed folder in bookmark list tree"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"post":{"tags":["Bundle Backend Power Tools"],"summary":"Add folder to bookmark list tree by ID","description":"Create a new folder in the bookmark list tree based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. \u003Cbr\u003E\nThe data must contain a valid \u003Cstrong\u003E{parentId}\u003C\/strong\u003E of existing folder or \u003Cstrong\u003E0\u003C\/strong\u003E for root level and \u003Cstrong\u003E{folderName}\u003C\/strong\u003E\n","operationId":"bundle_backend_power_tools_bl_tree_add_folder","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderName","parentId"],"properties":{"folderName":{"type":"string","example":"Bookmark Folder"},"parentId":{"type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"Successfully created folder in bookmark list tree"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E409 - Conflict\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}\/tree\/items":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"Add or update items in bookmark list tree","description":"Add or update existing items in the bookmark list tree based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. \u003Cbr\u003E\nThe data should contain the following fields: \n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003EselectedNodes\u003C\/strong\u003E: Item data which should be added to the tree\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EelementSortOrder\u003C\/strong\u003E: Sorting order which is used in manual sort mode (based on the existing tree item IDs)\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"bundle_backend_power_tools_bl_tree_add_update_items","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["selectedNodes","elementSortOrder"],"properties":{"selectedNodes":{"description":"Selected nodes to add","type":"array","items":{"required":["elementId","elementType"],"properties":{"elementId":{"description":"Element ID","type":"integer","example":123},"elementType":{"description":"Element type","type":"string","example":"object"},"bookmarkListItemId":{"description":"Bookmark list item ID","type":["integer","null"],"example":1},"parentFolderId":{"description":"Parent folder ID","type":["integer","null"],"example":5},"copy":{"description":"Whether to copy the item","type":"boolean","example":false}},"type":"object"}},"elementSortOrder":{"description":"Sort order based on IDs which should be applied for tree manual sorting","type":["string","null"],"example":"1,2,newElement,3"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully added\/updated items in bookmark list tree"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Backend Power Tools"],"summary":"Remove items from bookmark list tree","description":"Remove items from the bookmark list tree based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E\nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. \u003Cbr\u003E\nThe data must contain a valid \u003Cstrong\u003E{nodesToRemove}\u003C\/strong\u003E array with following data:\n\u003Cul\u003E\n  \u003Cli\u003E\u003Cstrong\u003EelementId\u003C\/strong\u003E: Original ID of the element to remove\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003EelementType\u003C\/strong\u003E: Type of the element to remove (object, asset, document, bookmark_folder)\u003C\/li\u003E\n  \u003Cli\u003E\u003Cstrong\u003Eid\u003C\/strong\u003E: bookmark list item ID of the element\u003C\/li\u003E\n\u003C\/ul\u003E\n","operationId":"bundle_backend_power_tools_bl_tree_remove_items","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["nodesToRemove"],"properties":{"nodesToRemove":{"description":"Selected nodes to remove from bookmark list","type":"array","items":{"required":["elementId","elementType","id"],"properties":{"elementId":{"description":"Element ID","type":"integer","example":123},"elementType":{"description":"Element type","type":"string","example":"object"},"id":{"description":"Bookmark list item ID","type":"integer","example":1}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully removed items from bookmark list tree"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/{id}\/tree":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"Get all nodes for the bookmark list tree","description":"Collection of all bookmark list tree nodes. \u003Cbr\u003E\nYou can use different query parameters to filter the items\n","operationId":"bundle_backend_power_tools_bl_get_tree","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":30}},{"name":"parentId","in":"query","description":"ID of the parent","required":true,"schema":{"type":"integer","example":0}},{"name":"elementType","in":"query","description":"Necessary to get data from default element trees by type.","required":false,"schema":{"type":"string","example":"asset"}}],"responses":{"200":{"description":"Paginated nodes with total count as header param as JSON","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBLTreeAsset"},{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBLTreeDataObject"},{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBLTreeDocument"},{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBLTreeFolder"},{"$ref":"#\/components\/schemas\/Document"},{"$ref":"#\/components\/schemas\/Image"},{"$ref":"#\/components\/schemas\/AssetDocument"},{"$ref":"#\/components\/schemas\/Audio"},{"$ref":"#\/components\/schemas\/Video"},{"$ref":"#\/components\/schemas\/Archive"},{"$ref":"#\/components\/schemas\/Text"},{"$ref":"#\/components\/schemas\/AssetFolder"},{"$ref":"#\/components\/schemas\/Unknown"},{"$ref":"#\/components\/schemas\/DataObject"},{"$ref":"#\/components\/schemas\/DataObjectFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/backend-power-tools\/bl\/update\/{id}":{"put":{"tags":["Bundle Backend Power Tools"],"summary":"Update bookmark list by ID","description":"update a specific bookmark list based on the given \u003Cstrong\u003E{id}\u003C\/strong\u003E and data. \u003Cbr\u003E \nThe \u003Cstrong\u003E{id}\u003C\/strong\u003E must be an ID of bookmark list. Please note that all fields are required for the data.\n","operationId":"bundle_backend_power_tools_bl_update","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string","example":"My bookmark list"},"sortBy":{"type":["string","null"],"example":"name"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated bookmark list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsBookmarkList"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboard":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"Create dashboard configuration","description":"Create a new dashboard configuration","operationId":"dashboards_create_dashboard_config","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"required":["name","rows"],"properties":{"name":{"type":["string","null"]},"rows":{"title":"Rows","description":"Define the rows of the dashboard.","type":"array","items":{"required":["layout_id","widgets"],"properties":{"layout_id":{"type":["string","null"]},"widgets":{"title":"Widgets","description":"Define the widgets of the row.","type":"array","items":{"required":["id","type","position"],"properties":{"id":{"type":["string","null"]},"type":{"type":["string","null"]},"position":{"type":["integer","null"],"minimum":1}},"type":"object"}}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"ID of the newly created dashboard configuration","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"Id of the created dashboard configuration","type":"string","example":"12345678-1234-1234-1234-123456789012"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboard\/{dashboardId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get dashboard by ID","description":"Get a specific dashboard by ID","operationId":"dashboards_get_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"responses":{"200":{"description":"Requested dashboard","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DashboardConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Studio Dashboards"],"summary":"Update dashboard configuration by ID","description":"Update a dashboard configuration by ID","operationId":"dashboards_update_dashboard_config_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Update dashboard by matching dashboard Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"required":["name","rows"],"properties":{"name":{"type":["string","null"]},"rows":{"title":"Rows","description":"Define the rows of the dashboard.","type":"array","items":{"required":["layout_id","widgets"],"properties":{"layout_id":{"type":["string","null"]},"widgets":{"title":"Widgets","description":"Define the widgets of the row.","type":"array","items":{"required":["id","type","position"],"properties":{"id":{"type":["string","null"]},"type":{"type":["string","null"]},"position":{"type":["integer","null"],"minimum":1}},"type":"object"}}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated dashboard configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Studio Dashboards"],"summary":"Delete dashboard by ID","description":"Delete a dashboard with the given \u003Cstrong\u003E{dashboardId}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{dashboardId}\u003C\/strong\u003E must be an ID of an existing dashboard.\n","operationId":"dashboards_delete_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Delete dashboard by matching dashboard Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"Successfully deleted dashboard"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboard\/{dashboardId}\/export":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Export dashboard by ID","description":"Export a dashboard configuration by ID ad JSON including its widgets","operationId":"dashboards_export_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"responses":{"200":{"description":"Successfully exported dashboard configuration","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\u0022example.jpg\u0022"}}},"content":{"application\/zip":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboard\/import\/{dashboardId}":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"Import dashboard","description":"Import a dashboard configuration from form zipped JSON including its widgets","operationId":"dashboards_import_dashboard","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":false,"schema":{"type":"string","example":"studio_default_dashboard"}}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully imported dashboard configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboards":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"List dashboards","description":"List all available dashboards","operationId":"dashboards_list_dashboards","responses":{"200":{"description":"Name and ID of all available dashboards","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/SimpleDashboard"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/dashboard\/{dashboardId}\/update-menu-shortcut":{"put":{"tags":["Bundle Studio Dashboards"],"summary":"Update dashboard menu shortcut","description":"Update the menu shortcut setting for a specific dashboard","operationId":"dashboards_dashboard_update_menu_shortcut","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["shortcut"],"properties":{"shortcut":{"type":["string","null"]}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated dashboard menu shortcut setting"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/layout-options":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get layout options","description":"Get all available layout options for a dashboard row","operationId":"dashboards_get_layout_options","responses":{"200":{"description":"All layout options successfully retrieved","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/LayoutOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/{widgetType}\/configuration":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"Create widget configuration","description":"Create a new dashboard widget configuration with default values based on the provided \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E.\n\u003Cbr\u003E The widget type has to be registered via Symfony Configuration.\n\u003Cbr\u003E Please note that \u003Cstrong\u003E{name}\u003C\/strong\u003E, \u003Cstrong\u003E{color}\u003C\/strong\u003E and \u003Cstrong\u003E{visualization}\u003C\/strong\u003E has to be provided.\n","operationId":"dashboards_widget_create","parameters":[{"name":"widgetType","in":"path","description":"Create widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]},"color":{"type":["string","null"]},"visualization":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully created widget configuration","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"Id of the created widget configuration","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/configurations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget configurations","description":"Listing of all dashboard widget configurations","operationId":"dashboards_widget_get_config_collection","responses":{"200":{"description":"Successfully retrieved widget configurations","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/{widgetType}\/data\/{widgetId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget data by id and type","description":"Get the data for a specific widget with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration. \u003Cbr\u003E\nThe returned data depends on the implemented data resolver for the widget type.\n","operationId":"dashboards_widget_get_data_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"Successfully retrieved widget data","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Widget data","type":"string","example":"Some data defined by the widget resolver"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/{widgetType}\/configuration\/{widgetId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget configuration by id","description":"Get a dashboard widget configuration with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration.\n","operationId":"dashboards_widget_get_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"Successfully retrieved widget configuration","content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Data of the widget configuration","type":"string","example":"Widget configuration data"}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E403 - Forbidden\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"put":{"tags":["Bundle Studio Dashboards"],"summary":"Update widget configuration by id and type","description":"Update the widget configuration with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E \nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an id of an existing widget. The widget type has to be registered via Symfony Configuration. \u003Cbr\u003E\nPlease note that \u003Cstrong\u003Eall configuration fields\u003C\/strong\u003E have to be provided.\n","operationId":"dashboards_widget_update_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Update widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Update widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]},"color":{"type":["string","null"]},"visualization":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated widget configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}},"delete":{"tags":["Bundle Studio Dashboards"],"summary":"Delete widget configuration by id and type","description":"Delete a dashboard widget with the given \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E and \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E. \u003Cbr\u003E\nThe \u003Cstrong\u003E{widgetId}\u003C\/strong\u003E must be an ID of an existing widget. The widget type has to be registered via Symfony Configuration.\n","operationId":"dashboards_widget_delete","parameters":[{"name":"widgetId","in":"path","description":"Delete widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Delete widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"Successfully deleted widget configuration"},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E404 - Not Found\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content\u003Cbr\u003E500 - Internal Server Error","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/{widgetType}\/configurations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget configuration options by type","description":"Get configuration field name and all available options for a specific widget type.\n\u003Cbr\u003E The \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E must be registered via Symfony Configuration.\n","operationId":"dashboards_widget_get_configuration_options","parameters":[{"name":"widgetType","in":"path","description":"Filter options by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"Successfully retrieved widget configurations","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DashboardsWidgetConfigConfiguration"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/types":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget types","description":"Listing of all available widget types","operationId":"dashboards_widget_get_type_collection","responses":{"200":{"description":"Successfully retrieved widget types","content":{"application\/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/WidgetType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/studio-dashboards\/widgets\/{widgetType}\/visualizations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"Get widget visualizations by type","description":"Listing of all available visualizations for a specific widget type.\n\u003Cbr\u003E The \u003Cstrong\u003E{widgetType}\u003C\/strong\u003E must be registered via Symfony Configuration.\n","operationId":"dashboards_widget_get_visualization_collection","parameters":[{"name":"widgetType","in":"path","description":"Filter options by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"Successfully retrieved widget visualizations","content":{"application\/json":{"schema":{"required":["visualizations"],"properties":{"visualizations":{"title":"Visualizations","description":"Dashboard widget visualization options.","type":"array","items":{"type":"string","example":"table"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/amdcd\/configs\/list":{"get":{"tags":["Bundle Asset Metadata Class Definitions"],"summary":"Get all available configs for editor","description":"Get all available configs for editor to be able to add asset metadata class definitions to the asset","operationId":"bundle_amdcd_configs_list","responses":{"200":{"description":"Successfully retrieved listing of all available configs","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/AMDCDListConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/bundle\/amdcd\/configs\/tree":{"get":{"tags":["Bundle Asset Metadata Class Definitions"],"summary":"Get all available configs for tree","description":"Get all available configs for tree based on the \u0022Bundle AMDCD SimpleConfig\u0022","operationId":"bundle_amdcd_configs_tree","responses":{"200":{"description":"Successfully retrieved config data","content":{"application\/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/AMDCDSimpleConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request\u003Cbr\u003E400 - Bad Request\u003Cbr\u003E401 - Unauthorized\u003Cbr\u003E405 - Method Not Allowed\u003Cbr\u003E415 - Unsupported Media Type\u003Cbr\u003E422 - Unprocessable Content","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}}},"components":{"schemas":{"AMDCDLayout":{"title":"AMDCD_Layout","required":["name","dataType","type","region","title","width","height","collapsible","collapsed","bodyStyle","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":["string","null"],"example":"pimcore_root"},"dataType":{"description":"Data Type","type":"string","example":"layout"},"type":{"description":"Type","type":["string","null"],"example":null},"region":{"description":"Region","type":["string","null"],"example":"center"},"title":{"description":"Title","type":["string","null"],"example":"MyLayout"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"Collapsed","type":"boolean","example":false},"bodyStyle":{"description":"Body Style","type":["string","null"],"example":"(float: left;)"},"children":{"description":"Children","type":"array","items":{"type":"object"},"example":"[{id: 1}]"}},"type":"object"},"AMDCDListConfig":{"title":"AMDCD_ListConfig","description":"List version of config","required":["name","title","prefix","iconCls","layoutDefinitions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Author"},"title":{"description":"title","type":"string","example":"Name of Author"},"prefix":{"description":"Prefix","type":"string","default":"","example":"amcd"},"iconCls":{"description":"Icon Class","type":"string","default":"pimcore_icon_settings","example":"pimcore_icon_settings"},"layoutDefinitions":{"oneOf":[{"$ref":"#\/components\/schemas\/AMDCDLayout","description":"layoutDefinitions"},{"type":"null"}],"description":"layoutDefinitions"}},"type":"object"},"AMDCDSimpleConfig":{"title":"AMDCD_SimpleConfig","description":"Simple version of config","required":["name","type","iconCls","expandable","leaf"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Author"},"title":{"description":"title","type":"string","example":"Name of Author"},"type":{"description":"Type","type":"string","default":"config","example":"config"},"iconCls":{"description":"Icon Class","type":"string","default":"pimcore_icon_settings","example":"pimcore_icon_settings"},"expandable":{"description":"Is Expandable","type":"boolean","default":false,"example":false},"leaf":{"description":"Is Leaf","type":"boolean","default":true,"example":true}},"type":"object"},"ActiveBundle":{"title":"Active Bundle","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Bundle name","type":"string","example":"PimcoreStudioBackendBundle"}},"type":"object"},"AddPerspectiveConfig":{"title":"Add Perspective Config","required":["name"],"properties":{"name":{"description":"Name","type":"string","example":"Cars"}},"type":"object"},"AdminSettings":{"title":"Admin Settings","required":["branding","assets","writeable"],"properties":{"branding":{"$ref":"#\/components\/schemas\/Branding","description":"Branding configuration"},"assets":{"$ref":"#\/components\/schemas\/Assets","description":"Assets configuration"},"writeable":{"description":"Whether the settings are writeable","type":"boolean","example":true}},"type":"object"},"AdminSettingsThumbnailPath":{"title":"Admin Settings Thumbnail Path","required":["customLogoSmall","customLogo","loginScreenCustomBackgroundImage"],"properties":{"customLogoSmall":{"description":"Path to custom logo thumbnail","type":["string","null"],"example":"\/Sample%20Content\/Background%20Images\/321\/image_small.png"},"customLogo":{"description":"Path to custom logo thumbnail","type":["string","null"],"example":"\/Sample%20Content\/Background%20Images\/321\/image-thumb.png"},"loginScreenCustomBackgroundImage":{"description":"Path to custom background image","type":["string","null"],"example":"\/Sample%20Content\/Background%20Images\/317\/background.png"}},"type":"object"},"AdvancedColumnConfig":{"title":"Advanced Column Config","required":["advancedColumns"],"properties":{"advancedColumns":{"description":"advancedColumns","type":"array","items":{"required":["key","config"],"properties":{"key":{"description":"Type of the column, e.g. \u0022simpleField\u0022, \u0022relationField\u0022, \u0022staticText\u0022","type":"string","example":"simpleField"},"config":{"type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/RelationFieldConfig"},{"$ref":"#\/components\/schemas\/SimpleFieldConfig"},{"$ref":"#\/components\/schemas\/StaticTextConfig"}]},"example":{"field":"name","relation":"manufacturer"}}},"type":"object"},"example":[{"key":"simpleField","config":{"field":"name"}}]},"transformers":{"description":"List if Transformers that should be applied","type":"array","items":{"$ref":"#\/components\/schemas\/Transformer"}}},"type":"object"},"AllowedTransition":{"title":"AllowedTransition","required":["name","label","iconCls","objectLayout","unsavedChangesBehaviour","notes"],"properties":{"name":{"description":"name","type":"string","example":"start_workflow"},"label":{"description":"label","type":"string","example":"Start Workflow"},"iconCls":{"description":"iconCls","type":"string","example":"pimcore_workflow_start"},"objectLayout":{"description":"objectLayout","type":"boolean","example":false},"unsavedChangesBehaviour":{"description":"unsavedChangesBehaviour","type":"string","example":"warn"},"notes":{"description":"notes","type":"array","items":{"type":"object"},"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Archive":{"title":"Archive","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"RenderAreaBlockData":{"title":"Area block render data for editmode","required":["editableDefinitions","htmlCode"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"editableDefinitions":{"description":"Dynamic array of editable definitions","type":"array","items":{"type":"object"},"example":"[{ \u0022id\u0022: \u0022editable_1\u0022, \u0022type\u0022: \u0022text\u0022, \u0022config\u0022: { \u0022label\u0022: \u0022Text\u0022, \u0022defaultValue\u0022: \u0022Default text\u0022 }, \u0022data\u0022: { \u0022text\u0022: \u0022Some text\u0022 } }]"},"htmlCode":{"description":"HTML code of the snippet","type":"string","example":"\u003Cdiv class=\u0022editable\u0022 data-key=\u0022editable_1\u0022\u003ESome text\u003C\/div\u003E"}},"type":"object"},"Asset":{"title":"Asset","required":["hasChildren","type","filename","mimeType","hasMetadata","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"hasChildren":{"description":"Has children","required":["hasChildren"],"type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"image"},"filename":{"description":"Filename","type":"string","example":"cool.jpg"},"mimeType":{"description":"Mimetype","type":["string","null"],"example":"image\/jpeg"},"hasMetadata":{"description":"Has metadata","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/asset.jpg"},"permissions":{"$ref":"#\/components\/schemas\/AssetPermissions"}},"type":"object"}]},"AssetDocument":{"title":"Asset Document","required":["pageCount","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"pageCount":{"description":"Page count","type":["integer","null"],"example":2},"imageThumbnailPath":{"description":"Path to image thumbnail","type":["string","null"],"example":"\/path\/to\/document\/imagethumbnail.jpg"}},"type":"object"}]},"AssetFolder":{"title":"Asset Folder","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"AssetPermissions":{"title":"Asset Permissions","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Permissions"}]},"AssetType":{"title":"Asset Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"image"}},"type":"object"},"AssetUploadInfo":{"title":"Asset Upload Info","required":["exists","assetId"],"properties":{"exists":{"description":"True if asset exists","type":"boolean","example":true},"assetId":{"description":"Id of existing asset","type":["integer","null"],"example":83}},"type":"object"},"AssetVersion":{"title":"AssetVersion","required":["type","fileName","creationDate","fileSize","mimeType","metadata","dimensions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"type":{"description":"asset type","type":"string","example":"image"},"fileName":{"description":"file name","type":"string","example":"myImageFile.png"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":["integer","null"],"example":1707312457},"fileSize":{"description":"file size","type":"integer","example":41862},"mimeType":{"description":"mime type","type":"string","example":"image\/png"},"metadata":{"description":"Metadata","type":"array","items":{"$ref":"#\/components\/schemas\/CustomMetadataVersion"}},"dimensions":{"$ref":"#\/components\/schemas\/Dimensions","description":"dimensions"}},"type":"object"},"Assets":{"title":"Assets","required":["hide_edit_image","disable_tree_preview"],"properties":{"hide_edit_image":{"description":"Hide edit image button","type":"boolean","example":false},"disable_tree_preview":{"description":"Disable tree preview","type":"boolean","example":true}},"type":"object"},"Audio":{"title":"Audio","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"AuthenticationToken":{"title":"Authentication Token","description":"Token for authentication","required":["token"],"properties":{"token":{"description":"Token","type":"string","example":"abc123xyz"}},"type":"object"},"AvailableCountry":{"title":"Available Country","required":["name","code"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Country name","type":"string","example":"Austria"},"code":{"description":"Country ISO 3166-1 code","type":"string","example":"AT"}},"type":"object"},"BlocklistEntry":{"title":"Blocklist","required":["email","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"email":{"description":"email address","type":"string","example":"email@pimcore.com"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":["integer","null"],"example":1707312457}},"type":"object"},"EmailAddressParameter":{"title":"Blocklist","required":["email"],"properties":{"email":{"description":"email address","type":"string","example":"someEmail@email-domain.com"}},"type":"object"},"Branding":{"title":"Branding","required":["backgroundShade","brandColor","loginScreenCustomBackgroundImage","loginScreenCustomImage"],"properties":{"backgroundShade":{"description":"Background shade","type":"string","example":"#CCCCCC"},"brandColor":{"description":"Brand color","type":"string","example":"#FFCC00"},"loginScreenCustomBackgroundImage":{"oneOf":[{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Custom image for login screen"},{"type":"null"}],"description":"Custom image for login screen","type":"object"},"customLogo":{"oneOf":[{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Custom logo"},{"type":"null"}],"description":"Custom logo","type":"object"}},"type":"object"},"BundleApplicationLoggerLogEntry":{"title":"Bundle Application Logger Log Entry","required":["id","priority","date","pid","message","fileObject","relatedElementData","component","source"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"priority":{"description":"Log priority level","type":"integer","example":2},"date":{"description":"Date","type":["string","null"],"example":"2023-10-01T12:00:00+00:00"},"pid":{"description":"PID","type":["integer","null"],"example":22},"message":{"description":"Message","type":["string","null"],"example":"Some Log Message"},"fileObject":{"description":"File object path","type":["string","null"],"example":"path\/to\/file.txt"},"relatedElementData":{"oneOf":[{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Data of related element"},{"type":"null"}],"description":"Data of related element","type":"object"},"component":{"description":"Component","type":["string","null"],"example":"SomeComponent::Class"},"source":{"description":"Source","type":["string","null"],"example":"Pimcore\\Bundle"}},"type":"object"},"BundleBackendPowerToolsAETDataObject":{"title":"Bundle Backend Power Tools AET Data Object","required":["text","allowDrag","allowDrop"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"properties":{"text":{"description":"Text","type":"string","example":"orange (\/Path\/to\/element\/)"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true}},"type":"object"}]},"BundleBackendPowerToolsAETVirtualFolder":{"title":"Bundle Backend Power Tools AET Virtual Folder","required":["id","type","key","path","icon","allowDrag","allowDrop","hasChildren","level"],"properties":{"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"1f0a82ba_4398_61a8_a4c3_016155cfcb10"},"type":{"description":"Type","type":"string","example":"folder"},"key":{"description":"Key","type":"string","example":"City Car"},"path":{"description":"Path","type":"string","example":"\/City Car\/"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":true},"level":{"description":"Level of the folder","type":"integer","example":2}},"type":"object"},"BundleBackendPowerToolsAETWidgetConfig":{"title":"Bundle Backend Power Tools Alternative Element Tree Widget Config","required":["progressIndicatorPollInterval","label","classId","className","workspaces"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/WidgetConfig"},{"properties":{"progressIndicatorPollInterval":{"description":"Progress indicator poll interval in ms","type":"integer","example":60000},"label":{"description":"Configuration label","type":["string","null"],"example":"My custom AET"},"classId":{"description":"Configuration class ID","type":["string","null"],"example":"CAR"},"className":{"description":"Configuration class name","type":["string","null"],"example":"Car"},"workspaces":{"description":"Workspaces","type":"array","items":{"$ref":"#\/components\/schemas\/BundleBackendPowerToolsAETWidgetConfigPath"}}},"type":"object"}]},"BundleBackendPowerToolsAETWidgetConfigPath":{"title":"Bundle Backend Power Tools Alternative Element Tree Widget Config Path","required":["workspaceItem","include"],"properties":{"workspaceItem":{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Data of the workspace item"},"include":{"description":"Include workspace","type":"boolean","example":false}},"type":"object"},"BundleBackendPowerToolsBLTreeAsset":{"title":"Bundle Backend Power Tools BL Tree Asset","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"text":{"description":"Text","type":"string","example":"key (\/Path\/to\/element\/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (\/Path\/to\/element\/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeDataObject":{"title":"Bundle Backend Power Tools BL Tree Data Object","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"properties":{"text":{"description":"Text","type":"string","example":"key (\/Path\/to\/element\/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (\/Path\/to\/element\/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeDocument":{"title":"Bundle Backend Power Tools BL Tree Document","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Document"},{"properties":{"text":{"description":"Text","type":"string","example":"key (\/Path\/to\/element\/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (\/Path\/to\/element\/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeFolder":{"title":"Bundle Backend Power Tools BL Tree Folder","required":["id","originalId","uid","type","elementType","parentId","key","icon","allowDrag","allowDrop","hasChildren","sortOrder"],"properties":{"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":83},"originalId":{"description":"Original ID","type":"string","example":"83-bookmark_folder"},"uid":{"description":"UID","type":"string","example":"24-bookmark_folder-root"},"type":{"description":"Type","type":"string","example":"folder"},"elementType":{"description":"ElementType","type":"string","example":"bookmark_folder"},"parentId":{"description":"Parent ID","type":"integer","example":0},"key":{"description":"Key","type":"string","example":"City Car"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"integer","example":0}},"type":"object"},"BundleBackendPowerToolsBookmarkList":{"title":"Bundle Backend Power Tools Bookmark List","required":["id","name","sortBy","owner","isOwner","itemCount","creationDate","shared","permission"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"name":{"description":"Name","type":"string","example":"My bookmark list"},"sortBy":{"description":"Sort by field","type":"string","example":"name"},"owner":{"description":"Owner username","type":"string","example":"admin"},"isOwner":{"description":"Is current user the owner","type":"boolean","example":true},"itemCount":{"description":"Number of items in the list","type":"integer","example":0},"creationDate":{"description":"Creation date timestamp","type":"integer","example":1760593921},"shared":{"description":"Is shared with other users","type":"boolean","example":false},"permission":{"description":"Permission level","type":"string","example":"edit"}},"type":"object"},"BundleBackendPowerToolsShareRecipient":{"title":"Bundle Backend Power Tools Share Recipient","required":["permission","recipientName","recipientId"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"permission":{"description":"Permission","type":"string","example":"edit"},"recipientName":{"description":"Recipient name","type":"string","example":"nameOfRecipient"},"recipientId":{"description":"Recipient Id","type":"integer","example":1}},"type":"object"},"BundleBackendPowerToolsShareUser":{"title":"Bundle Backend Power Tools Share User","required":["id","name","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User Id","type":"integer","example":1},"name":{"description":"User name","type":"string","example":"someAdminUser (Admin)"},"type":{"description":"Type","type":"string","example":"user"}},"type":"object"},"BundleCustomReportAdd":{"title":"Bundle Custom Report Add","required":["name"],"properties":{"name":{"description":"Name of the new custom report","type":"string","example":"myReport"}},"type":"object"},"BundleCustomReportClone":{"title":"Bundle Custom Report Clone","required":["newName"],"properties":{"newName":{"description":"New name the cloned custom report","type":"string","example":"myNewReport"}},"type":"object"},"BundleCustomReportUpdate":{"title":"Bundle Custom Report Update","required":["sql","dataSourceConfig","columnConfigurations","niceName","group","groupIconClass","iconClass","menuShortcut","reportClass","chartType","pieColumn","pieLabelColumn","xAxis","yAxis","sharedUserNames","sharedRoleNames","sharedGlobally"],"properties":{"sql":{"description":"Sql","type":"string","example":""},"columnConfigurations":{"description":"Configuration for columns to be displayed in report","type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsColumnConfigurationUpdate"}},"niceName":{"description":"Label\/nice name of report","type":"string","example":"Attributes"},"group":{"description":"Group of the report","type":"string","example":"My Reports"},"groupIconClass":{"description":"Group icon class","type":"string","example":"pimcore_group_icon_attributes"},"iconClass":{"description":"Icon class","type":"string","example":"pimcore_icon_attributes"},"menuShortcut":{"description":"Whether the report has a shortcut in the menu","type":"boolean","example":true},"reportClass":{"description":"Report class of custom report implementation","type":"string","example":""},"chartType":{"description":"Chart type","type":"string","example":"pie"},"sharedUserNames":{"description":"Array with user names the report is shared with","type":"array","items":{"type":"string"},"example":"[\u0022admin\u0022, \u0022superuser\u0022]"},"sharedRoleNames":{"description":"Array with roles the report is shared with","type":"array","items":{"type":"string"},"example":"[\u0022role\u0022, \u0022role2\u0022]"},"sharedGlobally":{"description":"Whether the report is shared globally","type":"boolean","example":false},"dataSourceConfig":{"description":"Configuration for data source. Content of array depends on selected adapter\/data source","type":"array","items":{"type":"object"},"example":[{"sql":"carClass","from":"object_localized_CAR_en","where":"objectType = \u0027actual-car\u0027","groupby":"carClass","orderby":"","orderbydir":null,"type":"sql"}]},"pieColumn":{"description":"Data column for pie chart","type":["string","null"],"example":"count(*)"},"pieLabelColumn":{"description":"Label of data column for pie chart","type":["string","null"],"example":"attributesAvailable"},"xAxis":{"description":"X axis column names","type":["string","null"],"example":"attributesAvailable"},"yAxis":{"description":"Y axis column information","type":["array","null"],"items":{"type":"string"},"example":"[\u0022attributesAvailable\u0022, \u0022count(*)\u0022]"}},"type":"object"},"BundleCustomReportsChartData":{"title":"Bundle Custom Reports Chart Data","required":["data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Chart data depending on the adapter in the report configuration.","type":"object"}},"type":"object"},"BundleCustomReportsColumnConfiguration":{"title":"Bundle Custom Reports Column Configuration","required":["disableOrderBy","disableFilterable","disableDropdownFilterable","disableLabel"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/BundleCustomReportsColumnConfigurationUpdate"},{"properties":{"name":{"description":"Name","type":"string","example":"attributesAvailable"},"display":{"description":"Display column","type":"boolean","example":true},"export":{"description":"Whether the column should be included in exports","type":"boolean","example":true},"order":{"description":"Order","type":"boolean","example":true},"label":{"description":"Label\/display name of column","type":"string","example":"Attributes"},"action":{"description":"Action of the column","type":"string","example":"openObject"},"id":{"description":"Id","type":"string","example":"401-3"},"width":{"description":"Width of the column","type":["integer","null"],"example":200},"displayType":{"description":"Display type of the column","type":["string","null"],"example":"text"},"filterType":{"description":"Type of the filter","type":["string","null"],"example":"numeric"},"filterDrilldown":{"description":"Drilldown filter","type":["string","null"],"example":"only_filter"},"disableOrderBy":{"description":"Disable order by","type":"boolean","example":false},"disableFilterable":{"description":"Disable filterable","type":"boolean","example":false},"disableDropdownFilterable":{"description":"Disable dropdown filterable","type":"boolean","example":false},"disableLabel":{"description":"Disable label","type":"boolean","example":false}},"type":"object"}]},"BundleCustomReportsColumnConfigurationUpdate":{"title":"Bundle Custom Reports Column Configuration Update Data","required":["name","display","export","order","label","action","id","width","displayType","filterType","filterDrilldown"],"properties":{"name":{"description":"Name","type":"string","example":"attributesAvailable"},"display":{"description":"Display column","type":"boolean","example":true},"export":{"description":"Whether the column should be included in exports","type":"boolean","example":true},"order":{"description":"Order","type":"boolean","example":true},"label":{"description":"Label\/display name of column","type":"string","example":"Attributes"},"action":{"description":"Action of the column","type":"string","example":"openObject"},"id":{"description":"Id","type":"string","example":"401-3"},"width":{"description":"Width of the column","type":["integer","null"],"example":200},"displayType":{"description":"Display type of the column","type":["string","null"],"example":"text"},"filterType":{"description":"Type of the filter","type":["string","null"],"example":"numeric"},"filterDrilldown":{"description":"Drilldown filter","type":["string","null"],"example":"only_filter"}},"type":"object"},"BundleCustomReportsColumnInformation":{"title":"Bundle Custom Reports Column Information","required":["name","disableOrderBy","disableFilterable","disableDropdownFilterable","disableLabel"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"attributesAvailable"},"disableOrderBy":{"description":"Disable order by","type":"boolean","example":false},"disableFilterable":{"description":"Disable filterable","type":"boolean","example":false},"disableDropdownFilterable":{"description":"Disable dropdown filterable","type":"boolean","example":false},"disableLabel":{"description":"Disable label","type":"boolean","example":false}},"type":"object"},"BundleCustomReportsConfigurationTreeNode":{"title":"Bundle Custom Reports Configuration Tree Node","required":["id","text","cls","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"Quality_Attributes"},"text":{"description":"text","type":"string","example":"Quality_Attributes"},"cls":{"description":"css class","type":"string","example":"pimcore_treenode_disabled"},"writeable":{"description":"writeable","type":"boolean","example":true}},"type":"object"},"BundleCustomReportsDataSourceConfig":{"title":"Bundle Custom Reports Data Source Config","required":["configuration"],"properties":{"configuration":{"description":"Configuration for data source. Content of array depends on selected adapter\/data source","type":"object","example":{"sql":"carClass","from":"object_localized_CAR_en","where":"objectType = \u0027actual-car\u0027","groupby":"carClass","orderby":"","orderbydir":null,"type":"sql"}}},"type":"object"},"BundleCustomReportsDetails":{"title":"Bundle Custom Reports Details","required":["name","sql","dataSourceConfig","columnConfigurations","niceName","group","groupIconClass","iconClass","menuShortcut","reportClass","chartType","pieColumn","pieLabelColumn","xAxis","yAxis","modificationDate","creationDate","sharedUserNames","sharedRoleNames","sharedGlobally","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Quality_Attributes"},"sql":{"description":"Sql","type":"string","example":""},"columnConfigurations":{"description":"Configuration for columns to be displayed in report","type":"array","items":{"$ref":"#\/components\/schemas\/BundleCustomReportsColumnConfiguration"}},"niceName":{"description":"Label\/nice name of report","type":"string","example":"Attributes"},"group":{"description":"Group of the report","type":"string","example":"My Reports"},"groupIconClass":{"description":"Group icon class","type":"string","example":"pimcore_group_icon_attributes"},"iconClass":{"description":"Icon class","type":"string","example":"pimcore_icon_attributes"},"menuShortcut":{"description":"Whether the report has a shortcut in the menu","type":"boolean","example":true},"reportClass":{"description":"Report class of custom report implementation","type":"string","example":""},"chartType":{"description":"Chart type","type":"string","example":"pie"},"modificationDate":{"description":"Modification date time stamp","type":"integer","example":1736762668},"creationDate":{"description":"Creation date time stamp","type":"integer","example":1567409307},"sharedUserNames":{"description":"Array with user names the report is shared with","type":"array","items":{"type":"string"},"example":"[\u0022admin\u0022, \u0022superuser\u0022]"},"sharedRoleNames":{"description":"Array with roles the report is shared with","type":"array","items":{"type":"string"},"example":"[\u0022role\u0022, \u0022role2\u0022]"},"sharedGlobally":{"description":"Whether the report is shared globally","type":"boolean","example":false},"writeable":{"description":"Whether the report is writeable","type":"boolean","example":true},"dataSourceConfig":{"description":"Configuration for data source. Content of array depends on selected adapter\/data source","type":["object","null"],"example":[]},"pieColumn":{"description":"Data column for pie chart","type":["string","null"],"example":"count(*)"},"pieLabelColumn":{"description":"Label of data column for pie chart","type":["string","null"],"example":"attributesAvailable"},"xAxis":{"description":"X axis column names","type":["string","null"],"example":"attributesAvailable"},"yAxis":{"description":"Y axis column information","type":["array","null"],"items":{"type":"string"},"example":"[\u0022attributesAvailable\u0022, \u0022count(*)\u0022]"}},"type":"object"},"BundleCustomReportsDrillDownOption":{"title":"Bundle Custom Reports Drill Down Option","description":"Drill down option data for custom reports","required":["name","value"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"name","example":"Full-Size","anyOf":[{"type":"string"},{"type":"integer"},{"type":"float"}]},"value":{"description":"value","example":"Full-Size","anyOf":[{"type":"string"},{"type":"integer"},{"type":"float"},{"type":"null"}]}},"type":"object"},"BundleCustomReportsSaveWidgetConfig":{"title":"Bundle Custom Reports Save Widget Config","required":["customReportName"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/CreateWidgetConfig"},{"properties":{"customReportName":{"description":"Report Configuration Name","type":"string","example":"Quality_Attributes"}},"type":"object"}]},"BundleCustomReportsTreeNode":{"title":"Bundle Custom Reports Tree Node","required":["name","niceName","iconClass","group","groupIconClass","menuShortcut","reportClass","hasDataSourceConfig"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"report name","type":"string","example":"Quality_Attributes"},"niceName":{"description":"nice name","type":"string","example":"Attributes"},"iconClass":{"description":"icon class","type":"string","example":"pimcore_icon_attributes"},"group":{"description":"group","type":"string","example":"Quality"},"groupIconClass":{"description":"group icon class","type":"string","example":"pimcore_group_icon_attributes"},"menuShortcut":{"description":"menu shortcut","type":"boolean","example":true},"reportClass":{"description":"report class","type":"string","example":""},"hasDataSourceConfig":{"description":"Whether the report has a data source configuration.","type":"boolean","example":false}},"type":"object"},"BundleCustomReportsWidgetConfig":{"title":"Bundle Custom Reports Widget Config","required":["color","customReportName","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Color","type":"string","example":"#FF5733"},"customReportName":{"description":"Report Configuration Name","type":"string","example":"Quality_Attributes"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"BundleDataHubConfiguration":{"title":"Bundle Data Hub Configuration","required":["id","text","type","iconCls","expandable","leaf","adapter","writable","permissions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"assets"},"text":{"description":"Text","type":"string","example":"assets"},"type":{"description":"Type","type":"string","example":"config"},"iconCls":{"description":"iconCls","type":"string","example":"plugin_pimcore_datahub_icon_graphql"},"expandable":{"description":"Expandable","type":"boolean","example":"false"},"leaf":{"description":"Leaf","type":"boolean","example":"true"},"permissions":{"description":"Permissions","type":["object","null"],"example":"{\u0022delete\u0022: true, \u0022update\u0022: true}"},"allowChildren":{"description":"Allow children","type":"boolean","example":"false"},"group":{"description":"Group","type":["string","null"],"example":"General Folder"},"children":{"description":"Children","type":["array","null"],"items":{"$ref":"#\/components\/schemas\/BundleDataHubConfiguration"}},"adapter":{"description":"Adapter","type":["string","null"],"example":"graphql"},"writable":{"description":"Writable","type":"boolean","example":"true"}},"type":"object"},"BundleDataHubConfigurationDetail":{"title":"Bundle Data Hub Configuration Detail","required":["name","configuration","userPermissions","supportedGraphQLQueryDataTypes","supportedGraphQLMutationDataTypes","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"assets"},"configuration":{"description":"Configuration data","type":"object"},"userPermissions":{"description":"User permissions","type":"object","example":{"update":true,"delete":true}},"supportedGraphQLQueryDataTypes":{"description":"Supported GraphQL query data types","type":"array","items":{"type":"string"}},"supportedGraphQLMutationDataTypes":{"description":"Supported GraphQL mutation data types","type":"array","items":{"type":"string"}},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubPermissionUser":{"title":"Bundle Data Hub Permission User","required":["id","text","elementType"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User or Role ID","type":"integer","example":42},"text":{"description":"User or Role name","type":"string","example":"admin"},"elementType":{"description":"Element type","type":"string","example":"user"}},"type":"object"},"BundleDataHubThumbnail":{"title":"Bundle Data Hub Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Thumbnail ID","type":"string","example":"content"},"text":{"description":"Thumbnail name","type":"string","example":"content"}},"type":"object"},"BundleDataHubUpdateConfiguration":{"title":"Bundle Data Hub Update Configuration","required":["data","modificationDate"],"properties":{"data":{"description":"JSON-encoded configuration containing general, schema, security, workspaces, and permissions","type":"string","example":"{\u0022general\u0022:{\u0022active\u0022:true,\u0022type\u0022:\u0022GraphQL\u0022,\u0022name\u0022:\u0022assets\u0022,\u0022description\u0022:\u0022\u0022,\u0022group\u0022:\u0022GQL\u0022},\u0022schema\u0022:{\u0022queryEntities\u0022:[],\u0022mutationEntities\u0022:[],\u0022specialEntities\u0022:[]},\u0022security\u0022:{\u0022method\u0022:\u0022datahub_apikey\u0022,\u0022apikey\u0022:\u0022your-key\u0022,\u0022skipPermissionCheck\u0022:false,\u0022disableIntrospection\u0022:false},\u0022workspaces\u0022:{\u0022asset\u0022:[],\u0022document\u0022:[],\u0022object\u0022:[]},\u0022permissions\u0022:{\u0022user\u0022:[],\u0022role\u0022:[]}}"},"modificationDate":{"description":"Client-side modification date timestamp for conflict detection","type":"integer","example":1768215191}},"type":"object"},"BundleDataHubUpdateConfigurationResponse":{"title":"Bundle Data Hub Update Configuration Response","required":["modificationDate"],"properties":{"modificationDate":{"description":"New modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataImporterCalculateTransformationResultTypeParameters":{"title":"Bundle Data Importer Calculate Transformation Result Type Parameters","required":["currentConfig"],"properties":{"currentConfig":{"description":"A single mapping configuration entry to evaluate the transformation result type for","properties":{"label":{"type":"string"},"dataSourceIndex":{"description":"Data source column indices"},"transformationPipeline":{"type":"array","items":{"type":"object"}},"dataTarget":{"type":"object"}},"type":"object"}},"type":"object"},"BundleDataImporterClassAttributesResponse":{"title":"Bundle Data Importer Class Attributes Response","required":["attributes"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"attributes":{"description":"List of available data object attributes for the class","type":"array","items":{"type":"object"}}},"type":"object"},"BundleDataImporterClassificationStoreKeyNameResponse":{"title":"Bundle Data Importer Classification Store Key Name Response","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"keyId":{"description":"The key ID (group-key format)","type":["string","null"],"example":"1-5"},"groupName":{"description":"The group name","type":["string","null"]},"keyName":{"description":"The key name","type":["string","null"]}},"type":"object"},"BundleDataImporterClassificationStoreKeysResponse":{"title":"Bundle Data Importer Classification Store Keys Response","required":["data","total"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"List of classification store key-group relations","type":"array","items":{"properties":{"keyId":{"description":"Key ID","type":"integer"},"groupId":{"description":"Group ID","type":"integer"},"keyName":{"description":"Key name","type":"string"},"keyDescription":{"description":"Key description","type":"string"},"id":{"description":"Combined group-key ID","type":"string"},"sorter":{"description":"Sort order","type":"integer"},"groupName":{"description":"Group name","type":"string"}},"type":"object"}},"total":{"description":"Total count of matching records","type":"integer","example":42}},"type":"object"},"BundleDataImporterColumnHeadersResponse":{"title":"Bundle Data Importer Column Headers Response","required":["columnHeaders"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"columnHeaders":{"description":"Available column headers from the preview data","type":"array","items":{"properties":{"id":{"description":"Column index","type":"string"},"dataIndex":{"description":"Column data index","type":"string"},"label":{"description":"Column label","type":"string"}},"type":"object"}}},"type":"object"},"BundleDataImporterConfigurationDetail":{"title":"Bundle Data Importer Configuration Detail","required":["name","configuration","userPermissions","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"my-import-config"},"configuration":{"description":"Configuration data","properties":{"general":{"type":"object"},"loaderConfig":{"type":"object"},"interpreterConfig":{"type":"object"},"resolverConfig":{"type":"object"},"processingConfig":{"type":"object"},"mappingConfig":{"type":"object"},"executionConfig":{"type":"object"}},"type":"object","example":{"general":{"name":"my-import-config","active":true},"loaderConfig":{"type":"asset"},"interpreterConfig":{"type":"csv"},"mappingConfig":[],"executionConfig":[],"resolverConfig":[],"processingConfig":[]}},"userPermissions":{"description":"User permissions","properties":{"update":{"type":"boolean","example":true},"delete":{"type":"boolean","example":true}},"type":"object"},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1640000000},"columnHeaders":{"description":"Available column headers from preview data","type":"array","items":{"type":"string"},"example":["id","name","sku","price"]}},"type":"object"},"BundleDataImporterConfigurationSaveParameters":{"title":"Bundle Data Importer Configuration Save Parameters","required":["configuration","modificationDate"],"properties":{"configuration":{"description":"Configuration data","properties":{"general":{"type":"object"},"loaderConfig":{"type":"object"},"interpreterConfig":{"type":"object"},"resolverConfig":{"type":"object"},"processingConfig":{"type":"object"},"mappingConfig":{"type":"object"},"executionConfig":{"type":"object"}},"type":"object","example":{"general":{"name":"my-import-config","active":true},"loaderConfig":{"type":"asset"},"interpreterConfig":{"type":"csv"},"mappingConfig":[],"executionConfig":[],"resolverConfig":[],"processingConfig":[]}},"modificationDate":{"description":"Modification date timestamp for optimistic locking","type":"integer","example":1640000000}},"type":"object"},"BundleDataImporterConnectionsResponse":{"title":"Bundle Data Importer Connections Response","required":["connections"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"connections":{"description":"List of available Doctrine database connections","type":"array","items":{"properties":{"name":{"description":"The connection name","type":"string","example":"default"},"value":{"description":"The connection service identifier","type":"string","example":"doctrine.dbal.default_connection"}},"type":"object"}}},"type":"object"},"BundleDataImporterCopyPreviewParameters":{"title":"Bundle Data Importer Copy Preview Parameters","properties":{"currentConfig":{"description":"Optional unsaved in-progress configuration from the UI. When provided, the loader uses these settings instead of the saved configuration.","properties":{"general":{"type":"object"},"loaderConfig":{"type":"object"},"interpreterConfig":{"type":"object"},"resolverConfig":{"type":"object"},"processingConfig":{"type":"object"},"mappingConfig":{"type":"object"},"executionConfig":{"type":"object"}},"type":["object","null"]}},"type":"object"},"BundleDataImporterCronValidationResponse":{"title":"Bundle Data Importer Cron Validation Response","required":["isValid","message"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isValid":{"description":"Whether the cron expression is valid","type":"boolean","example":true},"message":{"description":"Error message if the cron expression is invalid, empty string otherwise","type":"string","example":""}},"type":"object"},"BundleDataImporterDataPreviewResponse":{"title":"Bundle Data Importer Data Preview Response","required":["dataPreview","previewRecordIndex"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"dataPreview":{"description":"Preview data rows with column metadata","type":"array","items":{"properties":{"dataIndex":{"description":"Column index","type":"string"},"label":{"description":"Column label","type":"string"},"data":{"description":"Cell data value"},"mapped":{"description":"Whether this column is mapped","type":"boolean"}},"type":"object"}},"previewRecordIndex":{"description":"The actual record index that was loaded","type":"integer","example":0}},"type":"object"},"BundleDataImporterImportFileStatusResponse":{"title":"Bundle Data Importer Import File Status Response","required":["exists","message"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"exists":{"description":"Whether the import file has been uploaded","type":"boolean","example":true},"message":{"description":"Status message about the import file","type":"string","example":"Upload file already exists"},"filePath":{"description":"Path of the import file in storage (only when exists is true)","type":["string","null"],"example":"my-config\/upload.import"}},"type":"object"},"BundleDataImporterImportProgressResponse":{"title":"Bundle Data Importer Import Progress Response","required":["isRunning","totalItems","processedItems","progress"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isRunning":{"description":"Whether an import is currently running","type":"boolean","example":true},"totalItems":{"description":"Total number of items to import","type":"integer","example":100},"processedItems":{"description":"Number of items already processed","type":"integer","example":42},"progress":{"description":"Progress as a ratio between 0 and 1","type":"number","format":"float","example":0.42}},"type":"object"},"BundleDataImporterImportStartResponse":{"title":"Bundle Data Importer Import Start Response","required":["success"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"success":{"description":"Whether the import was successfully prepared and started","type":"boolean","example":true}},"type":"object"},"BundleDataImporterLoadPreviewParameters":{"title":"Bundle Data Importer Load Preview Parameters","properties":{"currentConfig":{"description":"Optional unsaved in-progress configuration from the UI. When provided, the interpreter and mapping use these settings instead of the saved configuration.","properties":{"general":{"type":"object"},"loaderConfig":{"type":"object"},"interpreterConfig":{"type":"object"},"resolverConfig":{"type":"object"},"processingConfig":{"type":"object"},"mappingConfig":{"type":"object"},"executionConfig":{"type":"object"}},"type":["object","null"]},"recordNumber":{"description":"Zero-based record number to preview from the data source","type":"integer","example":0}},"type":"object"},"BundleDataImporterTransformationResultPreviewsResponse":{"title":"Bundle Data Importer Transformation Result Previews Response","required":["transformationResultPreviews"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"transformationResultPreviews":{"description":"Transformation result preview strings for each mapping entry","type":"array","items":{"type":"string"}}},"type":"object"},"BundleDataImporterTransformationResultTypeResponse":{"title":"Bundle Data Importer Transformation Result Type Response","required":["type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"type":{"description":"The evaluated transformation result data type","type":"string","example":"default"}},"type":"object"},"BundleDataImporterUnitDataResponse":{"title":"Bundle Data Importer Unit Data Response","required":["UnitList"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"UnitList":{"description":"List of quantity value units","type":"array","items":{"properties":{"unitId":{"description":"The unit ID","type":"string","example":"kg"},"abbreviation":{"description":"The unit abbreviation","type":"string","example":"kg"}},"type":"object"}}},"type":"object"},"BundleDataQualityManagementColorSettings":{"title":"Bundle Data Quality Management Color Settings","required":["mark","fontColor","backgroundColor"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"mark":{"description":"Mark","type":"string","example":"A"},"fontColor":{"description":"Hex code of the font color","type":"string","example":"#104400"},"backgroundColor":{"description":"Hex code of the background color","type":"string","example":"#DAECB8"}},"type":"object"},"BundleDataQualityManagementDetailWidget":{"title":"Bundle Data Quality Management Detail Widget","required":["name","title","mark","score","rules","lastUpdated"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Data quality field name","type":"string","example":"textsAvailable"},"title":{"description":"Data quality field title","type":"string","example":"Texts Available"},"mark":{"description":"Mark for the data quality field","type":["string","null"],"example":"C"},"score":{"description":"Score for the data quality field","type":["number","null"],"format":"float","example":"0.66"},"rules":{"description":"Array of rule details","type":"array","items":{"$ref":"#\/components\/schemas\/BundleDataQualityManagementRule"}},"lastUpdated":{"description":"Last updated timestamp","type":["integer","null"],"example":1752670892}},"type":"object"},"BundleDataQualityManagementRule":{"title":"Bundle Data Quality Management Rule Data","required":["title","suggestion","valid"],"properties":{"title":{"description":"Title of the rule","type":"string","example":"Completeness"},"suggestion":{"description":"Suggestion","type":"string","example":"Fill in some required fields"},"valid":{"description":"Is rule valid","type":"boolean","example":true}},"type":"object"},"BundleEnterpriseSubscriptionToolsLicenseInformation":{"title":"Bundle Enterprise Subscription Tools License Information","required":["success","instanceId","legacyInstanceId","environment","instanceCode"],"properties":{"success":{"description":"Whether license check was successful or not","type":"boolean","example":"true"},"instanceId":{"description":"Instance Id","type":"string","example":"4q7D8Gce"},"legacyInstanceId":{"description":"Legacy Instance Id","type":"string","example":"a79ba4252e2e"},"environment":{"description":"Environment","type":"string","example":"dev"},"instanceCode":{"description":"Instance Code","type":"string","example":"ZTNiMGM0NDI5OGZjMWMxN"}},"type":"object"},"BundleHeadlessDocumentsBrick":{"title":"Bundle Headless Documents Brick","required":["id","name","icon","group","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of brick","type":"string","example":"Simple"},"name":{"description":"Name of brick","type":"string","example":"Simple"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"group":{"description":"Group","type":["string","null"],"example":"Simple Bricks"}},"type":"object"},"BundleHeadlessDocumentsBrickDetail":{"title":"Bundle Headless Documents Brick Detail","required":["id","name","content","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of brick","type":"string","example":"Simple"},"name":{"description":"Name of brick","type":"string","example":"Simple"},"content":{"description":"YAML-formatted string of brick content configuration","type":"string","example":"\u0022type: brick\\ngroup: null\\nitems:\\n\u0022"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true}},"type":"object"},"BundleHeadlessDocumentsBrickFolder":{"title":"Bundle Headless Documents Brick Folder","required":["id","name","icon","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of brick folder","type":"string","example":"group_simple_bricks"},"name":{"description":"Name of brick folder","type":"string","example":"simple_bricks"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsBrick"}}},"type":"object"},"BundleHeadlessDocumentsBrickHelp":{"title":"Bundle Headless Documents Brick Help","required":["editables"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"editables":{"description":"Available editable types with their YAML configuration examples","type":"object","example":{"input":"headline:\n    type: input\n    label: Headline","wysiwyg":"description:\n    type: wysiwyg\n    label: Description","image":"header_image:\n    type: image\n    label: \u0027Header Image\u0027"},"additionalProperties":{"type":"string"}}},"type":"object"},"BundleHeadlessDocumentsConfigList":{"title":"Bundle Headless Documents Config List Data","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of configuration","type":"string","example":"simple"}},"type":"object"},"BundleHeadlessDocumentsCreateConfig":{"title":"Bundle Headless Documents Create Configuration","required":["name"],"properties":{"name":{"description":"Name of the template","type":"string","example":"Simple"}},"type":"object"},"BundleHeadlessDocumentsSettingsData":{"title":"Bundle Headless Documents Settings Data","required":["title","description"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SnippetSettingsData"},{"properties":{"title":{"description":"Title","type":["string","null"],"example":"Page Title"},"description":{"description":"Description","type":["string","null"],"example":"Page Description"}},"type":"object"}]},"BundleHeadlessDocumentsTemplate":{"title":"Bundle Headless Documents Template","required":["id","name","icon","group","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of template","type":"string","example":"Simple"},"name":{"description":"Name of template","type":"string","example":"Simple"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"group":{"description":"Group","type":["string","null"],"example":"Simple Templates"}},"type":"object"},"BundleHeadlessDocumentsTemplateDetail":{"title":"Bundle Headless Documents Template Detail","required":["id","name","content","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of template","type":"string","example":"Simple"},"name":{"description":"Name of template","type":"string","example":"Simple"},"content":{"description":"YAML-formatted string of template content","type":"string","example":"\u0022layout: simple\\ngroup: null\\ncontent:\\n\u0022"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true}},"type":"object"},"BundleHeadlessDocumentsTemplateFolder":{"title":"Bundle Headless Documents Template Folder","required":["id","name","icon","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of template folder","type":"string","example":"group_simple_templates"},"name":{"description":"Name of template","type":"string","example":"simple_templates"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#\/components\/schemas\/BundleHeadlessDocumentsTemplate"}}},"type":"object"},"BundleHeadlessDocumentsTemplateHelp":{"title":"Bundle Headless Documents Template Help","required":["layouts","editables"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"layouts":{"description":"Available layout templates with their YAML configuration","type":"object","example":{"simple":"layout: simple\ncontent:\n    headline:\n        type: input","grid":"layout: grid\ncontent:\n    row:\n        type: panel","tabpanel":"layout: tabpanel\ncontent:\n    tab1:\n        type: panel"},"additionalProperties":{"type":"string"}},"editables":{"description":"Available editable types with their YAML configuration examples","type":"object","example":{"input":"headline:\n    type: input\n    label: Headline","wysiwyg":"description:\n    type: wysiwyg\n    label: Description","image":"header_image:\n    type: image\n    label: \u0027Header Image\u0027"},"additionalProperties":{"type":"string"}}},"type":"object"},"BundleHeadlessDocumentsUpdateConfig":{"title":"Bundle Headless Documents Update Content of Configuration","required":["content"],"properties":{"content":{"description":"Template content in YAML format","type":"string","example":"layout: simple\ncontent:\n    headline:\n        type: input\n        label: Headline"}},"type":"object"},"BundlePersonalizationCreateTargetingGroup":{"title":"Bundle Personalization Create Targeting Group","required":["name"],"properties":{"name":{"description":"Group name","type":"string","example":"new-customer"}},"type":"object"},"BundlePersonalizationCreateTargetingRule":{"title":"Bundle Personalization Create Targeting Rule","required":["name"],"properties":{"name":{"description":"Name of the targeting rule","type":"string","example":"My New Targeting Rule"}},"type":"object"},"BundlePersonalizationTargetGroup":{"title":"Bundle Personalization Target Group","required":["id","active","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":83},"active":{"description":"Is group active","type":"boolean","example":true},"name":{"description":"Name of the group","type":"string","example":"regular-customer"}},"type":"object"},"BundlePersonalizationTargetingGroupDetail":{"title":"Bundle Personalization Targeting Group Detail","required":["id","name","description","threshold","active"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Group ID","type":"integer","example":1},"name":{"description":"Group name","type":"string","example":"new-customer"},"description":{"description":"Group description","type":"string","example":""},"threshold":{"description":"Threshold value","type":"integer","example":1},"active":{"description":"Active status","type":"boolean","example":true}},"type":"object"},"BundlePersonalizationTargetingRule":{"title":"Bundle Personalization Targeting Rule","required":["id","name","active"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":1},"name":{"description":"Rule name","type":"string","example":"My Targeting Rule"},"active":{"description":"Is rule active","type":"boolean","example":true}},"type":"object"},"BundlePersonalizationTargetingRuleDetail":{"title":"Bundle Personalization Targeting Rule Detail","required":["id","priority","settings","conditions","actions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Rule ID","type":"integer","example":1},"priority":{"description":"Rule priority","type":"integer","example":10},"settings":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRuleSettings","description":"Rule settings"},"conditions":{"description":"Rule conditions","type":"array","items":{"type":"object","example":{"type":"cmf_customer_is_loggedin","operator":"and","bracketLeft":false,"bracketRight":false}}},"actions":{"description":"Rule actions","type":"array","items":{"type":"object","example":{"targetGroup":[1,2,3],"applyType":"cleanup_and_overwrite","type":"cmf_apply_target_groups_from_segments"}}}},"type":"object"},"BundlePersonalizationTargetingRulePriority":{"title":"Bundle Personalization Targeting Rule Priority","required":["id","priority"],"properties":{"id":{"description":"Id","type":"integer","example":1},"priority":{"description":"Rule priority","type":"integer","example":10}},"type":"object"},"BundlePersonalizationTargetingRuleSettings":{"title":"Bundle Personalization Targeting Rule Settings","required":["name","description","scope","active"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Rule name","type":"string","example":"My Targeting Rule"},"description":{"description":"Rule description","type":"string","example":"Rule for logged in customers"},"scope":{"description":"Targeting scope","type":"string","enum":["hit","session","session_with_variables","visitor"],"example":"hit"},"active":{"description":"Is rule active","type":"boolean","example":true}},"type":"object"},"BundlePersonalizationUpdateTargetingGroup":{"title":"Bundle Personalization Update Targeting Group","required":["description","threshold","active"],"properties":{"description":{"description":"Group description","type":"string","example":"Description of the targeting group"},"threshold":{"description":"Threshold value","type":"integer","example":1},"active":{"description":"Active status","type":"boolean","example":true}},"type":"object"},"BundlePersonalizationUpdateTargeting":{"title":"Bundle Personalization Update Targeting Rule","required":["settings","conditions","actions"],"properties":{"settings":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRuleSettings","description":"Rule settings"},"conditions":{"description":"Rule conditions","type":"array","items":{"type":"object","example":{"type":"cmf_customer_is_loggedin","operator":"and","bracketLeft":false,"bracketRight":false}}},"actions":{"description":"Rule actions","type":"array","items":{"type":"object","example":{"targetGroup":[1,2,3],"applyType":"cleanup_and_overwrite","type":"cmf_apply_target_groups_from_segments"}}}},"type":"object"},"BundlePersonalizationUpdateTargetingPriority":{"title":"Bundle Personalization Update Targeting Rule Priority","required":["priorities"],"properties":{"priorities":{"description":"Array of rule priority data","type":"array","items":{"$ref":"#\/components\/schemas\/BundlePersonalizationTargetingRulePriority"}}},"type":"object"},"BundlePortalEngineAsset":{"title":"Bundle Portal Engine Asset","required":["allowDrag","allowDrop","collectionId"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"collectionId":{"description":"Collection ID","type":"number","example":5}},"type":"object"}]},"BundlePortalEngineDataObject":{"title":"Bundle Portal Engine Data Object","required":["allowDrag","allowDrop","collectionId"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"properties":{"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"collectionId":{"description":"Collection ID","type":"number","example":5}},"type":"object"}]},"BundleSeoRedirect":{"title":"Bundle Seo Redirect","required":["id","type","source","sourceSite","passThroughParameters","target","targetSite","statusCode","priority","regex","active","expiry","creationDate","modificationDate","userOwner","userModification"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":["integer","null"],"example":1},"type":{"description":"Type of redirect","type":"string","example":"auto_create"},"source":{"description":"Source URL","type":["string","null"],"example":"\/old-path"},"sourceSite":{"description":"ID of the source site","type":["integer","null"],"example":1},"passThroughParameters":{"description":"Whether to pass through parameters","type":"boolean","example":true},"target":{"description":"Target URL","type":["string","null"],"example":"\/new-path"},"targetSite":{"description":"ID of the target site","type":["integer","null"],"example":1},"statusCode":{"description":"Status code","type":"integer","example":301},"priority":{"description":"Priority","type":"integer","example":8},"regex":{"description":"Whether the redirect uses regex","type":["boolean","null"],"example":true},"active":{"description":"Whether the redirect is active","type":"boolean","example":true},"expiry":{"description":"Expiry date in timestamp format","type":["integer","null"],"example":1712345678},"creationDate":{"description":"Creation date in timestamp format","type":["integer","null"],"example":1712345678},"modificationDate":{"description":"Modification date in timestamp format","type":["integer","null"],"example":1712345678},"userOwner":{"description":"ID of the user who owns the redirect","type":["integer","null"],"example":1},"userModification":{"description":"ID of the user who last modified the redirect","type":["integer","null"],"example":1}},"type":"object"},"BundleSeoRedirectAdd":{"title":"Bundle Seo Redirect Add","required":["type","source","target"],"properties":{"type":{"description":"Type of redirect","type":"string","example":"entire_uri"},"source":{"description":"Source URL","type":["string","null"],"example":"\/old-path"},"target":{"description":"Target URL","type":["string","null"],"example":"\/new-path"}},"type":"object"},"BundleSeoRedirectStatus":{"title":"Bundle Seo Redirect Status","required":["code","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"code":{"description":"Status code","type":"integer","example":301},"label":{"description":"Status label","type":"string","example":"Moved Permanently"}},"type":"object"},"BundleSeoRedirectUpdate":{"title":"Bundle Seo Redirect Update","required":["type","sourceSite","source","targetSite","target","statusCode","priority","regex","active","passThroughParameters","expiry"],"properties":{"type":{"description":"Type of redirect","type":"string","example":"entire_uri"},"sourceSite":{"description":"ID of the source site","type":["integer","null"],"example":1},"source":{"description":"Source URL","type":["string","null"],"example":"\/old-path"},"targetSite":{"description":"ID of the target site","type":["integer","null"],"example":1},"target":{"description":"Target URL","type":["string","null"],"example":"\/new-path"},"statusCode":{"description":"Status code","type":"integer","example":301},"priority":{"description":"Priority","type":"integer","example":8},"regex":{"description":"Whether the redirect uses regex","type":"boolean","example":false},"active":{"description":"Whether the redirect is active","type":"boolean","example":true},"passThroughParameters":{"description":"Whether to pass through parameters","type":"boolean","example":false},"expiry":{"description":"Expiry date in timestamp format","type":["integer","null"],"example":1712345678}},"type":"object"},"BundleSeoRedirectImportStats":{"title":"Bundle Seo Redirects Import Statistics","required":["total","imported","created","updated","errored","errors"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"total":{"description":"Number of total redirects","type":"integer","example":20},"imported":{"description":"Number of imported redirects","type":"integer","example":15},"created":{"description":"Number of created redirects","type":"integer","example":10},"updated":{"description":"Number of updated redirects","type":"integer","example":5},"errored":{"description":"Number of errored redirects","type":"integer","example":2},"errors":{"description":"List of errors where index is the index of import line","type":"array","items":{"type":"object","example":{"3":"Invalid source URL","5":"Target URL already exists"}}}},"type":"object"},"BundleStatisticsExplorerDataSource":{"title":"Bundle Statistics Explorer Data Source","required":["value","label","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"value":{"description":"Value","type":"string","example":"db_assets"},"label":{"description":"Label","type":"string","example":"[DB] Assets"},"type":{"description":"Type","type":"string","example":"MYSQL"}},"type":"object"},"BundleStatisticsExplorerDataSourceFields":{"title":"Bundle Statistics Explorer Data Source Fields","required":["data","operators"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"data","type":"array","items":{"type":"object"},"example":"[{\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}, {\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}]"},"operators":{"description":"operators","type":"array","items":{"type":"object"},"example":"[{\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}, {\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}]"}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsDefinition":{"title":"Bundle Statistics Explorer Data Source Fields Definition","required":["label","name","typeGroup","fields"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"label":{"description":"label","type":"string","example":"creationDate"},"name":{"description":"name","type":"string","example":"creationDate"},"typeGroup":{"description":"typeGroup","type":"string","example":"numeric"},"fields":{"description":"fields","type":"array","items":{"type":"object"},"example":"[{\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}, {\u0022key1\u0022:\u0022value1\u0022, \u0022key2\u0022: \u0022value2\u0022}]"}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsSettings":{"title":"Bundle Statistics Explorer Data Source Fields Settings","required":["statisticsMode","aggregations","columns"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"statisticsMode":{"description":"statisticsMode","type":"string","enum":["list","statistic"],"example":"list"},"aggregations":{"description":"aggregations","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}},"columns":{"description":"columns","type":"array","items":{"$ref":"#\/components\/schemas\/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsSettingsArray":{"title":"Bundle Statistics Explorer Data Source Fields Settings Array","required":["id","label","typeGroup","value"],"properties":{"id":{"description":"id","type":"string","example":"extModel2097-7"},"label":{"description":"label","type":"string","example":"creationDate"},"typeGroup":{"description":"typeGroup","type":"string","example":"numeric"},"value":{"description":"value","type":"string","example":"creationDate"}},"type":"object"},"BundleWebToPrintGenerateProcessData":{"title":"Bundle Web To Print Generate Process Data","required":["active","downloadAvailable","date","message","statusUpdate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"active":{"description":"Whether a PDF generation process is currently active","type":"boolean","example":true},"downloadAvailable":{"description":"Whether the generated PDF is available for download","type":"boolean","example":false},"statusUpdate":{"description":"Status update information","type":["array","null"],"items":{"type":"string"},"example":["Processing page 1 of 5","Rendering images"]},"date":{"description":"Last generation date","type":["string","null"],"example":"2025-11-05 14:30"},"message":{"description":"Last generation message","type":["string","null"],"example":"PDF generation completed successfully"}},"type":"object"},"BundleWebToPrintProcessingOption":{"title":"Bundle Web To Print Processing Option","required":["name","label","type","value","values"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Option name","type":"string","example":"dpi"},"label":{"description":"Option label","type":"string","example":"dpi"},"type":{"description":"Option type","type":"string","example":"select"},"value":{"description":"Option value","example":"Some value","oneOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"},{"type":"null"}]},"values":{"description":"Available option values","type":["array","null"],"items":{"oneOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}]},"example":[72,150,300,600]}},"type":"object"},"CsvSettings":{"title":"CSV Settings","required":["delimiter","quoteChar","escapeChar","lineTerminator"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"delimiter":{"description":"Field delimiter character","type":"string","example":";"},"quoteChar":{"description":"Quote character for fields","type":"string","example":"\u0022"},"escapeChar":{"description":"Escape character","type":"string","example":"\\"},"lineTerminator":{"description":"Line terminator character","type":"string","example":""}},"type":"object"},"ChangeMainDocument":{"title":"Change Main Document","required":["mainDocumentPath"],"properties":{"mainDocumentPath":{"description":"Main document path","type":["string","null"],"example":"\/path\/to\/main\/document"}},"type":"object"},"UpdateTagParameters":{"title":"Change Tag Parameters","description":"Parameters for changing a tag","properties":{"parentId":{"description":"Parent id","type":["integer","null"],"example":0},"name":{"description":"Tag name","type":["string","null"],"example":"tag 1"}},"type":"object"},"CheckPrettyUrl":{"title":"Check Pretty URL","required":["prettyUrl"],"properties":{"prettyUrl":{"description":"Pretty URL to check","type":"string","example":"\/my-pretty-url"}},"type":"object"},"ClassDefinitionIdentifierData":{"title":"Class Definition Identifier Data","required":["suggestedId","existingIds"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"suggestedId":{"description":"Suggested unique ID for the new class definition","type":"string","example":"AP"},"existingIds":{"description":"Array of existing class definition IDs","type":"array","items":{"type":"string"},"example":["AP","CP","MP"]}},"type":"object"},"ClassDefinitionList":{"title":"Class Definition List Item","required":["id","name","title","icon","group"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of class definition","type":"string","example":"AP"},"name":{"description":"Name of class definition","type":"string","example":"AccessoryPart"},"title":{"description":"Title","type":"string","example":"Accessory Part"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"}},"type":"object"},"ClassDefinitionObjectBrickData":{"title":"Class Definition Object Brick Data","required":["key","fieldName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the object brick","type":"string","example":"SaleInformation"},"fieldName":{"description":"Name of class definition field","type":"string","example":"saleInformation"}},"type":"object"},"ClassDefinitionTreeNodeFolder":{"title":"Class Definition Tree Node Folder","required":["children"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/ClassDefinitionList"},{"properties":{"children":{"description":"Child nodes","type":"array","items":{"$ref":"#\/components\/schemas\/ClassDefinitionTreeNode"}}},"type":"object"}]},"ClassDefinitionTreeNode":{"title":"Class Definition Tree Node Item","required":["enableGridLocking","hasBrickField"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/ClassDefinitionList"},{"properties":{"enableGridLocking":{"description":"Enable grid locking","type":"boolean","example":false},"hasBrickField":{"description":"Has brick field","type":"boolean","example":false}},"type":"object"}]},"AvailableVisibleField":{"title":"Class definition Visible Field","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Field key","type":"string","example":"id"}},"type":"object"},"ClassDefinitionFolderItem":{"title":"Class in data object folder","required":["id","name","inheritance"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of class","type":"string","example":"NE"},"name":{"description":"Name of class","type":"string","example":"News"},"inheritance":{"description":"Inheritance allowed","type":"boolean","example":"true"}},"type":"object"},"ClassLayoutCompact":{"title":"Class layout data in compact format to be used for e.g. listing in workspaces","required":["id","name","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of layout","type":"string","example":"CAR_0"},"name":{"description":"Name","type":"string","example":"Car"},"type":{"description":"Whether it is the default layout","type":"string","example":"main"}},"type":"object"},"ClassDefinition":{"title":"ClassDefinition","required":["id","name","title","description","creationDate","modificationDate","userOwner","parentClass","implementsInterfaces","listingParentClass","useTraits","listingUseTraits","encryption","allowInherit","allowVariants","showVariants","icon","group","showAppLoggerTab","linkGeneratorReference","previewGeneratorReference","compositeIndices","showFieldLookup","propertyVisibility","enableGridLocking","blockedVarsForExport","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of class definition","type":"string","example":"AP"},"name":{"description":"Name of class definition","type":"string","example":"AccessoryPart"},"title":{"description":"Title","type":"string","example":"Accessory Part"},"description":{"description":"Description","type":"string","example":"This class represents an accessory part"},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1700000000},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1700000000},"userOwner":{"description":"User id of owner","type":"integer","example":1},"parentClass":{"description":"Namespace of parent class","type":"string","example":"App\\Model\\DataObject\\AccessoryPart"},"implementsInterfaces":{"description":"Interface implementations","type":"string","example":"App\\Model\\DataObject\\Interface"},"listingParentClass":{"description":"List of parent class","type":"string","example":"App\\Model\\DataObject\\Listing"},"useTraits":{"description":"Traits usage","type":"string","example":"App\\Model\\DataObject\\Trait"},"listingUseTraits":{"description":"Traits usage listing","type":"string","example":"App\\Model\\DataObject\\ListingTrait"},"encryption":{"description":"Whether encryption is ued","type":"boolean","example":true},"allowInherit":{"description":"Whether inheritance is allowed","type":"boolean","example":true},"allowVariants":{"description":"Whether variants are allowed","type":"boolean","example":true},"showVariants":{"description":"Whether variants are visible in the tree","type":"boolean","example":true},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"showAppLoggerTab":{"description":"Show application logger tab","type":"boolean","example":true},"linkGeneratorReference":{"description":"Namespace of link generator","type":"string","example":"App\\Model\\DataObject\\LinkGenerator"},"previewGeneratorReference":{"description":"Namespace of preview generator","type":"string","example":"App\\Model\\DataObject\\PreviewGenerator"},"compositeIndices":{"description":"Composite indices","type":"object","example":[]},"showFieldLookup":{"description":"Show field lookup","type":"boolean","example":true},"propertyVisibility":{"description":"Visibility of properties for grid, search, ...","type":"object","example":[]},"enableGridLocking":{"description":"Whether grid locking is enabled","type":"boolean","example":true},"blockedVarsForExport":{"description":"Blocked variables for export","type":"array","items":{"type":"string"},"example":[]},"isWriteable":{"description":"Whether the class definition can be written to","type":"boolean","example":true},"group":{"description":"Group","type":["string","null"],"example":"system"}},"type":"object"},"Collection":{"title":"Classification Store Collection","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":"string","example":"value"},"groups":{"description":"List of Group IDs in collection","type":"object"}},"type":"object"},"KeyLayout":{"title":"Classification Store Collection","required":["id","name","description","definition"],"properties":{"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":"string","example":"value"},"definition":{"description":"Layout Definition","type":"object"}},"type":"object"},"ClassificationStoreStoreConfig":{"title":"Classification Store Configuration","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"}},"type":"object"},"Group":{"title":"Classification Store Group","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":["string","null"],"example":"value"}},"type":"object"},"CollectionLayout":{"title":"Classification Store Group Layout","required":["groups"],"properties":{"groups":{"description":"Groups","type":"array","items":{"$ref":"#\/components\/schemas\/GroupLayout"}}},"type":"object"},"GroupLayout":{"title":"Classification Store Group Layout","required":["id","name","keys"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":["string","null"],"example":"value"},"keys":{"description":"Description","type":"array","items":{"$ref":"#\/components\/schemas\/KeyLayout"}}},"type":"object"},"KeyGroupRelation":{"title":"Classification Store KeyGroupRelation","required":["keyId","groupId","keyName","groupName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"keyId":{"description":"Key ID","type":"integer","example":42},"groupId":{"description":"Group ID","type":"integer","example":42},"keyName":{"description":"Key Name","type":"string","example":"value"},"groupName":{"description":"Group Name","type":"string","example":"value"},"keyDescription":{"description":"Key Description","type":["string","null"],"example":"value"},"groupDescription":{"description":"Key Description","type":["string","null"],"example":"value"}},"type":"object"},"ColumnSchema":{"title":"Column","required":["key","locale","group"],"properties":{"key":{"description":"Key of the Column","type":"string","example":"id"},"locale":{"description":"Locale of the Column","type":["string","null"],"example":"de"},"group":{"description":"Define the group structure","type":"object","example":["system"]}},"type":"object"},"ConvertedQuantityValue":{"title":"Converted quantity values","required":["unitAbbreviation","unitLongName","convertedValue"],"properties":{"unitAbbreviation":{"description":"Unit Abbreviation","type":"string","example":"m"},"unitLongName":{"description":"Unit Long Name","type":"string","example":"Meter"},"convertedValue":{"description":"Converted Values","type":"number","format":"float","example":160}},"type":"object"},"ConvertedQuantityValues":{"title":"Converted quantity values","required":["originalValue","fromUnitId","convertedValues"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"originalValue":{"description":"Original Value","example":5,"anyOf":[{"type":"float"},{"type":"integer"}]},"fromUnitId":{"description":"From Unit Id","type":"string","example":"m"},"convertedValues":{"description":"Converted Values","type":"array","items":{"$ref":"#\/components\/schemas\/ConvertedQuantityValue"}}},"type":"object"},"SaveElementTreeWidgetConfig":{"title":"Create Element Tree Widget Config","required":["id","name","icon","contextPermissions","elementType","rootFolder","showRoot","classes","pql","pageSize"],"properties":{"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"contextPermissions":{"description":"Context Permissions","type":"object","example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}},"elementType":{"description":"Element Type","type":"string","example":"data-object"},"rootFolder":{"description":"Root Folder","type":"string","example":"\/Product Data\/Cars"},"showRoot":{"description":"Show Root","type":"boolean","example":false},"classes":{"description":"Classes","type":"object","example":["CAR"]},"pql":{"description":"PQL","type":["string","null"],"example":null},"pageSize":{"description":"Page size","type":["integer","null"],"example":20}},"type":"object"},"CreateNotificationsWidgetConfig":{"title":"Create Notifications Widget Config","required":["page","pageSize","dateFilterValue","dateFilterOperator","senderFilter","typeFilter","onlyUnread"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/CreateWidgetConfig"},{"properties":{"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":1},"dateFilterValue":{"description":"Date Filter Value","type":["string","null"],"example":"08\/20\/2024"},"dateFilterOperator":{"description":"Date Filter Operator","type":["string","null"],"example":"on"},"senderFilter":{"description":"Sender Filter","type":["integer","null"],"example":20},"typeFilter":{"description":"Type Filter","type":["string","null"],"example":"info"},"onlyUnread":{"description":"Filter Only Unread Notifications","type":"boolean","example":false}},"type":"object"}]},"SavePerspectiveConfig":{"title":"Create Perspective Config","required":["icon","contextPermissions","widgetsLeft","widgetsRight","widgetsBottom","expandedLeft","expandedRight"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/AddPerspectiveConfig"},{"properties":{"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"contextPermissions":{"description":"Context Permissions","type":"object"},"widgetsLeft":{"description":"Widgets Left","type":"object","example":{"widget_id":"widget_type"}},"widgetsRight":{"description":"Widgets Right","type":"object","example":{"widget_id":"widget_type"}},"widgetsBottom":{"description":"Widgets Bottom","type":"object","example":{"widget_id":"widget_type"}},"expandedLeft":{"description":"Left Expanded Widget","type":["string","null"],"example":"widget_id"},"expandedRight":{"description":"Right Expanded Widget","type":["string","null"],"example":"widget_id"}},"type":"object"}]},"CreateRecentlyModifiedWidgetConfig":{"title":"Create Recently Modified Widget Config","required":["elementType"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/CreateWidgetConfig"},{"properties":{"elementType":{"description":"Element Type","type":"string","example":"asset"}},"type":"object"}]},"CreateTagParameters":{"title":"Create Tag Parameters","description":"Parameters for creating a new tag","properties":{"parentId":{"description":"Parent id","type":"integer","example":0},"name":{"description":"Tag name","type":"string","example":"tag 1"}},"type":"object"},"CreateThumbnailConfig":{"title":"Create Thumbnail Config","required":["name"],"properties":{"name":{"description":"Thumbnail configuration name","type":"string","example":"my-thumbnail"}},"type":"object"},"CreateWidgetConfig":{"title":"Create Widget Config","required":["id","name","icon","color","visualization"],"properties":{"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"My Widget"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"color":{"description":"Color","type":"string","example":"#FF5733"},"visualization":{"description":"Visualization","type":["string","null"],"example":"table"}},"type":"object"},"CreateWysiwygWidgetConfig":{"title":"Create Wysiwyg Widget Config","required":["wysiwyg"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/CreateWidgetConfig"},{"properties":{"wysiwyg":{"description":"Wysiwyg Content","type":["string","null"],"example":"\u003Cp\u003EHello World\u003C\/p\u003E"}},"type":"object"}]},"CreateNote":{"title":"CreateNote","required":["title","description","type"],"properties":{"title":{"description":"title","type":"string","example":"Title of note"},"description":{"description":"description","type":"string","example":"Description of note"},"type":{"description":"type","type":"string","example":"Type of note"}},"type":"object"},"Credentials":{"title":"Credentials","description":"Credentials for authentication","required":["username","password"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"},"password":{"description":"Password","type":"string","example":"*****"}},"type":"object"},"CustomLayoutIdentifierData":{"title":"Custom Layout Identifier Data","required":["suggestedId","existingIds","existingNames"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"suggestedId":{"description":"Suggested unique ID for custom layout","type":"string","example":"custom_layout_1"},"existingIds":{"description":"Array of existing custom layout IDs","type":"array","items":{"type":"string"},"example":["custom_layout_1","custom_layout_2","custom_layout_3"]},"existingNames":{"description":"Array of existing custom layout names","type":"array","items":{"type":"string"},"example":["Custom Layout 1","Custom Layout 2","Custom Layout 3"]}},"type":"object"},"CustomLayout":{"title":"Custom layouts","required":["id","name","description","creationDate","modificationDate","userOwner","classId","default","layoutDefinition"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of custom layout","type":"string","example":"custom_layout_1"},"name":{"description":"Name","type":"string","example":"Custom Layout 1"},"description":{"description":"Description","type":"string","example":"This is a custom layout"},"creationDate":{"description":"Creation date timestamp","type":"integer","example":1633036800},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1633036800},"userOwner":{"description":"User id of owner","type":"integer","example":1},"classId":{"description":"Class id","type":"string","example":"Product"},"default":{"description":"Whether it is the default layout","type":"boolean","example":false},"layoutDefinition":{"oneOf":[{"$ref":"#\/components\/schemas\/Layout","description":"Layout definitions"},{"type":"null"}],"description":"Layout definitions","type":"object"}},"type":"object"},"CustomLayoutCompact":{"title":"Custom layouts in compact format to be used for e.g. listings","required":["id","name","default"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of custom layout","type":"string","example":"custom_layout_1"},"name":{"description":"Name","type":"string","example":"Custom Layout 1"},"default":{"description":"Whether it is the default layout","type":"boolean","example":false}},"type":"object"},"CustomAttributes":{"title":"CustomAttributes","description":"Custom attributes used mainly for the tree","required":["icon","tooltip","additionalIcons","key","additionalCssClasses"],"properties":{"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon","description":"Custom Icon"},{"type":"null"}],"description":"Custom Icon"},"tooltip":{"description":"Custom Tooltip","type":["string","null"],"example":"\u003Cb\u003EMy Tooltip\u003C\/b\u003E"},"additionalIcons":{"description":"AdditionalIcons","type":"array","items":{"type":"string","example":"some_other_icon"}},"key":{"description":"Custom Key\/Filename","type":["string","null"],"example":"my_custom_key"},"additionalCssClasses":{"description":"Additional Css Classes","type":"array","items":{"type":"string","example":"my_custom_class"}}},"type":"object"},"CustomMetadata":{"title":"CustomMetadata","required":["name","language","type","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"}},"type":"object"},"CustomMetadataVersion":{"title":"CustomMetadataVersion","required":["name","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["string","null"],"example":"data"}},"type":"object"},"CustomSettings":{"title":"CustomSettings","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"fixedCustomSettings":{"oneOf":[{"$ref":"#\/components\/schemas\/FixedCustomSettings","description":"fixed custom settings"},{"type":"null"}],"description":"fixed custom settings","example":"{ embeddedMetadata: { FileSize: 360 KiB }, checksum: b3685e8348e7ac4d30d0268f7e58902a }"},"dynamicCustomSettings":{"description":"dynamic custom settings - can be any key-value pair","type":"array","items":{"type":"object"},"example":"[{ imageWidth: 1280 }, { imageHeight: 720 }]"}},"type":"object"},"DashboardConfiguration":{"title":"Dashboard Configuration","required":["id","name","rows","ownerId","ownerUsername","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier for the dashboard","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name of the dashboard","type":"string","example":"My Dashboard"},"ownerId":{"description":"ID of the owner of the dashboard","type":"integer","example":1},"ownerUsername":{"description":"Username of the owner of the dashboard","type":"string","example":"john_doe"},"rows":{"description":"Number of rows in the dashboard","type":"array","items":{"$ref":"#\/components\/schemas\/LayoutOption"}},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true},"shareGlobally":{"description":"If Dashboard is shared globally","type":"boolean","example":true},"sharedUserNames":{"description":"List of names the Dashboard is shared with","type":"object","example":["jane_doe","max_mustermann"]},"sharedRoleNames":{"description":"List of roles the Dashboard is shared with","type":"object","example":["jane_doe","max_mustermann"]},"menuShortcutGroup":{"description":"Name of the group in the Menu","type":["string","null"],"example":"My Dashboard"}},"type":"object"},"DashboardsWidgetConfig":{"title":"Dashboards Widget Config","required":["id","name","widgetType","icon","visualization"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"widgetType":{"description":"Widget Type","type":"string","example":"wysiwyg"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"visualization":{"description":"Visualization","type":["string","null"],"example":"table"}},"type":"object"},"DashboardsWidgetConfigConfiguration":{"title":"Dashboards Widget Config Configuration","required":["name","options"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name of the configuration","type":["string","null"],"example":"elementType"},"options":{"description":"Configuration options","type":"object","example":["asset"]}},"type":"object"},"DashboardsWidgetType":{"title":"Dashboards Widget Type","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"last_changes"}},"type":"object"},"CloneParameters":{"title":"Data Object Clone Parameters","required":["recursive","updateReferences"],"properties":{"recursive":{"description":"Recursive","type":"boolean","example":false},"updateReferences":{"description":"Update References","type":"boolean","example":false}},"type":"object"},"DataObjectFolder":{"title":"Data Object Folder","required":["hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"properties":{"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false}},"type":"object"}]},"DataObjectPermissions":{"title":"Data Object Permissions","required":["save","unpublish","localizedEdit","localizedView"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Permissions"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true},"localizedEdit":{"description":"Localized Edit","type":["string","null"],"example":"default"},"localizedView":{"description":"Localized View","type":["string","null"],"example":"default"}},"type":"object"}]},"PreviewParameter":{"title":"Data Object Preview Parameters","required":["id"],"properties":{"id":{"description":"ID","type":"integer","example":83},"site":{"description":"Site","type":"integer","default":0,"example":1}},"type":"object"},"DataObjectDetail":{"title":"Data object with detail data","required":["objectData","inheritanceData","draftData","allowInheritance","showVariants","hasPreview","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"properties":{"showVariants":{"description":"Show variants","type":"boolean","example":false},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}},"inheritanceData":{"description":"Inheritance object data","type":"object","example":{"fieldKey":[]}},"draftData":{"oneOf":[{"$ref":"#\/components\/schemas\/DataObjectDraftData"},{"type":"null"}]}},"type":"object"}]},"DataObject":{"title":"DataObject","required":["key","className","type","published","hasChildren","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","index","childrenSortBy","childrenSortOrder","allowVariants"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"key":{"description":"Key","type":"string","example":"Giulietta"},"className":{"description":"Class name","type":"string","example":"car"},"type":{"description":"Type","type":"string","example":"image"},"published":{"description":"Published","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/dataObject"},"permissions":{"$ref":"#\/components\/schemas\/DataObjectPermissions"},"index":{"description":"Custom index","type":"integer","example":0},"childrenSortBy":{"description":"Sort mode of children","type":"string","example":"index"},"childrenSortOrder":{"description":"Sort order of children","type":"string","example":"asc"},"allowVariants":{"description":"Allow variants","type":["boolean","null"],"example":false}},"type":"object"}]},"DataObjectAddParameters":{"title":"DataObjectAdd","required":["key","classId","type"],"properties":{"key":{"description":"Key","type":"string","example":"my_new_data_object"},"classId":{"description":"Class Id","type":"string","example":"data_object_class_id"},"type":{"description":"Type","type":"string","enum":["object","variant"],"example":"object"}},"type":"object"},"DataObjectDraftData":{"title":"DataObjectDraftData","required":["id","modificationDate","isAutoSave"],"properties":{"id":{"description":"ID","type":"integer","example":83},"modificationDate":{"description":"Modification date","type":"integer","example":1634025600},"isAutoSave":{"description":"Is auto save","type":"boolean","example":false}},"type":"object"},"DataObjectVersion":{"title":"DataObjectVersion","required":["allowInheritance","showVariants","hasPreview","hasWorkflowAvailable","key","type","hasChildren","fullPath","index","allowVariants","className","published","objectData"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"showVariants":{"description":"Show variants","type":"boolean","example":false},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"key":{"description":"Key","type":"string","example":"Giulietta"},"type":{"description":"Type","type":"string","example":"image"},"hasChildren":{"description":"Has children","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/dataObject"},"index":{"description":"Custom index","type":"integer","example":0},"className":{"description":"Class name","type":["string","null"],"example":"car"},"published":{"description":"Published","type":["boolean","null"],"example":false},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}},"allowVariants":{"description":"Allow variants","type":["boolean","null"],"example":false},"properties":{"description":"Properties","type":"array","items":{"$ref":"#\/components\/schemas\/ElementProperty"}}},"type":"object"}]},"ElementProperty":{"title":"DataProperty","required":["key","data","type","inheritable","inherited"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"key_of_the_property"},"data":{"description":"data","type":["mixed","null"],"example":"123"},"type":{"description":"type","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false},"inherited":{"description":"inherited","type":"boolean","example":false},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"predefinedName":{"description":"predefinedName","type":["string","null"],"example":"name of the predefined property"},"description":{"description":"description","type":["string","null"],"example":"Description of the predefined property"}},"type":"object"},"DeleteInfo":{"title":"DeleteInfo","required":["hasDependencies","canUseRecycleBin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"hasDependencies":{"description":"hasDependencies","type":"boolean","example":true},"canUseRecycleBin":{"description":"canUseRecycleBin","type":"boolean","example":true}},"type":"object"},"DeltaItem":{"title":"Delta Item","description":"Translation delta item after merge","required":["key","deltaValues"],"properties":{"key":{"description":"Key of the translation","type":"string","example":"car"},"deltaValues":{"description":"List of translation deltas for the given key","type":"array","items":{"$ref":"#\/components\/schemas\/TranslationDeltaValues"}}},"type":"object"},"Dependency":{"title":"Dependency","required":["id","path","type","subType","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":1020},"path":{"description":"path","type":"string","example":"text"},"type":{"description":"type","type":"string","example":"asset"},"subType":{"description":"subType","type":"string","example":"image"},"published":{"description":"published","type":"boolean","example":"true"}},"type":"object"},"UserDependency":{"title":"Dependency to an Object","description":"Dependency to an Object","required":["id","path","subtype"],"properties":{"id":{"description":"ID of the object","type":"integer","example":42},"path":{"description":"Path to the object","type":"string","example":"\/path\/to\/object"},"subtype":{"description":"Subtype of the object","type":"string","example":"Car"}},"type":"object"},"DetailedRole":{"title":"Detailed User Role","description":"Contains all information about a role","required":["id","name","classes","parentId","permissions","docTypes","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or Role","type":["string","null"],"example":"admin"},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"docTypes":{"description":"List of document types for the role","type":"object","example":["1","2"]},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#\/components\/schemas\/PerspectiveConfig"}}},"type":"object"},"DevError":{"title":"DevError","description":"Error with details for developers","required":["message","details"],"properties":{"message":{"description":"Message","type":"string","example":"I got a bad feeling about this"},"details":{"description":"Details","type":"string","example":"Search your feelings. (Stack trace)"}},"type":"object"},"DocType":{"title":"DocType","required":["id","name","type","group","controller","template","priority","creationDate","modificationDate","staticGeneratorEnabled","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"Default Page"},"type":{"description":"Type","type":"string","example":"page"},"group":{"description":"Group","type":["string","null"],"example":"Default"},"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\DefaultController::indexAction"},"template":{"description":"Template","type":["string","null"],"example":"@App\/Resources\/views\/default.html.twig"},"priority":{"description":"Priority","type":"integer","example":0},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null},"staticGeneratorEnabled":{"description":"Static generator enabled","type":"boolean","example":false},"writeable":{"description":"Is writeable","type":"boolean","example":false}},"type":"object"},"DocTypeType":{"title":"DocType Type","required":["name","validTable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"page"},"validTable":{"description":"Valid table","type":"string","example":"page"},"childrenSupported":{"description":"Children supported","type":"boolean","example":false},"directRoute":{"description":"Direct route","type":"boolean","example":false},"predefinedDocumentTypes":{"description":"Predefined document types","type":"boolean","example":false},"translatable":{"description":"Translatable","type":"boolean","example":false},"translatableInheritance":{"description":"Translatable Inheritance","type":"boolean","example":false},"onlyPrintableChildren":{"description":"Only printable children","type":"boolean","example":false}},"type":"object"},"DocTypeAddParameters":{"title":"DocTypeAdd","required":["name","type"],"properties":{"name":{"description":"Name","type":"string","example":"New Document Type"},"type":{"description":"Type","type":"string","example":"page"}},"type":"object"},"DocTypeUpdateParameters":{"title":"DocTypeUpdate","required":["name","type","group","controller","template","priority","staticGeneratorEnabled"],"properties":{"name":{"description":"Name","type":"string","example":"My docType"},"type":{"description":"Type","type":"string","example":"page"},"group":{"description":"Group","type":["string","null"],"example":"Default"},"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\DefaultController::indexAction"},"template":{"description":"Template","type":["string","null"],"example":"@App\/Resources\/views\/default.html.twig"},"priority":{"description":"Priority","type":"integer","example":0},"staticGeneratorEnabled":{"description":"Static generator enabled","type":"boolean","example":false}},"type":"object"},"Document":{"title":"Document","required":["fullPath","published","type","key","index","hasChildren","hasWorkflowWithPermissions","permissions","isSite","navigationExclude"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/document"},"published":{"description":"Published","type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"link"},"key":{"description":"Key","type":"string","example":"page.html"},"index":{"description":"Custom index","type":"integer","example":0},"hasChildren":{"description":"Has children","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"permissions":{"$ref":"#\/components\/schemas\/DocumentPermissions"},"isSite":{"description":"Is document a site","type":"boolean","example":false},"navigationExclude":{"description":"Exclude document from navigation","type":"boolean","example":false}},"type":"object"}]},"DocumentCloneParameters":{"title":"Document Clone Parameters","required":["language","enableInheritance","recursive","updateReferences"],"properties":{"language":{"description":"Language for the new translation","type":["string","null"],"example":"en"},"enableInheritance":{"description":"Enable Inheritance","type":"boolean","example":false},"recursive":{"description":"Recursive","type":"boolean","example":false},"updateReferences":{"description":"Update References","type":"boolean","example":false}},"type":"object"},"DocumentController":{"title":"Document Controller","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"App\\Controller\\ContentController::indexAction"}},"type":"object"},"DocumentDetail":{"title":"Document Detail Data","required":["editableData","missingRequiredEditable","settingsData","draftData","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Document"},{"properties":{"editableData":{"description":"Document Editable Data","type":"object","example":{"editable":"value"}},"missingRequiredEditable":{"description":"Is missing required editable","type":"boolean","example":false},"settingsData":{"description":"Document Settings Data","type":"object","example":{"title":"Some Title","description":"Some Description","prettyUrl":"pretty\/url","controller":"App\\Controller\\PageController","template":"@app\/template.html.twig","contentMainDocumentId":123,"contentMainDocumentPath":"\/path\/to\/main\/document","supportsContentMain":false,"missingRequiredEditable":false,"staticGeneratorEnabled":false,"staticGeneratorLifetime":123456,"staticLastGenerated":1700000000,"url":"https:\/\/example.com\/"}},"draftData":{"$ref":"#\/components\/schemas\/PageSnippetDraftData"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false}},"type":"object"}]},"DocumentPermissions":{"title":"Document Permissions","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Permissions"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true}},"type":"object"}]},"DocumentTemplate":{"title":"Document Template","required":["path"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"path":{"description":"Path","type":"string","example":"@App\/Resources\/views\/default.html.twig"}},"type":"object"},"DocumentTranslationLink":{"title":"Document Translation Link","required":["language","documentId"],"properties":{"language":{"description":"Language","type":"string","example":"en"},"documentId":{"description":"Document Id","type":"integer","example":83}},"type":"object"},"DocumentTranslationLinks":{"title":"Document Translation Links","required":["language"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"language":{"description":"Language","type":"string","example":"en"},"translationLinks":{"description":"Translation links","type":"array","items":{"$ref":"#\/components\/schemas\/DocumentTranslationLink"}}},"type":"object"},"DocumentTranslationParent":{"title":"Document Translation Parent","required":["id","fullPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Document Id","type":"integer","example":83},"fullPath":{"description":"Document full path","type":"string","example":"\/path\/to\/document"}},"type":"object"},"DocumentType":{"title":"Document Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"page"}},"type":"object"},"DocumentAddParameters":{"title":"DocumentAdd","required":["key","type","title","navigationName","docTypeId","template","translationsSourceId","language","inheritanceSourceId"],"properties":{"key":{"description":"Key","type":"string","example":"my_new_document"},"type":{"description":"Type","type":"string","example":"page"},"title":{"description":"Title","type":["string","null"],"example":"Some page title"},"navigationName":{"description":"Navigation name","type":["string","null"],"example":"Some navigation name"},"docTypeId":{"description":"Document type ID","type":["string","null"],"example":"page"},"template":{"description":"Document template","type":["string","null"],"example":"default"},"translationsSourceId":{"description":"Id of the base document for new translation","type":["integer","null"],"example":33},"language":{"description":"Document language when adding a translation","type":["string","null"],"example":"en"},"inheritanceSourceId":{"description":"Id of the base document for content","type":["integer","null"],"example":33}},"type":"object"},"DocumentVersion":{"title":"DocumentVersion","required":["modificationDate","path","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"modificationDate":{"description":"modification date","type":"integer","example":1712823182},"path":{"description":"path","type":"string","example":"\/path\/to\/object"},"published":{"description":"published","type":"boolean","example":true}},"type":"object"},"Element":{"title":"Element","required":["id","parentId","path","icon","userOwner","userModification","locked","isLocked","creationDate","modificationDate","elementType"],"properties":{"id":{"description":"ID","type":"integer","example":83},"parentId":{"description":"ID of parent","type":"integer","example":1},"path":{"description":"path","type":"string","example":"\/path\/to\/element"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"userOwner":{"description":"ID of owner","type":"integer","example":1},"userModification":{"description":"User that modified the element","type":["integer","null"],"example":1},"locked":{"description":"Locked","type":["string","null"],"example":"locked"},"isLocked":{"description":"Is locked","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":["integer","null"],"example":221846400},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":327417600},"elementType":{"description":"elementType","type":"string","example":"asset"}},"type":"object"},"LocationData":{"title":"Element Location Data","required":["widgetId","treeLevelData"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"widgetId":{"description":"Widget Id","type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"},"treeLevelData":{"description":"Tree level data","type":"array","items":{"$ref":"#\/components\/schemas\/TreeLevelData"}}},"type":"object"},"ElementPath":{"title":"Element Path","required":["elementPath"],"properties":{"elementPath":{"description":"Element Path","type":"string","example":"path\/to\/element"}},"type":"object"},"ElementTreeWidgetConfig":{"title":"Element Tree Widget","required":["contextPermissions","elementType","rootFolder","showRoot","classes","pql","pageSize","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/WidgetConfig"},{"properties":{"contextPermissions":{"description":"Context Permissions","type":"object","example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}},"elementType":{"description":"Element Type","type":"string","example":"data-object"},"rootFolder":{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Data of root folder element"},"showRoot":{"description":"Show Root","type":"boolean","example":false},"classes":{"description":"Classes","type":"object","example":["CAR"]},"pql":{"description":"PQL","type":["string","null"],"example":null},"pageSize":{"description":"Page size","type":["integer","null"],"example":20},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"ElementUsage":{"title":"Element Usage","required":["data","hasHidden"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Data","type":"array","items":{"$ref":"#\/components\/schemas\/ElementUsageItem"}},"hasHidden":{"description":"hasHidden","type":"boolean","example":"false"},"totalCount":{"description":"totalCount","type":"integer","example":"40"}},"type":"object"},"ElementUsageBaseItem":{"title":"Element Usage Base Item","required":["id","type"],"properties":{"id":{"description":"ID","type":"integer","example":83},"type":{"description":"type","type":"string","enum":["data-object","object","asset","document"],"example":"data-object"}},"type":"object"},"ElementUsageItem":{"title":"Element Usage Item","required":["id","type","path"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/ElementUsageBaseItem"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":9},"type":{"description":"type","type":"string","example":"object"},"path":{"description":"path","type":"string","example":"\/Product Data\/Cars\/jaguar\/E-Type"}},"type":"object"}]},"ElementIcon":{"title":"ElementIcon","required":["type","value"],"properties":{"type":{"description":"Icon type","type":"string","enum":["name","path"],"example":"path"},"value":{"description":"Icon value","type":"string","example":"\/path\/to\/icon"}},"type":"object"},"EmailSettingsData":{"title":"Email Settings Data","required":["subject","from","replyTo","to","cc","bcc"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SnippetSettingsData"},{"properties":{"subject":{"description":"Subject","type":"string","example":"Some subject"},"from":{"description":"From","type":"string","example":"some-sender@email"},"replyTo":{"description":"Reply to","type":"string","example":"some-reply@email"},"to":{"description":"To","type":"string","example":"some-receiver@email"},"cc":{"description":"CC","type":"string","example":"some-copy@email"},"bcc":{"description":"BCC","type":"string","example":"some-hidden-copy@email"}},"type":"object"}]},"EmailDocumentParameters":{"title":"EmailDocumentParameters","required":["key","value"],"properties":{"key":{"description":"parameter key","type":"string","example":"some_parameter_key"},"value":{"description":"parameter value","type":"mixed","example":"some_parameter_value","anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"null"}]}},"type":"object"},"EmailLogEntry":{"title":"EmailLog","required":["id","sentDate","hasHtmlLog","hasTextLog","hasError","from","to","subject"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":23},"sentDate":{"description":"sent date","type":"integer","example":1707312457},"hasHtmlLog":{"description":"HTML log exists","type":"boolean","example":true},"hasTextLog":{"description":"Text log exists","type":"boolean","example":true},"hasError":{"description":"Error occurred","type":"boolean","example":true},"from":{"description":"from","type":["string","null"],"example":"from@pimcore.com"},"to":{"description":"to","type":["string","null"],"example":"to@pimcore.com"},"subject":{"description":"subject","type":["string","null"],"example":"E-Mail subject"}},"type":"object"},"EmailLogEntryDetail":{"title":"EmailLogDetail","required":["bcc","cc","error"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/EmailLogEntry"},{"properties":{"bcc":{"description":"bcc","type":["string","null"],"example":"email@pimcore.com"},"cc":{"description":"cc","type":["string","null"],"example":"email@pimcore.com"},"error":{"description":"error","type":["string","null"],"example":"Some error occurred"}},"type":"object"}]},"ObjectParameter":{"title":"EmailLogObjectParameterData","required":["id","type","class","path"],"properties":{"id":{"description":"id","type":"integer","example":1020},"elementType":{"description":"elementType","type":"string","example":"object"},"type":{"description":"type","type":"string","example":"object"},"class":{"description":"class","type":"string","example":"AppBundle\\Model\\MyObject"},"path":{"description":"path","type":"string","example":"\/path\/to\/object"}},"type":"object"},"EmailLogEntryParameter":{"title":"EmailLogParameters","required":["name","value","objectData"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"name","type":"string","example":"myParameter"},"value":{"description":"value","type":["string","null"],"example":"Some value"},"objectData":{"oneOf":[{"$ref":"#\/components\/schemas\/ObjectParameter","description":"data for object parameters"},{"type":"null"}],"description":"data for object parameters"}},"type":"object"},"Error":{"title":"Error","description":"Bad credentials or missing token, bad request, method not allowed, etc.","required":["message"],"properties":{"message":{"description":"Message","type":"string","example":"I am an error message"}},"type":"object"},"ExportAllFilter":{"title":"Export All Filter","description":"Contains all data that is needed to get all the data for the column.","required":["columnFilters","sortFilter"],"properties":{"columnFilters":{"description":"Column Filter","type":"object","example":"[{\u0022key\u0022:\u0022name\u0022,\u0022type\u0022: \u0022metadata.object\u0022,\u0022filterValue\u0022: 1, \u0022locale\u0022:\u0022de\u0022}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\u0022key\u0022:\u0022id\u0022,\u0022direction\u0022: \u0022ASC\u0022}"}},"type":"object"},"FieldCollectionConfig":{"title":"Field Collection Configuration","required":["key","title"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"MyFieldCollection"},"title":{"description":"Title","type":"string","example":"My Field Collection"}},"type":"object"},"FieldCollectionLayoutDefinition":{"title":"Field Collection Layout Definition","required":["key","title","width","height","collapsible","collapsed","datatype","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of Field Collection","type":"string","example":"my_field_collection"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"group":{"description":"Group","type":["string","null"],"example":"Group Name"},"name":{"description":"Name","type":["string","null"],"example":"Layout"},"type":{"description":"Type","type":["string","null"],"example":"object"},"region":{"description":"Region","type":["string","null"],"example":"main"},"title":{"description":"Title","type":["string","null"],"example":"My Field Collection"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"collapsed","type":"boolean","example":false},"children":{"description":"Children","type":"object","example":[]}},"type":"object"},"FixedCustomSettings":{"title":"FixedCustomSettings","required":["embeddedMetadata","embeddedMetadataExtracted"],"properties":{"embeddedMetadata":{"description":"embedded meta data of the asset - array of any key-value pairs","type":"array","items":{"type":"object"},"example":"{ FileSize: \u0022265 KiB\u0022, MIMEType: \u0022image\/jpeg\u0022 }"},"embeddedMetadataExtracted":{"description":"flag to indicate if the embedded meta data has been extracted from the asset","type":"boolean","example":true}},"type":"object"},"FocalPoint":{"title":"FocalPoint","required":["x","y"],"properties":{"x":{"description":"x Coordinate of FocalPoint","type":"integer","example":50},"y":{"description":"y Coordinate of FocalPoint","type":"integer","example":50}},"type":"object"},"FolderData":{"title":"Folder Data","description":"Folder Data Scheme for API","required":["folderName"],"properties":{"folderName":{"description":"Folder Name","type":"string","example":"Awesome stuff inside"}},"type":"object"},"PortalEngineWizardFormat":{"title":"Format for Wizard","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the format configuration","type":"string","example":"portal_default"},"name":{"description":"Display name of the format configuration","type":"string","example":"Portal Default"}},"type":"object"},"GdprDataProvider":{"title":"GDPR Data Provider","description":"GDPR Data Extractor search source(e.g., \u0022Data Objects\u0022, \u0022Pimcore user\u0022).","required":["key","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Unique key of the provider","type":"string","example":"data_objects"},"label":{"description":"Label of the provider","type":"string","example":"Data Objects"}},"type":"object"},"GdprDataRow":{"title":"GDPR Data Row","description":"GDPR Data Row","required":["data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Data row values","type":"object"}},"type":"object"},"SearchTerms":{"title":"GDPR Search Terms","description":"Object containing the values to search for. All fields are optional.","properties":{"id":{"description":"The ID to search for.","type":["integer","null"],"example":3},"firstname":{"description":"The first name to search for.","type":["string","null"],"example":"John"},"lastname":{"description":"The last name to search for.","type":["string","null"],"example":"Doe"},"email":{"description":"The email address to search for.","type":["string","null"],"example":"john.doe@example.com"}},"type":"object"},"GlobalAction":{"title":"GlobalAction","required":["name","label","iconCls","objectLayout","notes"],"properties":{"name":{"description":"name","type":"string","example":"start_workflow"},"label":{"description":"label","type":"string","example":"Start Workflow"},"iconCls":{"description":"iconCls","type":"string","example":"pimcore_workflow_start"},"objectLayout":{"description":"objectLayout","type":"boolean","example":false},"notes":{"description":"notes","type":"array","items":{"type":"object"},"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Column":{"title":"Grid Column Request","description":"Contains all data that is needed to get all the data for the column.","required":["type"],"properties":{"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"system.id"},"group":{"description":"Group","type":["array","null"],"items":{"type":"string"},"example":["system"]},"config":{"description":"Config","type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#\/components\/schemas\/AdvancedColumnConfig"}]},"example":{"key":"value"}}},"type":"object"},"Filter":{"title":"Grid Filter","description":"Contains all data that is needed to get all the data for the column.","required":["page","pageSize","includeDescendants"],"properties":{"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":50},"includeDescendants":{"description":"Include Descendant Items","type":"boolean","example":false},"columnFilters":{"description":"Column Filter","type":"object","example":"[{\u0022key\u0022:\u0022name\u0022,\u0022type\u0022: \u0022metadata.object\u0022,\u0022filterValue\u0022: 1, \u0022locale\u0022:\u0022de\u0022}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\u0022key\u0022:\u0022id\u0022,\u0022direction\u0022: \u0022ASC\u0022, \u0022locale\u0022: \u0022en\u0022}"}},"type":"object"},"ColumnConfiguration":{"title":"GridColumnConfiguration","description":"Contains all data to configure a grid column","required":["key","group","sortable","editable","localizable","type","config"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"id"},"group":{"description":"Define the group structure","type":"object","example":["system","id"]},"sortable":{"description":"Sortable","type":"boolean","example":true},"editable":{"description":"Editable","type":"boolean","example":false},"exportable":{"description":"Exportable","type":"boolean","example":false},"filterable":{"description":"Filterable","type":"boolean","example":false},"localizable":{"description":"Localizable","type":"boolean","example":false},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"integer"},"frontendType":{"description":"Frontend Type","type":"string","example":"integer"},"config":{"description":"Config","type":"object","example":{"key":"value"}}},"type":"object"},"ColumnData":{"title":"GridColumnData","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"value":{"description":"Value","type":["mixed","null"],"example":73},"fieldType":{"description":"Field Type of the column","type":["string","null"],"example":"input"},"inheritance":{"description":"inheritance","type":["object","null"],"example":{"objectId":42,"inInherited":true}}},"type":"object"},"Configuration":{"title":"GridConfiguration","description":"Contains all data to configure a grid column","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":["string","null"],"example":"My Configuration Description"}},"type":"object"},"DetailedConfiguration":{"title":"GridDetailedConfiguration","description":"Contains all data to configure a grid column","required":["name","shareGlobal","saveFilter","setAsFavorite","sharedUsers","sharedRoles","columns","filter","pageSize"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":["string","null"],"example":"My Configuration Description"},"shareGlobal":{"description":"shareGlobal","type":"boolean","example":false},"saveFilter":{"description":"saveFilter","type":"boolean","example":false},"setAsFavorite":{"description":"setAsFavorite","type":"boolean","example":false},"sharedUsers":{"description":"sharedUsers","type":"object","example":[42,1337]},"sharedRoles":{"description":"sharedRoles","type":"object","example":[42,1337]},"columns":{"description":"columns","type":"array","items":{"anyOf":[{"$ref":"#\/components\/schemas\/ColumnSchema"},{"$ref":"#\/components\/schemas\/Column"}]}},"filter":{"description":"filter","type":"array","items":{"$ref":"#\/components\/schemas\/Filter"}},"pageSize":{"description":"Page Size","type":"integer","example":42},"modificationDate":{"description":"Modification Date","type":["integer","null"],"example":1634025600},"creationDate":{"description":"Creation Date","type":["integer","null"],"example":1634025600},"ownerId":{"description":"ID of the owner","type":["integer","null"],"example":42},"id":{"description":"ID of the configuration","type":["integer","null"],"example":42}},"type":"object"},"HardlinkSettingsData":{"title":"Hardlink settings data","required":["sourceId","propertiesFromSource","childrenFromSource"],"properties":{"sourceId":{"description":"Source ID","type":["integer","null"],"example":83},"propertiesFromSource":{"description":"Properties from source","type":"boolean","example":true},"childrenFromSource":{"description":"Children from source","type":"boolean","example":false},"sourcePath":{"description":"Source path","type":["string","null"],"example":"\/path\/to\/source"}},"type":"object"},"Image":{"title":"Image","required":["format","width","height","isVectorGraphic","isAnimated","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"format":{"description":"Format","type":"string","example":"muhFormat"},"width":{"description":"width","type":"integer","example":666},"height":{"description":"height","type":"integer","example":333},"isVectorGraphic":{"description":"is vector graphic","type":"boolean","example":false},"isAnimated":{"description":"is animated","type":"boolean","example":false},"imageThumbnailPath":{"description":"path to thumbnail","type":"string","example":"\/path\/to\/element\/hulk-smash.jpg"}},"type":"object"}]},"ImageThumbnailConfigDetail":{"title":"Image Thumbnail Config Detail","required":["settings","writeable","medias"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"settings":{"$ref":"#\/components\/schemas\/ImageThumbnailSettings","description":"Thumbnail settings"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"medias":{"description":"Media query configurations with transformation items","type":"object","example":{"default":[{"method":"cover","arguments":{"width":1920,"height":600,"positioning":"center","forceResize":true}}]}}},"type":"object"},"ImageThumbnailSettings":{"title":"Image Thumbnail Settings","required":["name","description","group","format","quality","highResolution","preserveColor","forceProcessICCProfiles","preserveMetaData","rasterizeSVG","useCropBox","downloadable","modificationDate","creationDate","filenameSuffix","preserveAnimation"],"properties":{"name":{"description":"Thumbnail name","type":"string","example":"portalCarousel"},"description":{"description":"Thumbnail description","type":["string","null"],"example":""},"group":{"description":"Thumbnail group","type":["string","null"],"example":"Areas"},"format":{"description":"Output format","type":"string","example":"SOURCE"},"quality":{"description":"Quality setting","type":"integer","example":85},"highResolution":{"description":"High resolution factor","type":["number","null"],"example":0},"preserveColor":{"description":"Preserve color profile","type":"boolean","example":false},"forceProcessICCProfiles":{"description":"Force process ICC profiles","type":"boolean","example":false},"preserveMetaData":{"description":"Preserve meta data","type":"boolean","example":false},"rasterizeSVG":{"description":"Rasterize SVG","type":"boolean","example":false},"useCropBox":{"description":"Use crop box","type":"boolean","example":false},"downloadable":{"description":"Is downloadable","type":"boolean","example":true},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1755073298},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1565355190},"filenameSuffix":{"description":"Filename suffix","type":["string","null"],"example":null},"preserveAnimation":{"description":"Preserve animation","type":"boolean","example":false}},"type":"object"},"ImageData":{"title":"ImageData","properties":{"focalPoint":{"$ref":"#\/components\/schemas\/FocalPoint","description":"focalPoint"}},"type":"object"},"IndexStat":{"title":"Index Statistic","required":["name","items","size"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"pimcore_root"},"items":{"description":"Number of items in index","type":"integer","example":100},"size":{"description":"Size","type":"number","format":"float","example":123.45}},"type":"object"},"InvalidCredentials":{"title":"Invalid Credentials","description":"Invalid credentials after login attempt","required":["error"],"properties":{"error":{"description":"Error","type":"string","example":"Invalid credentials"}},"type":"object"},"JobRun":{"title":"JobRun","required":["id","ownerId","state","executionContext","totalElements","currentMessage","jobRunChildId","currentStep","totalSteps","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"ownerId":{"description":"Owner ID","type":["integer","null"],"example":123},"state":{"description":"State","type":"string","example":"running"},"executionContext":{"description":"Execution context","type":"string","example":"studio_stop_on_error"},"totalElements":{"description":"Total elements","type":"integer","example":0},"currentMessage":{"description":"Current Message og the last Event","type":"string","example":"Message"},"jobRunChildId":{"description":"Id of the child Job run","type":["integer","null"],"example":55},"currentStep":{"description":"Current Step of a running Job","type":["integer","null"],"example":0},"totalSteps":{"description":"Number of total Steps of a running Job","type":["integer","null"],"example":0},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null}},"type":"object"},"KeyBinding":{"title":"Key Binding for a User","description":"Key Binding for a User","required":["key","action","ctrl","alt","shift"],"properties":{"key":{"description":"ASCII Code for a key on the Keyboard","type":"integer","example":"83"},"action":{"description":"The action the key binding should execute","type":"string","example":"save"},"ctrl":{"description":"If CTRL key should be pressed","type":"boolean","example":"true"},"alt":{"description":"If ALT key should be pressed","type":"boolean","example":"true"},"shift":{"description":"If SHIFT key should be pressed","type":"boolean","example":"true"}},"type":"object"},"LastChangesEntry":{"title":"Last Changes Entry Data","required":["date","dateText","assets","dataObjects","documents"],"properties":{"date":{"description":"Modification Date","type":"integer","example":327417600},"dateText":{"description":"Modification Date Text","type":"string","example":"2025-07-24T12:00:00+00:00"},"assets":{"description":"Number of assets objects changed","type":"integer","example":0},"dataObjects":{"description":"Number of data objects changed","type":"integer","example":0},"documents":{"description":"Number of documents objects changed","type":"integer","example":0}},"type":"object"},"LastChangesWidgetConfig":{"title":"Last Changes Widget Config","required":["color","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"Layout":{"title":"Layout","required":["name","dataType","fieldType","type","layout","region","title","width","height","collapsible","collapsed","bodyStyle","locked","children","icon","labelAlign","labelWidth","border"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"pimcore_root"},"dataType":{"description":"Data Type","type":"string","example":"layout"},"fieldType":{"description":"Field Type","type":"string","example":"panel"},"type":{"description":"Type","type":["string","null"],"example":null},"layout":{"description":"Layout","type":["string","null"],"example":null},"region":{"description":"Region","type":["string","null"],"example":"center"},"title":{"description":"Title","type":["string","null"],"example":"MyLayout"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"Collapsed","type":"boolean","example":false},"bodyStyle":{"description":"Body Style","type":["string","null"],"example":"(float: left;)"},"locked":{"description":"Locked","type":"boolean","example":false},"children":{"description":"Children","type":"array","items":{"type":"object"},"example":"[{id: 1}]"},"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"labelAlign":{"description":"Label Align","type":"string","example":"left"},"labelWidth":{"description":"Label Width","type":"integer","example":100},"border":{"description":"Border","type":"boolean","example":false}},"type":"object"},"LayoutOption":{"title":"Layout Option","required":["layoutId","rows","columns","items"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"layoutId":{"description":"Unique identifier for the layout","type":"string","example":"dashboard-layout-1"},"rows":{"description":"Number of rows in the layout","type":"integer","example":4},"columns":{"description":"Number of columns in the layout","type":"integer","example":3},"items":{"description":"Array of layout items","type":"array","items":{"$ref":"#\/components\/schemas\/LayoutItem"}}},"type":"object"},"LayoutItem":{"title":"Layout item","required":["id","colSpan","rowSpan","colStart","rowStart","widget"],"properties":{"id":{"description":"Unique identifier for the layout item","type":"integer","example":1},"colSpan":{"description":"Number of columns the item spans","type":"integer","example":2},"rowSpan":{"description":"Number of rows the item spans","type":"integer","example":1},"colStart":{"description":"Column index where the item starts","type":"integer","example":0},"rowStart":{"description":"Row index where the item starts","type":"integer","example":0},"widget":{"oneOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig","description":"Widget for this position"},{"type":"null"}],"description":"Widget for this position"}},"type":"object"},"LinkSettingsData":{"title":"Link Settings Data","required":["internal","internalType","direct","linkType","href","rawHref"],"properties":{"internal":{"description":"Internal ID","type":["integer","null"],"example":83},"internalType":{"description":"Internal type","type":["string","null"],"example":"asset"},"direct":{"description":"Direct","type":"string","example":"\/path\/to\/asset"},"linkType":{"description":"Link type","type":"string","example":"direct"},"href":{"description":"Href","type":"string","example":"\/path\/to\/asset"},"rawHref":{"description":"Raw Href","type":"string","example":"\/some\/raw\/href"}},"type":"object"},"Note":{"title":"Note","required":["id","type","cId","cType","cPath","date","title","description","locked","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":666},"type":{"description":"type","type":"string","example":"Type of note"},"cId":{"description":"Id of element","type":"integer","example":667},"cType":{"description":"Type of element","type":"string","example":"asset"},"cPath":{"description":"Path of element","type":"string","example":"\/path\/to\/element"},"date":{"description":"Creation date of note","type":"integer","example":1634025600},"title":{"description":"title","type":"string","example":"Title of note"},"description":{"description":"description","type":"string","example":"This is a description"},"locked":{"description":"Locked","type":"boolean","example":false},"data":{"description":"Data of note","type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"example":"Can be pretty much anything"},"userId":{"description":"User ID","type":["integer","null"],"example":1},"userName":{"description":"Username","type":["string","null"],"example":"shaquille.oatmeal"}},"type":"object"},"NoteType":{"title":"NoteType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"info"}},"type":"object"},"NoteTypeCollection":{"title":"NoteTypeCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#\/components\/schemas\/NoteType"}}},"type":"object"},"Notification":{"title":"Notification","required":["message","payload","attachmentType","attachmentId","attachmentFullPath"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/NotificationListItem"},{"properties":{"message":{"description":"message","type":["string","null"],"example":"Notification message"},"payload":{"description":"payload","type":["string","null"],"example":"{\u0022key\u0022: \u0022value\u0022}"},"attachmentType":{"description":"linked attachment type","type":["string","null"],"example":"object"},"attachmentId":{"description":"linked attachment ID","type":["integer","null"],"example":3669},"attachmentFullPath":{"description":"linked attachment fullPath","type":["string","null"],"example":"\/path\/to\/attachment.jpg"}},"type":"object"}]},"NotificationMinimal":{"title":"Notification Minimal Data","required":["id","type","title","read","creationDate","recipient","sender"],"properties":{"id":{"description":"id","type":"integer","example":23},"type":{"description":"type","type":"string","example":"info"},"title":{"description":"title","type":"string","example":"Notification title"},"read":{"description":"read","type":"boolean","example":false},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"recipient":{"description":"recipient ID","type":"integet","example":1},"sender":{"description":"sender","type":["string","null"],"example":"Pimcore Admin"}},"type":"object"},"NotificationListItem":{"title":"NotificationListItem","required":["id","type","title","read","hasAttachment","creationDate","sender"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":23},"type":{"description":"type","type":"string","example":"info"},"title":{"description":"title","type":"string","example":"Notification title"},"read":{"description":"read","type":"boolean","example":false},"hasAttachment":{"description":"has attachment","type":"boolean","example":true},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"sender":{"description":"sender","type":["string","null"],"example":"Pimcore Admin"}},"type":"object"},"NotificationsWidgetConfig":{"title":"Notifications Widget Config","required":["color","page","pageSize","dateFilterValue","dateFilterOperator","senderFilter","typeFilter","onlyUnread","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":1},"dateFilterValue":{"description":"Date Filter Value","type":["string","null"],"example":"08\/20\/2024"},"dateFilterOperator":{"description":"Date Filter Operator","type":["string","null"],"example":"on"},"senderFilter":{"description":"Sender Filter","type":["integer","null"],"example":20},"typeFilter":{"description":"Type Filter","type":["string","null"],"example":"info"},"onlyUnread":{"description":"Filter Only Unread Notifications","type":"boolean","example":false},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"ObjectBrickLayoutDefinition":{"title":"Object Brick Layout Definition","required":["key","title","width","height","collapsible","collapsed","datatype","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of Object Brick","type":"string","example":"my_object_brick"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"name":{"description":"Name","type":["string","null"],"example":"Layout"},"type":{"description":"Type","type":["string","null"],"example":"object"},"region":{"description":"Region","type":["string","null"],"example":"main"},"title":{"description":"Title","type":["string","null"],"example":"My Object Brick"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"collapsed","type":"boolean","example":false},"children":{"description":"Children","type":"object","example":[]}},"type":"object"},"PageSettingsData":{"title":"Page Settings Data","required":["title","description","prettyUrl"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SnippetSettingsData"},{"properties":{"title":{"description":"Title","type":["string","null"],"example":"Link Title"},"description":{"description":"Description","type":["string","null"],"example":"Link Description"},"prettyUrl":{"description":"Pretty Url","type":["string","null"],"example":"pretty\/url"}},"type":"object"}]},"SnippetSettingsData":{"title":"Page Settings Data","required":["controller","template","contentMainDocumentId","contentMainDocumentPath","supportsContentMain","staticGeneratorEnabled","staticGeneratorLifetime","staticLastGenerated","url"],"properties":{"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\PageController"},"template":{"description":"Template","type":["string","null"],"example":"@app\/template.html.twig"},"contentMainDocumentId":{"description":"Main document ID","type":["integer","null"],"example":1},"contentMainDocumentPath":{"description":"Main document path","type":["string","null"],"example":"\/path\/to\/main\/document"},"supportsContentMain":{"description":"Supports main content","type":"boolean","example":false},"staticGeneratorEnabled":{"description":"Is static generator enabled","type":"boolean","example":false},"staticGeneratorLifetime":{"description":"Lifetime of static generator","type":["integer","null"],"example":123456},"staticLastGenerated":{"description":"Timestamp of last generated data","type":["integer","null"],"example":1700000000},"url":{"description":"Document Url","type":["string","null"],"example":"https:\/\/example.com\/"}},"type":"object"},"PageSnippet":{"title":"PageSnippet","required":["title","description"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Document"},{"properties":{"title":{"description":"Title of the Page Snippet","type":["string","null"],"example":"Title"},"description":{"description":"Description of the Page Snippet","type":["string","null"],"example":"Description"}},"type":"object"}]},"PageSnippetDraftData":{"title":"PageSnippetDraftData","required":["id","modificationDate","isAutoSave"],"properties":{"id":{"description":"ID","type":"integer","example":83},"modificationDate":{"description":"Modification date","type":"integer","example":1634025600},"isAutoSave":{"description":"Is auto save","type":"boolean","example":false}},"type":"object"},"PatchCustomMetadata":{"title":"PatchCustomMetadata","required":["name","language","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["string","null"],"example":"data"}},"type":"object"},"PatchError":{"title":"PatchError","description":"Response for PATCH requests with errors","properties":{"id":{"description":"ID","type":"integer","example":83},"message":{"description":"Message","type":"string","example":"I am an error message"}},"type":"object"},"Permissions":{"title":"Permissions","required":["list","view","publish","delete","rename","create","settings","versions","properties"],"properties":{"list":{"description":"List","type":"boolean","example":true},"view":{"description":"View","type":"boolean","example":true},"publish":{"description":"Publish","type":"boolean","example":true},"delete":{"description":"Delete","type":"boolean","example":true},"rename":{"description":"Rename","type":"boolean","example":true},"create":{"description":"Create","type":"boolean","example":true},"settings":{"description":"Settings","type":"boolean","example":true},"versions":{"description":"Versions","type":"boolean","example":true},"properties":{"description":"Properties","type":"boolean","example":true}},"type":"object"},"PerspectiveConfig":{"title":"Perspective Config","required":["id","name","icon","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Perspective ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"},"PerspectiveConfigDetail":{"title":"Perspective Config Detail","required":["contextPermissions","widgetsLeft","widgetsRight","widgetsBottom","expandedLeft","expandedRight"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/PerspectiveConfig"},{"properties":{"contextPermissions":{"description":"Context Permissions","type":"object","example":{"permission_group":{"permission1":true,"permission2":false}}},"widgetsLeft":{"description":"Widgets Left","type":"array","items":{"$ref":"#\/components\/schemas\/ElementTreeWidgetConfig"}},"widgetsRight":{"description":"Widgets Right","type":"array","items":{"$ref":"#\/components\/schemas\/ElementTreeWidgetConfig"}},"widgetsBottom":{"description":"Widgets Bottom","type":"array","items":{"$ref":"#\/components\/schemas\/ElementTreeWidgetConfig"}},"expandedLeft":{"description":"Left Expanded Widget","type":["string","null"],"example":"widget_id"},"expandedRight":{"description":"Right Expanded Widget","type":["string","null"],"example":"widget_id"}},"type":"object"}]},"PortalEngineWizardThumbnail":{"title":"Portal Engin Wizard Thumbnail","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the thumbnail configuration","type":"string","example":"portal_thumbnail"},"name":{"description":"Display name of the thumbnail configuration","type":"string","example":"Portal Thumbnail"}},"type":"object"},"PortalEngineAdminUserAssignment":{"title":"Portal Engine Admin User Assignment","required":["canSeeMenu","canAddNewCollection"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"canSeeMenu":{"description":"Determines whether the collections menu is visible for the user","type":"boolean","example":true},"canAddNewCollection":{"description":"Determines whether the user may create new collections","type":"boolean","example":true}},"type":"object"},"PortalEngineCollection":{"title":"Portal Engine Collection","required":["id","name","userEmail","itemCount","creationDate","currentSiteId","editable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier of the collection.","type":"integer","example":42},"name":{"description":"Human readable name of the collection.","type":"string","example":"My Favorites"},"userEmail":{"description":"Email address of the collection owner.","type":"string","example":"user@example.com"},"itemCount":{"description":"Number of items contained in the collection.","type":"integer","example":12},"creationDate":{"description":"Unix timestamp representing the creation time of the collection.","type":"integer","example":1704067200},"currentSiteId":{"description":"Name of the portal site the collection belongs to.","type":"string","example":"Dealer Portal"},"editable":{"description":"Indicates whether the collection can be edited by the current user.","type":"boolean","example":true}},"type":"object"},"PortalEngineCollectionShareListItem":{"title":"Portal Engine Collection Share List Item","required":["id","userName","permission"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User Id with whom the collection is shared","type":"integer","example":101},"userName":{"description":"User Name with whom the collection is shared","type":"string","example":"admin"},"permission":{"description":"Permission assigned to the share (read|edit)","type":"string","example":"read"}},"type":"object"},"PortalEngineCollectionUserGroup":{"title":"Portal Engine Collection User Group","required":["id","name","isGroup"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the user group","type":"integer","example":42},"name":{"description":"Display name of the user group","type":"string","example":"Dealer Managers"},"isGroup":{"description":"Flag indicating the entry represents a group","type":"boolean","example":true}},"type":"object"},"PortalEngineTreeFolder":{"title":"Portal Engine Tree Folder","required":["id","className","key","path","icon","elementType","allowDrag","allowDrop"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Data Pool ID","type":"string","example":1},"key":{"description":"Key","type":"string","example":"City Car"},"path":{"description":"Path","type":"string","example":"\/City Car\/"},"className":{"description":"Class Name","type":"string","example":"Car"},"elementType":{"description":"Type of the elements in the Folder","type":"string","example":"asset"},"type":{"description":"Type of the Folder","type":"string","example":"folder"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false}},"type":"object"},"PortalEngineTreeInformation":{"title":"Portal Engine Tree Information","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name of the tree","type":"string","example":"Collections"}},"type":"object"},"PortalEngineWizardAssetPool":{"title":"Portal Engine Wizard Asset Pool","required":["dataPoolName"],"properties":{"dataPoolName":{"description":"Unique identifier for the wizard asset pool.","type":"string","example":"Images"},"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"enableFolderNavigation":{"description":"Whether folder navigation is enabled for this pool.","type":"boolean","example":false},"enableTagNavigation":{"description":"Whether tag-based navigation is enabled for this pool.","type":"boolean","example":false},"availableDownloadThumbnails":{"description":"Configured download thumbnails for this pool.","type":"array","items":{"type":"string"},"example":["custom"]},"directDownloadShortcuts":{"description":"Available direct download shortcuts.","type":"array","items":{"type":"string"},"example":["cart"]},"availableDownloadFormats":{"description":"Download formats that can be used for exporting assets.","type":"array","items":{"type":"string"},"example":["Pimcore\\Bundle\\PortalEngineBundle\\Service\\DataPool\\DownloadFormat\\ZipDownloadFormat"]},"visibleLanguages":{"description":"Languages visible in the asset pool.","type":"array","items":{"type":"string"},"example":["de","en"]},"editableLanguages":{"description":"Languages that can be edited within the asset pool.","type":"array","items":{"type":"string"},"example":["de","en"]}},"type":"object"},"PortalEngineWizardCustomLayout":{"title":"Portal Engine Wizard Custom Layout","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the custom layout","type":"string","example":"CP"},"name":{"description":"Display name of the custom layout","type":"string","example":"Product Detail (ID: CP)"}},"type":"object"},"PortalEngineIcon":{"title":"Portal Engine Wizard Icon","required":["name","file"],"properties":{"name":{"description":"Name","type":"string","example":"crow"},"file":{"description":"File","type":"string","example":"\u003Csvg\u003E...\u003C\/svg\u003E"}},"type":"object"},"PortalEngineWizardObjectPool":{"title":"Portal Engine Wizard Object Pool","required":["dataPoolName","classDefinition","detailPageLayout"],"properties":{"dataPoolName":{"description":"Unique identifier for the wizard object pool.","type":"string","example":"Products"},"classDefinition":{"description":"Class definition key backing the object pool.","type":"string","example":"Product"},"detailPageLayout":{"description":"Custom layout identifier used for the detail page.","type":"string","example":"ProductDetailLayout"},"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"enableFolderNavigation":{"description":"Whether folder navigation is enabled for this pool.","type":"boolean","example":false},"enableTagNavigation":{"description":"Whether tag-based navigation is enabled for this pool.","type":"boolean","example":false},"availableDownloadThumbnails":{"description":"Configured download thumbnails for this pool.","type":"array","items":{"type":"string"},"example":["custom"]},"availableDownloadFormats":{"description":"Download formats that can be used for exporting data objects.","type":"array","items":{"type":"string"},"example":["Pimcore\\Bundle\\PortalEngineBundle\\Service\\DataPool\\DownloadFormat\\JsonDownloadFormat"]},"visibleLanguages":{"description":"Languages visible in the object pool.","type":"array","items":{"type":"string"},"example":["de","en"]}},"type":"object"},"PortalEngineWizardStartResponse":{"title":"Portal Engine Wizard Start Response","required":["tmpStoreKey"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"tmpStoreKey":{"description":"Temporary storage key generated for the running wizard.","type":"string","example":"portal-engine_wizard_650a9242c8b1d"}},"type":"object"},"PortalEngineWizardStatusResponse":{"title":"Portal Engine Wizard Status Response","required":["isWizardFinished","isWizardSuccess"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isWizardFinished":{"description":"Whether the wizard has finished processing.","type":"boolean","example":true},"isWizardSuccess":{"description":"Whether the wizard run finished successfully.","type":"boolean","example":true},"portalDocumentId":{"description":"ID of the created portal document when available.","type":["integer","null"],"example":1234},"statusMessage":{"description":"Latest status message returned by the wizard run.","type":["string","null"],"example":"Portal created"}},"type":"object"},"PortalEngineCollectionPortal":{"title":"Portal entry for collection selection","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the portal site","type":"integer","example":123},"name":{"description":"Display name of the portal","type":"string","example":"Dealer Portal"}},"type":"object"},"PredefinedMetadata":{"title":"PredefinedMetadata","required":["id","name","type","creationDate","modificationDate","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"custom_metadata"},"description":{"description":"Description","type":["string","null"],"example":"A predefined metadata"},"type":{"description":"Type","type":"string","example":"input"},"targetSubType":{"description":"Target sub type","type":["string","null"],"example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"},"config":{"description":"Config","type":["string","null"],"example":"config"},"language":{"description":"Language","type":["string","null"],"example":"en"},"group":{"description":"Group","type":["string","null"],"example":"group"},"creationDate":{"description":"Creation Date","type":"integer","example":1634025600},"modificationDate":{"description":"Modfication Date","type":"integer","example":1634025600},"isWriteable":{"description":"Writable","type":"boolean","example":false}},"type":"object"},"PredefinedProperty":{"title":"PredefinedProperty","required":["id","name","key","type","ctype","inheritable","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"alpha-numerical-value"},"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":["string","null"],"example":"Detailed description of the property"},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":["string","null"],"example":"test"},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"ctype":{"description":"ctype","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":"integer","example":221846400},"modificationDate":{"description":"Modification date","type":"integer","example":327417600}},"type":"object"},"QuantityValueUnit":{"title":"QuantityValueUnit","required":["id","abbreviation","group","longName","baseUnit","reference","factor","conversionOffset","converter"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":["string","null"],"example":"mm"},"abbreviation":{"description":"Abbreviation","type":["string","null"],"example":"mm"},"group":{"description":"Group","type":["string","null"],"example":null},"longName":{"description":"Long Name","type":["string","null"],"example":"Millimeter"},"baseUnit":{"description":"Base Unit","type":["string","null"],"example":"m"},"reference":{"description":"Reference","type":["string","null"],"example":null},"factor":{"description":"Factor","type":["number","null"],"format":"float","example":null},"conversionOffset":{"description":"Conversion Offset","type":["number","null"],"format":"float","example":null},"converter":{"description":"Converter","type":["string","null"],"example":null}},"type":"object"},"QueueItemCount":{"title":"Queue Item Count","required":["count"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"count":{"description":"Items in queue","type":"integer","example":42}},"type":"object"},"RecentlyModifiedElement":{"title":"Recently Modified Element Data","required":["id","type","subtype","fullPath","modificationDate","isPublished"],"properties":{"id":{"description":"Element ID","type":"integer","example":123},"type":{"description":"Type of the element","type":"string","example":"asset"},"subtype":{"description":"Subtype of the element","type":"string","example":"Image"},"fullPath":{"description":"Full path of the element","type":"string","example":"\/path\/to\/element"},"modificationDate":{"description":"Modification Date","type":"integer","example":327417600},"isPublished":{"description":"Is the element published","type":["boolean","null"],"example":true}},"type":"object"},"RecentlyModifiedWidgetConfig":{"title":"Recently Modified Elements Widget Config","required":["color","elementType","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"elementType":{"description":"Element Type","type":"string","example":"asset"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"Recipient":{"title":"Recipient","required":["id","recipientName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the Recipient","type":"integer","example":1},"recipientName":{"description":"User name or Group Name of the Recipient","type":"string","example":"Max Mustermann"}},"type":"object"},"RecycleBin":{"title":"Recycle Bin","required":["id","amount","date","deletedBy","path","subtype","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"amount":{"description":"Amount","type":"integer","example":1},"date":{"description":"Date","type":"integer","example":1617267600},"deletedBy":{"description":"Deleted By","type":"string","example":"admin"},"path":{"description":"Path","type":"string","example":"\/path\/to\/element"},"subtype":{"description":"Subtype","type":"string","example":"folder"},"type":{"description":"Type","type":"string","example":"asset"}},"type":"object"},"RelatedElementData":{"title":"RelatedElementData","required":["id","type","subtype","fullPath","isPublished"],"properties":{"id":{"description":"ID","type":"integer","example":83},"type":{"description":"Type of the element","type":"string","example":"object"},"subtype":{"description":"Subtype of the element","type":"string","example":"Product"},"fullPath":{"description":"Full path of the element","type":"string","example":"\/path\/to\/element"},"isPublished":{"description":"Is the element published","type":["boolean","null"],"example":true}},"type":"object"},"RelationFieldConfig":{"title":"Relation Field Config","required":["relation","field"],"properties":{"relation":{"description":"Relation Getter","type":"string","example":"manufacturer"},"field":{"description":"Field getter","type":"string","example":"name"}},"type":"object"},"ResetPassword":{"title":"ResetPassword","description":"Reset password parameters","required":["username","resetPasswordUrl"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"},"resetPasswordUrl":{"description":"Reset password URL","type":"string","example":"https:\/\/example.com\/reset-password"}},"type":"object"},"Progress":{"title":"SSEHandlerProgress","required":["progress","currentStep","totalSteps","jobStepName","jobName","jobRunId","user"],"properties":{"progress":{"description":"progress","type":"integer","example":69},"currentStep":{"description":"currentStep","type":"integer","example":1},"totalSteps":{"description":"totalSteps","type":"integer","example":3},"jobStepName":{"description":"jobStepName","type":"string","example":"Job Step Name"},"jobName":{"description":"jobName","type":"string","example":"Job Name"},"jobRunId":{"description":"jobRunId","type":"integer","example":73},"user":{"description":"user","type":"integer","example":2}},"type":"object"},"Finished":{"title":"SSEJobRunFinished","required":["jobRunId","jobRunName","ownerId","status","messages","notifyAll"],"properties":{"jobRunId":{"description":"jobRunId","type":"integer","example":73},"jobRunName":{"description":"jobRunName","type":"string","example":"my-job-name"},"ownerId":{"description":"ownerId","type":"integer","example":13},"status":{"description":"status","type":"string","example":"finished"},"messages":{"description":"messages","type":"array","items":{"type":"string"},"example":["Something went wrong"]},"notifyAll":{"description":"notifyAll","type":"boolean","example":false}},"type":"object"},"Schedule":{"title":"Schedule","required":["id","ctype","date","active","userId","username"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":666},"ctype":{"description":"ctype","type":"string","example":"Type of element"},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":["string","null"],"enum":["publish","delete"],"example":"publish"},"version":{"description":"Version ID","type":["integer","null"],"example":987},"active":{"description":"Active","type":"boolean","example":true},"userId":{"description":"User ID","type":"integer","example":999},"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"}},"type":"object"},"CreateClassDefinition":{"title":"Schema used to create class definitions","required":["name","uid"],"properties":{"name":{"description":"Name","type":"string","example":"My Class Definition"},"uid":{"description":"Class definition unique ID","type":"string","example":"my_class_definition_uid"}},"type":"object"},"CustomLayoutNew":{"title":"Schema used to create custom layouts","required":["name","classId"],"properties":{"name":{"description":"Name","type":"string","example":"My Custom Layout"},"classId":{"description":"Data object class id","type":"integer","example":"CAR"}},"type":"object"},"ClassDefinitionUpdate":{"title":"Schema used to update class definition configuration","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object","example":{"children":[{"name":"Layout","datatype":"layout","fieldtype":"panel","type":null,"region":null,"title":"","width":"","height":"","collapsible":false,"collapsed":false,"bodyStyle":"","locked":false,"layout":null,"border":false,"icon":"","labelWidth":100,"labelAlign":"left","invalidFieldError":null,"children":[]}]}},"values":{"description":"Values for class definition object itself","type":"object","example":{"id":"some_class_id","name":"MyClass","title":"My class title","description":"Description of my class","modificationDate":1765874636,"userOwner":1,"userModification":1,"parentClass":"","implementsInterfaces":"","listingParentClass":"","useTraits":"","listingUseTraits":"","encryption":false,"encryptedTables":[],"allowInherit":true,"allowVariants":false,"showVariants":false,"icon":"","group":"","showAppLoggerTab":false,"linkGeneratorReference":"","previewGeneratorReference":"","compositeIndices":[],"showFieldLookup":false,"propertyVisibility":{"grid":{"id":true,"key":false,"path":true,"published":true,"modificationDate":true,"creationDate":true},"search":{"id":true,"key":false,"path":true,"published":true,"modificationDate":true,"creationDate":true}},"enableGridLocking":false,"propertyVisibility.grid.id":true,"propertyVisibility.search.id":true,"propertyVisibility.grid.key":false,"propertyVisibility.search.key":false,"propertyVisibility.grid.path":true,"propertyVisibility.search.path":true,"propertyVisibility.grid.published":true,"propertyVisibility.search.published":true,"propertyVisibility.grid.modificationDate":true,"propertyVisibility.search.modificationDate":true,"propertyVisibility.grid.creationDate":true,"propertyVisibility.search.creationDate":true}}},"type":"object"},"CustomLayoutUpdate":{"title":"Schema used to update custom layouts","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object"},"values":{"description":"Values for custom layout object itself","type":"object"}},"type":"object"},"FormatedPath":{"title":"Select Option","required":["objectReference","formatedPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"objectReference":{"description":"Object Reference","type":"string","example":"object_11"},"formatedPath":{"description":"Formated Path","type":"string","example":"nice\/path"}},"type":"object"},"SelectOption":{"title":"Select Option","required":["key","value"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"key"},"value":{"description":"Value","type":"string","example":"value"}},"type":"object"},"SelectOptionTreeFolder":{"title":"Select Option Tree Folder","required":["id","name","icon","group","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of select option","type":"string","example":"EventStatus"},"name":{"description":"Text of select option","type":"string","example":"EventStatus"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#\/components\/schemas\/SelectOptionTree"}}},"type":"object"},"SelectOptionTree":{"title":"Select Option Tree Item","required":["id","name","icon","group","adminOnly"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of select option","type":"string","example":"EventStatus"},"name":{"description":"Text of select option","type":"string","example":"EventStatus"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"},"adminOnly":{"description":"Only for admin user","type":"boolean","example":false}},"type":"object"},"SendEmailParameters":{"title":"SendEmailParameters","required":["from","to","subject","contentType"],"properties":{"from":{"description":"from email address(es)","type":"string","example":"from@sender.com"},"to":{"description":"to email address(es)","type":"string","example":"to@receiver.com"},"subject":{"description":"email subject","type":"string","example":"My email subject"},"contentType":{"description":"email content type","type":"string","enum":["document","html","text"],"example":"text"},"content":{"description":"email content","type":["string","null"],"example":"My email message"},"documentPath":{"description":"path to the email document","type":["string","null"],"example":"\/path\/to\/document"},"documentParameters":{"description":"email document parameters","type":"array","items":{"$ref":"#\/components\/schemas\/EmailDocumentParameters"}},"attachmentId":{"description":"id of the asset attachment","type":["integer","null"],"example":83}},"type":"object"},"SendNotificationParameters":{"title":"SendEmailParameters","required":["recipientId","title","message"],"properties":{"recipientId":{"description":"recipient ID","type":"integer","example":"33"},"title":{"description":"title","type":"string","example":"New notification"},"message":{"description":"message","type":"string","example":"My notification message"},"attachmentType":{"description":"type of the attachment","type":["string","null"],"enum":["asset","document","object"],"example":null},"attachmentId":{"description":"ID of the attachment","type":["integer","null"],"example":83}},"type":"object"},"SettingsConfigurationData":{"title":"Settings Configuration Data","required":["id","name","icon"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"my-config"},"name":{"description":"Configuration name","type":"string","example":"My Configuration"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Configuration icon"}},"type":"object"},"SimpleDashboard":{"title":"Simple Dashboard","required":["id","name","owner"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier for the dashboard","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name of the dashboard","type":"string","example":"My Dashboard"},"owner":{"description":"ID of the owner of the dashboard","type":"integer","example":1},"menuShortcutGroup":{"description":"Name of the group in the Menu","type":["string","null"],"example":"My Dashboard"}},"type":"object"},"SimpleFieldConfig":{"title":"Simple Field Config","required":["field"],"properties":{"field":{"description":"Field getter","type":"string","example":"name"}},"type":"object"},"PhpCodeTransformer":{"title":"Simple PHP Code Transformer","description":"A PHP code transformer service with basic information","required":["key","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Unique key of the transformer","type":"string","example":"t_key"},"label":{"description":"Label of the transformer","type":"string","example":"Transformer"}},"type":"object"},"SimpleUser":{"title":"Simple User","description":"A user with the most imported information.","required":["id","username"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"username":{"description":"Name of the User","type":"string","example":"userName"}},"type":"object"},"SimpleRole":{"title":"Simple User Role","description":"A user role which is a combination of permissions and settings.","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the Role","type":"integer","example":"1"},"name":{"description":"Name of the Role","type":"string","example":"role"}},"type":"object"},"AssetSearchPreview":{"title":"SimpleSearchAssetDetail","required":["mimeType","thumbnail"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SimpleSearchPreview"},{"properties":{"mimeType":{"description":"Mimetype","type":["string","null"],"example":"image\/jpeg"},"thumbnail":{"description":"Thumbnail path","type":["string","null"],"example":"path\/to\/thumbnail"}},"type":"object"}]},"DataObjectSearchPreview":{"title":"SimpleSearchDataObjectDetail","required":["class","objectData"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SimpleSearchPreview"},{"properties":{"class":{"description":"Class name and Id","type":["string","null"],"example":"Car [CAR]"},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}}},"type":"object"}]},"SimpleSearchPreview":{"title":"SimpleSearchDetail","required":["id","elementType","type","userOwner","userOwnerName","userModification","userModificationName","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":"74"},"elementType":{"description":"elementType","type":"string","example":"asset"},"type":{"description":"Type","type":"string","example":"image"},"userOwner":{"description":"Id of owner","type":["integer","null"],"example":1},"userOwnerName":{"description":"Name of owner","type":["string","null"],"example":"admin"},"userModification":{"description":"Id of the user that modified the element","type":["integer","null"],"example":1},"userModificationName":{"description":"Name of the user that modified the element","type":["integer","null"],"example":"admin"},"creationDate":{"description":"Creation date","type":["integer","null"],"example":221846400},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":327417600}},"type":"object"},"DocumentSearchPreview":{"title":"SimpleSearchDocumentDetail","required":["language","documentData"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SimpleSearchPreview"},{"properties":{"language":{"description":"Document Language","type":["string","null"],"example":"English"},"documentData":{"oneOf":[{"$ref":"#\/components\/schemas\/PageSearchPreview","description":"Page document data"},{"type":"null"}],"description":"Page document data"}},"type":"object"}]},"PageSearchPreview":{"title":"SimpleSearchPageDetail","required":["title","description","name","hasPreviewImage"],"properties":{"title":{"description":"Title","type":["string","null"],"example":"Page"},"description":{"description":"Description","type":["string","null"],"example":"This is some page"},"name":{"description":"Navigation name","type":["string","null"],"example":"Awesome Page"},"hasPreviewImage":{"description":"Has Preview image","type":"boolean","example":false}},"type":"object"},"SimpleSearchResult":{"title":"SimpleSearchResult","required":["id","elementType","type","path","icon"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes","description":"Custom attributes for the tree"},"id":{"description":"id","type":"integer","example":"74"},"elementType":{"description":"elementType","type":"string","example":"asset"},"type":{"description":"type","type":"string","example":"image"},"path":{"description":"path","type":"string","example":"\/path\/to\/asset"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"icon"}},"type":"object"},"Site":{"title":"Site","required":["id","domains","domain","rootId","rootPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":0},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"domain":{"description":"Domain","type":"string","example":"main_site"},"rootId":{"description":"ID of the root","type":["integer","null"],"example":1},"rootPath":{"description":"Root path","type":["string","null"],"example":"\/"}},"type":"object"},"SiteDetailData":{"title":"Site Detail Data","required":["id","creationDate","modificationDate","mainDomain","domains","errorDocument","localizedErrorDocuments","redirectToMainDomain"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":0},"creationDate":{"description":"Creation Date","type":["integer","null"],"example":1712345678},"modificationDate":{"description":"Modification Date","type":["integer","null"],"example":1712345678},"mainDomain":{"description":"Main domain","type":"string","example":"main_site"},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"errorDocument":{"oneOf":[{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Data of error document"},{"type":"null"}],"description":"Data of error document","type":"object"},"localizedErrorDocuments":{"description":"Localized error documents mapped by locale","type":"object","example":{"en":{"id":123,"type":"document","subtype":"page","fullPath":"en\/error-page","isPublished":true}},"additionalProperties":{"$ref":"#\/components\/schemas\/RelatedElementData","description":"Error document data for locale"}},"redirectToMainDomain":{"description":"Redirect to main domain","type":"boolean","example":false}},"type":"object"},"StaticTextConfig":{"title":"Static Text Config","required":["text"],"properties":{"text":{"description":"Static Text","type":"string","example":"My Text"}},"type":"object"},"SubmitAction":{"title":"SubmitAction","description":"Schema for submission of workflow action","required":["actionType","elementId","elementType","workflowId","transitionId","workflowOptions"],"properties":{"actionType":{"description":"type of the action","type":"string","example":"transition"},"elementId":{"description":"Id of the element","type":"integer","example":50},"elementType":{"description":"Type of the element","type":"string","example":"data-object"},"workflowId":{"description":"Id of the workflow","type":"string","example":"my_first_workflow"},"transitionId":{"description":"Id of the transition","type":"string","example":"start_workflow"},"workflowOptions":{"description":"workflowOptions","type":["object","null"],"example":"{\u0022notes\u0022: \u0022Some note I want to write\u0022}"}},"type":"object"},"Subtype":{"title":"Subtype","required":["elementId","elementType","elementSubtype"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"elementId":{"description":"Element Id","type":"integer","example":14},"elementType":{"description":"Element Type","type":"string","example":"asset"},"elementSubtype":{"description":"Element Subtype","type":"string","example":"image"}},"type":"object"},"Tag":{"title":"Tag","required":["id","parentId","text","path","hasChildren","iconName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"tag ID","type":"integer","example":2},"parentId":{"description":"parent tag ID","type":"integer","example":0},"text":{"description":"tag text","type":"string","example":"Tag 1"},"path":{"description":"path","type":"string","example":"\/test"},"hasChildren":{"description":"has children","type":"boolean","example":false},"iconName":{"description":"IconName","type":"string","example":"pimcore_icon_pdf"},"children":{"description":"children","type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}},"type":"object"},"Text":{"title":"Text","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"TextLayoutPreview":{"title":"Text Layout Preview Data","required":["className","path","renderingData","renderingClass","html"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"className":{"description":"Name of class definition","type":"string","example":"Car"},"path":{"description":"Path of the data object for preview","type":["string","null"],"example":"\/cars\/my-car"},"renderingData":{"description":"Data for preview","type":["string","null"],"example":"{\u0022field1\u0022:\u0022value1\u0022,\u0022field2\u0022:\u0022value2\u0022}"},"renderingClass":{"description":"Rendering class for preview","type":["string","null"],"example":"App\\DataObject\\Car"},"html":{"description":"HTML preview of the layout","type":["string","null"],"example":"\u003Cdiv\u003E...\u003C\/div\u003E"}},"type":"object"},"Thumbnail":{"title":"Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"pimcore_system_treepreview"},"text":{"description":"text","type":"string","example":"original"}},"type":"object"},"ThumbnailConfigurationData":{"title":"Thumbnail Configuration Data","required":["writeable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SettingsConfigurationData"},{"properties":{"writeable":{"description":"Is configuration writeable","type":"boolean","example":true}},"type":"object"}]},"ThumbnailConfigurationFolderData":{"title":"Thumbnail Configuration Folder Data","required":["children"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/SettingsConfigurationData"},{"properties":{"children":{"description":"Child nodes","type":"array","items":{"$ref":"#\/components\/schemas\/ThumbnailConfigurationData"}}},"type":"object"}]},"ThumbnailCollection":{"title":"ThumbnailCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Thumbnail"}}},"type":"object"},"TokenLink":{"title":"TokenLink","description":"Token link parameters","required":["tokenLoginUrl"],"properties":{"tokenLoginUrl":{"description":"Token login URL","type":"string","example":"https:\/\/example.com\/login"}},"type":"object"},"Transformer":{"title":"Transformer","required":["key"],"properties":{"key":{"description":"Key of the Transformer","type":"string","example":"uppercase"},"config":{"description":"Configuration for the transformer","type":"object"}},"type":"object"},"Translation":{"title":"Translation","description":"Translation Scheme for API","required":["locale","keys"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"keys":{"description":"Keys for Translation - Fallback will be  applied to all Keys automatically","type":"array","items":{"type":"string","example":"not_your_typical_key"}},"useFallback":{"description":"Apply Fallback Language. Used only if no keys are defined","type":"boolean","example":true}},"type":"object"},"CreateTranslation":{"title":"Translation Create","description":"Translation Create Scheme for API","required":["translationData"],"properties":{"errorOnDuplicate":{"description":"Throw an error on duplicate key","type":"boolean","example":false},"translationData":{"description":"Translation Data","type":"array","items":{"$ref":"#\/components\/schemas\/CreateTranslationData"}}},"type":"object"},"TranslationData":{"title":"Translation Data","description":"Translation Data Scheme for API","required":["locale","translation"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"translation":{"description":"Translation","type":"string","example":"some_translated_string"}},"type":"object"},"CreateTranslationData":{"title":"Translation Data for create","description":"Translation Data Scheme for create endpoint of the API","required":["key","type"],"properties":{"key":{"description":"Key","type":"string","example":"my_translation_key"},"type":{"description":"Type","type":"string","example":"simple"},"domain":{"description":"Domain","type":"string","example":"studio"}},"type":"object"},"UpdateTranslation":{"title":"Translation Update","description":"Translation Update Scheme for API","required":["key","type","translationData"],"properties":{"key":{"description":"Key of the translation","type":"string","example":"car"},"type":{"description":"Type of the translation","type":["string","null"],"example":"simple"},"translationData":{"description":"Translation Data","type":"array","items":{"$ref":"#\/components\/schemas\/TranslationData"}}},"type":"object"},"TranslationDeltaValues":{"title":"Translation delta values","description":"Translation delta values","required":["locale","currentTranslation","importTranslation"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"currentTranslation":{"description":"Current translation","type":"string","example":"some translation"},"importTranslation":{"description":"Imported translation","type":"string","example":"some translation updated"}},"type":"object"},"Translations":{"title":"Translations","description":"Translations including all languages and keys","required":["key","translations","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the translation","type":"string","example":"car"},"translations":{"description":"List of translations for the given key","type":"array","items":{"type":"object","example":{"en":"Car","de":"Auto","fr":"Voiture"}}},"type":{"description":"Type simple or custom","type":"string","example":"simple"}},"type":"object"},"TreeLevelData":{"title":"Tree Level Data","required":["level","elementId","pageNumber"],"properties":{"parentId":{"description":"Parent ID","type":"integer","example":1},"elementId":{"description":"Element ID","type":"integer","example":66},"pageNumber":{"description":"Page Number","type":"integer","example":1}},"type":"object"},"TreeNode":{"title":"Tree Node","description":"One node in the a tree","required":["id","name","type","hasChildren"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique Identifier","type":"integer","example":"1"},"name":{"description":"Name of the tree node","type":"string","example":"admin"},"type":{"description":"Is ether folder or a specific item in the folder","type":"string","example":"user"},"hasChildren":{"description":"If a folder has sub items","type":"boolean","example":true}},"type":"object"},"TwoFactorAuth":{"title":"Two Factor Authentication Data","description":"Two Factor Authentication Data for a User","required":["required","enabled","type","active"],"properties":{"required":{"description":"Required","type":"boolean","example":true},"enabled":{"description":"Enabled","type":"boolean","example":true},"type":{"description":"Type","type":"string","example":"totp"},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"ConvertParameters":{"title":"Unit Convert Parameters","required":["fromUnitId","toUnitId","value"],"properties":{"fromUnitId":{"description":"From Unit Id","type":"string","example":"m"},"toUnitId":{"description":"To Unit Id","type":"string","example":"mm"},"value":{"description":"Value","example":5,"anyOf":[{"type":"float"},{"type":"integer"}]}},"type":"object"},"Unknown":{"title":"Unknown","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"UnreadCount":{"title":"Unread Count","required":["unreadNotificationsCount"],"properties":{"unreadNotificationsCount":{"description":"Count of unread notifications","type":"integer","example":1}},"type":"object"},"UpdateAdminSettings":{"title":"Update Admin Settings","required":["branding","assets"],"properties":{"branding":{"$ref":"#\/components\/schemas\/Branding","description":"Branding configuration"},"assets":{"$ref":"#\/components\/schemas\/Assets","description":"Assets configuration"}},"type":"object"},"UpdateSite":{"title":"Update Site","required":["mainDomain","domains","errorDocument","localizedErrorDocuments","redirectToMainDomain"],"properties":{"mainDomain":{"description":"Main domain","type":"string","example":"main_site"},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"errorDocument":{"description":"Error document","type":"string","example":"path\/to\/error\/document"},"localizedErrorDocuments":{"description":"Localized error documents","type":"object","example":{"en":"path\/to\/en\/error\/document","de":"path\/to\/de\/error\/document"}},"redirectToMainDomain":{"description":"Redirect to main domain","type":"boolean","example":false}},"type":"object"},"UpdateThumbnailConfig":{"title":"Update Thumbnail Config","required":["settings","medias","mediaOrder"],"properties":{"settings":{"description":"Thumbnail settings configuration","type":"object","example":{"description":"My thumbnail description","group":"Areas","format":"SOURCE","quality":95,"highResolution":0,"preserveColor":false,"forceProcessICCProfiles":false,"preserveMetaData":false,"rasterizeSVG":false,"preserveAnimation":false,"downloadable":false}},"medias":{"description":"Media configurations with transformation items","type":"object","example":{"default":[{"method":"scaleByWidth","arguments":{"width":1140,"forceResize":false}}]}},"mediaOrder":{"description":"Media configurations order","type":"object","example":{"default":0,"(max-width: 940px)":1}}},"type":"object"},"UpdateRole":{"title":"Update User Role","description":"Contains all information about a role that can be updated.","required":["name","classes","parentId","permissions","docTypes","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"name":{"description":"Name of Folder or Role","type":["string","null"],"example":"admin"},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"docTypes":{"description":"List of document types for the role","type":"object","example":["1","2"]},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"object","example":["studio_default_perspective","some_otherPerspective_Id"]}},"type":"object"},"UpdateCustomMetadata":{"title":"UpdateCustomMetadata","required":["name","language","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"}},"type":"object"},"UpdateCustomSettings":{"title":"UpdateCustomSettings","required":["key","value"],"properties":{"key":{"description":"Key","type":"string","example":"my_custom_setting_key"},"value":{"description":"Value","type":["mixed","null"],"example":"data"}},"type":"object"},"UpdateElementProperty":{"title":"UpdateDataProperty","required":["key","data","type","inheritable"],"properties":{"key":{"description":"key","type":"string","example":"Mister Proper"},"data":{"description":"data","type":["mixed","null"],"example":"123"},"type":{"description":"type","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false}},"type":"object"},"UpdatePredefinedProperty":{"title":"UpdatePredefinedProperty","required":["name","key","type","ctype","inheritable"],"properties":{"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":["string","null"],"example":"Detailed description of the property"},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":["string","null"],"example":"test"},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"ctype":{"description":"ctype","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false}},"type":"object"},"UpdateSchedule":{"title":"UpdateSchedule","required":["id","date","active"],"properties":{"id":{"description":"Id of schedule, if null a new one will be created","type":["integer","null"],"example":666},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":["string","null"],"enum":["publish","delete"],"example":"publish"},"version":{"description":"Version ID","type":["integer","null"],"example":987},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"UpdateVersion":{"title":"UpdateVersion","properties":{"public":{"description":"Public","type":["boolean","null"],"example":null},"note":{"description":"Note","type":["string","null"],"example":null}},"type":"object"},"UpdateUser":{"title":"User","description":"User Schema to update a User.","required":["email","firstname","lastname","admin","active","classes","docTypes","closeWarning","allowDirtyClose","contentLanguages","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationRequired","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"email":{"description":"Email of the User","type":["string","null"],"example":""},"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"admin":{"description":"If User is admin","type":"boolean","example":false},"active":{"description":"If User is active","type":"boolean","example":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"docTypes":{"description":"Allowed Document types to create","type":"object","example":["3","5"]},"closeWarning":{"description":"Show Close Warning","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#\/components\/schemas\/KeyBinding"}},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Date Time Locale for the User","type":"string","example":""},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"parentId":{"description":"Parent ID","type":"integer","example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"roles":{"description":"ID List of roles the user is assigned","type":"object","example":[12,14]},"twoFactorAuthenticationRequired":{"description":"Two Factor Authentication Enabled","type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"description":"Website Translation Languages Edit","type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"description":"Website Translation Languages View","type":"object","example":["de"]},"welcomeScreen":{"description":"Show welcome Screen","type":"boolean","example":true},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"object","example":["studio_default_perspective","some_otherPerspective_Id"]}},"type":"object"},"User":{"title":"User","description":"Contains all information about a user","required":["id","name","email","firstname","lastname","active","admin","classes","docTypes","closeWarning","allowDirtyClose","contentLanguages","hasImage","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthentication","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","objectDependencies","perspectives"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or User","type":["string","null"],"example":"admin"},"email":{"description":"Email of the User","type":["string","null"],"example":""},"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"active":{"description":"If a User is active","type":"boolean","example":true},"admin":{"description":"If User is admin","type":"boolean","example":false},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"docTypes":{"description":"Allowed doc types to create","type":"array","items":{"type":"string"}},"closeWarning":{"description":"Show close warning","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"hasImage":{"description":"If User has an Image","type":"boolean","example":true},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#\/components\/schemas\/KeyBinding"}},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Locale for dateTime","type":["string","null"],"example":""},"lastLogin":{"description":"Timestamp of the last login","type":["integer","null"],"example":"1718757677"},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"roles":{"description":"ID List of roles the user is assigned","type":"object","example":[12,14]},"twoFactorAuthentication":{"$ref":"#\/components\/schemas\/TwoFactorAuth","description":"Two Factor Authentication"},"websiteTranslationLanguagesEdit":{"description":"Website Translation Languages Edit","type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"description":"Website Translation Languages View","type":"object","example":["de"]},"welcomeScreen":{"description":"Show Welcome Screen","type":"boolean","example":true},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserDataObjectWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#\/components\/schemas\/UserDocumentWorkspace"}},"objectDependencies":{"$ref":"#\/components\/schemas\/ObjectDependencies","description":"Object Dependencies"},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#\/components\/schemas\/PerspectiveConfig"}}},"type":"object"},"UserDataObjectWorkspace":{"title":"User Document Workspace","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UserWorkspace"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true},"localizedEdit":{"description":"Localized Edit","type":["string","null"],"example":"default"},"localizedView":{"description":"Localized View","type":["string","null"],"example":"default"},"layouts":{"description":"Layouts","type":["string","null"],"example":"CAR"}},"type":"object"}]},"UserDocumentWorkspace":{"title":"User Document Workspace","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/UserWorkspace"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true}},"type":"object"}]},"UserInformation":{"title":"User Information","description":"Information about the user","required":["id","username","email","firstname","lastname","permissions","isAdmin","classes","docTypes","language","dateTimeLocale","welcomeScreen","memorizeTabs","allowDirtyClose","hasImage","contentLanguages","keyBindings","twoFactorAuthentication","activePerspective","perspectives","allowedLanguagesForEditingWebsiteTranslations","allowedLanguagesForViewingWebsiteTranslations"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User ID","type":"integer","example":1},"username":{"description":"Username","type":"string","example":"admin"},"email":{"description":"Email","type":["string","null"],"example":""},"firstname":{"description":"Firstname","type":["string","null"],"example":""},"lastname":{"description":"Lastname","type":["string","null"],"example":""},"permissions":{"description":"Permissions","type":"array","items":{"type":"string","example":"clear_cache"}},"isAdmin":{"description":"If user is an admin user","type":"boolean","example":false},"classes":{"description":"Allowed classes to create","type":"array","items":{"type":"string"}},"docTypes":{"description":"Allowed doc types to create","type":"array","items":{"type":"string"}},"language":{"description":"User Language","type":"string","example":"en"},"dateTimeLocale":{"description":"Locale for dateTime","type":["string","null"],"example":""},"welcomeScreen":{"description":"Welcome Screen","type":"boolean","example":true},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"hasImage":{"description":"Has Image","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"allowedLanguagesForEditingWebsiteTranslations":{"description":"List of valid website Languages to edit.","type":"array","items":{"type":"string"},"example":["de","en"]},"allowedLanguagesForViewingWebsiteTranslations":{"description":"List of valid website Languages to view.","type":"array","items":{"type":"string"},"example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#\/components\/schemas\/KeyBinding"}},"twoFactorAuthentication":{"$ref":"#\/components\/schemas\/TwoFactorAuth","description":"Two Factor Authentication"},"activePerspective":{"description":"Active studio perspective ID","type":["string","null"],"example":"studio_default_perspective"},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#\/components\/schemas\/PerspectiveConfig"}}},"type":"object"},"ObjectDependencies":{"title":"User Object Dependencies","description":"User Object Dependencies","required":["hasHidden","dependencies"],"properties":{"dependencies":{"description":"Dependencies to objects","type":"array","items":{"$ref":"#\/components\/schemas\/UserDependency"}},"hasHidden":{"description":"If is has hidden dependencies","type":"boolean","example":true}},"type":"object"},"UserPermission":{"title":"User Permission","description":"A permission for a user or role","required":["key","category"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the Permission","type":"string","example":"objects"},"category":{"description":"Category of the Permission","type":"string","example":"Datahub"}},"type":"object"},"UpdateUserProfile":{"title":"User Profile","description":"Schema to update a current User Profile.","required":["firstname","lastname","email","language","dateTimeLocale","welcomeScreen","memorizeTabs","contentLanguages","keyBindings"],"properties":{"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"email":{"description":"Email of the User","type":["string","null"],"example":""},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Date Time Locale for the User","type":"string","example":""},"welcomeScreen":{"description":"Show Welcome Screen","type":"boolean","example":true},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#\/components\/schemas\/KeyBinding"}}},"type":"object"},"UserWorkspace":{"title":"User Workspace","description":"Workspace of a user","required":["cid","cpath","list","view","publish","delete","rename","create","settings","versions","properties"],"properties":{"cid":{"description":"ID of the element","type":"integer","example":"1"},"cpath":{"description":"Path of the element","type":"string","example":"\/path\/to\/element"},"list":{"description":"List Permission","type":"boolean","example":true},"view":{"description":"View Permission","type":"boolean","example":true},"publish":{"description":"Publish Permission","type":"boolean","example":true},"delete":{"description":"Delete Permission","type":"boolean","example":true},"rename":{"description":"Rename Permission","type":"boolean","example":true},"create":{"description":"Create Permission","type":"boolean","example":true},"settings":{"description":"Settings Permission","type":"boolean","example":true},"versions":{"description":"Versions Permission","type":"boolean","example":true},"properties":{"description":"Properties Permission","type":"boolean","example":true}},"type":"object"},"Version":{"title":"Version","required":["id","cid","ctype","note","date","public","published","versionCount","autosave","user"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"version ID","type":"integer","example":2},"cid":{"description":"element ID","type":"integer","example":10},"ctype":{"description":"element type","type":"string","example":"object"},"note":{"description":"note","type":"string","example":"some note"},"date":{"description":"date","type":"integer","example":1712823182},"public":{"description":"public","type":"boolean","example":false},"published":{"description":"published","type":"boolean","example":false},"versionCount":{"description":"version count","type":"integer","example":10},"autosave":{"description":"autosave","type":"boolean","example":false},"user":{"$ref":"#\/components\/schemas\/VersionUser","description":"user"},"scheduled":{"description":"scheduled","type":["integer","null"],"example":null}},"type":"object"},"Dimensions":{"title":"VersionDimensions","properties":{"width":{"description":"width","type":["integer","null"],"example":1920},"height":{"description":"height","type":["integer","null"],"example":1080}},"type":"object"},"VersionUser":{"title":"VersionUser","properties":{"id":{"description":"ID","type":["integer","null"],"example":2},"name":{"description":"name","type":["string","null"],"example":"John Doe"}},"type":"object"},"Video":{"title":"Video","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"duration":{"description":"Duration","type":["number","null"],"format":"float","example":43560.5},"width":{"description":"Width","type":["integer","null"],"example":1920},"height":{"description":"Height","type":["integer","null"],"example":1080},"imageThumbnailPath":{"description":"Path to Image Thumbnail","type":["string","null"],"example":"\/path\/to\/video\/imagethumbnail.jpg"}},"type":"object"}]},"VideoThumbnailConfigDetail":{"title":"Video Thumbnail Config Detail","required":["settings","writeable","medias"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"settings":{"$ref":"#\/components\/schemas\/VideoThumbnailSettings","description":"Thumbnail settings"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"medias":{"description":"Media query configurations with transformation items","type":"object","example":{"default":[{"method":"scaleByHeight","arguments":{"height":300}}],"500K":[{"method":"scaleByHeight","arguments":{"height":500}}]}}},"type":"object"},"VideoThumbnailSettings":{"title":"Video Thumbnail Settings","required":["name","description","group","videoBitrate","audioBitrate","modificationDate","creationDate","filenameSuffix"],"properties":{"name":{"description":"Thumbnail name","type":"string","example":"content"},"description":{"description":"Thumbnail description","type":["string","null"],"example":"thumbnail for content videos"},"group":{"description":"Thumbnail group","type":["string","null"],"example":""},"videoBitrate":{"description":"Video bitrate in kbps","type":["integer","null"],"example":450},"audioBitrate":{"description":"Audio bitrate in kbps","type":["integer","null"],"example":128},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1769430880},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1565353556},"filenameSuffix":{"description":"Filename suffix","type":["string","null"],"example":null}},"type":"object"},"VideoType":{"title":"Video Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"image"}},"type":"object"},"WebsiteSetting":{"title":"Website Setting","required":["id","name","type","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"name":{"description":"Name","type":"string","example":"site_title"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":["string","null"],"example":"text"},"data":{"description":"Data","example":"Some text data","anyOf":[{"type":"string"},{"type":"boolean"},{"$ref":"#\/components\/schemas\/WebsiteSettingsObjectData"},{"type":"null"}]},"siteId":{"description":"Site ID","type":["integer","null"],"example":1},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null}},"type":"object"},"WebsiteSettingsAdd":{"title":"Website Settings Add","required":["name","type"],"properties":{"name":{"description":"Name","type":"string","example":"New Custom Setting"},"type":{"description":"Type","type":"string","example":"document"}},"type":"object"},"WebsiteSettingsObjectData":{"title":"Website Settings Object Data","required":["id","fullPath"],"properties":{"id":{"description":"element id","type":"integer","example":1020},"fullPath":{"description":"element fullPath","type":"string","example":"\/path\/to\/object"}},"type":"object"},"WebsiteSettingsType":{"title":"Website Settings Type","required":["key","title"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"boolean"},"title":{"description":"Title","type":"string","example":"Checkbox"}},"type":"object"},"WebsiteSettingsUpdate":{"title":"Website Settings Update","required":["name","language","data","siteId"],"properties":{"name":{"description":"Name","type":"string","example":"Updated Setting Title"},"language":{"description":"Language","type":"string","example":"en"},"data":{"description":"Data","example":"{\u0022id\u0022: 136,\u0022fullPath\u0022: \u0022\/de\u0022}","anyOf":[{"type":"string"},{"type":"boolean"},{"$ref":"#\/components\/schemas\/WebsiteSettingsObjectData"},{"type":"null"}]},"siteId":{"description":"Site ID","type":["integer","null"],"example":1}},"type":"object"},"WidgetConfig":{"title":"Widget Config","required":["id","name","widgetType","icon","onlyWrapper"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"widgetType":{"description":"Widget Type","type":"string","example":"element_trees"},"icon":{"$ref":"#\/components\/schemas\/ElementIcon","description":"Icon"},"onlyWrapper":{"description":"If widget is only wrapper of another configuration","type":"boolean","example":false}},"type":"object"},"WidgetType":{"title":"WidgetType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"info"}},"type":"object"},"WorkflowDetails":{"title":"WorkflowDetails","required":["workflowName","workflowLabel","workflowStatus","graph","workflowLayoutId","allowedTransitions","globalActions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"workflowName":{"description":"workflowName","type":"string","example":"simple_asset"},"workflowLabel":{"description":"workflowLabel","type":"string","example":"Sample Asset Workflow"},"workflowStatus":{"description":"workflowStatus","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowStatus"}},"graph":{"description":"graph","type":"string","example":"\u003Csvg\u003E...\u003C\/svg\u003E"},"workflowLayoutId":{"description":"workflowLayoutId","type":["string","null"],"example":"someWorkflowLayoutId"},"allowedTransitions":{"description":"allowedTransitions","type":"array","items":{"$ref":"#\/components\/schemas\/AllowedTransition"}},"globalActions":{"description":"globalActions","type":"array","items":{"$ref":"#\/components\/schemas\/GlobalAction"}}},"type":"object"},"WorkflowStatus":{"title":"WorkflowStatus","required":["color","colorInverted","title","label","layoutId","visibleInDetail"],"properties":{"color":{"description":"color","type":"string","example":"#3572b0"},"colorInverted":{"description":"colorInverted","type":"boolean","example":false},"title":{"description":"borderColor","type":"string","example":"#ffa500"},"label":{"description":"label","type":"string","example":"Edit Images"},"layoutId":{"description":"layoutId","type":["string","null"],"example":"someStatusLayoutId"},"visibleInDetail":{"description":"visibleInDetail","type":"boolean","example":true}},"type":"object"},"WysiwygWidgetConfig":{"title":"Wysiwyg Widget Config","required":["color","wysiwyg","isWriteable"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"wysiwyg":{"description":"Wysiwyg Content","type":"string","example":"\u003Cp\u003EHello World\u003C\/p\u003E"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]}}},"tags":[{"name":"Assets","description":"Asset operations to get\/update\/create\/delete assets"},{"name":"Asset Grid","description":"Asset Grid operations"},{"name":"Asset Thumbnails","description":"List thumbnails for assets like videos and images"},{"name":"Authorization","description":"Session-based login via username and password or logout and invalidate the session"},{"name":"Class Definition","description":"Class definition operations"},{"name":"Classification Store","description":"Classification store operations"},{"name":"Data Objects","description":"DataObject operations to get\/update\/create\/delete data objects"},{"name":"Data Object Grid","description":"DataObject Grid operations"},{"name":"Dependencies","description":"Get dependencies for a single element"},{"name":"Documents","description":"Document operations to get\/update\/create\/delete documents"},{"name":"Elements","description":"Get element properties for a single element based on its type and provided parameters"},{"name":"Execution Engine","description":"Execution engine operations related to job runs"},{"name":"E-Mails","description":"E-mail operations to get\/update\/create\/delete\/test emails and E-mail blocklist"},{"name":"Export","description":"Export"},{"name":"GDPR Data Extractor","description":"All operations related to GDPR data search and export."},{"name":"Mercure","description":"Retrieve JWT token for Mercure hub as cookie"},{"name":"Metadata","description":"Metadata operations to get\/update\/create\/delete metadata"},{"name":"Notes","description":"Note operations to list\/delete notes"},{"name":"Notifications","description":"Notification operations to get\/delete\/send notifications"},{"name":"Perspectives","description":"Operations to get\/update\/create\/delete properties and widgets"},{"name":"Properties","description":"Property operations to get\/update\/create\/delete properties"},{"name":"Recycle Bin","description":"Recycle bin operations to list\/restore\/flush deleted elements"},{"name":"Role Management","description":"Role Management operations"},{"name":"Schedule","description":"Get schedules for an element"},{"name":"Search","description":"Operations to get search configuration, search elements and get search result previews"},{"name":"Settings","description":"Get System Settings"},{"name":"Tags","description":"Tag operations to get\/list\/create\/update\/delete tags"},{"name":"Tags for Element","description":"Tag operations to get tags for an element"},{"name":"Translation","description":"Get translations either for a single key or multiple keys"},{"name":"Units","description":"Units operations like convert and get all units"},{"name":"User Management","description":"User Management operations"},{"name":"Versions","description":"Versions operations to get\/list\/publish\/delete and cleanup versions"},{"name":"Website Settings","description":"Website settings operations to list\/update\/create\/delete website settings"},{"name":"Workflows","description":"Workflows operations to get element workflow details"},{"name":"Settings Admin","description":"Settings Admin"},{"name":"Bundle Application Logger","description":"Application logger operations to list\/get log entries"},{"name":"Bundle Asset Metadata Class Definitions","description":"Get\/update\/delete configs and metadata"},{"name":"Bundle Backend Power Tools","description":"Operations related to the Backend Power Tools Bundle"},{"name":"Bundle Custom Reports","description":"Custom reports bundle operations to e.g. list reports and their configurations"},{"name":"Bundle Data Hub","description":"Operations related to Data Hub Bundle"},{"name":"Bundle Data Importer","description":"Operations related to Data Importer Bundle"},{"name":"Bundle Data Quality Management","description":"Operations related to the Data Quality Management Bundle"},{"name":"Bundle Enterprise Subscription Tools","description":"Enterprise Subscription Tools"},{"name":"Bundle Headless Documents","description":"Operations related to Headless Documents Bundle"},{"name":"Bundle Personalization","description":"Operations related to the Personalization Bundle"},{"name":"Bundle Portal Engine","description":"Portal Engine Bundle"},{"name":"Bundle Seo","description":"Seo bundle related operations (e.g. add\/remove\/list redirects)"},{"name":"Bundle Statistics Explorer","description":"Operations related to Statistics Explorer Bundle"},{"name":"Bundle Studio Dashboards","description":"Operations related to the Studio Dashboards Bundle"},{"name":"Bundle Web To Print","description":"Operations related to the Web to Print Bundle"}]}