diff --git a/assets/build/api/docs.jsonopenapi.json b/assets/build/api/docs.jsonopenapi.json index a058fc6f5..e90d240b5 100644 --- a/assets/build/api/docs.jsonopenapi.json +++ b/assets/build/api/docs.jsonopenapi.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Studio Backend API","description":"API for Studio generated by OpenApi Generator via zircote\/swagger-php","license":{"name":"GNU General Public License version 3 \u0026 Pimcore Commercial License","url":"https:\/\/www.pimcore.org\/license"},"version":"0.0.1"},"paths":{"\/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\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}\/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\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\/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":"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\/download\/csv\/{jobRunId}":{"get":{"tags":["Assets"],"summary":"Download CSV file for assets","description":"Download the CSV file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create csv endpoint\n","operationId":"asset_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":["Assets"],"summary":"Delete asset CSV 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":"asset_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\/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\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\/export\/csv\/asset":{"post":{"tags":["Assets"],"summary":"Creating CSV file for assets","description":"Creating the CSV file for assets. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n \u003Cli\u003E\u003Cstrong\u003Eassets\u003C\/strong\u003E: Array of asset 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\u003C\/ul\u003E Delimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E Header 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":"asset_export_csv_asset","requestBody":{"content":{"application\/json":{"schema":{"properties":{"assets":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"config":{"properties":{"delimiter":{"type":"string","example":";"},"header":{"type":"enum","enum":["asset_to_export","folder_to_export","asset_export_data","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array"],"example":"title"}},"type":"object"}},"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\/assets\/export\/csv\/folder":{"post":{"tags":["Assets"],"summary":"Creating CSV file for assets based on folder","description":"Creating the CSV file for assets 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 assets 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 Delimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E Header 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":"asset_export_csv_folder","requestBody":{"content":{"application\/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"},"config":{"properties":{"delimiter":{"type":"string","example":";"},"header":{"type":"enum","enum":["asset_to_export","folder_to_export","asset_export_data","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array"],"example":"title"}},"type":"object"}},"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\/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\/Filter"}},"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\/Asset Document"},{"$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","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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateCustomMetadata"},"nullable":true},"customSettings":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateCustomSettings"},"nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"},"nullable":true},"image":{"oneOf":[{"$ref":"#\/components\/schemas\/ImageData"}],"nullable":true,"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\/Asset Document"},{"$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","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/{folderId}\/{configurationId}":{"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":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"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\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\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":null}}],"responses":{"200":{"description":"Asset grid configuration","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\/assets\/grid\/configurations\/{folderId}":{"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","parameters":[{"name":"folderId","in":"path","description":"FolderId of the folderId","required":true,"schema":{"type":"integer","example":83}}],"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\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"},"nullable":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"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\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":["pageSize","name","description","columns"],"properties":{"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"},"nullable":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"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","columns"],"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":{"type":"array","items":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}}},"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\/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":null}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":null}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":null}}],"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\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}\/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\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}\/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\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}\/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\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}\/image\/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 existing asset image\n","operationId":"asset_image_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":{"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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"},"nullable":true}},"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\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\/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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"},"nullable":true}},"type":"object"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"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\/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":null}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":null}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":null}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":null}}],"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\/Asset Document"},{"$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\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"}},"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\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\/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 if asset with the same name and in the same path already exists, false otherwise","content":{"application\/json":{"schema":{"required":["exists"],"properties":{"exists":{"title":"exists","description":"True if asset exists, false otherwise","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\/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":"Successfully replaced asset 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\/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\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":null}},{"name":"aspectRatio","in":"query","description":"Aspect ratio","schema":{"type":"boolean","example":null}},{"name":"frame","in":"query","description":"Frame","schema":{"type":"boolean","example":null}},{"name":"async","in":"query","description":"Generate the asset asynchronously","schema":{"type":"boolean","example":null}}],"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\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}\/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\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}\/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\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\/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.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserInformation"}}}},"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\/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","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","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\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}\/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\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}":{"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\/DataObject"},{"$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":"Update needs to have the complete data present. \u003Cbr\u003E You can create\/update\/delete list entries like properties. \u003Cbr\u003E If you want to update only a single field, 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","minimum":1,"nullable":true},"index":{"type":"integer","minimum":0,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"childrenSortBy":{"type":"string","nullable":true},"childrenSortOrder":{"type":"string","nullable":true},"published":{"type":"boolean","nullable":true},"editableData":{"type":"object","example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }","nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"},"nullable":true}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated data object","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"$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"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/available-columns\/{classId}\/{folderId}":{"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":"path","description":"Identifies the class name for which the columns should be retrieved.","required":true,"schema":{"type":"string","example":"MyClass"}},{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"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-objects\/grid":{"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","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","columns"],"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":{"type":"array","items":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}}},"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\/{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}}],"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\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":{"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","minimum":1,"nullable":true},"index":{"type":"integer","minimum":0,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"childrenSortBy":{"type":"string","nullable":true},"childrenSortOrder":{"type":"string","nullable":true},"published":{"type":"boolean","nullable":true}},"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\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\/{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\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":null}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":null}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":null}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"className","in":"query","description":"Filter by class.","required":false,"schema":{"type":"string","enum":["AccessoryPart","asdf","BodyStyle","Car","Category","ComplexLayout","Customer","CustomerSegment","CustomerSegmentGroup","datatypetest","datetest","Event","fieldtest","FilterDefinition","foo5","LinkActivityDefinition","Manufacturer","mappingTest","News","OfferToolCustomProduct","OfferToolOffer","OfferToolOfferItem","OnlineShopOrder","OnlineShopOrderItem","OnlineShopTaxClass","OnlineShopVoucherSeries","OnlineShopVoucherToken","PortalUser","PortalUserGroup","simple","StudioFieldTypeTest","TermSegmentBuilderDefinition","Test","unittest"],"example":null}}],"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\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\/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\/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\/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\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-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\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\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}\/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\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":null}}],"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\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 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":null}}],"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\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}\/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\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\/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\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\/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\/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\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","example":"author","nullable":true}},"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":{"get":{"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","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":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":null}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":null}},{"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,"example":""}],"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":null}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":null}},{"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,"example":""}],"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":{"$ref":"#\/components\/schemas\/Filter"}},"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\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\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\/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\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":{"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 name of the property. \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":null}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":null}}],"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\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\/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","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","minimum":1,"nullable":true},"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","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","minimum":1,"nullable":true},"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","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","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","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","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","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\/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","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\/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"}]}}}}}}},"\/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":null}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":null}},{"name":"parentId","in":"query","description":"Filter tags by parent id.","required":false,"schema":{"type":"integer","minimum":0,"example":null}}],"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\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\/{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\/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\/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\/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":null}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"anyOf":[{"type":"integer","format":"int32"},{"type":"number","format":"float"}]},"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":null}},{"name":"toUnitId","in":"query","description":"Id of the unit to convert to","required":true,"schema":{"type":"string","example":null}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"anyOf":[{"type":"integer","format":"int32"},{"type":"number","format":"float"}]},"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":"float"},{"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","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","minimum":1,"nullable":true},"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","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","minimum":1,"nullable":true},"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","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","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","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\/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. 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":null}}],"responses":{"200":{"description":"user_search_summary_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\/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\/{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"}},"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\/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\/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"}]}}}}}}},"\/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\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\/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\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\/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":"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\/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\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":["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\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":["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\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":"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\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\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\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\/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":null}},{"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":{"properties":{"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowDetails"}}},"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"}]}}}}}}}},"components":{"schemas":{"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":[],"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Archive":{"title":"Archive","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"Asset":{"title":"Asset","required":["iconName","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"},{"type":"array","items":[]}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"image"},"filename":{"description":"Filename","type":"string","example":"cool.jpg"},"mimeType":{"description":"Mimetype","type":"string","example":"image\/jpeg","nullable":true},"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"}]},"Asset Document":{"title":"Asset Document","required":["pageCount","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"pageCount":{"description":"Page count","type":"integer","example":2,"nullable":true},"imageThumbnailPath":{"description":"Path to image thumbnail","type":"string","example":"\/path\/to\/document\/imagethumbnail.jpg","nullable":true}},"type":"object"}]},"AssetFolder":{"title":"Asset Folder","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"AssetPermissions":{"title":"Asset Permissions","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Permissions"}]},"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":"array","items":[]}]}},"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","example":1707312457,"nullable":true},"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"}},"type":"object"},"Audio":{"title":"Audio","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"BlocklistEntry":{"title":"Blocklist","required":["email","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"email":{"description":"email address","type":"string","example":"email@pimcore.com"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":"integer","example":1707312457,"nullable":true}},"type":"object"},"EmailAddressParameter":{"title":"Blocklist","required":["email"],"properties":{"email":{"description":"email address","type":"string","example":"someEmail@email-domain.com"}},"type":"object"},"UpdateTagParameters":{"title":"Change Tag Parameters","description":"Parameters for changing a tag","properties":{"parentId":{"description":"Parent id","type":"integer","example":0,"nullable":true},"name":{"description":"Tag name","type":"string","example":"tag 1","nullable":true}},"type":"object"},"Collection":{"title":"Collection","properties":{"totalItems":{"description":"total items","type":"integer","example":666},"items":{"description":"items","type":"mixed","example":["Asset","Folder","Document","DataObject"]}},"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","example":"de","nullable":true},"group":{"description":"Group of the Column","type":"string","example":"system"}},"type":"object"},"ConvertedQuantityValue":{"title":"Converted quantity values","required":["originalValue","fromUnitId","convertedValues"],"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"},{"type":"array","items":[]}]}},"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"},"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"},"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"},"CustomAttributes":{"title":"CustomAttributes","description":"Custom attributes used mainly for the tree","required":["icon","tooltip","additionalIcons","key","additionalCssClasses"],"properties":{"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon"}],"nullable":true,"description":"Custom Icon"},"tooltip":{"description":"Custom Tooltip","type":"string","example":"\u003Cb\u003EMy Tooltip\u003C\/b\u003E","nullable":true},"additionalIcons":{"description":"AdditionalIcons","type":"array","items":{"type":"string","example":"some_other_icon"}},"key":{"description":"Custom Key\/Filename","type":"string","example":"my_custom_key","nullable":true},"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"},{"type":"array","items":[]}]}},"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","example":"data","nullable":true}},"type":"object"},"CustomMetadataVersion":{"title":"CustomMetadataVersion","required":["name","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en","nullable":true},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":"string","example":"data","nullable":true}},"type":"object"},"CustomSettings":{"title":"CustomSettings","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"fixedCustomSettings":{"oneOf":[{"$ref":"#\/components\/schemas\/FixedCustomSettings"}],"nullable":true,"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":[],"example":"{ imageWidth: 1280, imageHeight: 720 }"}},"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","type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"}]},"DataObjectPermissions":{"title":"Data Object Permissions","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","example":"default","nullable":true},"localizedView":{"description":"Localized View","type":"string","example":"default","nullable":true},"layouts":{"description":"Layouts","type":"string","example":"default","nullable":true}},"type":"object"}]},"DataObject":{"title":"DataObject","required":["key","className","type","published","hasChildren","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","index","objectData","allowInheritance","allowVariants","showVariants","hasPreview"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"allowVariants":{"description":"Variants allowed","type":"boolean","example":false},"showVariants":{"description":"Show variants","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"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},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}}},"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":"enum","enum":["object","variant"],"example":"object"}},"type":"object"},"DataObjectVersion":{"title":"DataObjectVersion","required":["modificationDate","path","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"},"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"},{"type":"array","items":[]}]}},"key":{"description":"key","type":"string","example":"key_of_the_property"},"data":{"description":"data","type":"mixed","example":"123","nullable":true},"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","example":"comma,separated,values","nullable":true},"predefinedName":{"description":"predefinedName","type":"string","example":"name of the predefined property","nullable":true},"description":{"description":"description","type":"string","example":"Description of the predefined property","nullable":true}},"type":"object"},"DeleteInfo":{"title":"DeleteInfo","required":["hasDependencies","canUseRecycleBin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"hasDependencies":{"description":"hasDependencies","type":"boolean","example":true},"canUseRecycleBin":{"description":"canUseRecycleBin","type":"boolean","example":true}},"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"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"integer"},"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"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or Role","type":"string","example":"admin","nullable":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"type":"integer","example":"2","nullable":true},"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"}}},"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"},"Document":{"title":"Document","required":[],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/asset.jpg"}},"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"},{"type":"array","items":[]}]}},"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","userOwner","userModification","locked","isLocked","creationDate","modificationDate","permissions"],"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"},"userOwner":{"description":"ID of owner","type":"integer","example":1},"userModification":{"description":"User that modified the element","type":"integer","example":1},"locked":{"description":"Locked","type":"string","example":"locked","nullable":true},"isLocked":{"description":"Is locked","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":"integer","example":221846400,"nullable":true},"modificationDate":{"description":"Modification date","type":"integer","example":327417600,"nullable":true}},"type":"object"},"ElementIcon":{"title":"ElementIcon","required":["type","value"],"properties":{"type":{"description":"Icon type","type":"enum","enum":["name","path"],"example":"path"},"value":{"description":"Icon value","type":"string","example":"\/path\/to\/icon"}},"type":"object"},"EmailDocumentParameters":{"title":"EmailDocumentParameters","required":["key","value"],"properties":{"key":{"description":"parameter key","type":"string","example":"some_parameter_key"},"value":{"description":"parameter value","type":"value","example":"some_parameter_value","nullable":true}},"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"},{"type":"array","items":[]}]}},"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","example":"from@pimcore.com","nullable":true},"to":{"description":"to","type":"string","example":"to@pimcore.com","nullable":true},"subject":{"description":"subject","type":"string","example":"E-Mail subject","nullable":true}},"type":"object"},"EmailLogEntryDetail":{"title":"EmailLogDetail","required":["bcc","cc","error"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/EmailLogEntry"},{"properties":{"bcc":{"description":"bcc","type":"string","example":"email@pimcore.com","nullable":true},"cc":{"description":"cc","type":"string","example":"email@pimcore.com","nullable":true},"error":{"description":"error","type":"string","example":"Some error occurred","nullable":true}},"type":"object"}]},"ObjectParameter":{"title":"EmailLogObjectParameterData","required":["name","value"],"properties":{"id":{"description":"id","type":"integer","example":1020},"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"},{"type":"array","items":[]}]}},"name":{"description":"name","type":"string","example":"myParameter"},"value":{"description":"value","type":"string","example":"Some value","nullable":true},"objectData":{"oneOf":[{"$ref":"#\/components\/schemas\/ObjectParameter"}],"nullable":true,"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"},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key of Field Collection","type":"string"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"group":{"description":"Group","type":"string","example":"Group Name","nullable":true},"name":{"description":"Name","type":"string","example":"Layout","nullable":true},"type":{"description":"Type","type":"string","nullable":true},"region":{"description":"Region","type":"string","nullable":true},"title":{"description":"Title","type":"string","nullable":true},"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":"array","items":[],"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":[],"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","type":"integer","example":50},"y":{"description":"y","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"},"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":[],"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":["key","type","config"],"properties":{"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"type":{"description":"Type","type":"string","example":"system.integer"},"group":{"description":"Group","type":"string","example":"system","nullable":true},"config":{"description":"Config","type":"array","items":{"type":"string"},"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}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\u0022key\u0022:\u0022id\u0022,\u0022direction\u0022: \u0022ASC\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"},{"type":"array","items":[]}]}},"key":{"description":"Key","type":"string","example":"id"},"group":{"description":"Group","type":"string","example":"system"},"sortable":{"description":"Sortable","type":"boolean","example":true},"editable":{"description":"Editable","type":"boolean","example":false},"exportable":{"description":"Exportable","type":"boolean","example":false},"localizable":{"description":"Localizable","type":"boolean","example":false},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"value":{"description":"Value","type":"mixed","example":73,"nullable":true}},"type":"object"},"Configuration":{"title":"GridConfiguration","description":"Contains all data to configure a grid column","required":["id","name","description"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":"string","example":"My Configuration Description"}},"type":"object"},"DetailedConfiguration":{"title":"GridDetailedConfiguration","description":"Contains all data to configure a grid column","required":["name","description","shareGlobal","saveFilter","setAsFavorite","sharedUsers","sharedRoles","columns","filter","pageSize"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":"string","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":{"$ref":"#\/components\/schemas\/ColumnSchema"}},"filter":{"description":"filter","type":"array","items":{"$ref":"#\/components\/schemas\/Filter"}},"pageSize":{"description":"Page Size","type":"integer","example":42},"modificationDate":{"description":"Modification Date","type":"integer","example":1634025600,"nullable":true},"creationDate":{"description":"Creation Date","type":"integer","example":1634025600,"nullable":true},"ownerId":{"description":"ID of the owner","type":"integer","example":42,"nullable":true},"id":{"description":"ID of the configuration","type":"integer","example":42,"nullable":true}},"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"}]},"ImageData":{"title":"ImageData","properties":{"focalPoint":{"$ref":"#\/components\/schemas\/FocalPoint"}},"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"},"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 shoudl 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"},"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"},{"type":"array","items":[]}]}},"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","example":null,"nullable":true},"layout":{"description":"Layout","type":"string","example":null,"nullable":true},"region":{"description":"Region","type":"string","example":"center","nullable":true},"title":{"description":"Title","type":"string","example":"MyLayout","nullable":true},"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","example":"(float: left;)","nullable":true},"locked":{"description":"Locked","type":"boolean","example":false},"children":{"description":"Children","type":"array","items":[],"example":"[]"},"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon"}],"nullable":true,"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"},"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"},{"type":"array","items":[]}]}},"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":[],"example":"Can be pretty much anything"},"userId":{"description":"User ID","type":"integer","example":1,"nullable":true},"userName":{"description":"Username","type":"string","example":"shaquille.oatmeal","nullable":true}},"type":"object"},"NoteType":{"title":"NoteType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/NotificationListItem"},{"properties":{"message":{"description":"message","type":"string","example":"Notification message","nullable":true},"payload":{"description":"payload","type":"string","example":"{\u0022key\u0022: \u0022value\u0022}","nullable":true},"attachmentType":{"description":"linked attachment type","type":"string","example":"object","nullable":true},"attachmentId":{"description":"linked attachment ID","type":"integer","example":3669,"nullable":true}},"type":"object"}]},"NotificationListItem":{"title":"NotificationListItem","required":["id","type","title","read","hasAttachment","sentDate","sender"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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","example":"Pimcore Admin","nullable":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"},{"type":"array","items":[]}]}},"key":{"description":"Key of Object Brick","type":"string"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"name":{"description":"Name","type":"string","example":"Layout","nullable":true},"type":{"description":"Type","type":"string","nullable":true},"region":{"description":"Region","type":"string","nullable":true},"title":{"description":"Title","type":"string","nullable":true},"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":"array","items":[],"example":"[]"}},"type":"object"},"PatchCustomMetadata":{"title":"PatchCustomMetadata","required":["name"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en","nullable":true},"data":{"description":"Data","type":"string","example":"data","nullable":true}},"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","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"},"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"},{"type":"array","items":[]}]}},"id":{"description":"Id","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"custom_metadata"},"description":{"description":"Description","type":"string","example":"A predefined metadata","nullable":true},"type":{"description":"Type","type":"string","example":"input"},"targetSubType":{"description":"Target sub type","type":"string","example":"input","nullable":true},"data":{"description":"Data","type":"mixed","example":"data","nullable":true},"config":{"description":"Config","type":"string","example":"config","nullable":true},"language":{"description":"Language","type":"string","example":"en","nullable":true},"group":{"description":"Group","type":"string","example":"group","nullable":true},"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"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"string","example":"alpha-numerical-value"},"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":"string","example":"Detailed description of the property","nullable":true},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":"string","example":"test","nullable":true},"config":{"description":"config","type":"string","example":"comma,separated,values","nullable":true},"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"},{"type":"array","items":[]}]}},"id":{"description":"ID","type":"string","example":"mm","nullable":true},"abbreviation":{"description":"Abbreviation","type":"string","example":"mm","nullable":true},"group":{"description":"Group","type":"string","example":null,"nullable":true},"longName":{"description":"Long Name","type":"string","example":"Millimeter","nullable":true},"baseUnit":{"description":"Base Unit","type":"string","example":"m","nullable":true},"reference":{"description":"Reference","type":"string","example":null,"nullable":true},"factor":{"description":"Factor","type":"number","format":"float","example":null,"nullable":true},"conversionOffset":{"description":"Conversion Offset","type":"number","format":"float","example":null,"nullable":true},"converter":{"description":"Converter","type":"string","example":null,"nullable":true}},"type":"object"},"ResetPassword":{"title":"ResetPassword","description":"Username","required":["username"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"}},"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","state","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":"list","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"},{"type":"array","items":[]}]}},"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","enum":["publish","delete"],"nullable":true},"version":{"description":"Version ID","type":"integer","example":987,"nullable":true},"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"},"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":"enum","enum":["document","html","text"],"example":"text"},"content":{"description":"email content","type":"string","example":"My email message","nullable":true},"documentPath":{"description":"path to the email document","type":"string","example":"\/path\/to\/document","nullable":true},"documentParameters":{"description":"email document parameters","type":"array","items":{"$ref":"#\/components\/schemas\/EmailDocumentParameters"}},"attachmentId":{"description":"id of the asset attachment","type":"integer","example":83,"nullable":true}},"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":"enum","enum":["asset","document","object"],"example":null,"nullable":true},"attachmentId":{"description":"ID of the attachment","type":"integer","example":83,"nullable":true}},"type":"object"},"SimpleUser":{"title":"Simple User","description":"A user with the most imported information.","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"username":{"description":"Name of the User","type":"string","example":"role"}},"type":"object"},"SimpleRole":{"title":"Simple User Role","description":"A user role which is a combination of permissions and settings.","required":["id","category"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the Role","type":"integer","example":"1"},"name":{"description":"Name of the Role","type":"string","example":"role"}},"type":"object"},"Site":{"title":"Site","required":["id","domains","domain"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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","example":1,"nullable":true},"rootPath":{"description":"Root path","type":"string","example":"\/","nullable":true}},"type":"object"},"SubmitAction":{"title":"SubmitAction","description":"Schema for submission of workflow action","required":["actionType","elementId","elementType","workflowName","transition","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":"object"},"workflowName":{"description":"name of the workflow","type":"string","example":"my_first_workflow"},"transition":{"description":"transition","type":"string","example":"start_workflow"},"workflowOptions":{"description":"workflowOptions","type":"object","example":"{\u0022notes\u0022: \u0022Some note I want to write\u0022}"}},"type":"object"},"Tag":{"title":"Tag","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"}]},"Thumbnail":{"title":"Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"string","example":"pimcore_system_treepreview"},"text":{"description":"text","type":"string","example":"original"}},"type":"object"},"ThumbnailCollection":{"title":"ThumbnailCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Thumbnail"}}},"type":"object"},"Translation":{"title":"Translation","description":"Translation Scheme for API","required":["locale","keys"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"keys":{"description":"Keys","type":"array","items":{"type":"string","example":"not_your_typical_key"}}},"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"},{"type":"array","items":[]}]}},"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"},"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"}]},"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"],"properties":{"name":{"description":"Name of Folder or Role","type":"string","example":"admin","nullable":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"type":"integer","example":"2","nullable":true},"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"}}},"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","example":"data","nullable":true}},"type":"object"},"UpdateCustomSettings":{"title":"UpdateCustomSettings","required":["key","value"],"properties":{"key":{"description":"Key","type":"string","example":"my_custom_setting_key"},"value":{"description":"Value","type":"mixed","example":"data","nullable":true}},"type":"object"},"UpdateElementProperty":{"title":"UpdateDataProperty","required":["key","data","type","inheritable"],"properties":{"key":{"description":"key","type":"string","example":"Mister Proper"},"data":{"description":"data","type":"mixed","example":"123","nullable":true},"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","example":"Detailed description of the property","nullable":true},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":"string","example":"test","nullable":true},"config":{"description":"config","type":"string","example":"comma,separated,values","nullable":true},"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","example":666,"nullable":true},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":"string","enum":["publish","delete"],"nullable":true},"version":{"description":"Version ID","type":"integer","example":987,"nullable":true},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"UpdateVersion":{"title":"UpdateVersion","properties":{"public":{"description":"Public","type":"boolean","example":null,"nullable":true},"note":{"description":"Note","type":"string","example":null,"nullable":true}},"type":"object"},"UpdateUser":{"title":"User","description":"User Schema to update a User.","required":["active","classes","closeWarning","allowDirtyClose","contentLanguages","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationEnabled","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces"],"properties":{"email":{"description":"Email of the User","type":"string","example":"","nullable":true},"firstname":{"description":"Firstname of the User","type":"string","example":"","nullable":true},"lastname":{"description":"Lastname of the User","type":"string","example":"","nullable":true},"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"]},"closeWarning":{"type":"boolean","example":true},"allowDirtyClose":{"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"},"memorizeTabs":{"type":"boolean","example":true},"parentId":{"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]},"twoFactorAuthenticationEnabled":{"type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"welcomeScreen":{"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"}}},"type":"object"},"User":{"title":"User","description":"Contains all information about a user","required":["id","active","admin","classes","closeWarning","allowDirtyClose","contentLanguages","hasImage","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationEnabled","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","objectDependencies"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or User","type":"string","example":"admin","nullable":true},"email":{"description":"Email of the User","type":"string","example":"","nullable":true},"firstname":{"description":"Firstname of the User","type":"string","example":"","nullable":true},"lastname":{"description":"Lastname of the User","type":"string","example":"","nullable":true},"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"]},"closeWarning":{"type":"boolean","example":true},"allowDirtyClose":{"type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"hasImage":{"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"},"lastLogin":{"description":"Timestamp of the last login","type":"integer","example":"1718757677","nullable":true},"memorizeTabs":{"type":"boolean","example":true},"parentId":{"type":"integer","example":"2","nullable":true},"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]},"twoFactorAuthenticationEnabled":{"type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"welcomeScreen":{"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"}},"objectDependencies":{"$ref":"#\/components\/schemas\/ObjectDependencies"}},"type":"object"},"UserInformation":{"title":"User Information","description":"Information about the user","required":["username","permissions","isAdmin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"username":{"description":"Username","type":"string","example":"admin"},"permissions":{"description":"Permissions","type":"array","items":{"type":"string","example":"clear_cache"}},"isAdmin":{"description":"If user is an admin user","type":"boolean","example":false}},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key of the Permission","type":"string","example":"objects"},"category":{"description":"Category og the Permission","type":"string","example":"Datahub"}},"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"},{"type":"array","items":[]}]}},"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"},"scheduled":{"description":"scheduled","type":"integer","example":null,"nullable":true}},"type":"object"},"Dimensions":{"title":"VersionDimensions","properties":{"width":{"description":"width","type":"integer","example":1920,"nullable":true},"height":{"description":"height","type":"integer","example":1080,"nullable":true}},"type":"object"},"VersionUser":{"title":"VersionUser","properties":{"id":{"description":"ID","type":"integer","example":2,"nullable":true},"name":{"description":"name","type":"string","example":"John Doe","nullable":true}},"type":"object"},"Video":{"title":"Video","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"duration":{"description":"Duration","type":"number","format":"float","example":43560.5,"nullable":true},"width":{"description":"Width","type":"integer","example":1920,"nullable":true},"height":{"description":"Height","type":"integer","example":1080,"nullable":true},"imageThumbnailPath":{"description":"Path to Image Thumbnail","type":"string","example":"\/path\/to\/video\/imagethumbnail.jpg","nullable":true}},"type":"object"}]},"WorkflowDetails":{"title":"WorkflowDetails","required":["workflowName","workflowStatus","graph","allowedTransitions","globalActions"],"properties":{"workflowName":{"description":"workflowName","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"},"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"],"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"},"visibleInDetail":{"description":"visibleInDetail","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":"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":"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":"Properties","description":"Property operations to get\/update\/create\/delete properties"},{"name":"Role Management","description":"Role Management operations"},{"name":"Schedule","description":"Get schedules for an element"},{"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":"Workflows","description":"Workflows operations to get element workflow details"}]} \ No newline at end of file +{"openapi":"3.0.0","info":{"title":"Studio Backend API","description":"API for Studio generated by OpenApi Generator via zircote\/swagger-php","license":{"name":"GNU General Public License version 3 \u0026 Pimcore Commercial License","url":"https:\/\/www.pimcore.org\/license"},"version":"0.0.1"},"paths":{"\/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\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}\/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\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\/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":"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\/download\/csv\/{jobRunId}":{"get":{"tags":["Assets"],"summary":"Download CSV file for assets","description":"Download the CSV file with given \u003Cstrong\u003E{jobRunId}\u003C\/strong\u003E returned in the response of the create csv endpoint\n","operationId":"asset_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":["Assets"],"summary":"Delete asset CSV 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":"asset_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\/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\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\/export\/csv\/asset":{"post":{"tags":["Assets"],"summary":"Creating CSV file for assets","description":"Creating the CSV file for assets. \u003Cbr\u003E Parameters are: \u003Cul\u003E\n \u003Cli\u003E\u003Cstrong\u003Eassets\u003C\/strong\u003E: Array of asset 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\u003C\/ul\u003E Delimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E Header 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":"asset_export_csv_asset","requestBody":{"content":{"application\/json":{"schema":{"properties":{"assets":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"config":{"properties":{"delimiter":{"type":"string","example":";"},"header":{"type":"enum","enum":["asset_to_export","folder_to_export","asset_export_data","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array"],"example":"title"}},"type":"object"}},"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\/assets\/export\/csv\/folder":{"post":{"tags":["Assets"],"summary":"Creating CSV file for assets based on folder","description":"Creating the CSV file for assets 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 assets 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 Delimiter can be set to anything, but the default is a \u003Cstrong\u003Esemicolon\u003C\/strong\u003E \u003Cbr\u003E Header 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":"asset_export_csv_folder","requestBody":{"content":{"application\/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/Column"}},"filters":{"$ref":"#\/components\/schemas\/Filter"},"config":{"properties":{"delimiter":{"type":"string","example":";"},"header":{"type":"enum","enum":["asset_to_export","folder_to_export","asset_export_data","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array"],"example":"title"}},"type":"object"}},"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\/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\/Filter"}},"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\/Asset Document"},{"$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","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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateCustomMetadata"},"nullable":true},"customSettings":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateCustomSettings"},"nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"},"nullable":true},"image":{"oneOf":[{"$ref":"#\/components\/schemas\/ImageData"}],"nullable":true,"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\/Asset Document"},{"$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","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/Error"},{"$ref":"#\/components\/schemas\/DevError"}]}}}}}}},"\/pimcore-studio\/api\/assets\/grid\/configuration\/{folderId}\/{configurationId}":{"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":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"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\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\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":null}}],"responses":{"200":{"description":"Asset grid configuration","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\/assets\/grid\/configurations\/{folderId}":{"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","parameters":[{"name":"folderId","in":"path","description":"FolderId of the folderId","required":true,"schema":{"type":"integer","example":83}}],"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\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"},"nullable":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"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\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":["pageSize","name","description","columns"],"properties":{"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"},"nullable":false},"filter":{"oneOf":[{"$ref":"#\/components\/schemas\/Filter"}],"nullable":true,"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","columns"],"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":{"type":"array","items":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}}},"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\/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":null}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":null}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":null}}],"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\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}\/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":"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":null}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":null}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":null}},{"name":"contain","in":"query","description":"Contain","schema":{"type":"boolean","example":null}},{"name":"frame","in":"query","description":"Frame","schema":{"type":"boolean","example":null}},{"name":"cover","in":"query","description":"Cover","schema":{"type":"boolean","example":null}},{"name":"forceResize","in":"query","description":"ForceResize","schema":{"type":"boolean","example":null}}],"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\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\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}\/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\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}\/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\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}\/image\/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 existing asset image\n","operationId":"asset_image_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":{"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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"},"nullable":true}},"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\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\/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","minimum":1,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/PatchCustomMetadata"},"nullable":true}},"type":"object"}},"filters":{"$ref":"#\/components\/schemas\/Filter"}},"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\/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":null}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":null}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":null}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":null}}],"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\/Asset Document"},{"$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\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"}},"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\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\/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 if asset with the same name and in the same path already exists, false otherwise","content":{"application\/json":{"schema":{"required":["exists"],"properties":{"exists":{"title":"exists","description":"True if asset exists, false otherwise","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\/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":"Successfully replaced asset 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\/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\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":null}},{"name":"aspectRatio","in":"query","description":"Aspect ratio","schema":{"type":"boolean","example":null}},{"name":"frame","in":"query","description":"Frame","schema":{"type":"boolean","example":null}},{"name":"async","in":"query","description":"Generate the asset asynchronously","schema":{"type":"boolean","example":null}}],"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\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}\/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\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}\/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\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\/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.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserInformation"}}}},"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\/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","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","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\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}\/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\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}":{"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\/DataObject"},{"$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":"Update needs to have the complete data present. \u003Cbr\u003E You can create\/update\/delete list entries like properties. \u003Cbr\u003E If you want to update only a single field, 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","minimum":1,"nullable":true},"index":{"type":"integer","minimum":0,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"childrenSortBy":{"type":"string","nullable":true},"childrenSortOrder":{"type":"string","nullable":true},"published":{"type":"boolean","nullable":true},"editableData":{"type":"object","example":"{ \u0022someFieldKey\u0022: \u0022someValue\u0022 }","nullable":true},"properties":{"type":"array","items":{"$ref":"#\/components\/schemas\/UpdateElementProperty"},"nullable":true}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated data object","content":{"application\/json":{"schema":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/DataObject"},{"$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"}]}}}}}}},"\/pimcore-studio\/api\/data-object\/grid\/available-columns\/{classId}\/{folderId}":{"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":"path","description":"Identifies the class name for which the columns should be retrieved.","required":true,"schema":{"type":"string","example":"MyClass"}},{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"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-objects\/grid":{"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","requestBody":{"required":true,"content":{"application\/json":{"schema":{"required":["folderId","columns"],"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":{"type":"array","items":{"properties":{"columns":{"type":"array","items":{"$ref":"#\/components\/schemas\/ColumnData"}}},"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\/{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}}],"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\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":{"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","minimum":1,"nullable":true},"index":{"type":"integer","minimum":0,"nullable":true},"key":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"childrenSortBy":{"type":"string","nullable":true},"childrenSortOrder":{"type":"string","nullable":true},"published":{"type":"boolean","nullable":true}},"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\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\/{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\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":null}},{"name":"idSearchTerm","in":"query","description":"Filter assets\/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":null}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":null}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":null}},{"name":"className","in":"query","description":"Filter by class.","required":false,"schema":{"type":"string","example":"Car"}}],"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\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\/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\/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\/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\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-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\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\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}\/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\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":null}}],"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\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 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":null}}],"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\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}\/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\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\/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\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\/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\/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\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","example":"author","nullable":true}},"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":{"get":{"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","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":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":null}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":null}},{"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,"example":""}],"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":null}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":null}},{"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,"example":""}],"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":{"$ref":"#\/components\/schemas\/Filter"}},"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\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\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\/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\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":{"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 name of the property. \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":null}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":null}}],"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\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\/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","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","minimum":1,"nullable":true},"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","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","minimum":1,"nullable":true},"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","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","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","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","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","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\/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","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\/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"}]}}}}}}},"\/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":null}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":null}},{"name":"parentId","in":"query","description":"Filter tags by parent id.","required":false,"schema":{"type":"integer","minimum":0,"example":null}}],"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\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\/{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\/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\/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\/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":null}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"anyOf":[{"type":"integer","format":"int32"},{"type":"number","format":"float"}]},"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":null}},{"name":"toUnitId","in":"query","description":"Id of the unit to convert to","required":true,"schema":{"type":"string","example":null}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"anyOf":[{"type":"integer","format":"int32"},{"type":"number","format":"float"}]},"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":"float"},{"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","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","minimum":1,"nullable":true},"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","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","minimum":1,"nullable":true},"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","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","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","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\/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. 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":null}}],"responses":{"200":{"description":"user_search_summary_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\/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\/{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"}},"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\/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\/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"}]}}}}}}},"\/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\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\/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\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\/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":"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\/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\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":["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\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":["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\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":"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\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\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\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\/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":null}},{"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":{"properties":{"items":{"title":"items","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowDetails"}}},"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"}]}}}}}}}},"components":{"schemas":{"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":[],"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Archive":{"title":"Archive","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"Asset":{"title":"Asset","required":["iconName","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"},{"type":"array","items":[]}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"image"},"filename":{"description":"Filename","type":"string","example":"cool.jpg"},"mimeType":{"description":"Mimetype","type":"string","example":"image\/jpeg","nullable":true},"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"}]},"Asset Document":{"title":"Asset Document","required":["pageCount","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"pageCount":{"description":"Page count","type":"integer","example":2,"nullable":true},"imageThumbnailPath":{"description":"Path to image thumbnail","type":"string","example":"\/path\/to\/document\/imagethumbnail.jpg","nullable":true}},"type":"object"}]},"AssetFolder":{"title":"Asset Folder","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"AssetPermissions":{"title":"Asset Permissions","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Permissions"}]},"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":"array","items":[]}]}},"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","example":1707312457,"nullable":true},"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"}},"type":"object"},"Audio":{"title":"Audio","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"}]},"BlocklistEntry":{"title":"Blocklist","required":["email","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"email":{"description":"email address","type":"string","example":"email@pimcore.com"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":"integer","example":1707312457,"nullable":true}},"type":"object"},"EmailAddressParameter":{"title":"Blocklist","required":["email"],"properties":{"email":{"description":"email address","type":"string","example":"someEmail@email-domain.com"}},"type":"object"},"UpdateTagParameters":{"title":"Change Tag Parameters","description":"Parameters for changing a tag","properties":{"parentId":{"description":"Parent id","type":"integer","example":0,"nullable":true},"name":{"description":"Tag name","type":"string","example":"tag 1","nullable":true}},"type":"object"},"Collection":{"title":"Collection","properties":{"totalItems":{"description":"total items","type":"integer","example":666},"items":{"description":"items","type":"mixed","example":["Asset","Folder","Document","DataObject"]}},"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","example":"de","nullable":true},"group":{"description":"Group of the Column","type":"string","example":"system"}},"type":"object"},"ConvertedQuantityValue":{"title":"Converted quantity values","required":["originalValue","fromUnitId","convertedValues"],"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"},{"type":"array","items":[]}]}},"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"},"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"},"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"},"CustomAttributes":{"title":"CustomAttributes","description":"Custom attributes used mainly for the tree","required":["icon","tooltip","additionalIcons","key","additionalCssClasses"],"properties":{"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon"}],"nullable":true,"description":"Custom Icon"},"tooltip":{"description":"Custom Tooltip","type":"string","example":"\u003Cb\u003EMy Tooltip\u003C\/b\u003E","nullable":true},"additionalIcons":{"description":"AdditionalIcons","type":"array","items":{"type":"string","example":"some_other_icon"}},"key":{"description":"Custom Key\/Filename","type":"string","example":"my_custom_key","nullable":true},"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"},{"type":"array","items":[]}]}},"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","example":"data","nullable":true}},"type":"object"},"CustomMetadataVersion":{"title":"CustomMetadataVersion","required":["name","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en","nullable":true},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":"string","example":"data","nullable":true}},"type":"object"},"CustomSettings":{"title":"CustomSettings","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"fixedCustomSettings":{"oneOf":[{"$ref":"#\/components\/schemas\/FixedCustomSettings"}],"nullable":true,"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":[],"example":"{ imageWidth: 1280, imageHeight: 720 }"}},"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","type":"object","allOf":[{"$ref":"#\/components\/schemas\/DataObject"}]},"DataObjectPermissions":{"title":"Data Object Permissions","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","example":"default","nullable":true},"localizedView":{"description":"Localized View","type":"string","example":"default","nullable":true},"layouts":{"description":"Layouts","type":"string","example":"default","nullable":true}},"type":"object"}]},"DataObject":{"title":"DataObject","required":["key","className","type","published","hasChildren","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","index","objectData","allowInheritance","allowVariants","showVariants","hasPreview"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"allowVariants":{"description":"Variants allowed","type":"boolean","example":false},"showVariants":{"description":"Show variants","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"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},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}}},"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":"enum","enum":["object","variant"],"example":"object"}},"type":"object"},"DataObjectVersion":{"title":"DataObjectVersion","required":["modificationDate","path","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"},"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"},{"type":"array","items":[]}]}},"key":{"description":"key","type":"string","example":"key_of_the_property"},"data":{"description":"data","type":"mixed","example":"123","nullable":true},"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","example":"comma,separated,values","nullable":true},"predefinedName":{"description":"predefinedName","type":"string","example":"name of the predefined property","nullable":true},"description":{"description":"description","type":"string","example":"Description of the predefined property","nullable":true}},"type":"object"},"DeleteInfo":{"title":"DeleteInfo","required":["hasDependencies","canUseRecycleBin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"hasDependencies":{"description":"hasDependencies","type":"boolean","example":true},"canUseRecycleBin":{"description":"canUseRecycleBin","type":"boolean","example":true}},"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"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"integer"},"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"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or Role","type":"string","example":"admin","nullable":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"type":"integer","example":"2","nullable":true},"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"}}},"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"},"Document":{"title":"Document","required":[],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"customAttributes":{"$ref":"#\/components\/schemas\/CustomAttributes"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"\/path\/to\/asset.jpg"}},"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"},{"type":"array","items":[]}]}},"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","userOwner","userModification","locked","isLocked","creationDate","modificationDate","permissions"],"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"},"userOwner":{"description":"ID of owner","type":"integer","example":1},"userModification":{"description":"User that modified the element","type":"integer","example":1},"locked":{"description":"Locked","type":"string","example":"locked","nullable":true},"isLocked":{"description":"Is locked","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":"integer","example":221846400,"nullable":true},"modificationDate":{"description":"Modification date","type":"integer","example":327417600,"nullable":true}},"type":"object"},"ElementIcon":{"title":"ElementIcon","required":["type","value"],"properties":{"type":{"description":"Icon type","type":"enum","enum":["name","path"],"example":"path"},"value":{"description":"Icon value","type":"string","example":"\/path\/to\/icon"}},"type":"object"},"EmailDocumentParameters":{"title":"EmailDocumentParameters","required":["key","value"],"properties":{"key":{"description":"parameter key","type":"string","example":"some_parameter_key"},"value":{"description":"parameter value","type":"value","example":"some_parameter_value","nullable":true}},"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"},{"type":"array","items":[]}]}},"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","example":"from@pimcore.com","nullable":true},"to":{"description":"to","type":"string","example":"to@pimcore.com","nullable":true},"subject":{"description":"subject","type":"string","example":"E-Mail subject","nullable":true}},"type":"object"},"EmailLogEntryDetail":{"title":"EmailLogDetail","required":["bcc","cc","error"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/EmailLogEntry"},{"properties":{"bcc":{"description":"bcc","type":"string","example":"email@pimcore.com","nullable":true},"cc":{"description":"cc","type":"string","example":"email@pimcore.com","nullable":true},"error":{"description":"error","type":"string","example":"Some error occurred","nullable":true}},"type":"object"}]},"ObjectParameter":{"title":"EmailLogObjectParameterData","required":["name","value"],"properties":{"id":{"description":"id","type":"integer","example":1020},"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"},{"type":"array","items":[]}]}},"name":{"description":"name","type":"string","example":"myParameter"},"value":{"description":"value","type":"string","example":"Some value","nullable":true},"objectData":{"oneOf":[{"$ref":"#\/components\/schemas\/ObjectParameter"}],"nullable":true,"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"},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key of Field Collection","type":"string"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"group":{"description":"Group","type":"string","example":"Group Name","nullable":true},"name":{"description":"Name","type":"string","example":"Layout","nullable":true},"type":{"description":"Type","type":"string","nullable":true},"region":{"description":"Region","type":"string","nullable":true},"title":{"description":"Title","type":"string","nullable":true},"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":"array","items":[],"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":[],"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","type":"integer","example":50},"y":{"description":"y","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"},"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":[],"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":["key","type","config"],"properties":{"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"type":{"description":"Type","type":"string","example":"system.integer"},"group":{"description":"Group","type":"string","example":"system","nullable":true},"config":{"description":"Config","type":"array","items":{"type":"string"},"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}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\u0022key\u0022:\u0022id\u0022,\u0022direction\u0022: \u0022ASC\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"},{"type":"array","items":[]}]}},"key":{"description":"Key","type":"string","example":"id"},"group":{"description":"Group","type":"string","example":"system"},"sortable":{"description":"Sortable","type":"boolean","example":true},"editable":{"description":"Editable","type":"boolean","example":false},"exportable":{"description":"Exportable","type":"boolean","example":false},"localizable":{"description":"Localizable","type":"boolean","example":false},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":"string","example":"en","nullable":true},"value":{"description":"Value","type":"mixed","example":73,"nullable":true}},"type":"object"},"Configuration":{"title":"GridConfiguration","description":"Contains all data to configure a grid column","required":["id","name","description"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":"string","example":"My Configuration Description"}},"type":"object"},"DetailedConfiguration":{"title":"GridDetailedConfiguration","description":"Contains all data to configure a grid column","required":["name","description","shareGlobal","saveFilter","setAsFavorite","sharedUsers","sharedRoles","columns","filter","pageSize"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":"string","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":{"$ref":"#\/components\/schemas\/ColumnSchema"}},"filter":{"description":"filter","type":"array","items":{"$ref":"#\/components\/schemas\/Filter"}},"pageSize":{"description":"Page Size","type":"integer","example":42},"modificationDate":{"description":"Modification Date","type":"integer","example":1634025600,"nullable":true},"creationDate":{"description":"Creation Date","type":"integer","example":1634025600,"nullable":true},"ownerId":{"description":"ID of the owner","type":"integer","example":42,"nullable":true},"id":{"description":"ID of the configuration","type":"integer","example":42,"nullable":true}},"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"}]},"ImageData":{"title":"ImageData","properties":{"focalPoint":{"$ref":"#\/components\/schemas\/FocalPoint"}},"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"},"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 shoudl 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"},"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"},{"type":"array","items":[]}]}},"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","example":null,"nullable":true},"layout":{"description":"Layout","type":"string","example":null,"nullable":true},"region":{"description":"Region","type":"string","example":"center","nullable":true},"title":{"description":"Title","type":"string","example":"MyLayout","nullable":true},"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","example":"(float: left;)","nullable":true},"locked":{"description":"Locked","type":"boolean","example":false},"children":{"description":"Children","type":"array","items":[],"example":"[]"},"icon":{"oneOf":[{"$ref":"#\/components\/schemas\/ElementIcon"}],"nullable":true,"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"},"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"},{"type":"array","items":[]}]}},"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":[],"example":"Can be pretty much anything"},"userId":{"description":"User ID","type":"integer","example":1,"nullable":true},"userName":{"description":"Username","type":"string","example":"shaquille.oatmeal","nullable":true}},"type":"object"},"NoteType":{"title":"NoteType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"],"type":"object","allOf":[{"$ref":"#\/components\/schemas\/NotificationListItem"},{"properties":{"message":{"description":"message","type":"string","example":"Notification message","nullable":true},"payload":{"description":"payload","type":"string","example":"{\u0022key\u0022: \u0022value\u0022}","nullable":true},"attachmentType":{"description":"linked attachment type","type":"string","example":"object","nullable":true},"attachmentId":{"description":"linked attachment ID","type":"integer","example":3669,"nullable":true}},"type":"object"}]},"NotificationListItem":{"title":"NotificationListItem","required":["id","type","title","read","hasAttachment","sentDate","sender"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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","example":"Pimcore Admin","nullable":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"},{"type":"array","items":[]}]}},"key":{"description":"Key of Object Brick","type":"string"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"name":{"description":"Name","type":"string","example":"Layout","nullable":true},"type":{"description":"Type","type":"string","nullable":true},"region":{"description":"Region","type":"string","nullable":true},"title":{"description":"Title","type":"string","nullable":true},"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":"array","items":[],"example":"[]"}},"type":"object"},"PatchCustomMetadata":{"title":"PatchCustomMetadata","required":["name"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en","nullable":true},"data":{"description":"Data","type":"string","example":"data","nullable":true}},"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","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"},"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"},{"type":"array","items":[]}]}},"id":{"description":"Id","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"custom_metadata"},"description":{"description":"Description","type":"string","example":"A predefined metadata","nullable":true},"type":{"description":"Type","type":"string","example":"input"},"targetSubType":{"description":"Target sub type","type":"string","example":"input","nullable":true},"data":{"description":"Data","type":"mixed","example":"data","nullable":true},"config":{"description":"Config","type":"string","example":"config","nullable":true},"language":{"description":"Language","type":"string","example":"en","nullable":true},"group":{"description":"Group","type":"string","example":"group","nullable":true},"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"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"string","example":"alpha-numerical-value"},"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":"string","example":"Detailed description of the property","nullable":true},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":"string","example":"test","nullable":true},"config":{"description":"config","type":"string","example":"comma,separated,values","nullable":true},"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"},{"type":"array","items":[]}]}},"id":{"description":"ID","type":"string","example":"mm","nullable":true},"abbreviation":{"description":"Abbreviation","type":"string","example":"mm","nullable":true},"group":{"description":"Group","type":"string","example":null,"nullable":true},"longName":{"description":"Long Name","type":"string","example":"Millimeter","nullable":true},"baseUnit":{"description":"Base Unit","type":"string","example":"m","nullable":true},"reference":{"description":"Reference","type":"string","example":null,"nullable":true},"factor":{"description":"Factor","type":"number","format":"float","example":null,"nullable":true},"conversionOffset":{"description":"Conversion Offset","type":"number","format":"float","example":null,"nullable":true},"converter":{"description":"Converter","type":"string","example":null,"nullable":true}},"type":"object"},"ResetPassword":{"title":"ResetPassword","description":"Username","required":["username"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"}},"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","state","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":"list","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"},{"type":"array","items":[]}]}},"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","enum":["publish","delete"],"nullable":true},"version":{"description":"Version ID","type":"integer","example":987,"nullable":true},"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"},"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":"enum","enum":["document","html","text"],"example":"text"},"content":{"description":"email content","type":"string","example":"My email message","nullable":true},"documentPath":{"description":"path to the email document","type":"string","example":"\/path\/to\/document","nullable":true},"documentParameters":{"description":"email document parameters","type":"array","items":{"$ref":"#\/components\/schemas\/EmailDocumentParameters"}},"attachmentId":{"description":"id of the asset attachment","type":"integer","example":83,"nullable":true}},"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":"enum","enum":["asset","document","object"],"example":null,"nullable":true},"attachmentId":{"description":"ID of the attachment","type":"integer","example":83,"nullable":true}},"type":"object"},"SimpleUser":{"title":"Simple User","description":"A user with the most imported information.","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"username":{"description":"Name of the User","type":"string","example":"role"}},"type":"object"},"SimpleRole":{"title":"Simple User Role","description":"A user role which is a combination of permissions and settings.","required":["id","category"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the Role","type":"integer","example":"1"},"name":{"description":"Name of the Role","type":"string","example":"role"}},"type":"object"},"Site":{"title":"Site","required":["id","domains","domain"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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","example":1,"nullable":true},"rootPath":{"description":"Root path","type":"string","example":"\/","nullable":true}},"type":"object"},"SubmitAction":{"title":"SubmitAction","description":"Schema for submission of workflow action","required":["actionType","elementId","elementType","workflowName","transition","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","example":"{\u0022notes\u0022: \u0022Some note I want to write\u0022}"}},"type":"object"},"Tag":{"title":"Tag","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"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"}]},"Thumbnail":{"title":"Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"id","type":"string","example":"pimcore_system_treepreview"},"text":{"description":"text","type":"string","example":"original"}},"type":"object"},"ThumbnailCollection":{"title":"ThumbnailCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#\/components\/schemas\/Thumbnail"}}},"type":"object"},"Translation":{"title":"Translation","description":"Translation Scheme for API","required":["locale","keys"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"keys":{"description":"Keys","type":"array","items":{"type":"string","example":"not_your_typical_key"}}},"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"},{"type":"array","items":[]}]}},"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"},"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"}]},"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"],"properties":{"name":{"description":"Name of Folder or Role","type":"string","example":"admin","nullable":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"type":"integer","example":"2","nullable":true},"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"}}},"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","example":"data","nullable":true}},"type":"object"},"UpdateCustomSettings":{"title":"UpdateCustomSettings","required":["key","value"],"properties":{"key":{"description":"Key","type":"string","example":"my_custom_setting_key"},"value":{"description":"Value","type":"mixed","example":"data","nullable":true}},"type":"object"},"UpdateElementProperty":{"title":"UpdateDataProperty","required":["key","data","type","inheritable"],"properties":{"key":{"description":"key","type":"string","example":"Mister Proper"},"data":{"description":"data","type":"mixed","example":"123","nullable":true},"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","example":"Detailed description of the property","nullable":true},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":"string","example":"test","nullable":true},"config":{"description":"config","type":"string","example":"comma,separated,values","nullable":true},"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","example":666,"nullable":true},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":"string","enum":["publish","delete"],"nullable":true},"version":{"description":"Version ID","type":"integer","example":987,"nullable":true},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"UpdateVersion":{"title":"UpdateVersion","properties":{"public":{"description":"Public","type":"boolean","example":null,"nullable":true},"note":{"description":"Note","type":"string","example":null,"nullable":true}},"type":"object"},"UpdateUser":{"title":"User","description":"User Schema to update a User.","required":["active","classes","closeWarning","allowDirtyClose","contentLanguages","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationEnabled","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces"],"properties":{"email":{"description":"Email of the User","type":"string","example":"","nullable":true},"firstname":{"description":"Firstname of the User","type":"string","example":"","nullable":true},"lastname":{"description":"Lastname of the User","type":"string","example":"","nullable":true},"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"]},"closeWarning":{"type":"boolean","example":true},"allowDirtyClose":{"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"},"memorizeTabs":{"type":"boolean","example":true},"parentId":{"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]},"twoFactorAuthenticationEnabled":{"type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"welcomeScreen":{"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"}}},"type":"object"},"User":{"title":"User","description":"Contains all information about a user","required":["id","active","admin","classes","closeWarning","allowDirtyClose","contentLanguages","hasImage","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationEnabled","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","objectDependencies"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or User","type":"string","example":"admin","nullable":true},"email":{"description":"Email of the User","type":"string","example":"","nullable":true},"firstname":{"description":"Firstname of the User","type":"string","example":"","nullable":true},"lastname":{"description":"Lastname of the User","type":"string","example":"","nullable":true},"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"]},"closeWarning":{"type":"boolean","example":true},"allowDirtyClose":{"type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"hasImage":{"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"},"lastLogin":{"description":"Timestamp of the last login","type":"integer","example":"1718757677","nullable":true},"memorizeTabs":{"type":"boolean","example":true},"parentId":{"type":"integer","example":"2","nullable":true},"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]},"twoFactorAuthenticationEnabled":{"type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"welcomeScreen":{"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"}},"objectDependencies":{"$ref":"#\/components\/schemas\/ObjectDependencies"}},"type":"object"},"UserInformation":{"title":"User Information","description":"Information about the user","required":["username","permissions","isAdmin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":[]}]}},"username":{"description":"Username","type":"string","example":"admin"},"permissions":{"description":"Permissions","type":"array","items":{"type":"string","example":"clear_cache"}},"isAdmin":{"description":"If user is an admin user","type":"boolean","example":false}},"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"},{"type":"array","items":[]}]}},"key":{"description":"Key of the Permission","type":"string","example":"objects"},"category":{"description":"Category og the Permission","type":"string","example":"Datahub"}},"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"},{"type":"array","items":[]}]}},"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"},"scheduled":{"description":"scheduled","type":"integer","example":null,"nullable":true}},"type":"object"},"Dimensions":{"title":"VersionDimensions","properties":{"width":{"description":"width","type":"integer","example":1920,"nullable":true},"height":{"description":"height","type":"integer","example":1080,"nullable":true}},"type":"object"},"VersionUser":{"title":"VersionUser","properties":{"id":{"description":"ID","type":"integer","example":2,"nullable":true},"name":{"description":"name","type":"string","example":"John Doe","nullable":true}},"type":"object"},"Video":{"title":"Video","type":"object","allOf":[{"$ref":"#\/components\/schemas\/Asset"},{"properties":{"duration":{"description":"Duration","type":"number","format":"float","example":43560.5,"nullable":true},"width":{"description":"Width","type":"integer","example":1920,"nullable":true},"height":{"description":"Height","type":"integer","example":1080,"nullable":true},"imageThumbnailPath":{"description":"Path to Image Thumbnail","type":"string","example":"\/path\/to\/video\/imagethumbnail.jpg","nullable":true}},"type":"object"}]},"WorkflowDetails":{"title":"WorkflowDetails","required":["workflowName","workflowStatus","graph","allowedTransitions","globalActions"],"properties":{"workflowName":{"description":"workflowName","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"},"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"],"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"},"visibleInDetail":{"description":"visibleInDetail","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":"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":"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":"Properties","description":"Property operations to get\/update\/create\/delete properties"},{"name":"Role Management","description":"Role Management operations"},{"name":"Schedule","description":"Get schedules for an element"},{"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":"Workflows","description":"Workflows operations to get element workflow details"}]} \ No newline at end of file