{"openapi":"3.1.0","info":{"title":"Studio Backend API","description":"API for Studio generated by OpenApi Generator via zircote/swagger-php","license":{"name":"Pimcore Open Core License (POCL)","url":"https://github.com/pimcore/pimcore/blob/12.x/LICENSE.md"},"version":"0.14.19"},"servers":[{"url":"/","description":"Pimcore Studio Backend API"}],"paths":{"/pimcore-studio/api/assets/types":{"get":{"tags":["Assets"],"summary":"asset_get_types_summary","description":"asset_get_types_description","operationId":"asset_get_types","responses":{"200":{"description":"asset_get_types_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/AssetType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/batch-delete":{"delete":{"tags":["Assets"],"summary":"asset_batch_delete_summary","description":"asset_batch_delete_description","operationId":"asset_batch_delete","requestBody":{"content":{"application/json":{"schema":{"properties":{"ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"asset_batch_delete_created_response","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
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/clone/{parentId}":{"post":{"tags":["Assets"],"summary":"asset_clone_summary","description":"asset_clone_description","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":"asset_clone_success_response"},"201":{"description":"asset_clone_created_response","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
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/custom-settings":{"get":{"tags":["Assets"],"summary":"asset_custom_settings_get_by_id_summary","description":"asset_custom_settings_get_by_id_description","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":"asset_custom_settings_get_by_id_success_response","content":{"application/json":{"schema":{"properties":{"items":{"$ref":"#/components/schemas/CustomSettings"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_get_text_data_by_id_summary","description":"asset_get_text_data_by_id_description","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":"asset_get_text_data_by_id_success_response","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
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/document/download/custom":{"get":{"tags":["Assets"],"summary":"asset_document_download_custom_summary","description":"asset_document_download_custom_description","operationId":"asset_document_download_custom","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":false,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}}],"responses":{"200":{"description":"asset_document_download_custom_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/document/stream/custom":{"get":{"tags":["Assets"],"summary":"asset_document_stream_custom_summary","description":"asset_document_stream_custom_description","operationId":"asset_document_stream_custom","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":false,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"asset_document_stream_custom_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/document/stream/dynamic":{"get":{"tags":["Assets"],"summary":"asset_document_stream_dynamic_summary","description":"asset_document_stream_dynamic_description","operationId":"asset_document_stream_dynamic","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"config","in":"query","description":"A JSON encoded thumbnail configuration.","required":true,"schema":{"type":"string","example":"{\"alt\": \"\",\"cropPercent\": false,\"cropWidth\": 0,\"cropHeight\": 0,\"cropTop\": 0,\"cropLeft\": 0,\"thumbnail\": {\"width\": 200,\"height\": 200,\"interlace\": true,\"quality\": 90}}"}}],"responses":{"200":{"description":"asset_document_stream_dynamic_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_document_stream_preview_summary","description":"asset_document_stream_preview_description","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_document_stream_preview_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"202 - Not Completed
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/document/download/thumbnail/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"asset_document_download_by_thumbnail_summary","description":"asset_document_download_by_thumbnail_description","operationId":"asset_document_download_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}}],"responses":{"200":{"description":"asset_document_download_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/document/stream/thumbnail/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"asset_document_stream_by_thumbnail_summary","description":"asset_document_stream_by_thumbnail_description","operationId":"asset_document_stream_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page of the document","schema":{"type":"integer","example":1}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"asset_document_stream_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"application/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_download_zip_summary","description":"asset_download_zip_description","operationId":"asset_download_zip","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"asset_download_zip_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"delete":{"tags":["Assets"],"summary":"asset_delete_zip_summary","description":"asset_delete_zip_description","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
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_download_by_id_summary","description":"asset_download_by_id_description","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":"asset_download_by_id_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_export_zip_asset_summary","description":"asset_export_zip_asset_description","operationId":"asset_export_zip_asset","requestBody":{"content":{"application/json":{"schema":{"properties":{"assets":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"asset_export_zip_created_response","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
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
413 - Max File Size Exceeded
415 - Unsupported Media Type
422 - 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":"asset_export_zip_folder_summary","description":"asset_export_zip_folder_description","operationId":"asset_export_zip_folder","requestBody":{"content":{"application/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[83]},"filters":{"$ref":"#/components/schemas/ExportAllFilter"}},"type":"object"}}}},"responses":{"201":{"description":"asset_export_zip_created_response","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
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
413 - Max File Size Exceeded
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}":{"get":{"tags":["Assets"],"summary":"asset_get_by_id_summary","description":"asset_get_by_id_description","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":"asset_get_by_id_success_response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Image"},{"$ref":"#/components/schemas/AssetDocument"},{"$ref":"#/components/schemas/Audio"},{"$ref":"#/components/schemas/Video"},{"$ref":"#/components/schemas/Archive"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/AssetFolder"},{"$ref":"#/components/schemas/Unknown"}]}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"put":{"tags":["Assets"],"summary":"asset_update_by_id_summary","description":"asset_update_by_id_description","operationId":"asset_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"data":{"type":["string","null"]},"dataUri":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateCustomMetadata"}},"customSettings":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateCustomSettings"}},"properties":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateElementProperty"}},"image":{"oneOf":[{"$ref":"#/components/schemas/ImageData"},{"type":"null"}],"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"One of asset types","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Image"},{"$ref":"#/components/schemas/AssetDocument"},{"$ref":"#/components/schemas/Audio"},{"$ref":"#/components/schemas/Video"},{"$ref":"#/components/schemas/Archive"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/AssetFolder"},{"$ref":"#/components/schemas/Unknown"}]}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/grid/configuration/{configurationId}/delete":{"delete":{"tags":["Asset Grid"],"summary":"asset_delete_grid_configuration_by_configurationId_summary","description":"asset_delete_grid_configuration_by_configurationId_description","operationId":"asset_delete_grid_configuration_by_configurationId","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_get_available_grid_columns_summary","description":"asset_get_available_grid_columns_description","operationId":"asset_get_available_grid_columns","responses":{"200":{"description":"asset_get_available_grid_columns_success_response","content":{"application/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_get_grid_configuration_by_folderId_summary","description":"asset_get_grid_configuration_by_folderId_description","operationId":"asset_get_grid_configuration_by_folderId","parameters":[{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"configurationId","in":"query","description":"Configuration ID","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"asset_get_grid_configuration_by_folderId_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/grid/configurations":{"get":{"tags":["Asset Grid"],"summary":"asset_get_saved_grid_configurations_summary","description":"asset_get_saved_grid_configurations_description","operationId":"asset_get_saved_grid_configurations","responses":{"200":{"description":"asset_get_saved_grid_configurations_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/Configuration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_save_grid_configuration_description","description":"asset_save_grid_configuration_description","operationId":"asset_save_grid_configuration","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnSchema"}},"filter":{"oneOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"asset_save_grid_configuration_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_set_grid_configuration_as_favorite_summary","description":"asset_set_grid_configuration_as_favorite_description","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
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_update_grid_configuration_summary","description":"asset_update_grid_configuration_description","operationId":"asset_update_grid_configuration","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnSchema"}},"filter":{"oneOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"asset_update_grid_configuration_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_get_grid_summary","description":"asset_get_grid_description","operationId":"asset_get_grid","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId"],"properties":{"folderId":{"type":"integer","example":1},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"asset_get_grid_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
422 - 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":"asset_image_download_custom_summary","description":"asset_image_download_custom_description","operationId":"asset_image_download_custom","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"JPEG"}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":true,"schema":{"type":"string","enum":["resize","scaleByWidth","scaleByHeight"],"example":"scaleByWidth"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":80}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":300}}],"responses":{"200":{"description":"asset_image_download_custom_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_image_stream_custom_summary","description":"asset_image_stream_custom_description","operationId":"asset_image_stream_custom","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"mimeType","in":"query","description":"Mime type of downloaded image.","required":true,"schema":{"type":"string","enum":["JPEG","PNG"],"example":"PNG"}},{"name":"resizeMode","in":"query","description":"Resize mode of downloaded image.","required":true,"schema":{"type":"string","enum":["scaleByHeight","scaleByWidth","resize","none"],"example":"none"}},{"name":"width","in":"query","description":"Width of downloaded image","schema":{"type":"integer","example":140}},{"name":"height","in":"query","description":"Height of downloaded image","schema":{"type":"integer","example":140}},{"name":"quality","in":"query","description":"Quality of downloaded image","schema":{"type":"integer","example":85}},{"name":"dpi","in":"query","description":"Dpi of downloaded image","schema":{"type":"integer","example":72}},{"name":"contain","in":"query","description":"Contain","required":false,"schema":{"type":"boolean","example":false}},{"name":"frame","in":"query","description":"Frame","required":false,"schema":{"type":"boolean","example":false}},{"name":"cover","in":"query","description":"Cover","required":false,"schema":{"type":"boolean","example":false}},{"name":"forceResize","in":"query","description":"Force resize","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}}],"responses":{"200":{"description":"asset_image_stream_custom_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/image/stream/dynamic":{"get":{"tags":["Assets"],"summary":"asset_image_stream_dynamic_summary","description":"asset_image_stream_dynamic_description","operationId":"asset_image_stream_dynamic","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}},{"name":"config","in":"query","description":"A JSON encoded thumbnail configuration.","required":true,"schema":{"type":"string","example":"{\"alt\": \"\",\"cropPercent\": false,\"cropWidth\": 0,\"cropHeight\": 0,\"cropTop\": 0,\"cropLeft\": 0,\"thumbnail\": {\"width\": 200,\"height\": 200,\"interlace\": true,\"quality\": 90}}"}}],"responses":{"200":{"description":"asset_image_stream_dynamic_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_image_download_by_format_summary","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":"asset_image_download_by_format_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_image_stream_preview_summary","description":"asset_image_stream_preview_description","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":"asset_image_stream_preview_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/image/stream":{"get":{"tags":["Assets"],"summary":"asset_image_stream_summary","description":"asset_image_stream_description","operationId":"asset_image_stream","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"asset_image_stream_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_image_download_by_thumbnail_summary","description":"asset_image_download_by_thumbnail_description","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":"asset_image_download_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/image/stream/thumbnail/{thumbnailName}":{"get":{"tags":["Assets"],"summary":"asset_image_stream_by_thumbnail_summary","description":"asset_image_stream_by_thumbnail_description","operationId":"asset_image_stream_by_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the image","required":true,"schema":{"type":"integer","example":83}},{"name":"thumbnailName","in":"path","description":"Find asset by matching thumbnail name.","required":true,"schema":{"type":"string","example":"pimcore-system-treepreview"}},{"name":"cropPercent","in":"query","description":"","required":false,"schema":{"type":"boolean","example":false}},{"name":"cropWidth","in":"query","description":"CropWidth of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropHeight","in":"query","description":"CropHeight of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropTop","in":"query","description":"CropTop of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"cropLeft","in":"query","description":"CropLeft of image thumbnail","schema":{"type":"number","format":"float","example":0}},{"name":"mimeType","in":"query","description":"Mime type of steamed image.","required":false,"schema":{"type":"string","enum":["JPEG","PNG","source","original","print"],"example":"JPEG"}}],"responses":{"200":{"description":"asset_image_stream_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets":{"patch":{"tags":["Assets"],"summary":"asset_patch_by_id_summary","description":"asset_patch_by_id_description","operationId":"asset_patch_by_id","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["id"],"properties":{"id":{"description":"Asset ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PatchCustomMetadata"}}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"asset_patch_by_id_success_response"},"201":{"description":"asset_patch_by_id_created_response","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
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/folder":{"patch":{"tags":["Assets"],"summary":"asset_patch_folder_by_id_summary","description":"asset_patch_folder_by_id_description","operationId":"asset_patch_folder_by_id","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["folderId"],"properties":{"folderId":{"description":"Folder ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PatchCustomMetadata"}}},"type":"object"}},"filters":{"$ref":"#/components/schemas/ExportAllFilter"}},"type":"object"}}}},"responses":{"201":{"description":"asset_patch_by_id_created_response","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
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/{id}/thumbnail/clear":{"delete":{"tags":["Assets"],"summary":"asset_clear_thumbnail_summary","description":"asset_clear_thumbnail_description","operationId":"asset_clear_thumbnail","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/tree":{"get":{"tags":["Assets"],"summary":"asset_get_tree_summary","description":"asset_get_tree_description","operationId":"asset_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter assets by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"id = 69"}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"/path/to/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"asset_get_tree_success_description","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Image"},{"$ref":"#/components/schemas/AssetDocument"},{"$ref":"#/components/schemas/Audio"},{"$ref":"#/components/schemas/Video"},{"$ref":"#/components/schemas/Archive"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/AssetFolder"},{"$ref":"#/components/schemas/Unknown"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_add_summary","description":"asset_add_description","operationId":"asset_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the asset","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"File to upload","type":"string","format":"binary"},"assetType":{"description":"Type of the asset to create","type":["string","null"]}},"type":"object"}}}},"responses":{"200":{"description":"asset_add_success_response","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
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_upload_info_summary","description":"asset_upload_info_description","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":"asset_upload_info_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUploadInfo"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_replace_summary","description":"asset_replace_description","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":"asset_replace_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"new file name of the asset","type":"string","example":"image.jpg"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/add-zip/{parentId}":{"post":{"tags":["Assets"],"summary":"asset_upload_zip_summary","description":"asset_upload_zip_description","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":"asset_upload_zip_created_response","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
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_video_image_thumbnail_stream_summary","description":"asset_video_image_thumbnail_stream_description","operationId":"asset_video_image_thumbnail_stream","parameters":[{"name":"id","in":"path","description":"Id of the video","required":true,"schema":{"type":"integer","example":83}},{"name":"width","in":"query","description":"Width of the video image thumbnail","schema":{"type":"integer","example":265}},{"name":"height","in":"query","description":"Height of the video image thumbnail","schema":{"type":"integer","example":265}},{"name":"aspectRatio","in":"query","description":"Aspect ratio of the video image thumbnail","required":false,"schema":{"type":"boolean","example":false}},{"name":"frame","in":"query","description":"Frame of the video image thumbnail","required":false,"schema":{"type":"boolean","example":false}},{"name":"async","in":"query","description":"Generate the asset asynchronously","schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"asset_video_image_thumbnail_stream_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_video_download_by_thumbnail_summary","description":"asset_video_download_by_thumbnail_description","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":"asset_video_download_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"video/mp4":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - 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":"asset_video_stream_by_thumbnail_summary","description":"asset_video_stream_by_thumbnail_description","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":"asset_video_stream_by_thumbnail_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"example.jpg\""}}},"content":{"video/mp4":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/assets/video/types":{"get":{"tags":["Assets"],"summary":"asset_get_video_types_summary","description":"asset_get_video_types_description","operationId":"asset_get_video_types","responses":{"200":{"description":"asset_get_video_types_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/VideoType"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/login":{"post":{"tags":["Authorization"],"summary":"login_summary","description":"login_description","operationId":"login","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credentials"}}}},"responses":{"200":{"description":"login_success_response"},"401":{"description":"Invalid credentials Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCredentials"}}}},"default":{"description":"400 - Bad Request
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/logout":{"post":{"tags":["Authorization"],"summary":"logout_summary","description":"logout_description","operationId":"logout","responses":{"200":{"description":"logout_success_response"}}}},"/pimcore-studio/api/login/token":{"post":{"tags":["Authorization"],"summary":"login_token_summary","description":"login_token_description","operationId":"login_token","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationToken"}}}},"responses":{"200":{"description":"login_token_success_response"},"401":{"description":"Invalid credentials Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCredentials"}}}},"default":{"description":"400 - Bad Request
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/application-logger/list":{"post":{"tags":["Bundle Application Logger"],"summary":"bundle_application_logger_get_collection_summary","description":"bundle_application_logger_get_collection_description","operationId":"bundle_application_logger_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"key\":\"dateFrom\",\"type\":\"date\",\"filterValue\":{\"operator\": \"from\", \"value\": \"2025-06-25T10:00:00+02:00\"}},{\"key\":\"dateTo\",\"type\":\"date\",\"filterValue\":{\"operator\": \"to\", \"value\": \"2025-06-30T24:00:00+02:00\"}},{\"key\":\"priority\", \"type\":\"equals\", \"filterValue\": 2},{\"key\":\"pid\", \"type\":\"like\", \"filterValue\": 44}]"},"sortFilter":{"type":"object","example":"{\"key\":\"id\", \"direction\":\"DESC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_application_logger_get_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/BundleApplicationLoggerLogEntry"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/application-logger/components":{"get":{"tags":["Bundle Application Logger"],"summary":"bundle_application_logger_list_components_summary","description":"bundle_application_logger_list_components_description","operationId":"bundle_application_logger_list_components","responses":{"200":{"description":"bundle_application_logger_list_components_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"title":"Components","description":"Log components used in the ApplicationLogger.","type":"array","items":{"type":"string","example":"application"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/application-logger/priorities":{"get":{"tags":["Bundle Application Logger"],"summary":"bundle_application_logger_list_priorities_summary","description":"bundle_application_logger_list_priorities_description","operationId":"bundle_application_logger_list_priorities","responses":{"200":{"description":"bundle_application_logger_list_priorities_success_response","content":{"application/json":{"schema":{"required":["priorities"],"properties":{"priorities":{"title":"Log priority levels","description":"Log priority levels used in the ApplicationLogger.","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/drill-down-options":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_list_drill_down_options_summary","description":"custom_reports_list_drill_down_options_description","operationId":"custom_reports_list_drill_down_options","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","field"],"properties":{"name":{"type":["string","null"]},"field":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\"property\": \"count(*)\", \"type\":\"numeric\",\"operator\":\"lt\",\"value\":\"15\"}]"},"drillDownFilters":{"type":"object","example":"{\"field\":\"value\",\"anotherField\":\"anotherValue\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"custom_reports_list_drill_down_options_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsDrillDownOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/chart":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_chart_summary","description":"custom_reports_chart_description","operationId":"custom_reports_chart","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\"property\": \"count(*)\", \"type\":\"numeric\",\"operator\":\"lt\",\"value\":\"15\"}]"},"drillDownFilters":{"type":"object","example":"{\"field\":\"value\",\"anotherField\":\"anotherValue\"}"}},"type":"object"},"sortBy":{"description":"Sort by field.","type":"string","example":"id"},"sortOrder":{"description":"Sort order (ASC or DESC).","type":"string","example":"DESC"},"page":{"description":"Page of the report data","type":"integer","minimum":1,"example":1},"pageSize":{"description":"Page size of the report data","type":"integer","minimum":1,"example":"50"},"fields":{"description":"Fields to be included in the chart data. If not provided, all fields will be included.","type":"array","items":{"type":"string","example":"field1"}}},"type":"object"}}}},"responses":{"200":{"description":"custom_reports_chart_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsChartData"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/config/add":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_config_add_summary","description":"custom_reports_config_add_description","operationId":"custom_reports_config_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportAdd"}}}},"responses":{"200":{"description":"custom_reports_config_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/config/clone/{name}":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_config_clone_summary","description":"custom_reports_config_clone_description","operationId":"custom_reports_config_clone","parameters":[{"name":"name","in":"path","description":"Name of the report to clone","required":true,"schema":{"type":"string","example":"myOriginalReport"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportClone"}}}},"responses":{"200":{"description":"custom_reports_config_clone_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/column-config/{name}":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_column_config_list_summary","description":"custom_reports_column_config_list_description","operationId":"custom_reports_column_config_list","parameters":[{"name":"name","in":"path","description":"custom_reports_report_name_parameter","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportsDataSourceConfig"}}}},"responses":{"200":{"description":"custom_reports_column_config_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsColumnInformation"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/config/{name}":{"put":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_config_update_summary","description":"custom_reports_config_update_description","operationId":"custom_reports_config_update","parameters":[{"name":"name","in":"path","description":"custom_reports_report_name_parameter","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportUpdate"}}}},"responses":{"200":{"description":"custom_reports_config_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"delete":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_config_delete_summary","description":"custom_reports_config_delete_description","operationId":"custom_reports_config_delete","parameters":[{"name":"name","in":"path","description":"custom_reports_config_delete_name_parameter","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"responses":{"200":{"description":"custom_reports_config_delete_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/report/{name}":{"get":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_report_summary","operationId":"custom_reports_report","parameters":[{"name":"name","in":"path","description":"custom_reports_report_name_parameter","required":true,"schema":{"type":"string","example":"Quality_Attributes"}}],"responses":{"200":{"description":"custom_reports_report_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCustomReportsDetails"}}}},"default":{"description":"400 - Bad Request
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/tree/config":{"get":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_config_get_tree_summary","description":"custom_reports_config_get_tree_description","operationId":"custom_reports_config_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"custom_reports_get_tree_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsConfigurationTreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/export/csv":{"post":{"tags":["Bundle Custom Reports"],"summary":"custom_report_export_csv_summary","description":"custom_report_export_csv_description","operationId":"custom_report_export_csv","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"type":["string","null"]},"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\"property\": \"count(*)\", \"type\":\"numeric\",\"operator\":\"lt\",\"value\":\"15\"}]"},"drillDownFilters":{"type":"object","example":"{\"field\":\"value\",\"anotherField\":\"anotherValue\"}"}},"type":"object"},"sortBy":{"description":"Sort by field.","type":"string","example":"id"},"sortOrder":{"description":"Sort order (ASC or DESC).","type":"string","example":"DESC"},"page":{"description":"Page of the report data","type":"integer","minimum":1,"example":1},"pageSize":{"description":"Page size of the report data","type":"integer","minimum":1,"example":"50"},"includeHeaders":{"type":"boolean","example":false},"delimiter":{"type":"string","example":";"}},"type":"object"}}}},"responses":{"201":{"description":"custom_report_export_csv_created_response","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
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/custom-reports/tree":{"get":{"tags":["Bundle Custom Reports"],"summary":"custom_reports_get_tree_summary","description":"custom_reports_get_tree_description","operationId":"custom_reports_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"custom_reports_collection_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsTreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/add":{"post":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_add_summary","description":"bundle_seo_redirect_add_description","operationId":"bundle_seo_redirect_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleSeoRedirectAdd"}}}},"responses":{"200":{"description":"bundle_seo_redirect_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleSeoRedirect"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/cleanup":{"delete":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_cleanup_summary","description":"bundle_seo_redirect_cleanup_description","operationId":"bundle_seo_redirect_cleanup","responses":{"200":{"description":"bundle_seo_redirect_cleanup_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects":{"post":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirects_get_collection_summary","description":"bundle_seo_redirects_get_collection_description","operationId":"bundle_seo_redirects_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"type\":\"search\", \"filterValue\": \"https://www.some-site/old-url\"},{\"key\":\"source\", \"type\":\"url\", \"filterValue\": \"https://www.some-example\"},{\"key\":\"source\", \"type\":\"like\", \"filterValue\": \"en/news\"},{\"key\":\"target\", \"type\":\"equals\", \"filterValue\": \"en/news/new\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"priority\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_seo_redirects_get_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/BundleSeoRedirect"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/{id}":{"put":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_update_by_id_summary","description":"bundle_seo_redirect_update_by_id_description","operationId":"bundle_seo_redirect_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the redirect","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleSeoRedirectUpdate"}}}},"responses":{"200":{"description":"bundle_seo_redirect_update_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleSeoRedirect"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"delete":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_delete_summary","description":"bundle_seo_redirect_delete_description","operationId":"bundle_seo_redirect_delete","parameters":[{"name":"id","in":"path","description":"Id of the redirect","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_seo_redirect_delete_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/export":{"get":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirects_export_summary","description":"bundle_seo_redirects_export_description","operationId":"bundle_seo_redirects_export","responses":{"200":{"description":"bundle_seo_redirects_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"redirects.csv\""}}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/import":{"post":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirects_import_summary","description":"bundle_seo_redirects_import_description","operationId":"bundle_seo_redirects_import","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_seo_redirects_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleSeoRedirectImportStats"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/priorities":{"get":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_list_priorities_summary","description":"bundle_seo_redirect_list_priorities_description","operationId":"bundle_seo_redirect_list_priorities","responses":{"200":{"description":"bundle_seo_redirect_list_priorities_success_response","content":{"application/json":{"schema":{"required":["priorities"],"properties":{"priorities":{"title":"Redirect priority","description":"Redirect priority used in the PimcoreSeoBundle.","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/statuses":{"get":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_list_statuses_summary","description":"bundle_seo_redirect_list_statuses_description","operationId":"bundle_seo_redirect_list_statuses","responses":{"200":{"description":"bundle_seo_redirect_list_statuses_success_response","content":{"application/json":{"schema":{"required":["statuses"],"properties":{"statuses":{"title":"Redirect statuses","description":"List of redirect statuses used in the PimcoreSeoBundle.","type":"array","items":{"$ref":"#/components/schemas/BundleSeoRedirectStatus"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/seo/redirects/types":{"get":{"tags":["Bundle Seo"],"summary":"bundle_seo_redirect_list_types_summary","description":"bundle_seo_redirect_list_types_description","operationId":"bundle_seo_redirect_list_types","responses":{"200":{"description":"bundle_seo_redirect_list_types_success_response","content":{"application/json":{"schema":{"required":["types"],"properties":{"types":{"title":"Redirect types","description":"List of redirect types used in the PimcoreSeoBundle.","type":"array","items":{"type":"string","example":"path"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/available-visible-fields":{"get":{"tags":["Class Definition"],"summary":"class_get_available_visible_fields_summary","description":"class_get_available_visible_fields_description","operationId":"class_get_available_visible_fields","parameters":[{"name":"classNames","in":"query","description":"Comma-separated list of class names","required":false,"schema":{"type":"string","example":"Car,Manufacturer,News"}}],"responses":{"200":{"description":"class_get_available_visible_fields_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/AvailableVisibleField"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/collection":{"get":{"tags":["Class Definition"],"summary":"class_definition_collection_summary","description":"class_definition_collection_description","operationId":"class_definition_collection","responses":{"200":{"description":"class_definition_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/ClassDefinitionList"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/collection/creatable":{"get":{"tags":["Class Definition"],"summary":"class_definition_collection_creatable_summary","description":"class_definition_collection_creatable_description","operationId":"class_definition_collection_creatable","responses":{"200":{"description":"class_definition_collection_creatable_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/ClassDefinitionList"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/collection":{"get":{"tags":["Class Definition"],"summary":"class_custom_layout_collection_summary","description":"class_custom_layout_collection_description","operationId":"class_custom_layout_collection","parameters":[{"name":"classIds","in":"query","description":"Comma-separated list of class Ids","required":false,"schema":{"type":"string","example":"CAR,MA,CA"}}],"responses":{"200":{"description":"class_custom_layout_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/CustomLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/all-layouts":{"get":{"tags":["Class Definition"],"summary":"class_all_layout_collection_summary","description":"class_all_layout_collection_description","operationId":"class_all_layout_collection","responses":{"200":{"description":"class_all_layout_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/ClassLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/{customLayoutId}":{"get":{"tags":["Class Definition"],"summary":"class_custom_layout_get_summary","description":"class_custom_layout_get_description","operationId":"class_custom_layout_get","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_get_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_custom_layout_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayout"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"put":{"tags":["Class Definition"],"summary":"class_custom_layout_update_summary","description":"class_custom_layout_update_description","operationId":"class_custom_layout_update","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_update_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayoutUpdate"}}}},"responses":{"200":{"description":"class_custom_layout_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayout"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"post":{"tags":["Class Definition"],"summary":"class_custom_layout_create_summary","description":"class_custom_layout_create_description","operationId":"class_custom_layout_create","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_create_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayoutNew"}}}},"responses":{"200":{"description":"class_custom_layout_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayout"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"class_custom_layout_delete_summary","description":"class_custom_layout_delete_description","operationId":"class_custom_layout_delete","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_delete_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_custom_layout_delete_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/editor/collection/{objectId}":{"get":{"tags":["Class Definition"],"summary":"class_custom_layout_editor_collection_summary","description":"class_custom_layout_editor_collection_description","operationId":"class_custom_layout_editor_collection","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"class_custom_layout_editor_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/CustomLayoutCompact"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/export/{customLayoutId}":{"get":{"tags":["Class Definition"],"summary":"class_custom_layout_export_summary","description":"class_custom_layout_export_description","operationId":"class_custom_layout_export","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_export_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_custom_layout_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"custom_definition_CarToDo_export.json\""}}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/identifier-data/{classDefinitionId}":{"get":{"tags":["Class Definition"],"summary":"class_custom_layout_get_identifier_data_summary","description":"class_custom_layout_get_identifier_data_description","operationId":"class_custom_layout_get_identifier_data","parameters":[{"name":"classDefinitionId","in":"path","description":"Class definition unique identifier for custom layouts","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_custom_layout_get_identifier_data_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayoutIdentifierData"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/custom-layout/import/{customLayoutId}":{"post":{"tags":["Class Definition"],"summary":"class_custom_layout_import_summary","description":"class_custom_layout_import_description","operationId":"class_custom_layout_import","parameters":[{"name":"customLayoutId","in":"path","description":"class_custom_layout_import_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"class_custom_layout_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayout"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}/bricks":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_bricks_usages_summary","description":"class_definition_get_bricks_usages_description","operationId":"class_definition_get_bricks_usages","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_get_bricks_usages_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ClassDefinitionObjectBrickData"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/create":{"post":{"tags":["Class Definition"],"summary":"class_definition_create_summary","description":"class_definition_create_description","operationId":"class_definition_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClassDefinition"}}}},"responses":{"200":{"description":"class_definition_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayout"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_by_id_summary","description":"class_definition_get_by_id_description","operationId":"class_definition_get_by_id","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassDefinition"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"put":{"tags":["Class Definition"],"summary":"class_definition_update_summary","description":"class_definition_update_description","operationId":"class_definition_update","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassDefinitionUpdate"}}}},"responses":{"200":{"description":"class_definition_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassDefinition"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"class_definition_delete_summary","description":"class_definition_delete_description","operationId":"class_definition_delete","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_delete_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}/export":{"get":{"tags":["Class Definition"],"summary":"class_definition_export_summary","description":"class_definition_export_description","operationId":"class_definition_export","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"class_Car_export.json\""}}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/identifier-data":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_identifier_data_summary","description":"class_definition_get_identifier_data_description","operationId":"class_definition_get_identifier_data","responses":{"200":{"description":"class_definition_get_identifier_data_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassDefinitionIdentifierData"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}/import":{"post":{"tags":["Class Definition"],"summary":"class_definition_import_summary","description":"class_definition_import_description","operationId":"class_definition_import","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file with JSON encoded class definition configuration","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"class_definition_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassDefinition"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}/layout":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_layout_by_id_summary","description":"class_definition_get_layout_by_id_description","operationId":"class_definition_get_layout_by_id","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_get_layout_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Layout"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/detail/{id}/selected-visible-fields":{"get":{"tags":["Class Definition"],"summary":"class_get_selected_visible_fields_summary","description":"class_get_selected_visible_fields_description","operationId":"class_get_selected_visible_fields","parameters":[{"name":"id","in":"path","description":"Class definition unique identifier","required":true,"schema":{"type":"string","example":"CAR"}},{"name":"relationField","in":"query","description":"Relation field name for which the selected fields should be retrieved as dot notation.","required":false,"schema":{"type":"string","example":"myRelationField"}}],"responses":{"200":{"description":"class_get_selected_visible_fields_success_response","content":{"application/json":{"schema":{"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/class/definition/configuration-view/text-layout/preview":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_text_layout_preview_summary","description":"class_definition_get_text_layout_preview_description","operationId":"class_definition_get_text_layout_preview","parameters":[{"name":"className","in":"query","description":"Class definition name where layout is defined","required":true,"schema":{"type":"string","example":"Car"}},{"name":"path","in":"query","description":"Path to optional object to render the layout with","required":false,"schema":{"type":"string","example":"/cars/my-car"}},{"name":"renderingData","in":"query","description":"Optional dynamic data to be used for rendering the layout","required":false,"schema":{"type":"string","example":"
Some email HTML content
"}},"type":"object"}}}},"default":{"description":"400 - Bad RequestHello World
"}},"type":"object"}]},"CreateNote":{"title":"CreateNote","required":["title","description","type"],"properties":{"title":{"description":"title","type":"string","example":"Title of note"},"description":{"description":"description","type":"string","example":"Description of note"},"type":{"description":"type","type":"string","example":"Type of note"}},"type":"object"},"Credentials":{"title":"Credentials","description":"Credentials for authentication","required":["username","password"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"},"password":{"description":"Password","type":"string","example":"*****"}},"type":"object"},"CustomLayoutIdentifierData":{"title":"Custom Layout Identifier Data","required":["suggestedId","existingIds","existingNames"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"suggestedId":{"description":"Suggested unique ID for custom layout","type":"string","example":"custom_layout_1"},"existingIds":{"description":"Array of existing custom layout IDs","type":"array","items":{"type":"string"},"example":["custom_layout_1","custom_layout_2","custom_layout_3"]},"existingNames":{"description":"Array of existing custom layout names","type":"array","items":{"type":"string"},"example":["Custom Layout 1","Custom Layout 2","Custom Layout 3"]}},"type":"object"},"CustomLayout":{"title":"Custom layouts","required":["id","name","description","creationDate","modificationDate","userOwner","classId","default","layoutDefinition"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of custom layout","type":"string","example":"custom_layout_1"},"name":{"description":"Name","type":"string","example":"Custom Layout 1"},"description":{"description":"Description","type":"string","example":"This is a custom layout"},"creationDate":{"description":"Creation date timestamp","type":"integer","example":1633036800},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1633036800},"userOwner":{"description":"User id of owner","type":"integer","example":1},"classId":{"description":"Class id","type":"string","example":"Product"},"default":{"description":"Whether it is the default layout","type":"boolean","example":false},"layoutDefinition":{"oneOf":[{"$ref":"#/components/schemas/Layout","description":"Layout definitions"},{"type":"null"}],"description":"Layout definitions","type":"object"}},"type":"object"},"CustomLayoutCompact":{"title":"Custom layouts in compact format to be used for e.g. listings","required":["id","name","default"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of custom layout","type":"string","example":"custom_layout_1"},"name":{"description":"Name","type":"string","example":"Custom Layout 1"},"default":{"description":"Whether it is the default layout","type":"boolean","example":false}},"type":"object"},"CustomAttributes":{"title":"CustomAttributes","description":"Custom attributes used mainly for the tree","required":["icon","tooltip","additionalIcons","key","additionalCssClasses"],"properties":{"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Custom Icon"},{"type":"null"}],"description":"Custom Icon"},"tooltip":{"description":"Custom Tooltip","type":["string","null"],"example":"My Tooltip"},"additionalIcons":{"description":"AdditionalIcons","type":"array","items":{"type":"string","example":"some_other_icon"}},"key":{"description":"Custom Key/Filename","type":["string","null"],"example":"my_custom_key"},"additionalCssClasses":{"description":"Additional Css Classes","type":"array","items":{"type":"string","example":"my_custom_class"}}},"type":"object"},"CustomMetadata":{"title":"CustomMetadata","required":["name","language","type","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"}},"type":"object"},"CustomMetadataVersion":{"title":"CustomMetadataVersion","required":["name","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["string","null"],"example":"data"}},"type":"object"},"CustomSettings":{"title":"CustomSettings","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"fixedCustomSettings":{"oneOf":[{"$ref":"#/components/schemas/FixedCustomSettings","description":"fixed custom settings"},{"type":"null"}],"description":"fixed custom settings","example":"{ embeddedMetadata: { FileSize: 360 KiB }, checksum: b3685e8348e7ac4d30d0268f7e58902a }"},"dynamicCustomSettings":{"description":"dynamic custom settings - can be any key-value pair","type":"array","items":{"type":"object"},"example":"[{ imageWidth: 1280 }, { imageHeight: 720 }]"}},"type":"object"},"DashboardConfiguration":{"title":"Dashboard Configuration","required":["id","name","rows","ownerId","ownerUsername","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier for the dashboard","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name of the dashboard","type":"string","example":"My Dashboard"},"ownerId":{"description":"ID of the owner of the dashboard","type":"integer","example":1},"ownerUsername":{"description":"Username of the owner of the dashboard","type":"string","example":"john_doe"},"rows":{"description":"Number of rows in the dashboard","type":"array","items":{"$ref":"#/components/schemas/LayoutOption"}},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true},"shareGlobally":{"description":"If Dashboard is shared globally","type":"boolean","example":true},"sharedUserNames":{"description":"List of names the Dashboard is shared with","type":"array","items":{"type":"string"},"example":["jane_doe","max_mustermann"]},"sharedRoleNames":{"description":"List of roles the Dashboard is shared with","type":"array","items":{"type":"string"},"example":["jane_doe","max_mustermann"]},"menuShortcutGroup":{"description":"Name of the group in the Menu","type":["string","null"],"example":"My Dashboard"}},"type":"object"},"DashboardsWidgetConfig":{"title":"Dashboards Widget Config","required":["id","name","widgetType","icon","visualization"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"widgetType":{"description":"Widget Type","type":"string","example":"wysiwyg"},"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"visualization":{"description":"Visualization","type":["string","null"],"example":"table"}},"type":"object"},"DashboardsWidgetConfigConfiguration":{"title":"Dashboards Widget Config Configuration","required":["name","options"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name of the configuration","type":["string","null"],"example":"elementType"},"options":{"description":"Configuration options","type":"object","example":["asset"]}},"type":"object"},"DashboardsWidgetType":{"title":"Dashboards Widget Type","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"last_changes"}},"type":"object"},"CloneParameters":{"title":"Data Object Clone Parameters","required":["recursive","updateReferences"],"properties":{"recursive":{"description":"Recursive","type":"boolean","example":false},"updateReferences":{"description":"Update References","type":"boolean","example":false}},"type":"object"},"DataObjectFolder":{"title":"Data Object Folder","required":["hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DataObject"},{"properties":{"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false}},"type":"object"}]},"DataObjectPermissions":{"title":"Data Object Permissions","required":["save","unpublish","localizedEdit","localizedView"],"type":"object","allOf":[{"$ref":"#/components/schemas/Permissions"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true},"localizedEdit":{"description":"Localized Edit","type":["string","null"],"example":"default"},"localizedView":{"description":"Localized View","type":["string","null"],"example":"default"}},"type":"object"}]},"PreviewParameter":{"title":"Data Object Preview Parameters","required":["id"],"properties":{"id":{"description":"ID","type":"integer","example":83},"site":{"description":"Site","type":"integer","default":0,"example":1}},"type":"object"},"DataObjectDetail":{"title":"Data object with detail data","required":["objectData","inheritanceData","draftData","allowInheritance","showVariants","hasPreview","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DataObject"},{"properties":{"showVariants":{"description":"Show variants","type":"boolean","example":false},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}},"inheritanceData":{"description":"Inheritance object data","type":"object","example":{"fieldKey":{}}},"draftData":{"oneOf":[{"$ref":"#/components/schemas/DataObjectDraftData"},{"type":"null"}]}},"type":"object"}]},"DataObject":{"title":"DataObject","required":["key","className","type","published","hasChildren","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","index","childrenSortBy","childrenSortOrder","allowVariants"],"type":"object","allOf":[{"$ref":"#/components/schemas/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"key":{"description":"Key","type":"string","example":"Giulietta"},"className":{"description":"Class name","type":"string","example":"car"},"type":{"description":"Type","type":"string","example":"image"},"published":{"description":"Published","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"/path/to/dataObject"},"permissions":{"$ref":"#/components/schemas/DataObjectPermissions"},"index":{"description":"Custom index","type":"integer","example":0},"childrenSortBy":{"description":"Sort mode of children","type":"string","example":"index"},"childrenSortOrder":{"description":"Sort order of children","type":"string","example":"asc"},"allowVariants":{"description":"Allow variants","type":["boolean","null"],"example":false}},"type":"object"}]},"DataObjectAddParameters":{"title":"DataObjectAdd","required":["key","classId","type"],"properties":{"key":{"description":"Key","type":"string","example":"my_new_data_object"},"classId":{"description":"Class Id","type":"string","example":"data_object_class_id"},"type":{"description":"Type","type":"string","enum":["object","variant"],"example":"object"}},"type":"object"},"DataObjectDraftData":{"title":"DataObjectDraftData","required":["id","modificationDate","isAutoSave"],"properties":{"id":{"description":"ID","type":"integer","example":83},"modificationDate":{"description":"Modification date","type":"integer","example":1634025600},"isAutoSave":{"description":"Is auto save","type":"boolean","example":false}},"type":"object"},"DataObjectVersion":{"title":"DataObjectVersion","required":["allowInheritance","showVariants","hasPreview","hasWorkflowAvailable","key","type","hasChildren","fullPath","index","allowVariants","className","published","objectData"],"type":"object","allOf":[{"$ref":"#/components/schemas/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"showVariants":{"description":"Show variants","type":"boolean","example":false},"allowInheritance":{"description":"Inheritance allowed","type":"boolean","example":false},"hasPreview":{"description":"Has preview","type":"boolean","example":false},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"key":{"description":"Key","type":"string","example":"Giulietta"},"type":{"description":"Type","type":"string","example":"image"},"hasChildren":{"description":"Has children","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"/path/to/dataObject"},"index":{"description":"Custom index","type":"integer","example":0},"className":{"description":"Class name","type":["string","null"],"example":"car"},"published":{"description":"Published","type":["boolean","null"],"example":false},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}},"allowVariants":{"description":"Allow variants","type":["boolean","null"],"example":false},"properties":{"description":"Properties","type":"array","items":{"$ref":"#/components/schemas/ElementProperty"}}},"type":"object"}]},"ElementProperty":{"title":"DataProperty","required":["key","data","type","inheritable","inherited"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"key_of_the_property"},"data":{"description":"data","type":["mixed","null"],"example":"123"},"type":{"description":"type","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false},"inherited":{"description":"inherited","type":"boolean","example":false},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"predefinedName":{"description":"predefinedName","type":["string","null"],"example":"name of the predefined property"},"description":{"description":"description","type":["string","null"],"example":"Description of the predefined property"}},"type":"object"},"DeleteInfo":{"title":"DeleteInfo","required":["hasDependencies","canUseRecycleBin"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"hasDependencies":{"description":"hasDependencies","type":"boolean","example":true},"canUseRecycleBin":{"description":"canUseRecycleBin","type":"boolean","example":true}},"type":"object"},"DeltaItem":{"title":"Delta Item","description":"Translation delta item after merge","required":["key","deltaValues"],"properties":{"key":{"description":"Key of the translation","type":"string","example":"car"},"deltaValues":{"description":"List of translation deltas for the given key","type":"array","items":{"$ref":"#/components/schemas/TranslationDeltaValues"}}},"type":"object"},"Dependency":{"title":"Dependency","required":["id","path","type","subType","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":1020},"path":{"description":"path","type":"string","example":"text"},"type":{"description":"type","type":"string","example":"asset"},"subType":{"description":"subType","type":"string","example":"image"},"published":{"description":"published","type":"boolean","example":"true"}},"type":"object"},"UserDependency":{"title":"Dependency to an Object","description":"Dependency to an Object","required":["id","path","subtype"],"properties":{"id":{"description":"ID of the object","type":"integer","example":42},"path":{"description":"Path to the object","type":"string","example":"/path/to/object"},"subtype":{"description":"Subtype of the object","type":"string","example":"Car"}},"type":"object"},"DetailedRole":{"title":"Detailed User Role","description":"Contains all information about a role","required":["id","name","classes","parentId","permissions","docTypes","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or Role","type":["string","null"],"example":"admin"},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"docTypes":{"description":"List of document types for the role","type":"object","example":["1","2"]},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#/components/schemas/PerspectiveConfig"}}},"type":"object"},"DevError":{"title":"DevError","description":"Error with details for developers","required":["message","details"],"properties":{"message":{"description":"Message","type":"string","example":"I got a bad feeling about this"},"details":{"description":"Details","type":"string","example":"Search your feelings. (Stack trace)"}},"type":"object"},"DocType":{"title":"DocType","required":["id","name","type","group","controller","template","priority","creationDate","modificationDate","staticGeneratorEnabled","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"Default Page"},"type":{"description":"Type","type":"string","example":"page"},"group":{"description":"Group","type":["string","null"],"example":"Default"},"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\DefaultController::indexAction"},"template":{"description":"Template","type":["string","null"],"example":"@App/Resources/views/default.html.twig"},"priority":{"description":"Priority","type":"integer","example":0},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null},"staticGeneratorEnabled":{"description":"Static generator enabled","type":"boolean","example":false},"writeable":{"description":"Is writeable","type":"boolean","example":false}},"type":"object"},"DocTypeType":{"title":"DocType Type","required":["name","validTable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"page"},"validTable":{"description":"Valid table","type":"string","example":"page"},"childrenSupported":{"description":"Children supported","type":"boolean","example":false},"directRoute":{"description":"Direct route","type":"boolean","example":false},"predefinedDocumentTypes":{"description":"Predefined document types","type":"boolean","example":false},"translatable":{"description":"Translatable","type":"boolean","example":false},"translatableInheritance":{"description":"Translatable Inheritance","type":"boolean","example":false},"onlyPrintableChildren":{"description":"Only printable children","type":"boolean","example":false}},"type":"object"},"DocTypeAddParameters":{"title":"DocTypeAdd","required":["name","type"],"properties":{"name":{"description":"Name","type":"string","example":"New Document Type"},"type":{"description":"Type","type":"string","example":"page"}},"type":"object"},"DocTypeUpdateParameters":{"title":"DocTypeUpdate","required":["name","type","group","controller","template","priority","staticGeneratorEnabled"],"properties":{"name":{"description":"Name","type":"string","example":"My docType"},"type":{"description":"Type","type":"string","example":"page"},"group":{"description":"Group","type":["string","null"],"example":"Default"},"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\DefaultController::indexAction"},"template":{"description":"Template","type":["string","null"],"example":"@App/Resources/views/default.html.twig"},"priority":{"description":"Priority","type":"integer","example":0},"staticGeneratorEnabled":{"description":"Static generator enabled","type":"boolean","example":false}},"type":"object"},"Document":{"title":"Document","required":["fullPath","published","type","key","index","hasChildren","hasWorkflowWithPermissions","permissions","isSite","navigationExclude"],"type":"object","allOf":[{"$ref":"#/components/schemas/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"fullPath":{"description":"Full path","type":"string","example":"/path/to/document"},"published":{"description":"Published","type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"link"},"key":{"description":"Key","type":"string","example":"page.html"},"index":{"description":"Custom index","type":"integer","example":0},"hasChildren":{"description":"Has children","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"permissions":{"$ref":"#/components/schemas/DocumentPermissions"},"isSite":{"description":"Is document a site","type":"boolean","example":false},"navigationExclude":{"description":"Exclude document from navigation","type":"boolean","example":false}},"type":"object"}]},"DocumentCloneParameters":{"title":"Document Clone Parameters","required":["language","enableInheritance","recursive","updateReferences"],"properties":{"language":{"description":"Language for the new translation","type":["string","null"],"example":"en"},"enableInheritance":{"description":"Enable Inheritance","type":"boolean","example":false},"recursive":{"description":"Recursive","type":"boolean","example":false},"updateReferences":{"description":"Update References","type":"boolean","example":false}},"type":"object"},"DocumentController":{"title":"Document Controller","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"App\\Controller\\ContentController::indexAction"}},"type":"object"},"DocumentDetail":{"title":"Document Detail Data","required":["editableData","missingRequiredEditable","settingsData","draftData","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"editableData":{"description":"Document Editable Data","type":"object","example":{"editable":"value"}},"missingRequiredEditable":{"description":"Is missing required editable","type":"boolean","example":false},"settingsData":{"description":"Document Settings Data","type":"object","example":{"title":"Some Title","description":"Some Description","prettyUrl":"pretty/url","controller":"App\\Controller\\PageController","template":"@app/template.html.twig","contentMainDocumentId":123,"contentMainDocumentPath":"/path/to/main/document","supportsContentMain":false,"missingRequiredEditable":false,"staticGeneratorEnabled":false,"staticGeneratorLifetime":123456,"staticLastGenerated":1700000000,"url":"https://example.com/"}},"draftData":{"$ref":"#/components/schemas/PageSnippetDraftData"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false}},"type":"object"}]},"DocumentPermissions":{"title":"Document Permissions","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#/components/schemas/Permissions"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true}},"type":"object"}]},"DocumentTemplate":{"title":"Document Template","required":["path"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"path":{"description":"Path","type":"string","example":"@App/Resources/views/default.html.twig"}},"type":"object"},"DocumentTranslationLink":{"title":"Document Translation Link","required":["language","documentId"],"properties":{"language":{"description":"Language","type":"string","example":"en"},"documentId":{"description":"Document Id","type":"integer","example":83}},"type":"object"},"DocumentTranslationLinks":{"title":"Document Translation Links","required":["language"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"language":{"description":"Language","type":"string","example":"en"},"translationLinks":{"description":"Translation links","type":"array","items":{"$ref":"#/components/schemas/DocumentTranslationLink"}}},"type":"object"},"DocumentTranslationParent":{"title":"Document Translation Parent","required":["id","fullPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Document Id","type":"integer","example":83},"fullPath":{"description":"Document full path","type":"string","example":"/path/to/document"}},"type":"object"},"DocumentType":{"title":"Document Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"page"}},"type":"object"},"DocumentAddParameters":{"title":"DocumentAdd","required":["key","type","title","navigationName","docTypeId","template","translationsSourceId","language","inheritanceSourceId"],"properties":{"key":{"description":"Key","type":"string","example":"my_new_document"},"type":{"description":"Type","type":"string","example":"page"},"title":{"description":"Title","type":["string","null"],"example":"Some page title"},"navigationName":{"description":"Navigation name","type":["string","null"],"example":"Some navigation name"},"docTypeId":{"description":"Document type ID","type":["string","null"],"example":"page"},"template":{"description":"Document template","type":["string","null"],"example":"default"},"translationsSourceId":{"description":"Id of the base document for new translation","type":["integer","null"],"example":33},"language":{"description":"Document language when adding a translation","type":["string","null"],"example":"en"},"inheritanceSourceId":{"description":"Id of the base document for content","type":["integer","null"],"example":33}},"type":"object"},"DocumentVersion":{"title":"DocumentVersion","required":["modificationDate","path","published"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"modificationDate":{"description":"modification date","type":"integer","example":1712823182},"path":{"description":"path","type":"string","example":"/path/to/object"},"published":{"description":"published","type":"boolean","example":true}},"type":"object"},"Element":{"title":"Element","required":["id","parentId","path","icon","userOwner","userModification","locked","isLocked","creationDate","modificationDate","elementType"],"properties":{"id":{"description":"ID","type":"integer","example":83},"parentId":{"description":"ID of parent","type":"integer","example":1},"path":{"description":"path","type":"string","example":"/path/to/element"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"userOwner":{"description":"ID of owner","type":"integer","example":1},"userModification":{"description":"User that modified the element","type":["integer","null"],"example":1},"locked":{"description":"Locked","type":["string","null"],"example":"locked"},"isLocked":{"description":"Is locked","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":["integer","null"],"example":221846400},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":327417600},"elementType":{"description":"elementType","type":"string","example":"asset"}},"type":"object"},"LocationData":{"title":"Element Location Data","required":["widgetId","treeLevelData"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"widgetId":{"description":"Widget Id","type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"},"treeLevelData":{"description":"Tree level data","type":"array","items":{"$ref":"#/components/schemas/TreeLevelData"}}},"type":"object"},"ElementPath":{"title":"Element Path","required":["elementPath"],"properties":{"elementPath":{"description":"Element Path","type":"string","example":"path/to/element"}},"type":"object"},"ElementTreeWidgetConfig":{"title":"Element Tree Widget","required":["contextPermissions","elementType","rootFolder","showRoot","classes","pql","pageSize","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/WidgetConfig"},{"properties":{"contextPermissions":{"description":"Context Permissions","type":"object","example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}},"elementType":{"description":"Element Type","type":"string","example":"data-object"},"rootFolder":{"$ref":"#/components/schemas/RelatedElementData","description":"Data of root folder element"},"showRoot":{"description":"Show Root","type":"boolean","example":false},"classes":{"description":"Classes","type":"object","example":["CAR"]},"pql":{"description":"PQL","type":["string","null"],"example":null},"pageSize":{"description":"Page size","type":["integer","null"],"example":20},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"ElementUsage":{"title":"Element Usage","required":["data","hasHidden"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Data","type":"array","items":{"$ref":"#/components/schemas/ElementUsageItem"}},"hasHidden":{"description":"hasHidden","type":"boolean","example":"false"},"totalCount":{"description":"totalCount","type":"integer","example":"40"}},"type":"object"},"ElementUsageBaseItem":{"title":"Element Usage Base Item","required":["id","type"],"properties":{"id":{"description":"ID","type":"integer","example":83},"type":{"description":"type","type":"string","enum":["data-object","object","asset","document"],"example":"data-object"}},"type":"object"},"ElementUsageItem":{"title":"Element Usage Item","required":["id","type","path"],"type":"object","allOf":[{"$ref":"#/components/schemas/ElementUsageBaseItem"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":9},"type":{"description":"type","type":"string","example":"object"},"path":{"description":"path","type":"string","example":"/Product Data/Cars/jaguar/E-Type"}},"type":"object"}]},"ElementIcon":{"title":"ElementIcon","required":["type","value"],"properties":{"type":{"description":"Icon type","type":"string","enum":["name","path"],"example":"path"},"value":{"description":"Icon value","type":"string","example":"/path/to/icon"}},"type":"object"},"EmailSettingsData":{"title":"Email Settings Data","required":["subject","from","replyTo","to","cc","bcc"],"type":"object","allOf":[{"$ref":"#/components/schemas/SnippetSettingsData"},{"properties":{"subject":{"description":"Subject","type":"string","example":"Some subject"},"from":{"description":"From","type":"string","example":"some-sender@email"},"replyTo":{"description":"Reply to","type":"string","example":"some-reply@email"},"to":{"description":"To","type":"string","example":"some-receiver@email"},"cc":{"description":"CC","type":"string","example":"some-copy@email"},"bcc":{"description":"BCC","type":"string","example":"some-hidden-copy@email"}},"type":"object"}]},"EmailDocumentParameters":{"title":"EmailDocumentParameters","required":["key","value"],"properties":{"key":{"description":"parameter key","type":"string","example":"some_parameter_key"},"value":{"description":"parameter value","type":"mixed","example":"some_parameter_value","anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"null"}]}},"type":"object"},"EmailLogEntry":{"title":"EmailLog","required":["id","sentDate","hasHtmlLog","hasTextLog","hasError","from","to","subject"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":23},"sentDate":{"description":"sent date","type":"integer","example":1707312457},"hasHtmlLog":{"description":"HTML log exists","type":"boolean","example":true},"hasTextLog":{"description":"Text log exists","type":"boolean","example":true},"hasError":{"description":"Error occurred","type":"boolean","example":true},"from":{"description":"from","type":["string","null"],"example":"from@pimcore.com"},"to":{"description":"to","type":["string","null"],"example":"to@pimcore.com"},"subject":{"description":"subject","type":["string","null"],"example":"E-Mail subject"}},"type":"object"},"EmailLogEntryDetail":{"title":"EmailLogDetail","required":["bcc","cc","error"],"type":"object","allOf":[{"$ref":"#/components/schemas/EmailLogEntry"},{"properties":{"bcc":{"description":"bcc","type":["string","null"],"example":"email@pimcore.com"},"cc":{"description":"cc","type":["string","null"],"example":"email@pimcore.com"},"error":{"description":"error","type":["string","null"],"example":"Some error occurred"}},"type":"object"}]},"ObjectParameter":{"title":"EmailLogObjectParameterData","required":["id","type","class","path"],"properties":{"id":{"description":"id","type":"integer","example":1020},"elementType":{"description":"elementType","type":"string","example":"object"},"type":{"description":"type","type":"string","example":"object"},"class":{"description":"class","type":"string","example":"AppBundle\\Model\\MyObject"},"path":{"description":"path","type":"string","example":"/path/to/object"}},"type":"object"},"EmailLogEntryParameter":{"title":"EmailLogParameters","required":["name","value","objectData"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"name","type":"string","example":"myParameter"},"value":{"description":"value","type":["string","null"],"example":"Some value"},"objectData":{"oneOf":[{"$ref":"#/components/schemas/ObjectParameter","description":"data for object parameters"},{"type":"null"}],"description":"data for object parameters"}},"type":"object"},"Error":{"title":"Error","description":"Bad credentials or missing token, bad request, method not allowed, etc.","required":["message"],"properties":{"message":{"description":"Message","type":"string","example":"I am an error message"}},"type":"object"},"ExportAllFilter":{"title":"Export All Filter","description":"Contains all data that is needed to get all the data for the column.","required":["columnFilters","sortFilter"],"properties":{"columnFilters":{"description":"Column Filter","type":"object","example":"[{\"key\":\"name\",\"type\": \"metadata.object\",\"filterValue\": 1, \"locale\":\"de\"}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\"key\":\"id\",\"direction\": \"ASC\"}"}},"type":"object"},"FieldCollectionConfig":{"title":"Field Collection Configuration","required":["key","title"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"MyFieldCollection"},"title":{"description":"Title","type":"string","example":"My Field Collection"}},"type":"object"},"FieldCollectionDetail":{"title":"Field Collection Detail","required":["key","title","group","parentClass","implementsInterfaces","blockedVarsForExport","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"MyFieldCollection"},"title":{"description":"Title","type":["string","null"],"example":"My Field Collection"},"group":{"description":"Group","type":["string","null"],"example":"system"},"parentClass":{"description":"Namespace of parent class","type":["string","null"],"example":"App\\Model\\DataObject\\FieldCollection"},"implementsInterfaces":{"description":"Interface implementations","type":["string","null"],"example":"App\\Model\\DataObject\\Interface"},"blockedVarsForExport":{"description":"Blocked variables for export","type":"array","items":{"type":"string"},"example":[]},"isWriteable":{"description":"Whether the field collection definition can be written to","type":"boolean","example":true}},"type":"object"},"FieldCollectionLayoutDefinition":{"title":"Field Collection Layout Definition","required":["key","title","width","height","collapsible","collapsed","datatype","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of Field Collection","type":"string","example":"my_field_collection"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"group":{"description":"Group","type":["string","null"],"example":"Group Name"},"name":{"description":"Name","type":["string","null"],"example":"Layout"},"type":{"description":"Type","type":["string","null"],"example":"object"},"region":{"description":"Region","type":["string","null"],"example":"main"},"title":{"description":"Title","type":["string","null"],"example":"My Field Collection"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"collapsed","type":"boolean","example":false},"children":{"description":"Children","type":"object","example":[]}},"type":"object"},"FieldCollectionTreeNodeFolder":{"title":"Field Collection Tree Node Folder","required":["key","title","icon","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of folder with group_ prefix","type":"string","example":"group_News"},"name":{"description":"Group name","type":"string","example":"News"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group","type":"string","example":"News"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#/components/schemas/FieldCollectionTreeNode"}}},"type":"object"},"FieldCollectionTreeNode":{"title":"Field Collection Tree Node Item","required":["key","name","icon","group"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of field collection","type":"string","example":"myCollection"},"name":{"description":"Name","type":"string","example":"My Collection"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group name","type":["string","null"],"example":"News"}},"type":"object"},"FieldCollectionUsageData":{"title":"Field Collection Usage Data","required":["class","field"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"class":{"description":"Name of the class using the field collection","type":"string","example":"Car"},"field":{"description":"Name of the field in the class","type":"string","example":"myFieldCollection"}},"type":"object"},"FieldByType":{"title":"Field key by type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Field key","type":"string","example":"car"}},"type":"object"},"FixedCustomSettings":{"title":"FixedCustomSettings","required":["embeddedMetadata","embeddedMetadataExtracted"],"properties":{"embeddedMetadata":{"description":"embedded meta data of the asset - array of any key-value pairs","type":"array","items":{"type":"object"},"example":"{ FileSize: \"265 KiB\", MIMEType: \"image/jpeg\" }"},"embeddedMetadataExtracted":{"description":"flag to indicate if the embedded meta data has been extracted from the asset","type":"boolean","example":true}},"type":"object"},"FocalPoint":{"title":"FocalPoint","required":["x","y"],"properties":{"x":{"description":"x Coordinate of FocalPoint","type":"integer","example":50},"y":{"description":"y Coordinate of FocalPoint","type":"integer","example":50}},"type":"object"},"FolderData":{"title":"Folder Data","description":"Folder Data Scheme for API","required":["folderName"],"properties":{"folderName":{"description":"Folder Name","type":"string","example":"Awesome stuff inside"}},"type":"object"},"PortalEngineWizardFormat":{"title":"Format for Wizard","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the format configuration","type":"string","example":"portal_default"},"name":{"description":"Display name of the format configuration","type":"string","example":"Portal Default"}},"type":"object"},"GdprDataProvider":{"title":"GDPR Data Provider","description":"GDPR Data Extractor search source(e.g., \"Data Objects\", \"Pimcore user\").","required":["key","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Unique key of the provider","type":"string","example":"data_objects"},"label":{"description":"Label of the provider","type":"string","example":"Data Objects"}},"type":"object"},"GdprDataRow":{"title":"GDPR Data Row","description":"GDPR Data Row","required":["data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Data row values","type":"object"}},"type":"object"},"SearchTerms":{"title":"GDPR Search Terms","description":"Object containing the values to search for. All fields are optional.","properties":{"id":{"description":"The ID to search for.","type":["integer","null"],"example":3},"firstname":{"description":"The first name to search for.","type":["string","null"],"example":"John"},"lastname":{"description":"The last name to search for.","type":["string","null"],"example":"Doe"},"email":{"description":"The email address to search for.","type":["string","null"],"example":"john.doe@example.com"}},"type":"object"},"GlobalAction":{"title":"GlobalAction","required":["name","label","iconCls","objectLayout","notes"],"properties":{"name":{"description":"name","type":"string","example":"start_workflow"},"label":{"description":"label","type":"string","example":"Start Workflow"},"iconCls":{"description":"iconCls","type":"string","example":"pimcore_workflow_start"},"objectLayout":{"description":"objectLayout","type":"boolean","example":false},"notes":{"description":"notes","type":"array","items":{"type":"object"},"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Column":{"title":"Grid Column Request","description":"Contains all data that is needed to get all the data for the column.","required":["type"],"properties":{"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"system.id"},"group":{"description":"Group","type":["array","null"],"items":{"type":"string"},"example":["system"]},"config":{"description":"Config","type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/AdvancedColumnConfig"}]},"example":{"key":"value"}}},"type":"object"},"Filter":{"title":"Grid Filter","description":"Contains all data that is needed to get all the data for the column.","required":["page","pageSize","includeDescendants"],"properties":{"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":50},"includeDescendants":{"description":"Include Descendant Items","type":"boolean","example":false},"columnFilters":{"description":"Column Filter","type":"object","example":"[{\"key\":\"name\",\"type\": \"metadata.object\",\"filterValue\": 1, \"locale\":\"de\"}]"},"sortFilter":{"description":"Sort Filter","type":"object","example":"{\"key\":\"id\",\"direction\": \"ASC\", \"locale\": \"en\"}"}},"type":"object"},"ColumnConfiguration":{"title":"GridColumnConfiguration","description":"Contains all data to configure a grid column","required":["key","group","sortable","editable","localizable","type","config"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"id"},"group":{"description":"Define the group structure","type":"object","example":["system","id"]},"sortable":{"description":"Sortable","type":"boolean","example":true},"editable":{"description":"Editable","type":"boolean","example":false},"exportable":{"description":"Exportable","type":"boolean","example":false},"filterable":{"description":"Filterable","type":"boolean","example":false},"localizable":{"description":"Localizable","type":"boolean","example":false},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"integer"},"frontendType":{"description":"Frontend Type","type":"string","example":"integer"},"config":{"description":"Config","type":"object","example":{"key":"value"}}},"type":"object"},"ColumnData":{"title":"GridColumnData","properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"id"},"locale":{"description":"Locale","type":["string","null"],"example":"en"},"value":{"description":"Value","type":["mixed","null"],"example":73},"fieldType":{"description":"Field Type of the column","type":["string","null"],"example":"input"},"inheritance":{"description":"inheritance","type":["object","null"],"example":{"objectId":42,"inInherited":true}}},"type":"object"},"Configuration":{"title":"GridConfiguration","description":"Contains all data to configure a grid column","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":["string","null"],"example":"My Configuration Description"}},"type":"object"},"DetailedConfiguration":{"title":"GridDetailedConfiguration","description":"Contains all data to configure a grid column","required":["name","shareGlobal","saveFilter","setAsFavorite","sharedUsers","sharedRoles","columns","filter","pageSize"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"My Configuration"},"description":{"description":"Description","type":["string","null"],"example":"My Configuration Description"},"shareGlobal":{"description":"shareGlobal","type":"boolean","example":false},"saveFilter":{"description":"saveFilter","type":"boolean","example":false},"setAsFavorite":{"description":"setAsFavorite","type":"boolean","example":false},"sharedUsers":{"description":"sharedUsers","type":"object","example":[42,1337]},"sharedRoles":{"description":"sharedRoles","type":"object","example":[42,1337]},"columns":{"description":"columns","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ColumnSchema"},{"$ref":"#/components/schemas/Column"}]}},"filter":{"description":"filter","type":"array","items":{"$ref":"#/components/schemas/Filter"}},"pageSize":{"description":"Page Size","type":"integer","example":42},"modificationDate":{"description":"Modification Date","type":["integer","null"],"example":1634025600},"creationDate":{"description":"Creation Date","type":["integer","null"],"example":1634025600},"ownerId":{"description":"ID of the owner","type":["integer","null"],"example":42},"id":{"description":"ID of the configuration","type":["integer","null"],"example":42}},"type":"object"},"HardlinkSettingsData":{"title":"Hardlink settings data","required":["sourceId","propertiesFromSource","childrenFromSource"],"properties":{"sourceId":{"description":"Source ID","type":["integer","null"],"example":83},"propertiesFromSource":{"description":"Properties from source","type":"boolean","example":true},"childrenFromSource":{"description":"Children from source","type":"boolean","example":false},"sourcePath":{"description":"Source path","type":["string","null"],"example":"/path/to/source"}},"type":"object"},"Image":{"title":"Image","required":["format","width","height","isVectorGraphic","isAnimated","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#/components/schemas/Asset"},{"properties":{"format":{"description":"Format","type":"string","example":"muhFormat"},"width":{"description":"width","type":"integer","example":666},"height":{"description":"height","type":"integer","example":333},"isVectorGraphic":{"description":"is vector graphic","type":"boolean","example":false},"isAnimated":{"description":"is animated","type":"boolean","example":false},"imageThumbnailPath":{"description":"path to thumbnail","type":"string","example":"/path/to/element/hulk-smash.jpg"}},"type":"object"}]},"ImageThumbnailConfigDetail":{"title":"Image Thumbnail Config Detail","required":["settings","writeable","medias"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"settings":{"$ref":"#/components/schemas/ImageThumbnailSettings","description":"Thumbnail settings"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"medias":{"description":"Media query configurations with transformation items","type":"object","example":{"default":[{"method":"cover","arguments":{"width":1920,"height":600,"positioning":"center","forceResize":true}}]}}},"type":"object"},"ImageThumbnailSettings":{"title":"Image Thumbnail Settings","required":["name","description","group","format","quality","highResolution","preserveColor","forceProcessICCProfiles","preserveMetaData","rasterizeSVG","useCropBox","downloadable","modificationDate","creationDate","filenameSuffix","preserveAnimation"],"properties":{"name":{"description":"Thumbnail name","type":"string","example":"portalCarousel"},"description":{"description":"Thumbnail description","type":["string","null"],"example":""},"group":{"description":"Thumbnail group","type":["string","null"],"example":"Areas"},"format":{"description":"Output format","type":"string","example":"SOURCE"},"quality":{"description":"Quality setting","type":"integer","example":85},"highResolution":{"description":"High resolution factor","type":["number","null"],"example":0},"preserveColor":{"description":"Preserve color profile","type":"boolean","example":false},"forceProcessICCProfiles":{"description":"Force process ICC profiles","type":"boolean","example":false},"preserveMetaData":{"description":"Preserve meta data","type":"boolean","example":false},"rasterizeSVG":{"description":"Rasterize SVG","type":"boolean","example":false},"useCropBox":{"description":"Use crop box","type":"boolean","example":false},"downloadable":{"description":"Is downloadable","type":"boolean","example":true},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1755073298},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1565355190},"filenameSuffix":{"description":"Filename suffix","type":["string","null"],"example":null},"preserveAnimation":{"description":"Preserve animation","type":"boolean","example":false}},"type":"object"},"ImageData":{"title":"ImageData","properties":{"focalPoint":{"$ref":"#/components/schemas/FocalPoint","description":"focalPoint"}},"type":"object"},"IndexStat":{"title":"Index Statistic","required":["name","items","size"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"pimcore_root"},"items":{"description":"Number of items in index","type":"integer","example":100},"size":{"description":"Size","type":"number","format":"float","example":123.45}},"type":"object"},"InvalidCredentials":{"title":"Invalid Credentials","description":"Invalid credentials after login attempt","required":["error"],"properties":{"error":{"description":"Error","type":"string","example":"Invalid credentials"}},"type":"object"},"JsonExport":{"title":"JSON Export","required":["json","fileName"],"properties":{"json":{"description":"JSON encoded export data","type":"string"},"fileName":{"description":"Suggested file name for download","type":"string","example":"export.json"}},"type":"object"},"JobRun":{"title":"JobRun","required":["id","ownerId","state","executionContext","totalElements","currentMessage","jobRunChildId","currentStep","totalSteps","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"ownerId":{"description":"Owner ID","type":["integer","null"],"example":123},"state":{"description":"State","type":"string","example":"running"},"executionContext":{"description":"Execution context","type":"string","example":"studio_stop_on_error"},"totalElements":{"description":"Total elements","type":"integer","example":0},"currentMessage":{"description":"Current Message og the last Event","type":"string","example":"Message"},"jobRunChildId":{"description":"Id of the child Job run","type":["integer","null"],"example":55},"currentStep":{"description":"Current Step of a running Job","type":["integer","null"],"example":0},"totalSteps":{"description":"Number of total Steps of a running Job","type":["integer","null"],"example":0},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null}},"type":"object"},"KeyBinding":{"title":"Key Binding for a User","description":"Key Binding for a User","required":["key","action","ctrl","alt","shift"],"properties":{"key":{"description":"ASCII Code for a key on the Keyboard","type":"integer","example":"83"},"action":{"description":"The action the key binding should execute","type":"string","example":"save"},"ctrl":{"description":"If CTRL key should be pressed","type":"boolean","example":"true"},"alt":{"description":"If ALT key should be pressed","type":"boolean","example":"true"},"shift":{"description":"If SHIFT key should be pressed","type":"boolean","example":"true"}},"type":"object"},"LastChangesEntry":{"title":"Last Changes Entry Data","required":["date","dateText","assets","dataObjects","documents"],"properties":{"date":{"description":"Modification Date","type":"integer","example":327417600},"dateText":{"description":"Modification Date Text","type":"string","example":"2025-07-24T12:00:00+00:00"},"assets":{"description":"Number of assets objects changed","type":"integer","example":0},"dataObjects":{"description":"Number of data objects changed","type":"integer","example":0},"documents":{"description":"Number of documents objects changed","type":"integer","example":0}},"type":"object"},"LastChangesWidgetConfig":{"title":"Last Changes Widget Config","required":["color","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true},"showAssets":{"description":"Show Assets","type":"boolean","example":true},"showDataObjects":{"description":"Show Data Objects","type":"boolean","example":true},"showDocuments":{"description":"Show Documents","type":"boolean","example":true}},"type":"object"}]},"Layout":{"title":"Layout","required":["name","dataType","fieldType","type","layout","region","title","width","height","collapsible","collapsed","bodyStyle","locked","children","icon","labelAlign","labelWidth","border"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"pimcore_root"},"dataType":{"description":"Data Type","type":"string","example":"layout"},"fieldType":{"description":"Field Type","type":"string","example":"panel"},"type":{"description":"Type","type":["string","null"],"example":null},"layout":{"description":"Layout","type":["string","null"],"example":null},"region":{"description":"Region","type":["string","null"],"example":"center"},"title":{"description":"Title","type":["string","null"],"example":"MyLayout"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"Collapsed","type":"boolean","example":false},"bodyStyle":{"description":"Body Style","type":["string","null"],"example":"(float: left;)"},"locked":{"description":"Locked","type":"boolean","example":false},"children":{"description":"Children","type":"array","items":{"type":"object"},"example":"[{id: 1}]"},"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"labelAlign":{"description":"Label Align","type":"string","example":"left"},"labelWidth":{"description":"Label Width","type":"integer","example":100},"border":{"description":"Border","type":"boolean","example":false}},"type":"object"},"LayoutOption":{"title":"Layout Option","required":["layoutId","rows","columns","items"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"layoutId":{"description":"Unique identifier for the layout","type":"string","example":"dashboard-layout-1"},"rows":{"description":"Number of rows in the layout","type":"integer","example":4},"columns":{"description":"Number of columns in the layout","type":"integer","example":3},"items":{"description":"Array of layout items","type":"array","items":{"$ref":"#/components/schemas/LayoutItem"}}},"type":"object"},"LayoutItem":{"title":"Layout item","required":["id","colSpan","rowSpan","colStart","rowStart","widget"],"properties":{"id":{"description":"Unique identifier for the layout item","type":"integer","example":1},"colSpan":{"description":"Number of columns the item spans","type":"integer","example":2},"rowSpan":{"description":"Number of rows the item spans","type":"integer","example":1},"colStart":{"description":"Column index where the item starts","type":"integer","example":0},"rowStart":{"description":"Row index where the item starts","type":"integer","example":0},"widget":{"oneOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig","description":"Widget for this position"},{"type":"null"}],"description":"Widget for this position"}},"type":"object"},"LinkSettingsData":{"title":"Link Settings Data","required":["internal","internalType","direct","linkType","href","rawHref"],"properties":{"internal":{"description":"Internal ID","type":["integer","null"],"example":83},"internalType":{"description":"Internal type","type":["string","null"],"example":"asset"},"direct":{"description":"Direct","type":"string","example":"/path/to/asset"},"linkType":{"description":"Link type","type":"string","example":"direct"},"href":{"description":"Href","type":"string","example":"/path/to/asset"},"rawHref":{"description":"Raw Href","type":"string","example":"/some/raw/href"}},"type":"object"},"Note":{"title":"Note","required":["id","type","cId","cType","cPath","date","title","description","locked","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":666},"type":{"description":"type","type":"string","example":"Type of note"},"cId":{"description":"Id of element","type":"integer","example":667},"cType":{"description":"Type of element","type":"string","example":"asset"},"cPath":{"description":"Path of element","type":"string","example":"/path/to/element"},"date":{"description":"Creation date of note","type":"integer","example":1634025600},"title":{"description":"title","type":"string","example":"Title of note"},"description":{"description":"description","type":"string","example":"This is a description"},"locked":{"description":"Locked","type":"boolean","example":false},"data":{"description":"Data of note","type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"example":"Can be pretty much anything"},"userId":{"description":"User ID","type":["integer","null"],"example":1},"userName":{"description":"Username","type":["string","null"],"example":"shaquille.oatmeal"}},"type":"object"},"NoteType":{"title":"NoteType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"info"}},"type":"object"},"NoteTypeCollection":{"title":"NoteTypeCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#/components/schemas/NoteType"}}},"type":"object"},"Notification":{"title":"Notification","required":["message","payload","attachmentType","attachmentId","attachmentFullPath"],"type":"object","allOf":[{"$ref":"#/components/schemas/NotificationListItem"},{"properties":{"message":{"description":"message","type":["string","null"],"example":"Notification message"},"payload":{"description":"payload","type":["string","null"],"example":"{\"key\": \"value\"}"},"attachmentType":{"description":"linked attachment type","type":["string","null"],"example":"object"},"attachmentId":{"description":"linked attachment ID","type":["integer","null"],"example":3669},"attachmentFullPath":{"description":"linked attachment fullPath","type":["string","null"],"example":"/path/to/attachment.jpg"}},"type":"object"}]},"NotificationMinimal":{"title":"Notification Minimal Data","required":["id","type","title","read","creationDate","recipient","sender"],"properties":{"id":{"description":"id","type":"integer","example":23},"type":{"description":"type","type":"string","example":"info"},"title":{"description":"title","type":"string","example":"Notification title"},"read":{"description":"read","type":"boolean","example":false},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"recipient":{"description":"recipient ID","type":"integet","example":1},"sender":{"description":"sender","type":["string","null"],"example":"Pimcore Admin"}},"type":"object"},"NotificationListItem":{"title":"NotificationListItem","required":["id","type","title","read","hasAttachment","creationDate","sender"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":23},"type":{"description":"type","type":"string","example":"info"},"title":{"description":"title","type":"string","example":"Notification title"},"read":{"description":"read","type":"boolean","example":false},"hasAttachment":{"description":"has attachment","type":"boolean","example":true},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"sender":{"description":"sender","type":["string","null"],"example":"Pimcore Admin"}},"type":"object"},"NotificationsWidgetConfig":{"title":"Notifications Widget Config","required":["color","page","pageSize","dateFilterValue","dateFilterOperator","senderFilter","typeFilter","onlyUnread","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":1},"dateFilterValue":{"description":"Date Filter Value","type":["string","null"],"example":"08/20/2024"},"dateFilterOperator":{"description":"Date Filter Operator","type":["string","null"],"example":"on"},"senderFilter":{"description":"Sender Filter ","type":["integer","null"],"example":20},"typeFilter":{"description":"Type Filter ","type":["string","null"],"example":"info"},"onlyUnread":{"description":"Filter Only Unread Notifications ","type":"boolean","example":false},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"ObjectBrickConfig":{"title":"Object Brick Configuration","required":["key","title"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"MyObjectBrick"},"title":{"description":"Title","type":"string","example":"My Object Brick"}},"type":"object"},"ObjectBrickDetail":{"title":"Object Brick Detail","required":["key","title","group","parentClass","implementsInterfaces","blockedVarsForExport","isWriteable","classDefinitions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"MyObjectBrick"},"title":{"description":"Title","type":["string","null"],"example":"My Object Brick"},"group":{"description":"Group","type":["string","null"],"example":"system"},"parentClass":{"description":"Namespace of parent class","type":["string","null"],"example":"App\\Model\\DataObject\\ObjectBrick"},"implementsInterfaces":{"description":"Interface implementations","type":["string","null"],"example":"App\\Model\\DataObject\\Interface"},"blockedVarsForExport":{"description":"Blocked variables for export","type":"array","items":{"type":"string"},"example":[]},"isWriteable":{"description":"Whether the object brick definition can be written to","type":"boolean","example":true},"classDefinitions":{"description":"Class definitions assigned to this object brick","type":"array","items":{"properties":{"classname":{"type":"string","example":"Product"},"fieldname":{"type":"string","example":"myBrickField"}},"type":"object"},"example":[{"classname":"fieldTest","fieldname":"myBrickField"}]}},"type":"object"},"ObjectBrickLayoutDefinition":{"title":"Object Brick Layout Definition","required":["key","title","width","height","collapsible","collapsed","datatype","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of Object Brick","type":"string","example":"my_object_brick"},"datatype":{"description":"Data Type","type":"string","example":"layout"},"name":{"description":"Name","type":["string","null"],"example":"Layout"},"type":{"description":"Type","type":["string","null"],"example":"object"},"region":{"description":"Region","type":["string","null"],"example":"main"},"title":{"description":"Title","type":["string","null"],"example":"My Object Brick"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"collapsed","type":"boolean","example":false},"children":{"description":"Children","type":"object","example":[]}},"type":"object"},"ObjectBrickTreeNodeFolder":{"title":"Object Brick Tree Node Folder","required":["key","name","icon","group","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of folder with group_ prefix","type":"string","example":"group_Parts"},"name":{"description":"Group name","type":"string","example":"Parts"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group","type":"string","example":"Parts"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#/components/schemas/ObjectBrickTreeNode"}}},"type":"object"},"ObjectBrickTreeNode":{"title":"Object Brick Tree Node Item","required":["key","name","icon","group"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of object brick","type":"string","example":"myBrick"},"name":{"description":"Name","type":"string","example":"My Brick"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group name","type":["string","null"],"example":"News"}},"type":"object"},"ObjectBrickUsageData":{"title":"Object Brick Usage Data","required":["class","field"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"class":{"description":"Name of the class using the object brick","type":"string","example":"Product"},"field":{"description":"Name of the field in the class","type":"string","example":"myBrickField"}},"type":"object"},"PageSettingsData":{"title":"Page Settings Data","required":["title","description","prettyUrl"],"type":"object","allOf":[{"$ref":"#/components/schemas/SnippetSettingsData"},{"properties":{"title":{"description":"Title","type":["string","null"],"example":"Link Title"},"description":{"description":"Description","type":["string","null"],"example":"Link Description"},"prettyUrl":{"description":"Pretty Url","type":["string","null"],"example":"pretty/url"}},"type":"object"}]},"SnippetSettingsData":{"title":"Page Settings Data","required":["controller","template","contentMainDocumentId","contentMainDocumentPath","supportsContentMain","staticGeneratorEnabled","staticGeneratorLifetime","staticLastGenerated","url"],"properties":{"controller":{"description":"Controller","type":["string","null"],"example":"App\\Controller\\PageController"},"template":{"description":"Template","type":["string","null"],"example":"@app/template.html.twig"},"contentMainDocumentId":{"description":"Main document ID","type":["integer","null"],"example":1},"contentMainDocumentPath":{"description":"Main document path","type":["string","null"],"example":"/path/to/main/document"},"supportsContentMain":{"description":"Supports main content","type":"boolean","example":false},"staticGeneratorEnabled":{"description":"Is static generator enabled","type":"boolean","example":false},"staticGeneratorLifetime":{"description":"Lifetime of static generator","type":["integer","null"],"example":123456},"staticLastGenerated":{"description":"Timestamp of last generated data","type":["integer","null"],"example":1700000000},"url":{"description":"Document Url","type":["string","null"],"example":"https://example.com/"}},"type":"object"},"PageSnippet":{"title":"PageSnippet","required":["title","description"],"type":"object","allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"title":{"description":"Title of the Page Snippet","type":["string","null"],"example":"Title"},"description":{"description":"Description of the Page Snippet","type":["string","null"],"example":"Description"}},"type":"object"}]},"PageSnippetDraftData":{"title":"PageSnippetDraftData","required":["id","modificationDate","isAutoSave"],"properties":{"id":{"description":"ID","type":"integer","example":83},"modificationDate":{"description":"Modification date","type":"integer","example":1634025600},"isAutoSave":{"description":"Is auto save","type":"boolean","example":false}},"type":"object"},"PatchCustomMetadata":{"title":"PatchCustomMetadata","required":["name","language","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":["string","null"],"example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["string","null"],"example":"data"}},"type":"object"},"PatchError":{"title":"PatchError","description":"Response for PATCH requests with errors","properties":{"id":{"description":"ID","type":"integer","example":83},"message":{"description":"Message","type":"string","example":"I am an error message"}},"type":"object"},"Permissions":{"title":"Permissions","required":["list","view","publish","delete","rename","create","settings","versions","properties"],"properties":{"list":{"description":"List","type":"boolean","example":true},"view":{"description":"View","type":"boolean","example":true},"publish":{"description":"Publish","type":"boolean","example":true},"delete":{"description":"Delete","type":"boolean","example":true},"rename":{"description":"Rename","type":"boolean","example":true},"create":{"description":"Create","type":"boolean","example":true},"settings":{"description":"Settings","type":"boolean","example":true},"versions":{"description":"Versions","type":"boolean","example":true},"properties":{"description":"Properties","type":"boolean","example":true}},"type":"object"},"PerspectiveConfig":{"title":"Perspective Config","required":["id","name","icon","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Perspective ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"},"PerspectiveConfigDetail":{"title":"Perspective Config Detail","required":["contextPermissions","widgetsLeft","widgetsRight","widgetsBottom","expandedLeft","expandedRight"],"type":"object","allOf":[{"$ref":"#/components/schemas/PerspectiveConfig"},{"properties":{"contextPermissions":{"description":"Context Permissions","type":"object","example":{"permission_group":{"permission1":true,"permission2":false}}},"widgetsLeft":{"description":"Widgets Left","type":"array","items":{"$ref":"#/components/schemas/ElementTreeWidgetConfig"}},"widgetsRight":{"description":"Widgets Right","type":"array","items":{"$ref":"#/components/schemas/ElementTreeWidgetConfig"}},"widgetsBottom":{"description":"Widgets Bottom","type":"array","items":{"$ref":"#/components/schemas/ElementTreeWidgetConfig"}},"expandedLeft":{"description":"Left Expanded Widget","type":["string","null"],"example":"widget_id"},"expandedRight":{"description":"Right Expanded Widget","type":["string","null"],"example":"widget_id"}},"type":"object"}]},"PortalEngineWizardThumbnail":{"title":"Portal Engin Wizard Thumbnail","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the thumbnail configuration","type":"string","example":"portal_thumbnail"},"name":{"description":"Display name of the thumbnail configuration","type":"string","example":"Portal Thumbnail"}},"type":"object"},"PortalEngineAdminUserAssignment":{"title":"Portal Engine Admin User Assignment","required":["canSeeMenu","canAddNewCollection"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"canSeeMenu":{"description":"Determines whether the collections menu is visible for the user","type":"boolean","example":true},"canAddNewCollection":{"description":"Determines whether the user may create new collections","type":"boolean","example":true}},"type":"object"},"PortalEngineCollection":{"title":"Portal Engine Collection","required":["id","name","userEmail","itemCount","creationDate","currentSiteId","editable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier of the collection.","type":"integer","example":42},"name":{"description":"Human readable name of the collection.","type":"string","example":"My Favorites"},"userEmail":{"description":"Email address of the collection owner.","type":"string","example":"user@example.com"},"itemCount":{"description":"Number of items contained in the collection.","type":"integer","example":12},"creationDate":{"description":"Unix timestamp representing the creation time of the collection.","type":"integer","example":1704067200},"currentSiteId":{"description":"Name of the portal site the collection belongs to.","type":"string","example":"Dealer Portal"},"editable":{"description":"Indicates whether the collection can be edited by the current user.","type":"boolean","example":true}},"type":"object"},"PortalEngineCollectionShareListItem":{"title":"Portal Engine Collection Share List Item","required":["id","userName","permission"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User Id with whom the collection is shared","type":"integer","example":101},"userName":{"description":"User Name with whom the collection is shared","type":"string","example":"admin"},"permission":{"description":"Permission assigned to the share (read|edit)","type":"string","example":"read"}},"type":"object"},"PortalEngineCollectionUserGroup":{"title":"Portal Engine Collection User Group","required":["id","name","isGroup"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the user group","type":"integer","example":42},"name":{"description":"Display name of the user group","type":"string","example":"Dealer Managers"},"isGroup":{"description":"Flag indicating the entry represents a group","type":"boolean","example":true}},"type":"object"},"PortalEngineTreeFolder":{"title":"Portal Engine Tree Folder","required":["id","className","key","path","icon","elementType","allowDrag","allowDrop"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Data Pool ID","type":"string","example":1},"key":{"description":"Key","type":"string","example":"City Car"},"path":{"description":"Path","type":"string","example":"/City Car/"},"className":{"description":"Class Name","type":"string","example":"Car"},"elementType":{"description":"Type of the elements in the Folder","type":"string","example":"asset"},"type":{"description":"Type of the Folder","type":"string","example":"folder"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false}},"type":"object"},"PortalEngineTreeInformation":{"title":"Portal Engine Tree Information","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name of the tree","type":"string","example":"Collections"}},"type":"object"},"PortalEngineWizardAssetPool":{"title":"Portal Engine Wizard Asset Pool","required":["dataPoolName"],"properties":{"dataPoolName":{"description":"Unique identifier for the wizard asset pool.","type":"string","example":"Images"},"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"enableFolderNavigation":{"description":"Whether folder navigation is enabled for this pool.","type":"boolean","example":false},"enableTagNavigation":{"description":"Whether tag-based navigation is enabled for this pool.","type":"boolean","example":false},"availableDownloadThumbnails":{"description":"Configured download thumbnails for this pool.","type":"array","items":{"type":"string"},"example":["custom"]},"directDownloadShortcuts":{"description":"Available direct download shortcuts.","type":"array","items":{"type":"string"},"example":["cart"]},"availableDownloadFormats":{"description":"Download formats that can be used for exporting assets.","type":"array","items":{"type":"string"},"example":["Pimcore\\Bundle\\PortalEngineBundle\\Service\\DataPool\\DownloadFormat\\ZipDownloadFormat"]},"visibleLanguages":{"description":"Languages visible in the asset pool.","type":"array","items":{"type":"string"},"example":["de","en"]},"editableLanguages":{"description":"Languages that can be edited within the asset pool.","type":"array","items":{"type":"string"},"example":["de","en"]}},"type":"object"},"PortalEngineWizardCustomLayout":{"title":"Portal Engine Wizard Custom Layout","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the custom layout","type":"string","example":"CP"},"name":{"description":"Display name of the custom layout","type":"string","example":"Product Detail (ID: CP)"}},"type":"object"},"PortalEngineIcon":{"title":"Portal Engine Wizard Icon","required":["name","file"],"properties":{"name":{"description":"Name","type":"string","example":"crow"},"file":{"description":"File","type":"string","example":""}},"type":"object"},"PortalEngineWizardObjectPool":{"title":"Portal Engine Wizard Object Pool","required":["dataPoolName","classDefinition","detailPageLayout"],"properties":{"dataPoolName":{"description":"Unique identifier for the wizard object pool.","type":"string","example":"Products"},"classDefinition":{"description":"Class definition key backing the object pool.","type":"string","example":"Product"},"detailPageLayout":{"description":"Custom layout identifier used for the detail page.","type":"string","example":"ProductDetailLayout"},"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"enableFolderNavigation":{"description":"Whether folder navigation is enabled for this pool.","type":"boolean","example":false},"enableTagNavigation":{"description":"Whether tag-based navigation is enabled for this pool.","type":"boolean","example":false},"availableDownloadThumbnails":{"description":"Configured download thumbnails for this pool.","type":"array","items":{"type":"string"},"example":["custom"]},"availableDownloadFormats":{"description":"Download formats that can be used for exporting data objects.","type":"array","items":{"type":"string"},"example":["Pimcore\\Bundle\\PortalEngineBundle\\Service\\DataPool\\DownloadFormat\\JsonDownloadFormat"]},"visibleLanguages":{"description":"Languages visible in the object pool.","type":"array","items":{"type":"string"},"example":["de","en"]}},"type":"object"},"PortalEngineWizardStartResponse":{"title":"Portal Engine Wizard Start Response","required":["tmpStoreKey"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"tmpStoreKey":{"description":"Temporary storage key generated for the running wizard.","type":"string","example":"portal-engine_wizard_650a9242c8b1d"}},"type":"object"},"PortalEngineWizardStatusResponse":{"title":"Portal Engine Wizard Status Response","required":["isWizardFinished","isWizardSuccess"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isWizardFinished":{"description":"Whether the wizard has finished processing.","type":"boolean","example":true},"isWizardSuccess":{"description":"Whether the wizard run finished successfully.","type":"boolean","example":true},"portalDocumentId":{"description":"ID of the created portal document when available.","type":["integer","null"],"example":1234},"statusMessage":{"description":"Latest status message returned by the wizard run.","type":["string","null"],"example":"Portal created"}},"type":"object"},"PortalEngineCollectionPortal":{"title":"Portal entry for collection selection","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Identifier of the portal site","type":"integer","example":123},"name":{"description":"Display name of the portal","type":"string","example":"Dealer Portal"}},"type":"object"},"PredefinedMetadata":{"title":"PredefinedMetadata","required":["id","name","type","creationDate","modificationDate","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"string","example":"1"},"name":{"description":"Name","type":"string","example":"custom_metadata"},"description":{"description":"Description","type":["string","null"],"example":"A predefined metadata"},"type":{"description":"Type","type":"string","example":"input"},"targetSubType":{"description":"Target sub type","type":["string","null"],"example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"},"config":{"description":"Config","type":["string","null"],"example":"config"},"language":{"description":"Language","type":["string","null"],"example":"en"},"group":{"description":"Group","type":["string","null"],"example":"group"},"creationDate":{"description":"Creation Date","type":"integer","example":1634025600},"modificationDate":{"description":"Modfication Date","type":"integer","example":1634025600},"isWriteable":{"description":"Writable","type":"boolean","example":false}},"type":"object"},"PredefinedProperty":{"title":"PredefinedProperty","required":["id","name","key","type","ctype","inheritable","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"alpha-numerical-value"},"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":["string","null"],"example":"Detailed description of the property"},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":["string","null"],"example":"test"},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"ctype":{"description":"ctype","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false},"creationDate":{"description":"Creation date","type":"integer","example":221846400},"modificationDate":{"description":"Modification date","type":"integer","example":327417600}},"type":"object"},"QuantityValueUnit":{"title":"QuantityValueUnit","required":["id","abbreviation","group","longName","baseUnit","reference","factor","conversionOffset","converter"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":["string","null"],"example":"mm"},"abbreviation":{"description":"Abbreviation","type":["string","null"],"example":"mm"},"group":{"description":"Group","type":["string","null"],"example":null},"longName":{"description":"Long Name","type":["string","null"],"example":"Millimeter"},"baseUnit":{"description":"Base Unit","type":["string","null"],"example":"m"},"reference":{"description":"Reference","type":["string","null"],"example":null},"factor":{"description":"Factor","type":["number","null"],"format":"float","example":null},"conversionOffset":{"description":"Conversion Offset","type":["number","null"],"format":"float","example":null},"converter":{"description":"Converter","type":["string","null"],"example":null}},"type":"object"},"QueueItemCount":{"title":"Queue Item Count","required":["count"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"count":{"description":"Items in queue","type":"integer","example":42}},"type":"object"},"RecentlyModifiedElement":{"title":"Recently Modified Element Data","required":["id","type","subtype","fullPath","modificationDate","isPublished"],"properties":{"id":{"description":"Element ID","type":"integer","example":123},"type":{"description":"Type of the element","type":"string","example":"asset"},"subtype":{"description":"Subtype of the element","type":"string","example":"Image"},"fullPath":{"description":"Full path of the element","type":"string","example":"/path/to/element"},"modificationDate":{"description":"Modification Date","type":"integer","example":327417600},"isPublished":{"description":"Is the element published","type":["boolean","null"],"example":true}},"type":"object"},"RecentlyModifiedWidgetConfig":{"title":"Recently Modified Elements Widget Config","required":["color","elementType","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"elementType":{"description":"Element Type","type":"string","example":"asset"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]},"Recipient":{"title":"Recipient","required":["id","recipientName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the Recipient","type":"integer","example":1},"recipientName":{"description":"User name or Group Name of the Recipient","type":"string","example":"Max Mustermann"}},"type":"object"},"RecycleBin":{"title":"Recycle Bin","required":["id","amount","date","deletedBy","path","subtype","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"amount":{"description":"Amount","type":"integer","example":1},"date":{"description":"Date","type":"integer","example":1617267600},"deletedBy":{"description":"Deleted By","type":"string","example":"admin"},"path":{"description":"Path","type":"string","example":"/path/to/element"},"subtype":{"description":"Subtype","type":"string","example":"folder"},"type":{"description":"Type","type":"string","example":"asset"}},"type":"object"},"RelatedElementData":{"title":"RelatedElementData","required":["id","type","subtype","fullPath","isPublished"],"properties":{"id":{"description":"ID","type":"integer","example":83},"type":{"description":"Type of the element","type":"string","example":"object"},"subtype":{"description":"Subtype of the element","type":"string","example":"Product"},"fullPath":{"description":"Full path of the element","type":"string","example":"/path/to/element"},"isPublished":{"description":"Is the element published","type":["boolean","null"],"example":true}},"type":"object"},"RelationFieldConfig":{"title":"Relation Field Config","required":["relation","field"],"properties":{"relation":{"description":"Relation Getter","type":"string","example":"manufacturer"},"field":{"description":"Field getter","type":"string","example":"name"}},"type":"object"},"ResetPassword":{"title":"ResetPassword","description":"Reset password parameters","required":["username","resetPasswordUrl"],"properties":{"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"},"resetPasswordUrl":{"description":"Reset password URL","type":"string","example":"https://example.com/reset-password"}},"type":"object"},"Progress":{"title":"SSEHandlerProgress","required":["progress","currentStep","totalSteps","jobStepName","jobName","jobRunId","user"],"properties":{"progress":{"description":"progress","type":"integer","example":69},"currentStep":{"description":"currentStep","type":"integer","example":1},"totalSteps":{"description":"totalSteps","type":"integer","example":3},"jobStepName":{"description":"jobStepName","type":"string","example":"Job Step Name"},"jobName":{"description":"jobName","type":"string","example":"Job Name"},"jobRunId":{"description":"jobRunId","type":"integer","example":73},"user":{"description":"user","type":"integer","example":2}},"type":"object"},"Finished":{"title":"SSEJobRunFinished","required":["jobRunId","jobRunName","ownerId","status","messages","notifyAll"],"properties":{"jobRunId":{"description":"jobRunId","type":"integer","example":73},"jobRunName":{"description":"jobRunName","type":"string","example":"my-job-name"},"ownerId":{"description":"ownerId","type":"integer","example":13},"status":{"description":"status","type":"string","example":"finished"},"messages":{"description":"messages","type":"array","items":{"type":"string"},"example":["Something went wrong"]},"notifyAll":{"description":"notifyAll","type":"boolean","example":false}},"type":"object"},"SaveLastChangesWidgetConfig":{"title":"Save Last Changes Widget Config","required":["showAssets","showDataObjects","showDocuments"],"type":"object","allOf":[{"$ref":"#/components/schemas/CreateWidgetConfig"},{"properties":{"showAssets":{"description":"Show Assets","type":"boolean","example":true},"showDataObjects":{"description":"Show Data Objects","type":"boolean","example":true},"showDocuments":{"description":"Show Documents","type":"boolean","example":true}},"type":"object"}]},"Schedule":{"title":"Schedule","required":["id","ctype","date","active","userId","username"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"integer","example":666},"ctype":{"description":"ctype","type":"string","example":"Type of element"},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":["string","null"],"enum":["publish","delete"],"example":"publish"},"version":{"description":"Version ID","type":["integer","null"],"example":987},"active":{"description":"Active","type":"boolean","example":true},"userId":{"description":"User ID","type":"integer","example":999},"username":{"description":"Username","type":"string","example":"shaquille.oatmeal"}},"type":"object"},"CreateClassDefinition":{"title":"Schema used to create class definitions","required":["name","uid"],"properties":{"name":{"description":"Name","type":"string","example":"My Class Definition"},"uid":{"description":"Class definition unique ID","type":"string","example":"my_class_definition_uid"}},"type":"object"},"CustomLayoutNew":{"title":"Schema used to create custom layouts","required":["name","classId"],"properties":{"name":{"description":"Name","type":"string","example":"My Custom Layout"},"classId":{"description":"Data object class id","type":"integer","example":"CAR"}},"type":"object"},"CreateFieldCollection":{"title":"Schema used to create field collection definitions","required":["key"],"properties":{"key":{"description":"Key of the field collection","type":"string","example":"MyFieldCollection"}},"type":"object"},"CreateObjectBrick":{"title":"Schema used to create object brick definitions","required":["key"],"properties":{"key":{"description":"Key of the object brick","type":"string","example":"MyObjectBrick"}},"type":"object"},"CreateSelectOption":{"title":"Schema used to create select option configurations","required":["id"],"properties":{"id":{"description":"ID of the select options configuration","type":"string","example":"EventStatus"}},"type":"object"},"ClassDefinitionUpdate":{"title":"Schema used to update class definition configuration","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object","example":{"children":[{"name":"Layout","datatype":"layout","fieldtype":"panel","type":null,"region":null,"title":"","width":"","height":"","collapsible":false,"collapsed":false,"bodyStyle":"","locked":false,"layout":null,"border":false,"icon":"","labelWidth":100,"labelAlign":"left","invalidFieldError":null,"children":[]}]}},"values":{"description":"Values for class definition object itself","type":"object","example":{"name":"MyClass","title":"My class title","description":"Description of my class","parentClass":"","implementsInterfaces":"","listingParentClass":"","useTraits":"","listingUseTraits":"","encryption":false,"encryptedTables":[],"allowInherit":true,"allowVariants":false,"showVariants":false,"icon":"","group":"","showAppLoggerTab":false,"linkGeneratorReference":"","previewGeneratorReference":"","compositeIndices":[],"showFieldLookup":false,"propertyVisibility":{"grid":{"id":true,"key":false,"path":true,"published":true,"modificationDate":true,"creationDate":true},"search":{"id":true,"key":false,"path":true,"published":true,"modificationDate":true,"creationDate":true}},"enableGridLocking":false,"propertyVisibility.grid.id":true,"propertyVisibility.search.id":true,"propertyVisibility.grid.key":false,"propertyVisibility.search.key":false,"propertyVisibility.grid.path":true,"propertyVisibility.search.path":true,"propertyVisibility.grid.published":true,"propertyVisibility.search.published":true,"propertyVisibility.grid.modificationDate":true,"propertyVisibility.search.modificationDate":true,"propertyVisibility.grid.creationDate":true,"propertyVisibility.search.creationDate":true}}},"type":"object"},"CustomLayoutUpdate":{"title":"Schema used to update custom layouts","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object"},"values":{"description":"Values for custom layout object itself","type":"object"}},"type":"object"},"FieldCollectionUpdate":{"title":"Schema used to update field collection definition","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object","example":{"children":[{"name":"Layout","datatype":"layout","fieldtype":"panel","type":null,"region":"","title":"Pattern","width":"","height":"","collapsible":false,"collapsed":false,"bodyStyle":"","locked":false,"layout":"","border":false,"icon":null,"labelWidth":100,"labelAlign":"left","invalidFieldError":null,"children":[{"name":"count","datatype":"data","fieldtype":"numeric","title":"Token Count","tooltip":"","mandatory":false,"noteditable":false,"index":false,"locked":false,"style":"","permissions":null,"relationType":false,"invisible":false,"visibleGridView":false,"visibleSearch":false,"defaultValue":null,"integer":true,"unsigned":true,"minValue":1,"maxValue":null,"unique":false,"decimalSize":null,"decimalPrecision":null,"width":400,"defaultValueGenerator":"","invalidFieldError":null,"children":null}]}]}},"values":{"description":"Values for field collection definition metadata","type":"object","example":{"parentClass":"\\App\\Bundle\\Model\\MyCustomParentType","implementsInterfaces":"","title":"","group":"Voucher","blockedVarsForExport":[]}}},"type":"object"},"ObjectBrickUpdate":{"title":"Schema used to update object brick definition","required":["configuration","values"],"properties":{"configuration":{"description":"Layout configuration for fields (Panel, Input, ..)","type":"object","example":{"children":[{"name":"Layout","datatype":"layout","fieldtype":"panel","type":null,"region":"","title":"Pattern","width":"","height":"","collapsible":false,"collapsed":false,"bodyStyle":"","locked":false,"layout":"","border":false,"icon":null,"labelWidth":100,"labelAlign":"left","invalidFieldError":null,"children":[{"name":"count","datatype":"data","fieldtype":"numeric","title":"Token Count","tooltip":"","mandatory":false,"noteditable":false,"index":false,"locked":false,"style":"","permissions":null,"relationType":false,"invisible":false,"visibleGridView":false,"visibleSearch":false,"defaultValue":null,"integer":true,"unsigned":true,"minValue":1,"maxValue":null,"unique":false,"decimalSize":null,"decimalPrecision":null,"width":400,"defaultValueGenerator":"","invalidFieldError":null,"children":null}]}]}},"values":{"description":"Values for object brick definition metadata","type":"object","example":{"parentClass":"\\App\\Bundle\\Model\\MyCustomParentType","implementsInterfaces":"","title":"","group":"Voucher","classDefinitions":[{"classname":"Product","fieldname":"myBrickField"}],"blockedVarsForExport":[]}}},"type":"object"},"UpdateSelectOption":{"title":"Schema used to update select option configurations","required":["group","adminOnly","useTraits","implementsInterfaces","selectOptions"],"properties":{"group":{"description":"Group name","type":["string","null"],"example":"system"},"adminOnly":{"description":"Whether this configuration is restricted to admin","type":"boolean","example":false},"useTraits":{"description":"PHP traits to use","type":"string","example":""},"implementsInterfaces":{"description":"PHP interfaces to implement","type":"string","example":""},"selectOptions":{"description":"Select option entries","type":["array","null"],"items":{"$ref":"#/components/schemas/SelectOptionData"}}},"type":"object"},"FormatedPath":{"title":"Select Option","required":["objectReference","formatedPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"objectReference":{"description":"Object Reference","type":"string","example":"object_11"},"formatedPath":{"description":"Formated Path","type":"string","example":"nice/path"}},"type":"object"},"SelectOption":{"title":"Select Option","required":["key","value"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"key"},"value":{"description":"Value","type":"string","example":"value"}},"type":"object"},"SelectOptionData":{"title":"Select Option Data","required":["value","label","name"],"properties":{"value":{"description":"Value of the select option","type":"string","example":"active"},"label":{"description":"Display label of the select option","type":"string","example":"Active"},"name":{"description":"Enum case name of the select option","type":"string","example":"Active"}},"type":"object"},"SelectOptionDetail":{"title":"Select Option Detail","required":["id","group","adminOnly","useTraits","implementsInterfaces","selectOptions","enumName","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the select options configuration","type":"string","example":"EventStatus"},"group":{"description":"Group name","type":["string","null"],"example":"system"},"adminOnly":{"description":"Whether this configuration is restricted to admin","type":"boolean","example":false},"useTraits":{"description":"PHP traits to use","type":"string","example":""},"implementsInterfaces":{"description":"PHP interfaces to implement","type":"string","example":""},"selectOptions":{"description":"Select option entries","type":"array","items":{"$ref":"#/components/schemas/SelectOptionData"}},"enumName":{"description":"Fully qualified enum name","type":"string","example":"Pimcore\\Model\\DataObject\\SelectOptions\\EventStatus"},"isWriteable":{"description":"Whether the configuration is writeable","type":"boolean","example":true}},"type":"object"},"SelectOptionTreeFolder":{"title":"Select Option Tree Folder","required":["id","name","icon","group","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of select option","type":"string","example":"EventStatus"},"name":{"description":"Text of select option","type":"string","example":"EventStatus"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"},"children":{"description":"Child nodes","type":"array","items":{"$ref":"#/components/schemas/SelectOptionTree"}}},"type":"object"},"SelectOptionTree":{"title":"Select Option Tree Item","required":["id","name","icon","group","adminOnly"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of select option","type":"string","example":"EventStatus"},"name":{"description":"Text of select option","type":"string","example":"EventStatus"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"},"adminOnly":{"description":"Only for admin user","type":"boolean","example":false}},"type":"object"},"SelectOptionUsageItem":{"title":"Select Option Usage Item","required":["class","field"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"class":{"description":"Name of the class using the select options","type":"string","example":"Car"},"field":{"description":"Name of the field using the select options","type":"string","example":"status"}},"type":"object"},"SendEmailParameters":{"title":"SendEmailParameters","required":["from","to","subject","contentType"],"properties":{"from":{"description":"from email address(es)","type":"string","example":"from@sender.com"},"to":{"description":"to email address(es)","type":"string","example":"to@receiver.com"},"subject":{"description":"email subject","type":"string","example":"My email subject"},"contentType":{"description":"email content type","type":"string","enum":["document","html","text"],"example":"text"},"content":{"description":"email content","type":["string","null"],"example":"My email message"},"documentPath":{"description":"path to the email document","type":["string","null"],"example":"/path/to/document"},"documentParameters":{"description":"email document parameters","type":"array","items":{"$ref":"#/components/schemas/EmailDocumentParameters"}},"attachmentId":{"description":"id of the asset attachment","type":["integer","null"],"example":83}},"type":"object"},"SendNotificationParameters":{"title":"SendEmailParameters","required":["recipientId","title","message"],"properties":{"recipientId":{"description":"recipient ID","type":"integer","example":"33"},"title":{"description":"title","type":"string","example":"New notification"},"message":{"description":"message","type":"string","example":"My notification message"},"attachmentType":{"description":"type of the attachment","type":["string","null"],"enum":["asset","document","object"],"example":null},"attachmentId":{"description":"ID of the attachment","type":["integer","null"],"example":83}},"type":"object"},"SettingsConfigurationData":{"title":"Settings Configuration Data","required":["id","name","icon"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"my-config"},"name":{"description":"Configuration name","type":"string","example":"My Configuration"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Configuration icon"}},"type":"object"},"SimpleDashboard":{"title":"Simple Dashboard","required":["id","name","owner"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique identifier for the dashboard","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name of the dashboard","type":"string","example":"My Dashboard"},"owner":{"description":"ID of the owner of the dashboard","type":"integer","example":1},"menuShortcutGroup":{"description":"Name of the group in the Menu","type":["string","null"],"example":"My Dashboard"}},"type":"object"},"SimpleFieldConfig":{"title":"Simple Field Config","required":["field"],"properties":{"field":{"description":"Field getter","type":"string","example":"name"}},"type":"object"},"PhpCodeTransformer":{"title":"Simple PHP Code Transformer","description":"A PHP code transformer service with basic information","required":["key","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Unique key of the transformer","type":"string","example":"t_key"},"label":{"description":"Label of the transformer","type":"string","example":"Transformer"}},"type":"object"},"SimpleUser":{"title":"Simple User","description":"A user with the most imported information.","required":["id","username"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"username":{"description":"Name of the User","type":"string","example":"userName"}},"type":"object"},"SimpleRole":{"title":"Simple User Role","description":"A user role which is a combination of permissions and settings.","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the Role","type":"integer","example":"1"},"name":{"description":"Name of the Role","type":"string","example":"role"}},"type":"object"},"AssetSearchPreview":{"title":"SimpleSearchAssetDetail","required":["mimeType","thumbnail"],"type":"object","allOf":[{"$ref":"#/components/schemas/SimpleSearchPreview"},{"properties":{"mimeType":{"description":"Mimetype","type":["string","null"],"example":"image/jpeg"},"thumbnail":{"description":"Thumbnail path","type":["string","null"],"example":"path/to/thumbnail"}},"type":"object"}]},"DataObjectSearchPreview":{"title":"SimpleSearchDataObjectDetail","required":["class","objectData"],"type":"object","allOf":[{"$ref":"#/components/schemas/SimpleSearchPreview"},{"properties":{"class":{"description":"Class name and Id","type":["string","null"],"example":"Car [CAR]"},"objectData":{"description":"Detail object data","type":"object","example":{"fieldKey":"field value"}}},"type":"object"}]},"SimpleSearchPreview":{"title":"SimpleSearchDetail","required":["id","elementType","type","userOwner","userOwnerName","userModification","userModificationName","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":"74"},"elementType":{"description":"elementType","type":"string","example":"asset"},"type":{"description":"Type","type":"string","example":"image"},"userOwner":{"description":"Id of owner","type":["integer","null"],"example":1},"userOwnerName":{"description":"Name of owner","type":["string","null"],"example":"admin"},"userModification":{"description":"Id of the user that modified the element","type":["integer","null"],"example":1},"userModificationName":{"description":"Name of the user that modified the element","type":["integer","null"],"example":"admin"},"creationDate":{"description":"Creation date","type":["integer","null"],"example":221846400},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":327417600}},"type":"object"},"DocumentSearchPreview":{"title":"SimpleSearchDocumentDetail","required":["language","documentData"],"type":"object","allOf":[{"$ref":"#/components/schemas/SimpleSearchPreview"},{"properties":{"language":{"description":"Document Language","type":["string","null"],"example":"English"},"documentData":{"oneOf":[{"$ref":"#/components/schemas/PageSearchPreview","description":"Page document data"},{"type":"null"}],"description":"Page document data"}},"type":"object"}]},"PageSearchPreview":{"title":"SimpleSearchPageDetail","required":["title","description","name","hasPreviewImage"],"properties":{"title":{"description":"Title","type":["string","null"],"example":"Page"},"description":{"description":"Description","type":["string","null"],"example":"This is some page"},"name":{"description":"Navigation name","type":["string","null"],"example":"Awesome Page"},"hasPreviewImage":{"description":"Has Preview image","type":"boolean","example":false}},"type":"object"},"SimpleSearchResult":{"title":"SimpleSearchResult","required":["id","elementType","type","path","icon"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"id":{"description":"id","type":"integer","example":"74"},"elementType":{"description":"elementType","type":"string","example":"asset"},"type":{"description":"type","type":"string","example":"image"},"path":{"description":"path","type":"string","example":"/path/to/asset"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"}},"type":"object"},"Site":{"title":"Site","required":["id","domains","domain","rootId","rootPath"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":0},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"domain":{"description":"Domain","type":"string","example":"main_site"},"rootId":{"description":"ID of the root","type":["integer","null"],"example":1},"rootPath":{"description":"Root path","type":["string","null"],"example":"/"}},"type":"object"},"SiteDetailData":{"title":"Site Detail Data","required":["id","creationDate","modificationDate","mainDomain","domains","errorDocument","localizedErrorDocuments","redirectToMainDomain"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":0},"creationDate":{"description":"Creation Date","type":["integer","null"],"example":1712345678},"modificationDate":{"description":"Modification Date","type":["integer","null"],"example":1712345678},"mainDomain":{"description":"Main domain","type":"string","example":"main_site"},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"errorDocument":{"oneOf":[{"$ref":"#/components/schemas/RelatedElementData","description":"Data of error document"},{"type":"null"}],"description":"Data of error document","type":"object"},"localizedErrorDocuments":{"description":"Localized error documents mapped by locale","type":"object","example":{"en":{"id":123,"type":"document","subtype":"page","fullPath":"en/error-page","isPublished":true}},"additionalProperties":{"$ref":"#/components/schemas/RelatedElementData","description":"Error document data for locale"}},"redirectToMainDomain":{"description":"Redirect to main domain","type":"boolean","example":false}},"type":"object"},"StaticTextConfig":{"title":"Static Text Config","required":["text"],"properties":{"text":{"description":"Static Text","type":"string","example":"My Text"}},"type":"object"},"SubmitAction":{"title":"SubmitAction","description":"Schema for submission of workflow action","required":["actionType","elementId","elementType","workflowId","transitionId","workflowOptions"],"properties":{"actionType":{"description":"type of the action","type":"string","example":"transition"},"elementId":{"description":"Id of the element","type":"integer","example":50},"elementType":{"description":"Type of the element","type":"string","example":"data-object"},"workflowId":{"description":"Id of the workflow","type":"string","example":"my_first_workflow"},"transitionId":{"description":"Id of the transition","type":"string","example":"start_workflow"},"workflowOptions":{"description":"workflowOptions","type":["object","null"],"example":"{\"notes\": \"Some note I want to write\"}"}},"type":"object"},"Subtype":{"title":"Subtype","required":["elementId","elementType","elementSubtype"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"elementId":{"description":"Element Id","type":"integer","example":14},"elementType":{"description":"Element Type","type":"string","example":"asset"},"elementSubtype":{"description":"Element Subtype","type":"string","example":"image"}},"type":"object"},"Tag":{"title":"Tag","required":["id","parentId","text","path","hasChildren","iconName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"tag ID","type":"integer","example":2},"parentId":{"description":"parent tag ID","type":"integer","example":0},"text":{"description":"tag text","type":"string","example":"Tag 1"},"path":{"description":"path","type":"string","example":"/test"},"hasChildren":{"description":"has children","type":"boolean","example":false},"iconName":{"description":"IconName","type":"string","example":"pimcore_icon_pdf"},"children":{"description":"children","type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"type":"object"},"Text":{"title":"Text","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"}]},"TextLayoutPreview":{"title":"Text Layout Preview Data","required":["className","path","renderingData","renderingClass","html"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"className":{"description":"Name of class definition","type":"string","example":"Car"},"path":{"description":"Path of the data object for preview","type":["string","null"],"example":"/cars/my-car"},"renderingData":{"description":"Data for preview","type":["string","null"],"example":"{\"field1\":\"value1\",\"field2\":\"value2\"}"},"renderingClass":{"description":"Rendering class for preview","type":["string","null"],"example":"App\\DataObject\\Car"},"html":{"description":"HTML preview of the layout","type":["string","null"],"example":"Hello World
"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true}},"type":"object"}]}}},"tags":[{"name":"Assets","description":"tag_assets_description"},{"name":"Asset Grid","description":"tag_asset_grid_description"},{"name":"Asset Thumbnails","description":"tag_asset_thumbnail_description"},{"name":"Authorization","description":"tag_authorization_description"},{"name":"Class Definition","description":"tag_class_description"},{"name":"Classification Store","description":"tag_classification_store"},{"name":"Data Objects","description":"tag_dataobjects_description"},{"name":"Data Object Grid","description":"tag_dataobject_grid_description"},{"name":"Dependencies","description":"tag_dependencies_description"},{"name":"Documents","description":"tag_documents_description"},{"name":"Elements","description":"tag_elements_description"},{"name":"Execution Engine","description":"tag_execution_engine_description"},{"name":"E-Mails","description":"tag_emails_description"},{"name":"Export","description":"tag_export_description"},{"name":"GDPR Data Extractor","description":"tag_gdpr_description"},{"name":"Mercure","description":"tag_mercure_description"},{"name":"Metadata","description":"tag_metadata_description"},{"name":"Notes","description":"tag_notes_description"},{"name":"Notifications","description":"tag_notifications_description"},{"name":"Perspectives","description":"tag_perspectives_description"},{"name":"Properties","description":"tag_properties_description"},{"name":"Recycle Bin","description":"tag_recycle_bin_description"},{"name":"Role Management","description":"tag_role_description"},{"name":"Schedule","description":"tag_schedule_description"},{"name":"Search","description":"tag_search_description"},{"name":"Settings","description":"tag_settings_description"},{"name":"Tags","description":"tag_tags_description"},{"name":"Tags for Element","description":"tag_tags_for_element_description"},{"name":"Translation","description":"tag_translation_description"},{"name":"Units","description":"tag_units_description"},{"name":"User Management","description":"tag_user_description"},{"name":"Versions","description":"tag_versions_description"},{"name":"Website Settings","description":"tag_website_settings_description"},{"name":"Workflows","description":"tag_workflows_description"},{"name":"Settings Admin","description":"Settings Admin"},{"name":"Bundle Application Logger","description":"tag_bundle_application_logger_description"},{"name":"Bundle Asset Metadata Class Definitions","description":"bundle_tag_asset_metadata_class_definitions_description"},{"name":"Bundle Backend Power Tools","description":"bundle_tag_backend_power_tools_description"},{"name":"Bundle Copilot","description":"bundle_tag_copilot_description"},{"name":"Bundle Custom Reports","description":"tag_bundle_custom_reports_description"},{"name":"Bundle Data Hub","description":"bundle_tag_data_hub_description"},{"name":"Bundle Data Hub File Export","description":"bundle_tag_data_hub_file_export_description"},{"name":"Bundle Data Hub Simple Rest","description":"bundle_tag_data_hub_simple_rest_description"},{"name":"Bundle Data Hub Webhooks","description":"bundle_tag_data_hub_webhooks_description"},{"name":"Bundle Data Quality Management","description":"bundle_tag_data_quality_management_description"},{"name":"Bundle Enterprise Subscription Tools","description":"bundle_tag_enterprise_subscription_tools_description"},{"name":"Bundle Personalization","description":"bundle_tag_personalization_description"},{"name":"Bundle Portal Engine","description":"bundle_tag_portal_engine_description"},{"name":"Bundle Seo","description":"tag_bundle_seo_description"},{"name":"Bundle Statistics Explorer","description":"bundle_tag_statistics_explorer_description"},{"name":"Bundle Studio Dashboards","description":"bundle_tag_dashboards_description"},{"name":"Bundle Web To Print","description":"bundle_tag_web_to_print_description"}]}