Repository: pimcore/data-hub Branch: 2026.x Commit: e4827eec8b3f Files: 788 Total size: 6.0 MB Directory structure: gitextract_h5rchwfk/ ├── .editorconfig ├── .gitattributes ├── .github/ │ ├── CODEOWNERS │ ├── ISSUE_TEMPLATE/ │ │ ├── Bug-Report.yml │ │ ├── Feature-Request.yml │ │ ├── Improvement.yml │ │ └── config.yml │ ├── PULL_REQUEST_TEMPLATE.md │ ├── ci/ │ │ ├── files/ │ │ │ ├── .my.cnf │ │ │ ├── bin/ │ │ │ │ └── console │ │ │ ├── config/ │ │ │ │ ├── bundles.php │ │ │ │ ├── config.yaml │ │ │ │ ├── packages/ │ │ │ │ │ ├── security.yaml │ │ │ │ │ └── test/ │ │ │ │ │ └── config.yaml │ │ │ │ ├── services.yaml │ │ │ │ └── system.yml │ │ │ ├── kernel/ │ │ │ │ └── Kernel.php │ │ │ ├── public/ │ │ │ │ ├── .htaccess │ │ │ │ └── index_test.php │ │ │ ├── security.yaml │ │ │ └── templates/ │ │ │ └── .gitkeep │ │ └── scripts/ │ │ └── setup-pimcore-environment.sh │ └── workflows/ │ ├── cla-check.yaml │ ├── codeception.yml │ ├── frontend-build-pr.yaml │ ├── frontend-publish-unified.yaml │ ├── new-docs.yml │ ├── new-php-cs-fixer.yaml │ ├── new-static-analysis.yaml │ ├── shared-frontend-build.yaml │ ├── shared-npm-publish.yaml │ └── stale.yml ├── .gitignore ├── .php-cs-fixer.dist.php ├── CONTRIBUTING.md ├── LICENSE.md ├── README.md ├── SECURITY.md ├── assets/ │ └── studio/ │ ├── README.md │ ├── build/ │ │ └── api/ │ │ ├── docs.jsonopenapi.json │ │ └── openapi-config.ts │ ├── dist/ │ │ └── .gitkeep │ ├── eslint.config.mjs │ ├── js/ │ │ └── src/ │ │ ├── components/ │ │ │ └── base-detail-view/ │ │ │ ├── base-detail-view.styles.tsx │ │ │ ├── base-detail-view.tsx │ │ │ ├── components/ │ │ │ │ └── config-toolbar/ │ │ │ │ ├── config-toolbar.styles.ts │ │ │ │ ├── config-toolbar.tsx │ │ │ │ └── index.ts │ │ │ ├── hooks/ │ │ │ │ ├── index.ts │ │ │ │ └── use-detail-view.ts │ │ │ └── index.ts │ │ ├── config/ │ │ │ └── service-ids.ts │ │ ├── main.ts │ │ ├── modules/ │ │ │ ├── config/ │ │ │ │ ├── components/ │ │ │ │ │ ├── column-config-modal/ │ │ │ │ │ │ ├── base-column-editor.tsx │ │ │ │ │ │ ├── column-config-modal.tsx │ │ │ │ │ │ ├── column-editor-item.tsx │ │ │ │ │ │ ├── column-locale-control.tsx │ │ │ │ │ │ ├── column-pipeline-form.tsx │ │ │ │ │ │ ├── column-preview.tsx │ │ │ │ │ │ ├── index.ts │ │ │ │ │ │ ├── types.ts │ │ │ │ │ │ ├── use-add-column-dropdown.ts │ │ │ │ │ │ └── use-column-editor-state.ts │ │ │ │ │ ├── config-sidebar/ │ │ │ │ │ │ ├── components/ │ │ │ │ │ │ │ └── config-sidebar-toolbar/ │ │ │ │ │ │ │ └── toolbar.tsx │ │ │ │ │ │ ├── config-sidebar.styles.ts │ │ │ │ │ │ └── config-sidebar.tsx │ │ │ │ │ ├── export-button/ │ │ │ │ │ │ ├── export-button.tsx │ │ │ │ │ │ └── index.ts │ │ │ │ │ ├── field-width-container.tsx │ │ │ │ │ ├── import-button/ │ │ │ │ │ │ └── import-button.tsx │ │ │ │ │ ├── migration-modal/ │ │ │ │ │ │ ├── index.ts │ │ │ │ │ │ └── migration-modal.tsx │ │ │ │ │ └── tabs/ │ │ │ │ │ ├── config-tab-content.tsx │ │ │ │ │ ├── config-tabs.styles.tsx │ │ │ │ │ └── config-tabs.tsx │ │ │ │ ├── config-api-slice-enhanced.ts │ │ │ │ ├── config-api-slice.gen.ts │ │ │ │ ├── config-container.tsx │ │ │ │ ├── dynamic-types/ │ │ │ │ │ ├── adapters/ │ │ │ │ │ │ └── dynamic-type-data-hub-adapter-graphql.tsx │ │ │ │ │ ├── dynamic-type-data-hub-adapter-abstract.tsx │ │ │ │ │ ├── dynamic-type-data-hub-adapter-registry.ts │ │ │ │ │ └── index.ts │ │ │ │ ├── hooks/ │ │ │ │ │ ├── use-data-hub-config.ts │ │ │ │ │ └── use-tab-manager.ts │ │ │ │ ├── index.tsx │ │ │ │ ├── providers/ │ │ │ │ │ └── config-provider.tsx │ │ │ │ ├── users-api-slice.gen.ts │ │ │ │ └── utils/ │ │ │ │ ├── adapter-helpers.ts │ │ │ │ ├── get-export-url.ts │ │ │ │ └── tree-helpers.ts │ │ │ ├── graphql/ │ │ │ │ ├── components/ │ │ │ │ │ ├── backend-types.ts │ │ │ │ │ ├── graphql-detail-view.tsx │ │ │ │ │ ├── inline-dropdown-panel/ │ │ │ │ │ │ ├── inline-dropdown-panel.styles.tsx │ │ │ │ │ │ └── inline-dropdown-panel.tsx │ │ │ │ │ ├── tabs/ │ │ │ │ │ │ ├── general-tab.tsx │ │ │ │ │ │ ├── permissions-tab/ │ │ │ │ │ │ │ ├── permission-accordion.tsx │ │ │ │ │ │ │ ├── permission-grid.tsx │ │ │ │ │ │ │ └── types.ts │ │ │ │ │ │ ├── permissions-tab.tsx │ │ │ │ │ │ ├── schema-definition-tab/ │ │ │ │ │ │ │ ├── generic-types-grid.tsx │ │ │ │ │ │ │ ├── mutation-grid.tsx │ │ │ │ │ │ │ ├── query-grid.tsx │ │ │ │ │ │ │ ├── schema-accordion.tsx │ │ │ │ │ │ │ ├── schema-fields-modal/ │ │ │ │ │ │ │ │ ├── available-fields-tree/ │ │ │ │ │ │ │ │ │ ├── available-fields-tree.styles.ts │ │ │ │ │ │ │ │ │ ├── available-fields-tree.tsx │ │ │ │ │ │ │ │ │ ├── empty-tree-drop-zone.styles.ts │ │ │ │ │ │ │ │ │ ├── empty-tree-drop-zone.tsx │ │ │ │ │ │ │ │ │ ├── hooks/ │ │ │ │ │ │ │ │ │ │ ├── use-drop-validation.ts │ │ │ │ │ │ │ │ │ │ ├── use-tree-context.tsx │ │ │ │ │ │ │ │ │ │ ├── use-tree-nodes.tsx │ │ │ │ │ │ │ │ │ │ └── use-tree-state.ts │ │ │ │ │ │ │ │ │ ├── index.ts │ │ │ │ │ │ │ │ │ ├── source-config-utils.ts │ │ │ │ │ │ │ │ │ ├── tree-item/ │ │ │ │ │ │ │ │ │ │ └── tree-item.ts │ │ │ │ │ │ │ │ │ ├── tree-node-renderer.tsx │ │ │ │ │ │ │ │ │ └── utils/ │ │ │ │ │ │ │ │ │ ├── tree-conversion-utils.ts │ │ │ │ │ │ │ │ │ ├── tree-operations.ts │ │ │ │ │ │ │ │ │ └── tree-validation-utils.ts │ │ │ │ │ │ │ │ ├── components/ │ │ │ │ │ │ │ │ │ ├── add-all-definitions-button.tsx │ │ │ │ │ │ │ │ │ ├── class-attributes-sidebar.styles.tsx │ │ │ │ │ │ │ │ │ ├── class-attributes-sidebar.tsx │ │ │ │ │ │ │ │ │ ├── draggable-tree-title.tsx │ │ │ │ │ │ │ │ │ ├── operator-grid-item.tsx │ │ │ │ │ │ │ │ │ └── operators-sidebar.tsx │ │ │ │ │ │ │ │ ├── definitions/ │ │ │ │ │ │ │ │ │ └── system-column-definitions.ts │ │ │ │ │ │ │ │ ├── drag-types.ts │ │ │ │ │ │ │ │ ├── hooks/ │ │ │ │ │ │ │ │ │ ├── class-attributes-tree-helpers.ts │ │ │ │ │ │ │ │ │ ├── use-class-attributes-tree.tsx │ │ │ │ │ │ │ │ │ ├── use-objectbrick-layouts.tsx │ │ │ │ │ │ │ │ │ └── use-sidebar-entries.tsx │ │ │ │ │ │ │ │ ├── schema-fields-modal.styles.ts │ │ │ │ │ │ │ │ ├── schema-fields-modal.tsx │ │ │ │ │ │ │ │ └── types.ts │ │ │ │ │ │ │ └── types.ts │ │ │ │ │ │ ├── schema-definition-tab.tsx │ │ │ │ │ │ ├── security-definition-tab/ │ │ │ │ │ │ │ ├── types.ts │ │ │ │ │ │ │ ├── workspace-accordion.tsx │ │ │ │ │ │ │ └── workspace-grid.tsx │ │ │ │ │ │ └── security-definition-tab.tsx │ │ │ │ │ └── types.ts │ │ │ │ ├── graphql-api-slice-enhanced.ts │ │ │ │ ├── graphql-api-slice.gen.ts │ │ │ │ ├── index.tsx │ │ │ │ └── utils/ │ │ │ │ └── transformers.ts │ │ │ ├── log-tab/ │ │ │ │ ├── filter-sidebar/ │ │ │ │ │ ├── filter-sidebar.styles.tsx │ │ │ │ │ └── filter-sidebar.tsx │ │ │ │ ├── hooks/ │ │ │ │ │ └── use-refresh-interval/ │ │ │ │ │ └── use-refresh-interval.ts │ │ │ │ ├── index.ts │ │ │ │ ├── log-tab.tsx │ │ │ │ └── sidebar-provider/ │ │ │ │ └── sidebar-provider.tsx │ │ │ └── operators/ │ │ │ ├── components/ │ │ │ │ ├── operator-modal.tsx │ │ │ │ └── thumbnail-select.tsx │ │ │ ├── dynamic-type-operator-abstract.ts │ │ │ ├── dynamic-type-operator-registry.ts │ │ │ ├── hooks/ │ │ │ │ ├── use-operator-groups.tsx │ │ │ │ ├── use-operator-modal.tsx │ │ │ │ └── use-operator.tsx │ │ │ ├── operators/ │ │ │ │ ├── alias/ │ │ │ │ │ ├── alias-config-modal.tsx │ │ │ │ │ └── dynamic-type-operator-alias.tsx │ │ │ │ ├── concatenator/ │ │ │ │ │ ├── concatenator-config-modal.tsx │ │ │ │ │ └── dynamic-type-operator-concatenator.tsx │ │ │ │ ├── date-formatter/ │ │ │ │ │ ├── date-formatter-config-modal.tsx │ │ │ │ │ └── dynamic-type-operator-date-formatter.tsx │ │ │ │ ├── element-counter/ │ │ │ │ │ ├── dynamic-type-operator-element-counter.tsx │ │ │ │ │ └── element-counter-config-modal.tsx │ │ │ │ ├── if-empty/ │ │ │ │ │ ├── dynamic-type-operator-if-empty.tsx │ │ │ │ │ └── if-empty-config-modal.tsx │ │ │ │ ├── index.ts │ │ │ │ ├── locale-collector/ │ │ │ │ │ ├── dynamic-type-operator-locale-collector.tsx │ │ │ │ │ └── locale-collector-config-modal.tsx │ │ │ │ ├── locale-switcher/ │ │ │ │ │ ├── dynamic-type-operator-locale-switcher.tsx │ │ │ │ │ └── locale-switcher-config-modal.tsx │ │ │ │ ├── substring/ │ │ │ │ │ ├── dynamic-type-operator-substring.tsx │ │ │ │ │ └── substring-config-modal.tsx │ │ │ │ ├── text/ │ │ │ │ │ ├── dynamic-type-operator-text.tsx │ │ │ │ │ └── text-config-modal.tsx │ │ │ │ ├── thumbnail/ │ │ │ │ │ ├── dynamic-type-operator-thumbnail.tsx │ │ │ │ │ └── thumbnail-config-modal.tsx │ │ │ │ ├── thumbnail-html/ │ │ │ │ │ ├── dynamic-type-operator-thumbnail-html.tsx │ │ │ │ │ └── thumbnail-html-config-modal.tsx │ │ │ │ ├── translate-value/ │ │ │ │ │ ├── dynamic-type-operator-translate-value.tsx │ │ │ │ │ └── translate-value-config-modal.tsx │ │ │ │ └── trimmer/ │ │ │ │ ├── dynamic-type-operator-trimmer.tsx │ │ │ │ └── trimmer-config-modal.tsx │ │ │ └── thumbnails-api-slice.gen.ts │ │ ├── plugins.ts │ │ └── sdk/ │ │ ├── index.ts │ │ └── utils/ │ │ └── yaml.ts │ ├── package.json │ ├── rsbuild.config.ts │ └── tsconfig.json ├── codeception.dist.yml ├── composer.json ├── doc/ │ ├── 01_Installation_and_Upgrade/ │ │ ├── 01_Upgrade_Notes.md │ │ └── README.md │ ├── 02_Basic_Principle.md │ ├── 04_Studio.md │ ├── 10_GraphQL/ │ │ ├── 01_Configuration/ │ │ │ ├── 01_General_Settings.md │ │ │ ├── 02_Schema_Settings.md │ │ │ ├── 03_Security_Settings.md │ │ │ ├── 04_Custom_Permissions.md │ │ │ └── 15_Customize_Endpoint_URL.md │ │ ├── 04_Query/ │ │ │ ├── 01_Document_Queries.md │ │ │ ├── 04_Asset_Queries.md │ │ │ ├── 05_DataObject_Queries.md │ │ │ ├── 08_Localization.md │ │ │ ├── 10_Filtering.md │ │ │ ├── 11_Query_Samples/ │ │ │ │ ├── 05_Sample_Element_Properties.md │ │ │ │ ├── 08_ClassificationStore.md │ │ │ │ ├── 10_Sample_GetTranslation.md │ │ │ │ ├── 11_Sample_GetAsset.md │ │ │ │ ├── 12_Sample_Asset_Metadata.md │ │ │ │ ├── 13_Sample_GetAssetListing.md │ │ │ │ ├── 14_Sample_GetTranslationListing.md │ │ │ │ ├── 20_Sample_Manufacturer_Listing.md │ │ │ │ ├── 21_Sample_ManyToMany_Object_Relation.md │ │ │ │ ├── 22_Sample_Advanced_ManyToMany_Object_Relation.md │ │ │ │ ├── 23_Sample_Advanced_ManyToMany_Relation_Metadata.md │ │ │ │ ├── 24_Sample_Fieldcollections.md │ │ │ │ ├── 25_Sample_Parent_Children_Siblings.md │ │ │ │ ├── 26_Sample_Get_Linked_Data.md │ │ │ │ ├── 27_Sample_Translate_Values.md │ │ │ │ └── _category_.json │ │ │ ├── 11_Using_Aliases.md │ │ │ ├── 15_Add_Custom_Query_Datatype.md │ │ │ ├── 16_Add_Custom_Query_Operator.md │ │ │ └── 20_Add_Custom_Query.md │ │ ├── 07_Mutation/ │ │ │ ├── 01_Document_Mutations.md │ │ │ ├── 04_Asset_Mutations.md │ │ │ ├── 20_DataObject_Mutations.md │ │ │ ├── 24_Mutation_Samples/ │ │ │ │ ├── 01_FreeformAPI_Create_Document_with_Areablocks.md │ │ │ │ ├── 02_FreeformAPI_Update_Email_Document.md │ │ │ │ ├── 03_FreeformAPI_Create_new_Link_Document.md │ │ │ │ ├── 04_TreeAPI_Create_Document_with_Areablocks.md │ │ │ │ ├── 10_Sample_Add_Relations.md │ │ │ │ ├── 15_Fieldcollection_Mutations.md │ │ │ │ └── 20_Operators/ │ │ │ │ └── 01_Locale_Collector.md │ │ │ ├── 25_Add_Custom_Mutation_Datatype.md │ │ │ ├── 26_Add_Custom_Mutation_Operator.md │ │ │ └── 27_Add_Custom_Mutations.md │ │ ├── 08_Operators/ │ │ │ ├── Mutation/ │ │ │ │ ├── IfEmpty.md │ │ │ │ ├── LocalCollector.md │ │ │ │ └── LocaleSwitcher.md │ │ │ ├── Query/ │ │ │ │ ├── Alias.md │ │ │ │ ├── AssetThumbnail.md │ │ │ │ ├── AssetThumbnailHTML.md │ │ │ │ ├── Concatenator.md │ │ │ │ ├── DateFormatter.md │ │ │ │ ├── ElementCounter.md │ │ │ │ ├── StaticText.md │ │ │ │ ├── Substring.md │ │ │ │ ├── TranslateValue.md │ │ │ │ └── Trimmer.md │ │ │ └── README.md │ │ ├── 10_Events.md │ │ └── README.md │ ├── 20_Deployment.md │ └── 30_Testing.md ├── phpstan-baseline.neon ├── phpstan-bootstrap.php ├── phpstan.neon ├── src/ │ ├── .gitkeep │ ├── Command/ │ │ └── Configuration/ │ │ ├── MigrateLegacyConfig.php │ │ └── RebuildWorkspacesCommand.php │ ├── ConfigEvents.php │ ├── Configuration/ │ │ ├── Dao.php │ │ └── Workspace/ │ │ ├── AbstractWorkspace.php │ │ ├── Asset.php │ │ ├── Dao.php │ │ ├── DataObject.php │ │ └── Document.php │ ├── Configuration.php │ ├── Controller/ │ │ ├── Studio/ │ │ │ ├── Config/ │ │ │ │ ├── AddController.php │ │ │ │ ├── CloneController.php │ │ │ │ ├── CollectionController.php │ │ │ │ ├── DeleteController.php │ │ │ │ ├── ExportController.php │ │ │ │ ├── GetController.php │ │ │ │ ├── ImportController.php │ │ │ │ └── UpdateController.php │ │ │ ├── GraphQL/ │ │ │ │ ├── ExplorerController.php │ │ │ │ └── ExplorerUrlController.php │ │ │ ├── Thumbnails/ │ │ │ │ └── CollectionController.php │ │ │ └── Users/ │ │ │ └── CollectionController.php │ │ └── WebserviceController.php │ ├── DependencyInjection/ │ │ ├── Compiler/ │ │ │ ├── CustomDocumentTypePass.php │ │ │ └── ImportExportLocatorsPass.php │ │ ├── Configuration.php │ │ └── PimcoreDataHubExtension.php │ ├── Event/ │ │ ├── AdminEvents.php │ │ ├── Config/ │ │ │ └── SpecialEntitiesEvent.php │ │ ├── ConfigurationEvents.php │ │ ├── GraphQL/ │ │ │ ├── AssetMetadataEvents.php │ │ │ ├── ExecutorEvents.php │ │ │ ├── ListingEvents.php │ │ │ ├── Model/ │ │ │ │ ├── ExecutorEvent.php │ │ │ │ ├── ExecutorResultEvent.php │ │ │ │ ├── ListingEvent.php │ │ │ │ ├── MutationTypeEvent.php │ │ │ │ ├── OutputCachePreLoadEvent.php │ │ │ │ ├── OutputCachePreSaveEvent.php │ │ │ │ ├── PermissionEvent.php │ │ │ │ └── QueryTypeEvent.php │ │ │ ├── MutationEvents.php │ │ │ ├── OutputCacheEvents.php │ │ │ ├── PermissionEvents.php │ │ │ └── QueryEvents.php │ │ ├── IsValidDataObjectTriggerEvent.php │ │ └── Studio/ │ │ └── PreResponse/ │ │ ├── ConfigurationDetailEvent.php │ │ ├── ConfigurationEvent.php │ │ ├── PermissionUserEvent.php │ │ └── ThumbnailEvent.php │ ├── EventListener/ │ │ └── DataChangeListener.php │ ├── EventSubscriber/ │ │ └── StudioContextPermissionsSubscriber.php │ ├── GraphQL/ │ │ ├── AssetType/ │ │ │ ├── AssetEmbeddedMetaInfoItem.php │ │ │ ├── AssetFolderType.php │ │ │ ├── AssetInputType.php │ │ │ ├── AssetMetadataItem.php │ │ │ ├── AssetTreeType.php │ │ │ └── AssetType.php │ │ ├── BaseDescriptor.php │ │ ├── BlockDescriptor.php │ │ ├── ClassTypeDefinitions.php │ │ ├── ClassificationstoreFeatureQueryTypeGenerator/ │ │ │ ├── Base.php │ │ │ ├── BooleanSelect.php │ │ │ ├── CalculatedValue.php │ │ │ ├── Checkbox.php │ │ │ ├── Country.php │ │ │ ├── Countrymultiselect.php │ │ │ ├── Date.php │ │ │ ├── Datetime.php │ │ │ ├── Input.php │ │ │ ├── InputQuantityValue.php │ │ │ ├── Language.php │ │ │ ├── Languagemultiselect.php │ │ │ ├── Multiselect.php │ │ │ ├── Numeric.php │ │ │ ├── QuantityValue.php │ │ │ ├── RgbaColor.php │ │ │ ├── Select.php │ │ │ ├── Slider.php │ │ │ ├── Textarea.php │ │ │ ├── Time.php │ │ │ └── Wysiwyg.php │ │ ├── ClassificationstoreFeatureType/ │ │ │ ├── BooleanSelectType.php │ │ │ ├── CheckboxType.php │ │ │ ├── DateType.php │ │ │ ├── Helper.php │ │ │ ├── MultiselectType.php │ │ │ ├── QuantityValueType.php │ │ │ └── StringType.php │ │ ├── ClassificationstoreType/ │ │ │ ├── Feature.php │ │ │ └── Group.php │ │ ├── DataObjectInputProcessor/ │ │ │ ├── AdvancedManyToManyObjectRelation.php │ │ │ ├── AdvancedManyToManyRelation.php │ │ │ ├── Base.php │ │ │ ├── BaseOperator.php │ │ │ ├── Date.php │ │ │ ├── ExternalImage.php │ │ │ ├── Fieldcollections.php │ │ │ ├── Geopoint.php │ │ │ ├── IfEmptyOperator.php │ │ │ ├── Image.php │ │ │ ├── ImageGallery.php │ │ │ ├── InputQuantityValue.php │ │ │ ├── Link.php │ │ │ ├── LocaleCollectorOperator.php │ │ │ ├── LocaleSwitcherOperator.php │ │ │ ├── ManyToManyObjectRelation.php │ │ │ ├── ManyToManyRelation.php │ │ │ ├── ManyToOneRelation.php │ │ │ ├── QuantityValue.php │ │ │ └── Table.php │ │ ├── DataObjectMutationFieldConfigGenerator/ │ │ │ ├── AdvancedManyToManyObjectRelation.php │ │ │ ├── AdvancedManyToManyRelation.php │ │ │ ├── Base.php │ │ │ ├── BooleanSelect.php │ │ │ ├── Checkbox.php │ │ │ ├── Date.php │ │ │ ├── ExternalImage.php │ │ │ ├── Fieldcollections.php │ │ │ ├── Geopoint.php │ │ │ ├── Image.php │ │ │ ├── ImageGallery.php │ │ │ ├── InputQuantityValue.php │ │ │ ├── Link.php │ │ │ ├── ManyToManyObjectRelation.php │ │ │ ├── ManyToManyRelation.php │ │ │ ├── ManyToOneRelation.php │ │ │ ├── Multiselect.php │ │ │ ├── Numeric.php │ │ │ ├── QuantityValue.php │ │ │ └── Table.php │ │ ├── DataObjectMutationFieldConfigGeneratorInterface.php │ │ ├── DataObjectMutationOperatorConfigGenerator/ │ │ │ ├── Base.php │ │ │ ├── IfEmpty.php │ │ │ ├── LocaleCollector.php │ │ │ └── LocaleSwitcher.php │ │ ├── DataObjectQueryFieldConfigGenerator/ │ │ │ ├── AbstractTable.php │ │ │ ├── AssetBase.php │ │ │ ├── Base.php │ │ │ ├── Block.php │ │ │ ├── CalculatedValue.php │ │ │ ├── Checkbox.php │ │ │ ├── Classificationstore.php │ │ │ ├── Date.php │ │ │ ├── Datetime.php │ │ │ ├── Geobounds.php │ │ │ ├── Geopoint.php │ │ │ ├── Geopolygon.php │ │ │ ├── Helper/ │ │ │ │ ├── AssetBase.php │ │ │ │ ├── Base.php │ │ │ │ ├── Hotspotimage.php │ │ │ │ ├── Href.php │ │ │ │ ├── Image.php │ │ │ │ ├── ImageGallery.php │ │ │ │ ├── Multihref.php │ │ │ │ ├── MultihrefMetadata.php │ │ │ │ ├── Objects.php │ │ │ │ ├── ObjectsMetadata.php │ │ │ │ └── ReverseManyToManyObjects.php │ │ │ ├── Hotspotimage.php │ │ │ ├── Href.php │ │ │ ├── Image.php │ │ │ ├── ImageGallery.php │ │ │ ├── Input.php │ │ │ ├── InputQuantityValue.php │ │ │ ├── Link.php │ │ │ ├── Multihref.php │ │ │ ├── MultihrefMetadata.php │ │ │ ├── Multiselect.php │ │ │ ├── Numeric.php │ │ │ ├── Objects.php │ │ │ ├── ObjectsMetadata.php │ │ │ ├── QuantityValue.php │ │ │ ├── ReverseManyToManyObjectRelation.php │ │ │ ├── Select.php │ │ │ ├── Slider.php │ │ │ ├── StructuredTable.php │ │ │ ├── Table.php │ │ │ ├── UrlSlug.php │ │ │ └── Video.php │ │ ├── DataObjectQueryFieldConfigGeneratorInterface.php │ │ ├── DataObjectQueryOperatorConfigGenerator/ │ │ │ ├── Alias.php │ │ │ ├── Base.php │ │ │ ├── Concatenator.php │ │ │ ├── DateFormatter.php │ │ │ ├── ElementCounter.php │ │ │ ├── IntBase.php │ │ │ ├── StringBase.php │ │ │ ├── Substring.php │ │ │ ├── Thumbnail.php │ │ │ ├── ThumbnailHtml.php │ │ │ ├── TranslateValue.php │ │ │ └── Trimmer.php │ │ ├── DataObjectType/ │ │ │ ├── AbstractRelationsType.php │ │ │ ├── BlockEntryType.php │ │ │ ├── ElementDescriptorInputType.php │ │ │ ├── ElementMetadataKeyValuePairInputType.php │ │ │ ├── ElementMetadataKeyValuePairType.php │ │ │ ├── FieldcollectionType.php │ │ │ ├── GeoboundsType.php │ │ │ ├── GeopointInputType.php │ │ │ ├── GeopointType.php │ │ │ ├── HotspotType.php │ │ │ ├── HrefType.php │ │ │ ├── InputQuantityValueInputType.php │ │ │ ├── InputQuantityValueType.php │ │ │ ├── InputType/ │ │ │ │ ├── AbstractRelationInputType.php │ │ │ │ └── ImageInputType.php │ │ │ ├── LinkInputType.php │ │ │ ├── LinkType.php │ │ │ ├── LocalizedType.php │ │ │ ├── MultihrefMetadataType.php │ │ │ ├── ObjectFolderType.php │ │ │ ├── ObjectMetadataType.php │ │ │ ├── ObjectTreeType.php │ │ │ ├── PimcoreObjectType.php │ │ │ ├── QuantityValueInputType.php │ │ │ ├── QuantityValueType.php │ │ │ ├── QuantityValueUnitType.php │ │ │ ├── UrlSlugType.php │ │ │ ├── VideoType.php │ │ │ └── VideoTypeDataType.php │ │ ├── DataObjectTypeFactory.php │ │ ├── DocumentElementInputProcessor/ │ │ │ ├── Areablock.php │ │ │ ├── Base.php │ │ │ ├── Block.php │ │ │ ├── EditablesTrait.php │ │ │ ├── Embed.php │ │ │ ├── Image.php │ │ │ ├── Input.php │ │ │ ├── Multiselect.php │ │ │ ├── Scheduledblock.php │ │ │ ├── Select.php │ │ │ └── Wysiwyg.php │ │ ├── DocumentElementMutationFieldConfigGenerator/ │ │ │ ├── Areablock.php │ │ │ ├── Base.php │ │ │ ├── Block.php │ │ │ ├── Embed.php │ │ │ ├── Image.php │ │ │ ├── Input.php │ │ │ ├── Multiselect.php │ │ │ ├── Scheduledblock.php │ │ │ ├── Select.php │ │ │ └── Wysiwyg.php │ │ ├── DocumentElementQueryFieldConfigGenerator/ │ │ │ ├── Areablock.php │ │ │ ├── Base.php │ │ │ ├── Block.php │ │ │ ├── Checkbox.php │ │ │ ├── Date.php │ │ │ ├── Embed.php │ │ │ ├── Image.php │ │ │ ├── Input.php │ │ │ ├── Link.php │ │ │ ├── Multiselect.php │ │ │ ├── Numeric.php │ │ │ ├── Pdf.php │ │ │ ├── Relation.php │ │ │ ├── Relations.php │ │ │ ├── Scheduledblock.php │ │ │ ├── Select.php │ │ │ ├── Table.php │ │ │ ├── Textarea.php │ │ │ ├── Video.php │ │ │ └── Wysiwyg.php │ │ ├── DocumentElementType/ │ │ │ ├── AreablockDataInputType.php │ │ │ ├── AreablockDataType.php │ │ │ ├── AreablockType.php │ │ │ ├── BlockType.php │ │ │ ├── CheckboxType.php │ │ │ ├── DateType.php │ │ │ ├── EmbedType.php │ │ │ ├── ImageType.php │ │ │ ├── InputType.php │ │ │ ├── LinkDataType.php │ │ │ ├── LinkType.php │ │ │ ├── MultiselectType.php │ │ │ ├── NumericType.php │ │ │ ├── PdfType.php │ │ │ ├── RelationType.php │ │ │ ├── RelationsType.php │ │ │ ├── ScheduledblockDataInputType.php │ │ │ ├── ScheduledblockDataType.php │ │ │ ├── ScheduledblockType.php │ │ │ ├── SelectType.php │ │ │ ├── SimpleTextType.php │ │ │ ├── TableType.php │ │ │ ├── TextareaType.php │ │ │ ├── VideoType.php │ │ │ └── WysiwygType.php │ │ ├── DocumentResolver/ │ │ │ ├── Email.php │ │ │ ├── Hardlink.php │ │ │ ├── Link.php │ │ │ └── PageSnippet.php │ │ ├── DocumentType/ │ │ │ ├── AbstractDocumentType.php │ │ │ ├── DocumentElementType.php │ │ │ ├── DocumentFolderType.php │ │ │ ├── DocumentLinkInputType.php │ │ │ ├── DocumentPageInputType.php │ │ │ ├── DocumentTranslationType.php │ │ │ ├── DocumentTreeType.php │ │ │ ├── DocumentType.php │ │ │ ├── EmailType.php │ │ │ ├── HardlinkType.php │ │ │ ├── LinkType.php │ │ │ ├── PageSnippetType.php │ │ │ ├── PageType.php │ │ │ └── SnippetType.php │ │ ├── ElementDescriptor.php │ │ ├── ElementTag.php │ │ ├── Exception/ │ │ │ ├── ClientSafeException.php │ │ │ ├── InvalidFieldDefinitionException.php │ │ │ └── NotAllowedException.php │ │ ├── FeatureDescriptor.php │ │ ├── FieldHelper/ │ │ │ ├── AbstractFieldHelper.php │ │ │ ├── AssetFieldHelper.php │ │ │ ├── DataObjectFieldHelper.php │ │ │ └── DocumentFieldHelper.php │ │ ├── FieldcollectionDescriptor.php │ │ ├── General/ │ │ │ ├── AnyDocumentTargetType.php │ │ │ ├── AnyTargetType.php │ │ │ ├── FolderType.php │ │ │ └── UploadType.php │ │ ├── GeneralTypeFactory.php │ │ ├── Helper.php │ │ ├── Mutation/ │ │ │ ├── MutationType.php │ │ │ └── Operator/ │ │ │ └── Factory/ │ │ │ ├── DefaultMutationOperatorFactory.php │ │ │ └── DefaultMutationOperatorFactoryBase.php │ │ ├── OperatorTypeDefinitionInterface.php │ │ ├── PropertyType/ │ │ │ ├── AssetFolderType.php │ │ │ ├── AssetType.php │ │ │ ├── CheckboxType.php │ │ │ ├── DataObjectType.php │ │ │ ├── DocumentFolderType.php │ │ │ ├── DocumentType.php │ │ │ ├── ElementPropertyType.php │ │ │ ├── HotspotMetadataType.php │ │ │ ├── ObjectFolderType.php │ │ │ ├── ObjectsType.php │ │ │ ├── SelectType.php │ │ │ ├── TextType.php │ │ │ └── TextareaType.php │ │ ├── Query/ │ │ │ ├── ConfigElementInterface.php │ │ │ ├── Operator/ │ │ │ │ ├── AbstractOperator.php │ │ │ │ ├── Alias.php │ │ │ │ ├── Concatenator.php │ │ │ │ ├── DateFormatter.php │ │ │ │ ├── ElementCounter.php │ │ │ │ ├── Factory/ │ │ │ │ │ ├── DefaultOperatorFactoryBase.php │ │ │ │ │ ├── DefaultQueryOperatorFactory.php │ │ │ │ │ └── OperatorFactoryInterface.php │ │ │ │ ├── OperatorInterface.php │ │ │ │ ├── Substring.php │ │ │ │ ├── Text.php │ │ │ │ ├── Thumbnail.php │ │ │ │ ├── ThumbnailHtml.php │ │ │ │ ├── TranslateValue.php │ │ │ │ └── Trimmer.php │ │ │ ├── QueryType.php │ │ │ └── Value/ │ │ │ ├── AbstractValue.php │ │ │ ├── DefaultValue.php │ │ │ └── ValueInterface.php │ │ ├── RelationHelper.php │ │ ├── Resolver/ │ │ │ ├── AssetListing.php │ │ │ ├── AssetType.php │ │ │ ├── Base.php │ │ │ ├── DataObject.php │ │ │ ├── Document.php │ │ │ ├── Element.php │ │ │ ├── Geobounds.php │ │ │ ├── Geopoint.php │ │ │ ├── HotspotType.php │ │ │ ├── Link.php │ │ │ ├── MultihrefMetadata.php │ │ │ ├── ObjectMetadata.php │ │ │ ├── QuantityValue.php │ │ │ ├── QueryType.php │ │ │ ├── TranslationListing.php │ │ │ ├── UrlSlug.php │ │ │ └── Video.php │ │ ├── Service.php │ │ ├── SharedType/ │ │ │ ├── HotspotCropType.php │ │ │ ├── HotspotHotspotType.php │ │ │ ├── HotspotMarkerType.php │ │ │ ├── JsonType.php │ │ │ └── KeyValueType.php │ │ ├── Traits/ │ │ │ ├── ElementIdentificationTrait.php │ │ │ ├── ElementTagTrait.php │ │ │ ├── PermissionInfoTrait.php │ │ │ └── ServiceTrait.php │ │ ├── TranslationType/ │ │ │ └── TranslationType.php │ │ ├── TypeDefinitionInterface.php │ │ └── TypeInterface/ │ │ ├── CsFeature.php │ │ ├── Element.php │ │ └── Property.php │ ├── Hydrator/ │ │ ├── ConfigurationDehydrator.php │ │ ├── ConfigurationDehydratorInterface.php │ │ ├── ConfigurationDetailHydrator.php │ │ ├── ConfigurationDetailHydratorInterface.php │ │ ├── ConfigurationHydrator.php │ │ ├── ConfigurationHydratorInterface.php │ │ ├── PermissionUserHydrator.php │ │ ├── PermissionUserHydratorInterface.php │ │ ├── ThumbnailHydrator.php │ │ └── ThumbnailHydratorInterface.php │ ├── Installer.php │ ├── Migrations/ │ │ └── PimcoreX/ │ │ ├── Version20210305134111.php │ │ ├── Version20211108160248.php │ │ ├── Version20221212152145.php │ │ ├── Version20230329133119.php │ │ └── Version20230503165847.php │ ├── Model/ │ │ └── SpecialEntitySetting.php │ ├── MySafeException.php │ ├── OpenApi/ │ │ ├── Attribute/ │ │ │ ├── Request/ │ │ │ │ └── FileUploadRequestBody.php │ │ │ └── Response/ │ │ │ └── Content/ │ │ │ ├── ExplorerUrlJson.php │ │ │ └── HtmlContent.php │ │ └── Config/ │ │ ├── Prefix.php │ │ └── Tags.php │ ├── PimcoreDataHubBundle.php │ ├── Resources/ │ │ ├── config/ │ │ │ ├── config.yml │ │ │ ├── doctrine_migrations.yml │ │ │ ├── eventlistener.yml │ │ │ ├── graphql.yml │ │ │ ├── pimcore/ │ │ │ │ ├── config.yaml │ │ │ │ ├── routing.yml │ │ │ │ └── studio_backend.yaml │ │ │ ├── services.yml │ │ │ ├── studio_backend.yaml │ │ │ └── studio_ui.yaml │ │ ├── public/ │ │ │ ├── playground/ │ │ │ │ ├── animations.css │ │ │ │ ├── index.css │ │ │ │ └── middleware.js │ │ │ └── studio/ │ │ │ └── build/ │ │ │ └── ce357842-7dfd-46ae-9fd3-897e4c6c6ffe/ │ │ │ ├── entrypoints.json │ │ │ ├── exposeRemote.js │ │ │ ├── main.html │ │ │ ├── manifest.json │ │ │ ├── mf-manifest.json │ │ │ ├── mf-stats.json │ │ │ └── static/ │ │ │ └── js/ │ │ │ ├── 109.62a4c31b.js │ │ │ ├── 109.62a4c31b.js.LICENSE.txt │ │ │ ├── async/ │ │ │ │ ├── 346.60211bf9.js │ │ │ │ ├── 696.3b1d6da3.js │ │ │ │ ├── 696.3b1d6da3.js.LICENSE.txt │ │ │ │ ├── 840.4693a4bb.js │ │ │ │ ├── 840.4693a4bb.js.LICENSE.txt │ │ │ │ ├── __federation_expose_default_export.87553f32.js │ │ │ │ ├── __federation_expose_default_export.87553f32.js.LICENSE.txt │ │ │ │ ├── __federation_expose_plugins.c4cf01bd.js │ │ │ │ └── __federation_expose_plugins.c4cf01bd.js.LICENSE.txt │ │ │ ├── main.9c3ad8a2.js │ │ │ ├── main.9c3ad8a2.js.LICENSE.txt │ │ │ ├── remoteEntry.js │ │ │ └── remoteEntry.js.LICENSE.txt │ │ ├── translations/ │ │ │ ├── admin.ca.yml │ │ │ ├── admin.cs.yml │ │ │ ├── admin.de.yml │ │ │ ├── admin.en.yml │ │ │ ├── admin.es.yml │ │ │ ├── admin.fr.yml │ │ │ ├── admin.hu.yml │ │ │ ├── admin.it.yml │ │ │ ├── admin.nl.yml │ │ │ ├── admin.pl.yml │ │ │ ├── admin.pt_br.yml │ │ │ ├── admin.ro.yml │ │ │ ├── admin.sk.yml │ │ │ ├── admin.sv.yml │ │ │ ├── admin.th.yml │ │ │ ├── admin.zh_Hans.yml │ │ │ ├── studio.de.yaml │ │ │ ├── studio.en.yaml │ │ │ ├── studio.es.yaml │ │ │ ├── studio.fr.yaml │ │ │ ├── studio.it.yaml │ │ │ ├── studio.no.yaml │ │ │ ├── studio.sv.yaml │ │ │ └── studio_api_docs.en.yaml │ │ └── views/ │ │ └── Feature/ │ │ └── explorer.html.twig │ ├── Schema/ │ │ ├── AddConfiguration.php │ │ ├── CloneConfiguration.php │ │ ├── Configuration.php │ │ ├── ConfigurationDetail.php │ │ ├── PermissionUser.php │ │ ├── Thumbnail.php │ │ ├── UpdateConfiguration.php │ │ └── UpdateConfigurationResponse.php │ ├── Service/ │ │ ├── CheckConsumerPermissionsService.php │ │ ├── FileUploadService.php │ │ ├── OutputCacheService.php │ │ ├── OutputCacheServiceInterface.php │ │ ├── ResponseService.php │ │ ├── ResponseServiceInterface.php │ │ └── Studio/ │ │ ├── ConfigurationService.php │ │ ├── ConfigurationServiceInterface.php │ │ ├── GraphQLExplorerService.php │ │ ├── GraphQLExplorerServiceInterface.php │ │ ├── ThumbnailService.php │ │ ├── ThumbnailServiceInterface.php │ │ ├── UserService.php │ │ └── UserServiceInterface.php │ ├── Utils/ │ │ └── Constants/ │ │ └── PermissionConstants.php │ ├── Webpack/ │ │ └── WebpackEntryPointProvider.php │ └── WorkspaceHelper.php └── tests/ ├── GraphQL/ │ ├── ResolveTest.php │ └── Traits/ │ └── ElementIdentificationTraitTest.php ├── GraphQL.suite.yml ├── Model/ │ ├── ImportingConfigTest.php │ └── _bootstrap.php ├── Model.suite.yml ├── Readme.md ├── Service/ │ ├── CheckConsumerPermissionsServiceTest.php │ ├── OutputCacheServiceTest.php │ └── _bootstrap.php ├── Service.suite.dist.yml ├── _bootstrap.php ├── _support/ │ ├── GraphQLTester.php │ ├── Helper/ │ │ ├── Model.php │ │ ├── Service.php │ │ └── Unit.php │ ├── ModelTester.php │ ├── Resources/ │ │ ├── class_DataHubTestEntity_import.json │ │ └── configuration_query_mutation_allowed.json │ ├── ServiceTester.php │ └── Test/ │ ├── ModelTestCase.php │ └── TestCase.php └── bin/ ├── docker-compose.yml └── init-tests.sh ================================================ FILE CONTENTS ================================================ ================================================ FILE: .editorconfig ================================================ root = true [*] charset = utf-8 end_of_line = lf indent_style = space indent_size = 4 [*.php] insert_final_newline = true trim_trailing_whitespace = true [*.md] trim_trailing_whitespace = false [*.yml] indent_size = 4 [composer.json] indent_style = space indent_size = 2 ================================================ FILE: .gitattributes ================================================ * -text # Exclude build/test files from archive to reduce ZIP size for composer dist download /.github export-ignore /tests export-ignore /.editorconfig export-ignore /.gitattributes export-ignore /.gitignore export-ignore /.markdownlint.json export-ignore /.php-cs-fixer.dist.php export-ignore /CLA.md export-ignore /CONTRIBUTING.md export-ignore /codeception.dist.yml export-ignore /phpstan* export-ignore ================================================ FILE: .github/CODEOWNERS ================================================ .github/workflows/ @bluvulture @berfinyuksel ================================================ FILE: .github/ISSUE_TEMPLATE/Bug-Report.yml ================================================ name: Bug Report description: File a bug report title: "[Bug]: " labels: [Bug] body: - type: markdown attributes: value: | ## Important notice As an open core project we love to work together with our community to improve and develop our products. It's also important for us to make clear that **we're not working for you or your company**, but we enjoy to work together to solve existing bugs. So we would love to see PRs with bugfixes, discuss them and we are happy to merge them when they are ready. For details see also our [contributing guidelines](https://github.com/pimcore/pimcore/blob/10.x/CONTRIBUTING.md). Bug reports that do not meet the conditions listed below will be closed/deleted without comment. - Bug was verified on the latest supported version. - This is not a security issue -> see [our security policy](https://github.com/pimcore/pimcore/security/policy) instead. - You are not able to provide a pull request that fixes the issue. - There's no existing ticket for the same issue. - type: textarea attributes: label: Expected behavior validations: required: true - type: textarea attributes: label: Actual behavior validations: required: true - type: textarea attributes: label: Steps to reproduce validations: required: true ================================================ FILE: .github/ISSUE_TEMPLATE/Feature-Request.yml ================================================ name: Feature Request description: Request or propose a new feature title: "[Feature]: " labels: ["New Feature"] body: - type: markdown attributes: value: | ## Important notice As an open core project we love to work together with our community to improve and develop our products. It's also important for us to make clear that **we're not working for you or your company**, but we enjoy to work together to improve or add new features to the product. So we are always ready to discuss features and improvements with our community. Especially for bigger topics, please [start a discussion](https://github.com/pimcore/pimcore/discussions) first to aviod unnecessary efforts. As soon as a topic is more specific, feel free to create issues for it or even better provide a corresponding PR as we love to review and merge contributions. Feature requests that do not meet the conditions listed below will be closed/deleted without comment. - There's no existing ticket for the same topic - This is already a specific ready-to-work-on feature request - type: textarea attributes: label: Feature description validations: required: true ================================================ FILE: .github/ISSUE_TEMPLATE/Improvement.yml ================================================ name: Improvement description: Request or propose an improvement title: "[Improvement]: " labels: ["Improvement"] body: - type: markdown attributes: value: | ## Important notice As an open core project we love to work together with our community to improve and develop our products. It's also important for us to make clear that **we're not working for you or your company**, but we enjoy to work together to improve or add new features to the product. So we are always ready to discuss features and improvements with our community. Especially for bigger topics, please [start a discussion](https://github.com/pimcore/pimcore/discussions) first to aviod unnecessary efforts. As soon as a topic is more specific, feel free to create issues for it or even better provide a corresponding PR as we love to review and merge contributions. Feature requests that do not meet the conditions listed below will be closed/deleted without comment. - There's no existing ticket for the same topic - This is already a specific ready-to-work-on feature request - type: textarea attributes: label: Improvement description validations: required: true ================================================ FILE: .github/ISSUE_TEMPLATE/config.yml ================================================ blank_issues_enabled: false contact_links: - name: We are hiring! url: https://pimcore.com/en/careers?utm_source=github&utm_medium=issue-template-data-hub&utm_campaign=careers about: Enjoy working with Pimcore? Join us on our mission! - name: Community Support url: https://github.com/pimcore/pimcore/discussions about: Please ask and answer questions here. ================================================ FILE: .github/PULL_REQUEST_TEMPLATE.md ================================================ ## Changes in this pull request Resolves # ## Additional info ================================================ FILE: .github/ci/files/.my.cnf ================================================ [client] host=127.0.0.1 port=33006 user=root password= ================================================ FILE: .github/ci/files/bin/console ================================================ #!/usr/bin/env php getParameterOption(['--env', '-e'], null, true)) { putenv('APP_ENV='.$_SERVER['APP_ENV'] = $_ENV['APP_ENV'] = $env); } if ($input->hasParameterOption('--no-debug', true)) { putenv('APP_DEBUG='.$_SERVER['APP_DEBUG'] = $_ENV['APP_DEBUG'] = '0'); } /** @var \Pimcore\Kernel $kernel */ $kernel = \Pimcore\Bootstrap::startupCli(); $application = new \Pimcore\Console\Application($kernel); $application->run(); return $application; }; ================================================ FILE: .github/ci/files/config/bundles.php ================================================ ['all' => true], Pimcore\Bundle\StudioBackendBundle\PimcoreStudioBackendBundle::class => ['all' => true], Pimcore\Bundle\StudioUiBundle\PimcoreStudioUiBundle::class => ['all' => true], ]; ================================================ FILE: .github/ci/files/config/config.yaml ================================================ imports: - { resource: services.yaml } - { resource: system.yml } pimcore_data_hub: config_location: data_hub: write_target: type: 'settings-store' ================================================ FILE: .github/ci/files/config/packages/security.yaml ================================================ security: providers: pimcore_admin: id: Pimcore\Security\User\UserProvider firewalls: dev: pattern: ^/(_(profiler|wdt)|css|images|js)/ security: false pimcore_studio: '%pimcore_studio_backend.firewall_settings%' # Pimcore WebDAV HTTP basic // DO NOT CHANGE! pimcore_webdav: pattern: ^/asset/webdav provider: pimcore_admin http_basic: ~ access_control: # Pimcore admin ACl // DO NOT CHANGE! - { path: ^/pimcore-studio/api/(docs|docs/json|translations|user/reset-password)$, roles: PUBLIC_ACCESS } - { path: ^/pimcore-studio/api, roles: ROLE_PIMCORE_USER } - { path: ^/asset/webdav, roles: ROLE_PIMCORE_USER } role_hierarchy: # Pimcore admin // DO NOT CHANGE! ROLE_PIMCORE_ADMIN: [ROLE_PIMCORE_USER] ================================================ FILE: .github/ci/files/config/packages/test/config.yaml ================================================ imports: - { resource: ../../config.yaml } # this cache is used during tests when setting up pimcore framework: cache: pools: pimcore.cache.pool: public: true tags: true default_lifetime: 31536000 # 1 year adapter: cache.adapter.array doctrine: dbal: connections: default: url: '%pimcore_test.db.dsn%' host: ~ port: ~ dbname: ~ user: ~ password: ~ mapping_types: bit: boolean pimcore: product_registration: instance_identifier: '%env(PIMCORE_INSTANCE_IDENTIFIER)%' product_key: '%env(PIMCORE_PRODUCT_KEY)%' parameters: pimcore_test.db.dsn: '%env(PIMCORE_TEST_DB_DSN)%' env(PIMCORE_TEST_DB_DSN): ~ pimcore.encryption.secret: '%env(PIMCORE_ENCRYPTION_SECRET)%' ================================================ FILE: .github/ci/files/config/services.yaml ================================================ parameters: secret: ThisTokenIsNotSoSecretChangeIt # customize the full path to external executables # normally they are auto-detected by `which program` or auto-discovered in the configured path in # System Settings -> General -> Additional $PATH variable # but in general it's a good idea to have your programs in your $PATH environment variable (system wide) #pimcore_executable_composer: php /opt/vendor/bin/composer.phar #pimcore_executable_soffice: /opt/libreoffice/bin/soffice #pimcore_executable_gs: /opt/ghostscript/bin/gs #pimcore_executable_pdftotext: /opt/tools/pdftotext #pimcore_executable_xvfb-run: /opt/tools/xvfb-run #pimcore_executable_pngcrush: /opt/tools/pngcrush #pimcore_executable_zopflipng: /opt/tools/zopflipng #pimcore_executable_pngout: /opt/tools/pngout #pimcore_executable_advpng: /opt/tools/advpng #pimcore_executable_cjpeg: /opt/tools/cjpeg #pimcore_executable_jpegoptim: /opt/tools/jpegoptim #pimcore_executable_php: /usr/local/custom-php/bin/php #pimcore_executable_nice: /opt/tools/nice #pimcore_executable_nohup: /opt/tools/nohup #pimcore_executable_ffmpeg: /opt/tools/ffmpeg #pimcore_executable_exiftool: /opt/tools/exiftool services: # default configuration for services in *this* file _defaults: # automatically injects dependencies in your services autowire: true # automatically registers your services as commands, event subscribers, etc. autoconfigure: true # this means you cannot fetch services directly from the container via $container->get() # if you need to do this, you can override this setting on individual services public: true # Example custom templating helper # AppBundle\Templating\Helper\Example: # # templating helpers need to be public as they # # are fetched from the container on demand # public: true # tags: # - { name: templating.helper, alias: fooBar } # Example event listener for objects # AppBundle\EventListener\TestListener: # tags: # - { name: kernel.event_listener, event: pimcore.dataobject.preUpdate, method: onObjectPreUpdate } Pimcore\Bundle\DataHubBundle\Installer: public: true arguments: $bundle: "@=service('kernel').getBundle('PimcoreDataHubBundle')" ================================================ FILE: .github/ci/files/config/system.yml ================================================ pimcore: general: timezone: Europe/Berlin path_variable: '' domain: pimcore-test.dev redirect_to_maindomain: false language: en valid_languages: 'en,de' fallback_languages: en: '' de: '' default_language: '' disable_usage_statistics: false documents: versions: days: null steps: 10 error_pages: default: /error allow_trailing_slash: 'no' generate_preview: true objects: versions: days: null steps: 10 assets: versions: days: null steps: 10 icc_rgb_profile: '' icc_cmyk_profile: '' full_page_cache: enabled: false lifetime: null exclude_patterns: '' exclude_cookie: '' httpclient: adapter: Socket proxy_host: '' proxy_port: '' proxy_user: '' proxy_pass: '' email: sender: name: pimcore email: pimcore@example.com return: name: pimcore email: pimcore@example.com debug: email_addresses: '' applicationlog: mail_notification: send_log_summary: false filter_priority: null mail_receiver: '' archive_treshold: '30' archive_alternative_database: '' ================================================ FILE: .github/ci/files/kernel/Kernel.php ================================================ Options -MultiViews # mime types AddType video/mp4 .mp4 AddType video/webm .webm AddType image/jpeg .pjpeg Options +SymLinksIfOwnerMatch # Use UTF-8 encoding for anything served text/plain or text/html AddDefaultCharset utf-8 RewriteEngine On Header always unset X-Content-Type-Options # Determine the RewriteBase automatically and set it as environment variable. # If you are using Apache aliases to do mass virtual hosting or installed the # project in a subdirectory, the base path will be prepended to allow proper # resolution of the app.php file and to redirect to the correct URI. It will # work in environments without path prefix as well, providing a safe, one-size # fits all solution. But as you do not need it in this case, you can comment # the following 2 lines to eliminate the overhead. RewriteCond %{REQUEST_URI}::$1 ^(/.+)/(.*)::\2$ RewriteRule ^(.*) - [E=BASE:%1] # Sets the HTTP_AUTHORIZATION header removed by Apache RewriteCond %{HTTP:Authorization} . RewriteRule ^ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}] # Redirect to URI without front controller to prevent duplicate content # (with and without `/app.php`). Only do this redirect on the initial # rewrite by Apache and not on subsequent cycles. Otherwise we would get an # endless redirect loop (request -> rewrite to front controller -> # redirect -> request -> ...). # So in case you get a "too many redirects" error or you always get redirected # to the start page because your Apache does not expose the REDIRECT_STATUS # environment variable, you have 2 choices: # - disable this feature by commenting the following 2 lines or # - use Apache >= 2.3.9 and replace all L flags by END flags and remove the # following RewriteCond (best solution) RewriteCond %{ENV:REDIRECT_STATUS} ^$ RewriteRule ^app\.php(?:/(.*)|$) %{ENV:BASE}/$1 [R=301,L] RewriteCond %{REQUEST_URI} ^/(fpm|server)-(info|status|ping) RewriteRule . - [L] # restrict access to dotfiles RewriteCond %{REQUEST_FILENAME} -d [OR] RewriteCond %{REQUEST_FILENAME} -l [OR] RewriteCond %{REQUEST_FILENAME} -f RewriteRule /\.|^\.(?!well-known/) - [F,L] # ASSETS: check if request method is GET (because of WebDAV) and if the requested file (asset) exists on the filesystem, if both match, deliver the asset directly RewriteCond %{REQUEST_METHOD} ^(GET|HEAD) RewriteCond %{DOCUMENT_ROOT}/var/assets%{REQUEST_URI} -f RewriteRule ^(.*)$ /var/assets%{REQUEST_URI} [PT,L] # Thumbnails RewriteCond %{REQUEST_URI} .*/(image|video)-thumb__[\d]+__.* RewriteCond %{DOCUMENT_ROOT}/var/tmp/%1-thumbnails%{REQUEST_URI} -f RewriteRule ^(.*)$ /var/tmp/%1-thumbnails%{REQUEST_URI} [PT,L] # cache-buster rule for scripts & stylesheets embedded using view helpers RewriteRule ^cache-buster\-[\d]+/(.*) $1 [PT,L] # If the requested filename exists, simply serve it. # We only want to let Apache serve files and not directories. RewriteCond %{REQUEST_FILENAME} -f RewriteRule ^ - [L] # Rewrite all other queries to the front controller. RewriteRule ^ %{ENV:BASE}/index_test.php [L] ########################################## ### OPTIONAL PERFORMANCE OPTIMIZATIONS ### ########################################## # Force compression for mangled headers. # http://developer.yahoo.com/blogs/ydn/posts/2010/12/pushing-beyond-gzipping SetEnvIfNoCase ^(Accept-EncodXng|X-cept-Encoding|X{15}|~{15}|-{15})$ ^((gzip|deflate)\s*,?\s*)+|[X~-]{4,13}$ HAVE_Accept-Encoding RequestHeader append Accept-Encoding "gzip,deflate" env=HAVE_Accept-Encoding # Compress all output labeled with one of the following MIME-types # (for Apache versions below 2.3.7, you don't need to enable `mod_filter` # and can remove the `` and `` lines # as `AddOutputFilterByType` is still in the core directives). AddOutputFilterByType DEFLATE application/atom+xml application/javascript application/json \ application/vnd.ms-fontobject application/x-font-ttf application/rss+xml \ application/x-web-app-manifest+json application/xhtml+xml \ application/xml font/opentype image/svg+xml image/x-icon \ text/css text/html text/plain text/x-component text/xml text/javascript ExpiresActive on ExpiresDefault "access plus 31536000 seconds" # specific overrides #ExpiresByType text/css "access plus 1 year" # pimcore mod_pagespeed integration # pimcore automatically disables mod_pagespeed in the following situations: debug-mode on, /admin, preview, editmode, ... # if you want to disable pagespeed for specific actions in pimcore you can use $this->disableBrowserCache() in your action RewriteCond %{REQUEST_URI} ^/(mod_)?pagespeed_(statistics|message|console|beacon|admin|global_admin) RewriteRule . - [L] ModPagespeed Off AddOutputFilterByType MOD_PAGESPEED_OUTPUT_FILTER text/html ModPagespeedModifyCachingHeaders off ModPagespeedRewriteLevel PassThrough # low risk filters ModPagespeedEnableFilters remove_comments,recompress_images # low and moderate filters, recommended filters, but can cause problems ModPagespeedEnableFilters lazyload_images,extend_cache_images,inline_preview_images,sprite_images ModPagespeedEnableFilters combine_css,rewrite_css,move_css_to_head,flatten_css_imports,extend_cache_css,prioritize_critical_css ModPagespeedEnableFilters extend_cache_scripts,combine_javascript,canonicalize_javascript_libraries,rewrite_javascript # high risk #ModPagespeedEnableFilters defer_javascript,local_storage_cache ================================================ FILE: .github/ci/files/public/index_test.php ================================================ handle($request); $response->send(); $kernel->terminate($request, $response); return $kernel; }; ================================================ FILE: .github/ci/files/security.yaml ================================================ security: providers: pimcore_admin: id: Pimcore\Security\User\UserProvider firewalls: dev: pattern: ^/(_(profiler|wdt)|css|images|js)/ security: false # Pimcore WebDAV HTTP basic // DO NOT CHANGE! pimcore_webdav: pattern: ^/asset/webdav provider: pimcore_admin http_basic: ~ access_control: # Pimcore admin ACl // DO NOT CHANGE! - { path: ^/admin/settings/display-custom-logo, roles: PUBLIC_ACCESS } - { path: ^/admin/login/2fa-verify, roles: IS_AUTHENTICATED_2FA_IN_PROGRESS } - { path: ^/admin/login/2fa-setup, roles: ROLE_PIMCORE_USER } - { path: ^/admin/login/2fa, roles: IS_AUTHENTICATED_2FA_IN_PROGRESS } - { path: ^/admin/login$, roles: PUBLIC_ACCESS } - { path: ^/admin/login/(login|lostpassword|deeplink|csrf-token)$, roles: PUBLIC_ACCESS } - { path: ^/admin, roles: ROLE_PIMCORE_USER } - { path: ^/asset/webdav, roles: ROLE_PIMCORE_USER } role_hierarchy: # Pimcore admin // DO NOT CHANGE! ROLE_PIMCORE_ADMIN: [ROLE_PIMCORE_USER] ================================================ FILE: .github/ci/files/templates/.gitkeep ================================================ ================================================ FILE: .github/ci/scripts/setup-pimcore-environment.sh ================================================ #!/bin/bash set -eu mkdir -p var/config mkdir -p bin cp .github/ci/files/.env . cp -r .github/ci/files/config/. config cp -r .github/ci/files/templates/. templates cp -r .github/ci/files/bin/console bin/console chmod 755 bin/console cp -r .github/ci/files/kernel/. kernel cp -r .github/ci/files/public/. public ================================================ FILE: .github/workflows/cla-check.yaml ================================================ name: CLA check on: issue_comment: types: [created] pull_request_target: types: [opened, closed, synchronize] jobs: cla-workflow: uses: pimcore/workflows-collection-public/.github/workflows/reusable-cla-check.yaml@main if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' secrets: CLA_ACTION_ACCESS_TOKEN: ${{ secrets.CLA_ACTION_ACCESS_TOKEN }} ================================================ FILE: .github/workflows/codeception.yml ================================================ name: "Codeception Tests centralised" on: schedule: - cron: "0 3 * * 1,3,5" workflow_dispatch: push: branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" - "feature-*" pull_request_target: types: [opened, synchronize, reopened] env: PIMCORE_PROJECT_ROOT: ${{ github.workspace }} PRIVATE_REPO: ${{ github.event.repository.private }} concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} cancel-in-progress: true jobs: setup-matrix: runs-on: ubuntu-latest outputs: php_versions: ${{ steps.parse-php-versions.outputs.php_versions }} matrix: ${{ steps.set-matrix.outputs.matrix }} private_repo: ${{ env.PRIVATE_REPO }} steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.base.ref || github.ref }} - name: Checkout reusable workflow repo uses: actions/checkout@v4 with: repository: pimcore/workflows-collection-public ref: main path: reusable-workflows - name: Parse PHP versions from composer.json id: parse-php-versions run: | if [ -f composer.json ]; then php_versions=$(jq -r '.require.php' composer.json | grep -oP '\d+\.\d+' | tr '\n' ',' | sed 's/,$//') if [ -z "$php_versions" ]; then echo "No PHP versions found in composer.json" echo "Setting default PHP value" echo "php_versions=default" >> $GITHUB_OUTPUT else echo "php_versions=$php_versions" >> $GITHUB_OUTPUT echo "#### php versions #### : $php_versions" fi else echo "composer.json not found" exit 1 fi - name: Set up matrix id: set-matrix run: | php_versions="${{ steps.parse-php-versions.outputs.php_versions }}" MATRIX_JSON=$(cat reusable-workflows/codeception-tests-configuration/matrix-config.json) IFS=',' read -ra VERSIONS_ARRAY <<< "$php_versions" FILTERED_MATRIX_JSON=$(echo $MATRIX_JSON | jq --arg php_versions "$php_versions" ' { matrix: [ .configs[] | select(.php_version == $php_versions) | .matrix[] ] }') ENCODED_MATRIX_JSON=$(echo $FILTERED_MATRIX_JSON | jq -c .) echo "matrix=${ENCODED_MATRIX_JSON}" >> $GITHUB_OUTPUT codeception-tests: needs: setup-matrix strategy: matrix: ${{ fromJson(needs.setup-matrix.outputs.matrix) }} uses: pimcore/workflows-collection-public/.github/workflows/reusable-codeception-tests-centralized.yaml@main with: APP_ENV: test PIMCORE_TEST: 1 PRIVATE_REPO: ${{ needs.setup-matrix.outputs.private_repo}} PHP_VERSION: ${{ matrix.matrix.php-version }} DATABASE: ${{ matrix.matrix.database }} SERVER_VERSION: ${{ matrix.matrix.server_version }} DEPENDENCIES: ${{ matrix.matrix.dependencies }} EXPERIMENTAL: ${{ matrix.matrix.experimental }} PIMCORE_VERSION: ${{ matrix.matrix.pimcore_version }} secrets: SSH_PRIVATE_KEY_PIMCORE_DEPLOYMENTS_USER: ${{ secrets.SSH_PRIVATE_KEY_PIMCORE_DEPLOYMENTS_USER }} COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN: ${{ secrets.COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN }} PIMCORE_INSTANCE_IDENTIFIER: ${{ secrets.PIMCORE_CI_INSTANCE_IDENTIFIER }} PIMCORE_ENCRYPTION_SECRET: ${{ secrets.PIMCORE_CI_ENCRYPTION_SECRET }} PIMCORE_PRODUCT_KEY: ${{ secrets.PIMCORE_CI_PRODUCT_KEY }} ================================================ FILE: .github/workflows/frontend-build-pr.yaml ================================================ name: "Frontend Build (PR and Feature Branches)" on: push: branches: - "[0-9]+.[0-9]+" - "feature-*" - "nightly" pull_request_target: branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" - "*_actions" - "feature-*" - "nightly" workflow_dispatch: env: BRANCH_NAME: ${{ github.head_ref || github.ref_name }} permissions: contents: read jobs: build: permissions: contents: write uses: ./.github/workflows/shared-frontend-build.yaml ================================================ FILE: .github/workflows/frontend-publish-unified.yaml ================================================ name: Frontend build and publish on: push: branches: - "[0-9]+.x" - "[0-9].[0-9]" tags: - "v*" workflow_dispatch: env: BRANCH_NAME: ${{ github.head_ref || github.ref_name }} TARGET_RELEASE: 2.4.0 permissions: id-token: write # Required for OIDC contents: read jobs: canary-build: if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/') permissions: contents: write uses: ./.github/workflows/shared-frontend-build.yaml canary-generate-version: if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/') needs: canary-build runs-on: ubuntu-latest outputs: generated_version: ${{ steps.gen.outputs.version }} steps: - name: Checkout repository uses: actions/checkout@v4 - name: Generate Canary Version id: gen shell: bash run: | # Get the base version (e.g., "1.2.3") from package.json BASE_VERSION=${{ env.TARGET_RELEASE }} # Remove any pre-release suffix if present BASE_VERSION=${BASE_VERSION%%-*} # Create a timestamp (YYYYMMDD--HHMMSS) TIMESTAMP=$(date +'%Y%m%d-%H%M%S') # Get a short commit hash (7 characters) GIT_HASH=$(git rev-parse --short=7 HEAD) NEW_VERSION="${BASE_VERSION}-canary.${TIMESTAMP}-${GIT_HASH}" echo "Computed version: ${NEW_VERSION}" echo "version=${NEW_VERSION}" >> "$GITHUB_OUTPUT" canary-publish: if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/') needs: canary-generate-version permissions: id-token: write # Required for OIDC contents: read uses: ./.github/workflows/shared-npm-publish.yaml with: version: "${{ needs.canary-generate-version.outputs.generated_version }}" tag: "canary" release-determine-version: if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') runs-on: ubuntu-latest outputs: version: ${{ steps.extract_version.outputs.version }} npm_tag: ${{ steps.extract_npm.outputs.npm_tag }} steps: - name: Checkout repository uses: actions/checkout@v4 - name: Extract version from tag id: extract_version shell: bash run: | # In a push event on a tag, github.ref_name contains the tag name (e.g. "v1.2.3") TAG_NAME="${GITHUB_REF_NAME}" echo "Detected tag: ${TAG_NAME}" # Remove the leading "v" using Bash parameter expansion VERSION="${TAG_NAME#v}" echo "Computed version: ${VERSION}" echo "version=${VERSION}" >> "$GITHUB_OUTPUT" - name: Extract npm tag id: extract_npm shell: bash run: | # Retrieve the version from the previous step VERSION="${{ steps.extract_version.outputs.version }}" echo "Using version: ${VERSION}" # Determine the npm tag: # If the version contains a hyphen, assume there is a pre-release identifier. if [[ "$VERSION" == *"-"* ]]; then # Extract text after the first hyphen pre_release="${VERSION#*-}" # Extract only the leading contiguous alphabetical string npm_tag="$(echo "$pre_release" | grep -oE '^[A-Za-z]+' | tr '[:upper:]' '[:lower:]')" # Fallback: if nothing is extracted, default to latest. if [ -z "$npm_tag" ]; then npm_tag="latest" fi else npm_tag="latest" fi echo "Computed npm tag: ${npm_tag}" # Export the npm tag as an output for downstream steps echo "npm_tag=${npm_tag}" >> "$GITHUB_OUTPUT" publish-release: if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') needs: release-determine-version uses: ./.github/workflows/shared-npm-publish.yaml with: version: "${{ needs.release-determine-version.outputs.version }}" tag: "${{ needs.release-determine-version.outputs.npm_tag }}" ================================================ FILE: .github/workflows/new-docs.yml ================================================ name: "Documentation (Reusable)" on: pull_request_target: branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" - "docs_actions" paths: - "doc/**" - ".github/workflows/new-docs.yml" - "README.md" push: branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" - "docs_actions" paths: - "doc/**" - ".github/workflows/new-docs.yml" - "README.md" permissions: contents: read jobs: docs: uses: pimcore/workflows-collection-public/.github/workflows/reusable-docs.yaml@main with: docs_path: "doc" secrets: DOCS_GENERATOR_ACCESS_TOKEN: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} ================================================ FILE: .github/workflows/new-php-cs-fixer.yaml ================================================ name: "PHP-CS-Fixer" on: workflow_dispatch: push: branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" - "*_actions" - "feature-*" permissions: contents: write jobs: php-style: uses: pimcore/workflows-collection-public/.github/workflows/reusable-php-cs-fixer.yaml@fix-failed-workflow with: head_ref: ${{ github.head_ref || github.ref_name }} repository: ${{ github.repository }} config_file: ".php-cs-fixer.dist.php" secrets: PHP_CS_FIXER_GITHUB_TOKEN: ${{ secrets.PHP_CS_FIXER_GITHUB_TOKEN }} ================================================ FILE: .github/workflows/new-static-analysis.yaml ================================================ name: "Static analysis centralised" on: schedule: - cron: '0 3 * * 1,3,5' workflow_dispatch: pull_request: types: [ opened, synchronize, reopened ] paths-ignore: - 'assets/**' - 'assets-customized/**' - 'doc/**' - 'install/**' - 'src/Resources/public/**' push: paths-ignore: - 'assets/**' - 'assets-customized/**' - 'doc/**' - 'install/**' - 'src/Resources/public/**' branches: - "[0-9]+.[0-9]+" - "[0-9]+.x" env: PIMCORE_PROJECT_ROOT: ${{ github.workspace }} PRIVATE_REPO: ${{ github.event.repository.private }} concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} cancel-in-progress: true jobs: setup-matrix: runs-on: ubuntu-latest outputs: php_versions: ${{ steps.parse-php-versions.outputs.php_versions }} phpstan_matrix: ${{ steps.set-matrix.outputs.phpstan_matrix }} private_repo: ${{ env.PRIVATE_REPO }} steps: - name: Checkout code uses: actions/checkout@v4 - name: Checkout reusable workflow repo uses: actions/checkout@v4 with: repository: pimcore/workflows-collection-public ref: main path: reusable-workflows - name: Parse PHP versions from composer.json id: parse-php-versions run: | if [ -f composer.json ]; then php_versions=$(jq -r '.require.php' composer.json | grep -oP '\d+\.\d+' | tr '\n' ',' | sed 's/,$//') if [ -z "$php_versions" ]; then echo "php_versions=default" >> "$GITHUB_OUTPUT" else echo "php_versions=$php_versions" >> "$GITHUB_OUTPUT" fi else exit 1 fi - name: Set up matrix JSON id: set-matrix run: | php_versions="${{ steps.parse-php-versions.outputs.php_versions }}" MATRIX_JSON=$(cat reusable-workflows/phpstan-configuration/matrix-config.json) FILTERED_MATRIX_JSON=$(echo "$MATRIX_JSON" | jq --arg php_versions "$php_versions" '{ include: [ .configs[] | select(.php_version == $php_versions) | .matrix[] ] }') ENCODED_MATRIX_JSON=$(echo "$FILTERED_MATRIX_JSON" | jq -c .) echo "phpstan_matrix=$ENCODED_MATRIX_JSON" >> "$GITHUB_OUTPUT" static-analysis: needs: setup-matrix uses: pimcore/workflows-collection-public/.github/workflows/reusable-static-analysis-unified.yaml@main with: phpstan_matrix: ${{ needs.setup-matrix.outputs.phpstan_matrix }} private_repo: ${{ needs.setup-matrix.outputs.private_repo }} APP_ENV: test PIMCORE_TEST: 1 COVERAGE: "none" secrets: SSH_PRIVATE_KEY_PIMCORE_DEPLOYMENTS_USER: ${{ secrets.SSH_PRIVATE_KEY_PIMCORE_DEPLOYMENTS_USER }} COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN: ${{ secrets.COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN }} PIMCORE_CI_INSTANCE_IDENTIFIER: ${{ secrets.PIMCORE_CI_INSTANCE_IDENTIFIER }} PIMCORE_CI_ENCRYPTION_SECRET: ${{ secrets.PIMCORE_CI_ENCRYPTION_SECRET }} PIMCORE_CI_PRODUCT_KEY: ${{ secrets.PIMCORE_CI_PRODUCT_KEY }} ================================================ FILE: .github/workflows/shared-frontend-build.yaml ================================================ name: "Shared Frontend Build" on: workflow_call: permissions: contents: write jobs: install: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.head_ref || github.ref_name }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: 24 - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Install dependencies working-directory: ./assets/studio run: npm ci lint: needs: install runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.head_ref || github.ref_name }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: 24 - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Run code linting working-directory: ./assets/studio run: npm run lint-fix - uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: Apply eslint-fixer changes check-types: needs: install runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.head_ref || github.ref_name }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: 24 - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Run code linting working-directory: ./assets/studio run: npm run check-types build: needs: - lint - check-types runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.head_ref || github.ref_name }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: 24 - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Run production build working-directory: ./assets/studio run: npm run build - uses: stefanzweifel/git-auto-commit-action@v5 with: file_pattern: './src/Resources/public/studio/' commit_message: Automatic frontend build ================================================ FILE: .github/workflows/shared-npm-publish.yaml ================================================ name: shared-npm-publish on: workflow_call: inputs: version: description: "The new version to set (e.g., 1.2.3)" required: true type: string tag: description: "The npm tag to use when publishing (default: latest)" required: false type: string default: "latest" env: BRANCH_NAME: ${{ github.head_ref || github.ref_name }} jobs: install: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ env.BRANCH_NAME }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24' registry-url: 'https://registry.npmjs.org' - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Install dependencies working-directory: ./assets/studio run: npm ci publish: runs-on: ubuntu-latest needs: install permissions: id-token: write # Required for OIDC contents: read steps: - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ env.BRANCH_NAME }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Cache npm dependencies uses: actions/cache@v4 with: path: ./assets/studio/node_modules key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - name: Run build types working-directory: ./assets/studio run: npm run generate-types - name: Setup Node.js uses: actions/setup-node@v4 with: node-version: '24' registry-url: 'https://registry.npmjs.org' - name: Set package version working-directory: ./assets/studio run: npm version ${{ inputs.version }} --no-git-tag-version --allow-same-version - name: Publish package to npm with OIDC working-directory: ./assets/studio run: npx npm@latest publish --tag ${{ inputs.tag }} --access public ================================================ FILE: .github/workflows/stale.yml ================================================ name: Handle stale issues on: workflow_dispatch: schedule: - cron: '37 7 * * *' jobs: call-stale-workflow: uses: pimcore/workflows-collection-public/.github/workflows/stale.yml@v1.1.0 ================================================ FILE: .gitignore ================================================ Thumbs.db *.log # symfony default /.web-server-pid /app/config/parameters.yml /build/ /phpunit.xml /web/bundles/ /web/var/ # PHP-CS-Fixer /.php_cs /.php-cs-fixer.cache # composer /composer.lock # PhpStorm / IDEA .idea # Test env /bin /cache /config /kernel /public /templates /tests/_output /tests/_support/_generated /var /vendor /.env /.env.test /.htaccess /auth.json /config.json # studio related /assets/studio/node_modules assets/studio/dist/* !assets/studio/dist/.gitkeep !assets/studio/dist/types !assets/studio/dist/types/* ================================================ FILE: .php-cs-fixer.dist.php ================================================ in([ __DIR__ . '/src', __DIR__ . '/tests', ]) ->exclude([ __DIR__ . '/tests/_output', __DIR__ . '/tests/_support/_generated', ]) ; // do not enable self_accessor as it breaks pimcore models relying on get_called_class() $config = new PhpCsFixer\Config(); $config->setRules([ '@PSR1' => true, '@PSR2' => true, 'array_syntax' => ['syntax' => 'short'], 'list_syntax' => ['syntax' => 'short'], 'header_comment' => [ 'comment_type' => 'PHPDoc', 'header' => 'This source file is available under the terms of the' . PHP_EOL . 'Pimcore Open Core License (POCL)' . PHP_EOL . 'Full copyright and license information is available in' . PHP_EOL . 'LICENSE.md which is distributed with this source code.' . PHP_EOL . PHP_EOL . ' @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com)' . PHP_EOL . ' @license Pimcore Open Core License (POCL)' ], 'blank_line_before_statement' => true, 'encoding' => true, 'function_typehint_space' => true, 'single_line_comment_style' => true, 'lowercase_cast' => true, 'magic_constant_casing' => true, 'method_argument_space' => ['on_multiline' => 'ignore'], 'class_attributes_separation' => true, 'native_function_casing' => true, 'no_blank_lines_after_class_opening' => true, 'no_blank_lines_after_phpdoc' => true, 'no_empty_comment' => true, 'no_empty_phpdoc' => true, 'no_empty_statement' => true, 'no_extra_blank_lines' => true, 'no_leading_import_slash' => true, 'no_leading_namespace_whitespace' => true, 'no_short_bool_cast' => true, 'no_spaces_around_offset' => true, 'no_superfluous_phpdoc_tags' => ['allow_mixed' => true, 'remove_inheritdoc' => true], 'no_unneeded_control_parentheses' => true, 'no_unused_imports' => true, 'no_whitespace_before_comma_in_array' => true, 'no_whitespace_in_blank_line' => true, 'object_operator_without_whitespace' => true, 'ordered_imports' => true, 'phpdoc_indent' => true, 'phpdoc_no_useless_inheritdoc' => true, 'phpdoc_scalar' => true, 'phpdoc_separation' => true, 'phpdoc_single_line_var_spacing' => true, 'return_type_declaration' => true, 'short_scalar_cast' => true, 'single_blank_line_before_namespace' => true, 'single_quote' => true, 'space_after_semicolon' => true, 'standardize_not_equals' => true, 'ternary_operator_spaces' => true, 'trailing_comma_in_multiline' => true, 'whitespace_after_comma_in_array' => true, ]); $config->setFinder($finder); return $config; ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing to Pimcore Datahub ## Bug Reports & Feature Requests The Pimcore team heavily uses (and loves!) GitHub for all of our software management. We use GitHub issues exclusively to track all bugs and features. * [Open an issue](https://github.com/pimcore/data-hub/issues) here on GitHub. If you can, **please provide a fix and create a pull request (PR) instead**; this will automatically create an issue for you. * Report security issues only to security@pimcore.org * Please be patient as not all items will be tested immediately - remember, Pimcore Datahub is open core and free of charge. * Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! Please feel free to re-open issues we've closed if there's something we've missed, and they still need to be addressed. ## Contributing Pull Requests PR's are even better than issues. We gladly accept community pull requests. There are a few necessary steps before we can accept a pull request: * [Fork us!](https://help.github.com/articles/fork-a-repo/) * Select the right branch. main(e.g. 1.x) for features and improvements or latest maintenance branch for bug fixes (e.g. 1.0) * Code! Follow the coding standards defined [here](https://github.com/pimcore/data-hub/blob/1.x/.php-cs-fixer.dist.php). * [Send a pull request](https://help.github.com/articles/using-pull-requests/) from your fork’s branch to our `master` branch. * [Sign the CLA](https://cla-assistant.io/pimcore/data-hub) - see also below. ### Contributor License Agreement The following terms are used throughout this agreement: * **You** - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any entity that controls or is controlled by the legal entity, or is under common control with it. * **Project** - is an umbrella term that refers to any and all Pimcore projects. * **Contribution** - any type of work that is submitted to a Project, including any modifications or additions to existing work. * **Submitted** - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or verbal communication with Pimcore, contributors or maintainers. #### 1. Grant of Copyright License. Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your contributions and such derivative works. Except for this license, You reserve all rights, title, and interest in your contributions. #### 2. Grant of Patent License. Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted. If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging that your contribution or any project it was submitted to constitutes or is responsible for direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the date such litigation is filed. #### 3. Source of Contribution. Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware. ================================================ FILE: LICENSE.md ================================================ # License Copyright (C) Pimcore GmbH (https://www.pimcore.com) This software is available under the terms of the following Pimcore Open Core License (POCL) **PIMCORE OPEN CORE LICENSE AGREEMENT (POCL)** **Last Update: June 2025** This Open Core License Agreement ("**Agreement**" or “**POCL**”), effective as of the day of the first installation or use by Customer (the "**Effective Date**"), is by and between Pimcore GmbH, Söllheimer Straße 16, AT-5020 Salzburg, Republic of Austria (hereinafter "**Licensor**" or “**Pimcore**”) and the user of the Software, as defined herein, (hereinafter "**Licensee**" or "**Customer**"). Licensor and Licensee may be referred to herein collectively as the "**Parties**" or individually as a "**Party**." **WHEREAS** Licensor desires to license out certain Pimcore Software (“**Software**“). **WHEREAS** (a) Software for which the source code is publicly available but which is not licensed out as open source software is "**Open Core Software**" and (b) Software for which the source code is not publicly available is "**Proprietary Software**", both covered by this Agreement. **WHEREAS** the exact products that are available under this Agreement are defined in the additional contractual documents or by inclusion of, or referral to, this Agreement within the source code or within the source code repositories; if not provided for otherwise, a software element is Proprietary Software. **WHEREAS** the Software is protected by copyright world- wide; and **WHEREAS** Licensee desires to obtain a license to use the Software for its internal business purposes, subject to the terms and conditions of this Agreement. **NOW, THEREFORE**, in consideration of the mutual covenants, terms, and conditions set forth herein, and for other good and valuable consideration, the receipt and sufficiency of which are hereby acknowledged, the Parties agree as follows. ### 1. LICENSE 1.1 PLEASE READ THIS PIMCORE SOFTWARE LICENSE AGREEMENT CAREFULLY AS IT CONSTITUTES A LEGALLY BINDING AGREEMENT. BY INSTALLING OR USING THE SOFTWARE, YOU ACCEPT AND AGREE TO ALL TERMS AND CONDITIONS OF THIS AGREEMENT, AND CONFIRM THAT YOUR STATEMENT – IF APPLICABLE – ON THE RELEVANT GLOBAL REVENUE IS CORRECT AND COMPLETE. IF YOU REPRESENT A LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE FULL LEGAL AUTHORITY TO ENTER INTO THIS AGREEMENT TO BIND THAT LEGAL ENTITY. IF YOU DO NOT AGREE TO THESE TERMS AND CONDITIONS, YOU MAY NOT INSTALL OR USE THE SOFTWARE. 1.2 Pimcore grants the Customer a non-exclusive, non-transferable, non-sublicensable, geographically unlimited right, limited in time to the term of the Agreement, to use the Software and to customize, modify or adapt it for its own purposes. Unless if required by Pimcore for compliance with applicable laws or any order of a governmental authority, the Customer is not obliged to share these modifications, adaptations, and customizations (“**Derivatives**”) with Pimcore or anyone else. 1.2.1 Solution Development and Production Use (Open Core Software) “**Production Use**” means the usage of a software for development of solutions and productions within a business operation. a) An organization with total global revenue not exceeding €5 million (€5M) or equivalent amount in other currency annually (“**Threshold**”) may qualify for a free license for Production Use of the Open Core Software, provided such organization is not a part, subsidiary, affiliate, or shell company to another organization, entity, or company group whose total combined revenue exceeds the Threshold. Eligibility must be self-certified by the Customer when starting the use of the Open Core Software and is subject to periodic review and audit by Pimcore. If at any time the Customer’s revenue exceeds the Threshold, a paid commercial license will be required for continued Production Use of the software. The Customer is obliged to inform Pimcore about relevant changes in revenues. Pimcore is entitled to charge license fees retroactively from the date on which Customer exceeded the Threshold. b) Non-profit and educational organizations are eligible for a free license for Production Use of the Open Core Software, subject to Pimcore’s non-profit criteria. For this purpose, “non-profit” refers to entities that are legally recognized as non-profit or tax-exempt under applicable law and operate exclusively for charitable, educational, or scientific purposes without profit distribution. Government bodies, municipalities, political parties, and public institutions are excluded unless explicitly approved by Pimcore. Pimcore shall decide at its own reasonable discretion whether (a) the Threshold is exceeded or (b) the requirements for non-profit or educational usage are met. Legal recourse is excluded with regard to such decision of Pimcore. 1.2.2 Non-Production Use and Transition to Production Use (Open Core Software) For non-production purposes—such as demonstrations, prototype design, proofs of concept, and sales presentations (collectively referred to as “**Non-Production Use**”)—the use of POCL-based software is free of charge. However, to showcase or demonstrate the features of the Enterprise Edition of Pimcore for any Non-Production Use, a Pimcore Developer License Agreement (PDLA) must be purchased. If the Customer or a Partner or any other third person acting on the Customer’s behalf initiates development of a solution with the intention or foreseeable or actual effect of deploying it into production, such use from its beginning shall be deemed Production Use of the Open Core Software for which the Threshold applies from the outset. Individual transition periods to Production Use may be agreed between Pimcore and Customer in writing. Pimcore reserves the right to audit, verify and enforce compliance with these terms, including restricting or terminating access to the Open Core Software. 1.2.3 The use of Proprietary Software is never free of charge. Sect. 1.2.1 and 1.2.2 do not apply to Proprietary Software. 1.3 Restrictions on Use 1.3.1 The Customer may not offer the Software as a hosted or managed service by granting third parties access to a significant part of its features or functions. Additionally, the Customer may not fork, modify, or redistribute the Software, or any Derivative, in a manner that results in a competing or functionally comparable product that is offered as a free or commercial alternative to Pimcore’s official offerings. 1.3.2 The Customer shall also refrain from incorporating the Software, or any Derivative, into a commercial product or service offering materially deriving its economic value from the Software, even if it is not directly exposed or obvious. 1.3.3 The Customer is also prohibited from representing, implying, or otherwise suggesting that its use, distribution, or customization of the Software is endorsed, certified, or supported by Pimcore, unless such authorization has been explicitly granted in writing. 1.3.4 The Customer may only use the Software for its own enterprise. The Customer may not use the Software simultaneously in more instances than Customer has acquired usage licences for. The Customer is only permitted to copy the Software to the extent that this is necessary for the intended use, including the correction of errors. The creation of a backup copy is permitted if it is necessary to secure the contractual use. 1.3.5 The Customer must not, at any time, (i) rent, lease, lend, sell, license, assign, distribute, publish, transfer, or otherwise make available the Software; (ii) reverse engineer, disassemble, decompile, decode, adapt, or otherwise attempt to derive or gain access to source code of the Proprietary Software, in whole or in part; (iii) use the Software in any manner or for any purpose that infringes, misappropriate, or otherwise wireless any intellectual property ride or other ride of any person, or that violates any applicable law. 1.4 If the Customer violates any of the provisions Sect. 1.2 and 1.3, all rights of usage granted under the POCL shall immediately become invalid and shall automatically revert to Pimcore. In this case, the Customer must immediately and completely cease using the Software, delete all copies of the Software installed on its systems and delete any backup copies made or hand them over to Pimcore. In addition, Pimcore reserves the right to take all legal steps. 1.5 Sect. 1.4 applies accordingly if a Derivative of the Customer infringe upon patents. 1.6 The parties may agree on expanded usage rights, arrangements for enterprise customers, and special OEM provisions separately. 1.7 Upon request, the Customer shall enable Pimcore to verify the proper use of the Software, in particular whether the Customer is using the Software as agreed. For this purpose, the Customer shall provide Pimcore with information, grant access to relevant documents and records and enable an audit of the hardware and software environment by Pimcore or an auditing company named by Pimcore and acceptable to the Customer. Pimcore may carry out the audit on the Customer's premises during the Customer's regular business hours or have it carried out by third parties bound to secrecy. Pimcore shall ensure that the Customer's business operations are disturbed as little as possible by the on-site audit. If the inspection reveals a licence violation by the Customer that is not merely minimal, the Customer shall bear the costs of the inspection, otherwise Pimcore shall bear them. Pimcore reserves all other rights. 1.8 Licensee acknowledges that, as between Licensee and Licensor, Licensor owns all right, title, and interest, including all intellectual property rights, in and to the Software and, with respect to third-party products, the applicable third-party licensors own all right, title and interest, including all intellectual property rights, in and to the third-party products. 1.9 Licensor reserves all rights not expressly granted to Licensee in this Agreement. Except for the limited rights and licenses expressly granted under this Agreement, nothing in this Agreement grants, by implication, waiver, estoppel, or otherwise, to Licensee or any third party any intellectual property rights or other right, title, or interest in or to the Software. ### 2. CONTRIBUTIONS OF DERIVATIVES 2.1 If the Customer wishes to contribute to the Software or to distribute a Derivative, both must be made in accordance with the Pimcore Contributors License Agreement (“PCLA”), available at . The PCLA stipulates the terms under which intellectual contributions are managed, ensuring that all parties' rights are protected. Acceptance of the PCLA is mandatory for all contributors and can be reviewed on the source-code repository. Contributions without adherence to the PCLA will not be accepted. 2.2 Any contribution to the Software by a Derivative must be clearly documented, in order to maintain transparency and integrity of the source code. 2.3. Any Derivative distributed must prominently be specified as “Derivative”, comply with the terms of the POCL, include copyright notices, and be licensed as a whole under the terms of the POCL, with the proviso that the recipient (licensee) of the out-licensed Derivative gets the role of the “Customer” regarding rights and obligations. Upon distribution of any Derivative, recipient must be provided with a copy of this POCL. ### 3. COLLATERAL OBLIGATIONS OF THE CUSTOMER 3.1 The Customer shall not manipulate, in particular modify, move, remove, suppress, switch off or circumvent licence keys and technical protection mechanisms in the Software, e. g. directly, or through the use of intermediaries, white-labelling, or segmentation of services designed to avoid licensing obligations. 3.2 The Customer shall not alter or obfuscate any of the Pimcore's licensing, copyright, or other proprietary notices within the Software. Any use of Pimcore’s trademarks must comply with applicable laws. 3.3 The Customer shall not modify, relocate, disable, or bypass any functionalities associated with the Pimcore Store. 3.4 The Customer shall not (a) use GPLv3-licensed Pimcore software alongside POCL licensed Software, and shall not (b) revert from POCL to GPLv3, to protect the Customer’s rights in Derivatives. 3.5 The Customer must ensure that the access data to the user accounts is not passed on to unauthorised third parties and is protected against unauthorised access by third parties. The authorised users shall be instructed accordingly. The Customer shall inform Pimcore immediately if there is a suspicion of misuse of the Software. 3.6 If Customer infringes upon one of the provisions set up by Sect. 3.1 through 3.5, Sect. 1.4 sentence 1 applies accordingly. ### 4. CONFIDENTIALITY From time to time during the Term, either Party may disclose or make available to the other Party information about its business affairs, products, confidential intellectual property, trade secrets, third-party confidential information, and other sensitive or proprietary information, whether orally or in written, electronic, or other form or media, and whether or not marked, designated or otherwise identified as "confidential" (collectively, "**Confidential Information**"). Confidential Information does not include information that, at the time of disclosure is: (a) in the public domain; (b) known to the receiving Party at the time of disclosure; (c) rightfully obtained by the receiving Party on a non-confidential basis from a third party; or (d) independently developed by the receiving Party. The receiving Party shall not disclose the disclosing Party's Confidential Information to any person or entity, except to the receiving Party's employees who have a need to know the Confidential Information for the receiving Party to exercise its rights or perform its obligations hereunder. Notwithstanding the foregoing, each Party may disclose Confidential Information to the limited extent required (i) in order to comply with the order of a court or other governmental body, or as otherwise necessary to comply with applicable law, provided that the Party making the disclosure pursuant to the order shall first have given written notice to the other Party and made a reasonable effort to obtain a protective order; or (ii) to establish a Party's rights under this Agreement, including to make required court filings. On the expiration or termination of this Agreement, the receiving Party shall promptly return to the disclosing Party all copies, whether in written, electronic, or other form or media, of the disclosing Party's Confidential Information, or destroy all such copies and certify in writing to the disclosing Party that such Confidential Information has been destroyed. Each Party's obligations of non­disclosure with regard to Confidential Information are effective as of the Effective Date and will expire five years from the date first disclosed to the receiving Party; provided, however, with respect to any Confidential Information that constitutes a trade secret (as determined under applicable law), such obligations of non-disclosure will survive the termination or expiration of this Agreement for as long as such Confidential Information remains subject to trade secret protection under applicable law. ### 5. LIMITED WARRANTY AND WARRANTY DISCLAIMER Pimcore warrants that, at the time of delivery, the Software does not contain any virus or other malicious code that would cause the Software to become inoperable or incapable of being used in accordance with its documentation. The warranties set forth herein do not apply and become null and void if Licensee breaches any material provision of this Agreement or any instrument related hereto, or if Licensee, or any person provided access to the Software by Licensee whether or not in violation of this Agreement: (i) installs or uses the Software on or in connection with any hardware or software not specified in the documentation or expressly authorized by Licensor in writing; (ii) illicitly modifies or damages the Software; or (iii) misuses the Software, including any use of the Software other than as specified in the documentation or expressly authorized by Licensor in writing. If any Software fails to comply with the warranty set forth hereinbefore, and such failure is not excluded from warranty pursuant to this provision, Licensor shall, subject to Licensee's promptly notifying Licensor in writing of such failure, at its sole option, either: (i) repair or replace the Software, provided that Licensee provides Licensor with all information Licensor reasonably requests to resolve the reported failure, including sufficient information to enable the Licensor to recreate such failure; or (ii) refund the fees paid for such Software, subject to Licensee's ceasing all use of and, if requested by Licensor, returning to Licensor all copies of the Software. If Licensor repairs or replaces the Software, the warranty will continue to run from the Effective Date and not from Licensee's receipt of the repair or replacement. The remedies set forth in this Section 5 are Licensee's sole remedies and Licensor's sole liability under the limited warranty set forth in this Section 5. EXCEPT FOR THE LIMITED WARRANTY SET FORTH IN THIS SECTION 5, THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" AND LICENSOR HEREBY DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE. LICENSOR SPECIFICALLY DISCLAIMS ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, AND ALL WARRANTIES ARISING FROM COURSE OF DEALING, USAGE, OR TRADE PRACTICE. LICENSOR MAKES NO WARRANTY OF ANY KIND THAT THE SOFTWARE AND DOCUMENTATION, OR ANY PRODUCTS OR RESULTS OF THE USE THEREOF, WILL MEET LICENSEE'S OR ANY OTHER PERSON'S REQUIREMENTS, OPERATE WITHOUT INTERRUPTION, ACHIEVE ANY INTENDED RESULT, BE COMPATIBLE OR WORK WITH ANY SOFTWARE, SYSTEM OR OTHER SERVICES, OR BE SECURE, ACCURATE, COMPLETE, FREE OF HARMFUL CODE, OR ERROR FREE. ### 6. DEFECTS 6.1 The Customer is obliged to notify Pimcore of any defect or error in the Software immediately after its occurrence. 6.2 Before reporting any defect or error, the Customer must carry out an analysis of the system environment as far as possible to ensure that the defect or error is not due to system components that are not covered by this Agreement. 6.3 The Customer shall immediately install or carry out updates or other troubleshooting measures provided by Pimcore. 6.4 Violations of the obligations to co-operate may result in additional costs for Pimcore. The Customer must reimburse Pimcore for such costs, unless it is not responsible for them. ### 7. LIMITATION OF LIABILITY IN NO EVENT WILL LICENSOR BE LIABLE UNDER OR IN CONNECTION WITH THIS AGREEMENT UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE, FOR ANY: (a) CONSEQUENTIAL, INCIDENTAL, INDIRECT, EXEMPLARY, SPECIAL, ENHANCED, OR PUNITIVE DAMAGES; (b) INCREASED COSTS, DIMINUTION IN VALUE OR LOST BUSINESS, PRODUCTION, REVENUES, OR PROFITS; (c) LOSS OF GOODWILL OR REPUTATION; (d) USE, INABILITY TO USE, LOSS, INTERRUPTION, DELAY OR RECOVERY OF ANY DATA, OR BREACH OF DATA OR SYSTEM SECURITY; OR (e) COST OF REPLACEMENT GOODS OR SERVICES, IN EACH CASE REGARDLESS OF WHETHER LICENSOR WAS ADVISED OF THE POSSIBILITY OF SUCH LOSSES OR DAMAGES OR SUCH LOSSES OR DAMAGES WERE OTHERWISE FORESEEABLE. IN NO EVENT WILL LICENSOR'S AGGREGATE LIABILITY ARISING OUT OF OR RELATED TO THIS AGREEMENT UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE EXCEED THE TOTAL AMOUNTS PAID TO LICENSOR UNDER THIS AGREEMENT IN THE TWELVE (12) MONTH PERIOD PRECEDING THE EVENT GIVING RISE TO THE CLAIM. ### 8. INDEMNIFICATION The Customer shall indemnify Pimcore and its affiliates, officers, directors, employees, agents, and assigns, from and against all claims, losses, damages, liabilities, costs, and expenses (including reasonable attorney’s fees and costs) against Pimcore arising out of or relating to the Customer’s use of the Software or Derivatives. ### 9. TERMINATION Term and termination will be regulated separately. If Customer uses the Software in violation of this Agreement or otherwise violates the use rights or prohibitions contained in this Agreement, Customer’s License shall automatically terminate. Upon termination of this Agreement, the Customer shall uninstall the Software, including all copies, and delete any remaining Software residues from its IT system. The Customer must destroy any backup copies made. At Pimcore's request, the Customer must confirm that it has fulfilled these obligations. ### 10. REMUNERATION The remuneration for the use of the software shall be agreed separately. ### 11. MISCELLANEOUS 11.1 The Software may automatically collect and transmit non-personal statistical data related to its installation and use, including but not limited to the number of records in the database, installed modules, system configuration, and usage metrics ("Usage Data"). Such data is collected solely for the purposes of product improvement, support, and analytics. Licensee agrees not to interfere with the collection and transmission of Usage Data. 11.2 Licensee may not assign or transfer any of its rights or delegate any of its obligations hereunder, in each case whether voluntarily, involuntarily, by operation of law or otherwise, without the prior written consent of Licensor. Any purported assignment, transfer, or delegation in violation of this Section is null and void. No assignment, transfer, or delegation will relieve the assigning or delegating Party of any of its obligations hereunder. This Agreement is binding upon and inures to the benefit of the Parties hereto and their respective permitted successors and assigns. 11.3 Each Party acknowledges and agrees that a breach or threatened breach by such Party of any of its contractual obligations may cause the other Party irreparable harm for which monetary damages would not be an adequate remedy and agrees that, in the event of such breach or threatened breach, the other Party will be entitled to equitable relief, including a restraining order, an injunction, specific performance, and any other relief that may be available from any court, without any requirement to post a bond or other security, or to prove actual damages or that monetary damages are not an adequate remedy. Such remedies are not exclusive and are in addition to all other remedies that may be available at law, in equity, or otherwise. 11.4 No amendment to or modification of this Agreement is effective unless it is in writing and signed by an authorized representative of each Party. No waiver by any Party of any of the provisions hereof will be effective unless explicitly set forth in writing and signed by the Party so waiving. Except as otherwise set forth in this Agreement, (i) no failure to exercise, or delay in exercising, any rights, remedy, power, or privilege arising from this Agreement will operate or be construed as a waiver thereof, and (ii) no single or partial exercise of any right, remedy, power, or privilege hereunder will preclude any other or further exercise thereof or the exercise of any other right, remedy, power, or privilege. 11.5 If any provision of this Agreement is invalid, illegal, or unenforceable in any jurisdiction, such invalidity, illegality, or unenforceability will not affect any other term or provision of this Agreement or invalidate or render unenforceable such term or provision in any other jurisdiction. Upon such determination that any term or other provision is invalid, illegal, or unenforceable, the Parties hereto shall negotiate in good faith to modify this Agreement so as to effect the original intent of the Parties as closely as possible in a mutually acceptable manner in order that the transactions contemplated hereby be consummated as originally contemplated to the greatest extent possible. 11.6 In all relevant respects that are not regulated by this Agreement, the following documents shall apply, as far as applicable: - Pimcore Terms & Conditions, available at [] - Pimcore Privacy Statement (PPS) - Pimcore Data Processing Agreement (PDPA) - Pimcore PaaS Terms & Conditions 11.7 Specifications originating from the Customer regarding the service content and legal elements, such as GTC or contractual clauses, do not apply. 11.8 Support, maintenance, and other services remain subject to separate agreements. ================================================ FILE: README.md ================================================ --- title: Datahub --- # Pimcore Datahub [SonarQube Cloud](https://sonarcloud.io/summary/new_code?id=pimcore_data-hub) Pimcore Datahub (data delivery and consumption platform) integrates different input & output channel technologies into a simple & easy-to-configure system on top of Pimcore. The basic configuration of Datahub comes with a GraphQL API, which is described in the next sections of this documentation. To use another configuration, Pimcore Datahub can be extended with different adapters (see [Further Information](#further-information)). ![Overview](./doc/img/overview.jpg) *Sample presentation of Datahub config when choosing the GraphQL endpoint* A short introduction video of an output channel based on the GraphQL query language can be found [here](./doc/img/graphql/intro.mp4). ## Features in a Nutshell - Easy-to-configure interface layer for data delivery and consumption - Tool of choice to connect Pimcore to any other systems and applications besides internal PHP API - whether they are backend applications like ERP systems or frontend applications like your storefront - Multiple endpoints definition for different use cases and target/source systems - Central and easy-to-use GUI to transform and prepare data for defined endpoints - To-be-exposed data restriction to endpoints by defining workspaces and schemas. ## Documentation Overview - [Installation](./doc/01_Installation_and_Upgrade/README.md) - [Basic principle](./doc/02_Basic_Principle.md) for configuring an endpoint - [GraphQL](./doc/10_GraphQL/README.md) [*default and recommended endpoint*] - [Configuration & Deployment](./doc/20_Deployment.md) - [Testing](./doc/30_Testing.md) ## Further Information On Pimcore Datahub adapters: - [Datahub Simple Rest API](https://pimcore.com/docs/platform/Datahub_Simple_Rest/) - [Datahub File Export](https://pimcore.com/docs/platform/Datahub_File_Export/) - [Datahub Productsup](https://pimcore.com/docs/platform/Datahub_Productsup/) ## Contributions As Pimcore Datahub is a community project, any contributions highly appreciated. For details see our [Contributing guide](https://github.com/pimcore/data-hub/blob/master/CONTRIBUTING.md). ================================================ FILE: SECURITY.md ================================================ # Security Policy ## Reporting a Vulnerability If you think that you have found a security issue, don’t use the bug tracker and don’t publish it publicly. Instead, all security issues must be reported via a private vulnerability report. Please follow the [instructions](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) to submit a private report. ## Resolving Process Every submitted security issue is handled with top priority by following these steps: 1. Confirm the vulnerability 2. Determine the severity 3. Contact reporter 4. Work on a patch 5. Get a CVE identification number (may be done by the reporter or a security service provider) 6. Patch reviewing 7. Tagging a new release for supported versions 8. Publish security announcement ================================================ FILE: assets/studio/README.md ================================================ # Data Hub This package provides TypeScript support for Pimcore Data Hub, enabling type-safe integration and development when working with Data Hub functionalities within the Pimcore ecosystem. It includes: - Comprehensive TypeScript definitions for the Data Hub SDK, ensuring strong typing and improved developer experience ## Documentation For detailed guidance on installation, configuration, and working with Data Hub, refer to the official [Pimcore Data Hub documentation](https://docs.pimcore.com/platform/Datahub/). ================================================ FILE: assets/studio/build/api/docs.jsonopenapi.json ================================================ {"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 HTML data
"}},{"name":"renderingClass","in":"query","description":"Optional rendering class to be used for rendering the layout","required":false,"schema":{"type":"string","example":"My\\Custom\\Class"}},{"name":"html","in":"query","description":"Optional static HTML to be used for rendering the layout","required":false,"schema":{"type":"string","example":"
Some HTML data
"}}],"responses":{"200":{"description":"class_definition_get_text_layout_preview_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"text-layout-preview.html\""}}},"content":{"text/html":{"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/class/definition/configuration-view/tree":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_tree_summary","description":"class_definition_get_tree_description","operationId":"class_definition_get_tree","parameters":[{"name":"withGroup","in":"query","description":"Whether to group the results.","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"class_definition_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ClassDefinitionTreeNode"},{"$ref":"#/components/schemas/ClassDefinitionTreeNodeFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/field-collection/collection":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_collection_summary","description":"class_field_collection_collection_description","operationId":"class_field_collection_collection","responses":{"200":{"description":"class_field_collection_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/FieldCollectionConfig"}}},"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/field-collection":{"post":{"tags":["Class Definition"],"summary":"class_field_collection_create_summary","description":"class_field_collection_create_description","operationId":"class_field_collection_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFieldCollection"}}}},"responses":{"200":{"description":"class_field_collection_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCollectionDetail"}}}},"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/field-collection/{key}":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_get_by_key_summary","description":"class_field_collection_get_by_key_description","operationId":"class_field_collection_get_by_key","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"responses":{"200":{"description":"class_field_collection_get_by_key_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCollectionDetail"}}}},"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_field_collection_update_summary","description":"class_field_collection_update_description","operationId":"class_field_collection_update","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCollectionUpdate"}}}},"responses":{"200":{"description":"class_field_collection_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCollectionDetail"}}}},"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":["Class Definition"],"summary":"class_field_collection_delete_summary","description":"class_field_collection_delete_description","operationId":"class_field_collection_delete","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"responses":{"200":{"description":"class_field_collection_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/field-collection/{key}/export":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_export_summary","description":"class_field_collection_export_description","operationId":"class_field_collection_export","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"responses":{"200":{"description":"class_field_collection_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"fieldcollection_MyFieldCollection_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/field-collection/{key}/import":{"post":{"tags":["Class Definition"],"summary":"class_field_collection_import_summary","description":"class_field_collection_import_description","operationId":"class_field_collection_import","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file with JSON encoded field collection definition","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"class_field_collection_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCollectionDetail"}}}},"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/field-collection/{objectId}/object/layout":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_object_layout_summary","description":"class_field_collection_object_layout_description","operationId":"class_field_collection_object_layout","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"class_field_collection_object_layout_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/FieldCollectionLayoutDefinition"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/class/field-collection/{key}/layout":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_get_layout_by_key_summary","description":"class_field_collection_get_layout_by_key_description","operationId":"class_field_collection_get_layout_by_key","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"responses":{"200":{"description":"class_field_collection_get_layout_by_key_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigLayoutDefinition"}}}},"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/field-collection/tree":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_get_tree_summary","description":"class_field_collection_get_tree_description","operationId":"class_field_collection_get_tree","parameters":[{"name":"allowedTypes","in":"query","description":"Comma-separated list of allowed field collection types to filter by.","required":false,"schema":{"type":"string","example":"NewsCars,NewsText"}}],"responses":{"200":{"description":"class_field_collection_get_tree_success_response","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/FieldCollectionTreeNode"},{"$ref":"#/components/schemas/FieldCollectionTreeNodeFolder"}]}}},"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/field-collection/{key}/usages":{"get":{"tags":["Class Definition"],"summary":"class_field_collection_get_usages_summary","description":"class_field_collection_get_usages_description","operationId":"class_field_collection_get_usages","parameters":[{"name":"key","in":"path","description":"Field collection unique key","required":true,"schema":{"type":"string","example":"MyFieldCollection"}}],"responses":{"200":{"description":"class_field_collection_get_usages_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FieldCollectionUsageData"}}},"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/definition/fields-by-type":{"get":{"tags":["Class Definition"],"summary":"class_get_fields_by_type_summary","description":"class_get_fields_by_type_description","operationId":"class_get_fields_by_type","parameters":[{"name":"classId","in":"query","description":"The class ID to retrieve fields for.","required":true,"schema":{"type":"string","example":"EV"}},{"name":"type","in":"query","description":"Comma-separated list of field types to filter by.","required":true,"schema":{"type":"string","example":"manyToOneRelation,objectbricks"}}],"responses":{"200":{"description":"class_get_fields_by_type_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/FieldByType"}}},"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/folder/{folderId}":{"get":{"tags":["Class Definition"],"summary":"class_definition_folder_collection_summary","description":"class_definition_folder_collection_description","operationId":"class_definition_folder_collection","parameters":[{"name":"folderId","in":"path","description":"FolderId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"class_definition_folder_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/ClassDefinitionFolderItem"}}},"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/definition/{dataObjectClass}":{"get":{"tags":["Class Definition"],"summary":"class_definition_get_summary","description":"class_definition_get_description","operationId":"class_definition_get","parameters":[{"name":"dataObjectClass","in":"path","description":"class_definition_get_data_object_class","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"class_definition_get_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"}]}}}}}}},"/pimcore-studio/api/class/object-brick/classes":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_classes_summary","description":"class_object_brick_classes_description","operationId":"class_object_brick_classes","responses":{"200":{"description":"class_object_brick_classes_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/object-brick/collection":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_collection_summary","description":"class_object_brick_collection_description","operationId":"class_object_brick_collection","responses":{"200":{"description":"class_object_brick_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/ObjectBrickConfig"}}},"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/object-brick":{"post":{"tags":["Class Definition"],"summary":"class_object_brick_create_summary","description":"class_object_brick_create_description","operationId":"class_object_brick_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateObjectBrick"}}}},"responses":{"200":{"description":"class_object_brick_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectBrickDetail"}}}},"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/object-brick/{key}/custom-layout/{customLayoutId}":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_custom_layout_get_summary","description":"class_object_brick_custom_layout_get_description","operationId":"class_object_brick_custom_layout_get","parameters":[{"name":"key","in":"path","description":"class_object_brick_custom_layout_get_key","required":true,"schema":{"type":"string","example":"SaleInformation"}},{"name":"customLayoutId","in":"path","description":"class_object_brick_custom_layout_get_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_object_brick_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_object_brick_custom_layout_update_summary","description":"class_object_brick_custom_layout_update_description","operationId":"class_object_brick_custom_layout_update","parameters":[{"name":"key","in":"path","description":"class_object_brick_custom_layout_update_key","required":true,"schema":{"type":"string","example":"SaleInformation"}},{"name":"customLayoutId","in":"path","description":"class_object_brick_custom_layout_update_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomLayoutUpdate"}}}},"responses":{"200":{"description":"class_object_brick_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"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"class_object_brick_custom_layout_delete_summary","description":"class_object_brick_custom_layout_delete_description","operationId":"class_object_brick_custom_layout_delete","parameters":[{"name":"key","in":"path","description":"class_object_brick_custom_layout_delete_key","required":true,"schema":{"type":"string","example":"SaleInformation"}},{"name":"customLayoutId","in":"path","description":"class_object_brick_custom_layout_delete_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_object_brick_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/object-brick/{key}/custom-layout/{customLayoutId}/export":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_custom_layout_export_summary","description":"class_object_brick_custom_layout_export_description","operationId":"class_object_brick_custom_layout_export","parameters":[{"name":"key","in":"path","description":"class_object_brick_custom_layout_export_key","required":true,"schema":{"type":"string","example":"SaleInformation"}},{"name":"customLayoutId","in":"path","description":"class_object_brick_custom_layout_export_layout_id","required":true,"schema":{"type":"string","example":"CarTodo"}}],"responses":{"200":{"description":"class_object_brick_custom_layout_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"custom_definition_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/object-brick/{key}/custom-layout/{customLayoutId}/import":{"post":{"tags":["Class Definition"],"summary":"class_object_brick_custom_layout_import_summary","description":"class_object_brick_custom_layout_import_description","operationId":"class_object_brick_custom_layout_import","parameters":[{"name":"key","in":"path","description":"class_object_brick_custom_layout_import_key","required":true,"schema":{"type":"string","example":"SaleInformation"}},{"name":"customLayoutId","in":"path","description":"class_object_brick_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_object_brick_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/object-brick/{key}":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_get_by_key_summary","description":"class_object_brick_get_by_key_description","operationId":"class_object_brick_get_by_key","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"class_object_brick_get_by_key_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectBrickDetail"}}}},"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_object_brick_update_summary","description":"class_object_brick_update_description","operationId":"class_object_brick_update","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectBrickUpdate"}}}},"responses":{"200":{"description":"class_object_brick_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectBrickDetail"}}}},"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":["Class Definition"],"summary":"class_object_brick_delete_summary","description":"class_object_brick_delete_description","operationId":"class_object_brick_delete","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"class_object_brick_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/object-brick/{key}/export":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_export_summary","description":"class_object_brick_export_description","operationId":"class_object_brick_export","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"class_object_brick_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"objectbrick_MyObjectBrick_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/object-brick/{key}/import":{"post":{"tags":["Class Definition"],"summary":"class_object_brick_import_summary","description":"class_object_brick_import_description","operationId":"class_object_brick_import","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"Import file with JSON encoded object brick definition","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"class_object_brick_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectBrickDetail"}}}},"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/object-brick/{objectId}/object/layout":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_object_layout_summary","description":"class_object_brick_object_layout_description","operationId":"class_object_brick_object_layout","parameters":[{"name":"objectId","in":"path","description":"ObjectId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"class_object_brick_object_layout_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/ObjectBrickLayoutDefinition"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/class/object-brick/{key}/layout":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_get_layout_by_key_summary","description":"class_object_brick_get_layout_by_key_description","operationId":"class_object_brick_get_layout_by_key","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"class_object_brick_get_layout_by_key_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigLayoutDefinition"}}}},"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/object-brick/tree":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_get_tree_summary","description":"class_object_brick_get_tree_description","operationId":"class_object_brick_get_tree","responses":{"200":{"description":"class_object_brick_get_tree_success_response","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/ObjectBrickTreeNode"},{"$ref":"#/components/schemas/ObjectBrickTreeNodeFolder"}]}}},"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/object-brick/{key}/usages":{"get":{"tags":["Class Definition"],"summary":"class_object_brick_get_usages_summary","description":"class_object_brick_get_usages_description","operationId":"class_object_brick_get_usages","parameters":[{"name":"key","in":"path","description":"Object brick unique key","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"class_object_brick_get_usages_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ObjectBrickUsageData"}}},"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/select-option":{"post":{"tags":["Class Definition"],"summary":"class_select_option_create_summary","description":"class_select_option_create_description","operationId":"class_select_option_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSelectOption"}}}},"responses":{"200":{"description":"class_select_option_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectOptionDetail"}}}},"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/select-option/{id}":{"get":{"tags":["Class Definition"],"summary":"class_select_option_get_summary","description":"class_select_option_get_description","operationId":"class_select_option_get","parameters":[{"name":"id","in":"path","description":"Select option configuration ID","required":true,"schema":{"type":"string","example":"EventStatus"}}],"responses":{"200":{"description":"class_select_option_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectOptionDetail"}}}},"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_select_option_update_summary","description":"class_select_option_update_description","operationId":"class_select_option_update","parameters":[{"name":"id","in":"path","description":"Select option configuration ID","required":true,"schema":{"type":"string","example":"EventStatus"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSelectOption"}}}},"responses":{"200":{"description":"class_select_option_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectOptionDetail"}}}},"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"}]}}}}}},"delete":{"tags":["Class Definition"],"summary":"class_select_option_delete_summary","description":"class_select_option_delete_description","operationId":"class_select_option_delete","parameters":[{"name":"id","in":"path","description":"Select option configuration ID","required":true,"schema":{"type":"string","example":"EventStatus"}}],"responses":{"200":{"description":"class_select_option_delete_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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"}]}}}}}}},"/pimcore-studio/api/class/select-option/tree":{"get":{"tags":["Class Definition"],"summary":"class_select_option_get_tree_summary","description":"class_select_option_get_tree_description","operationId":"class_select_option_get_tree","parameters":[{"name":"withGroup","in":"query","description":"Whether to group the results.","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"class_select_option_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/SelectOptionTree"},{"$ref":"#/components/schemas/SelectOptionTreeFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/select-option/{id}/usages":{"get":{"tags":["Class Definition"],"summary":"class_select_option_get_usages_summary","description":"class_select_option_get_usages_description","operationId":"class_select_option_get_usages","parameters":[{"name":"id","in":"path","description":"Select option configuration ID","required":true,"schema":{"type":"string","example":"EventStatus"}}],"responses":{"200":{"description":"class_select_option_get_usages_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SelectOptionUsageItem"}}},"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/classification-store/collections":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_collections_summary","description":"classification_store_get_collections_description","operationId":"classification_store_get_collections","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}}],"responses":{"200":{"description":"classification_store_get_collections_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/Collection"}}},"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/classification-store/groups":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_groups_summary","description":"classification_store_get_groups_description","operationId":"classification_store_get_groups","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"classification_store_get_groups_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/Group"}}},"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/classification-store/key-group-relations":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_key_group_relations_summary","description":"classification_store_get_key_group_relations_description","operationId":"classification_store_get_key_group_relations","parameters":[{"name":"storeId","in":"query","description":"Classification Store ID","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"query","description":"Class ID","required":false,"schema":{"type":"string","example":"AP"}},{"name":"searchTerm","in":"query","description":"Search Term","required":false,"schema":{"type":"string","example":"search term"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"classification_store_get_key_group_relations_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/KeyGroupRelation"}}},"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/classification-store/layout-by-collection/{collectionId}":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_layout_by_collection_summary","description":"classification_store_get_layout_by_collection_description","operationId":"classification_store_get_layout_by_collection","parameters":[{"name":"objectId","in":"query","description":"object ID","required":true,"schema":{"type":"integer","example":83}},{"name":"collectionId","in":"path","description":"CollectionId of the Collection ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"classification_store_get_layout_by_collection_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionLayout"}}}},"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/classification-store/layout-by-group/{groupId}":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_layout_by_group_summary","description":"classification_store_get_layout_by_group_description","operationId":"classification_store_get_layout_by_group","parameters":[{"name":"objectId","in":"query","description":"object ID","required":true,"schema":{"type":"integer","example":83}},{"name":"groupId","in":"path","description":"GroupId of the Group ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"classification_store_get_layout_by_group_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupLayout"}}}},"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/classification-store/layout-by-key/{keyId}":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_layout_by_key_summary","description":"classification_store_get_layout_by_key_description","operationId":"classification_store_get_layout_by_key","parameters":[{"name":"objectId","in":"query","description":"object ID","required":false,"schema":{"type":"integer","example":83}},{"name":"keyId","in":"path","description":"KeyId of the Key ID","required":true,"schema":{"type":"integer","example":83}},{"name":"fieldName","in":"query","description":"Field Name","required":true,"schema":{"type":"string","example":"technicalAttributes"}}],"responses":{"200":{"description":"classification_store_get_layout_by_key_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyLayout"}}}},"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/classification-store/config/collection":{"get":{"tags":["Classification Store"],"summary":"classification_store_get_config_collection_summary","description":"classification_store_get_config_collection_description","operationId":"classification_store_get_config_collection","responses":{"200":{"description":"classification_store_get_config_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/ClassificationStoreStoreConfig"}}},"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/data-objects/add/{parentId}":{"post":{"tags":["Data Objects"],"summary":"data_object_add_summary","description":"data_object_add_description","operationId":"data_object_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataObjectAddParameters"}}}},"responses":{"200":{"description":"data_object_add_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of created data object","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/data-objects/batch-delete":{"delete":{"tags":["Data Objects"],"summary":"data_object_batch_delete_summary","description":"data_object_batch_delete_description","operationId":"data_object_batch_delete","requestBody":{"content":{"application/json":{"schema":{"properties":{"ids":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"201":{"description":"data_object_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/data-objects/{id}/clone/{parentId}":{"post":{"tags":["Data Objects"],"summary":"data_object_clone_summary","description":"data_object_clone_description","operationId":"data_object_clone","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"parentId","in":"path","description":"ParentId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneParameters"}}}},"responses":{"200":{"description":"data_object_clone_success_response"},"201":{"description":"data_object_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/data-objects/{id}":{"get":{"tags":["Data Objects"],"summary":"data_object_get_by_id_summary","description":"data_object_get_by_id_description","operationId":"data_object_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_get_by_id_success_response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/DataObjectDetail"},{"$ref":"#/components/schemas/DataObjectFolder"}]}}}},"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":["Data Objects"],"summary":"data_object_update_by_id_summary","description":"data_object_update_by_id_description","operationId":"data_object_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"useDraftData":{"type":["boolean","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \"someFieldKey\": \"someValue\" }"},"properties":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateElementProperty"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_update_by_id_success_response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/DataObjectDetail"},{"$ref":"#/components/schemas/DataObjectFolder"}]}}}},"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/data-objects/grid/preview":{"post":{"tags":["Data Object Grid"],"summary":"data_object_get_grid_preview_summary","description":"data_object_get_grid_preview_description","operationId":"data_object_get_grid_preview","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["objectId","column"],"properties":{"objectId":{"type":"integer","example":1},"column":{"$ref":"#/components/schemas/Column"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_get_grid_preview_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColumnData"}}}},"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/data-object/grid/configuration/{configurationId}":{"delete":{"tags":["Data Object Grid"],"summary":"data_object_delete_grid_configuration_by_configurationId_summary","description":"data_object_delete_grid_configuration_by_configurationId_description","operationId":"data_object_delete_grid_configuration_by_configurationId","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request
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/data-object/grid/configuration/{folderId}/{classId}":{"get":{"tags":["Data Object Grid"],"summary":"data_object_get_grid_configuration_summary","description":"data_object_get_grid_configuration_description","operationId":"data_object_get_grid_configuration","parameters":[{"name":"folderId","in":"path","description":"FolderId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}},{"name":"configurationId","in":"query","description":"Configuration ID","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_get_grid_configuration_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request
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/data-object/grid/configurations/{classId}":{"get":{"tags":["Data Object Grid"],"summary":"data_object_list_saved_grid_configurations_summary","description":"data_object_list_saved_grid_configurations_description","operationId":"data_object_list_saved_grid_configurations","parameters":[{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}}],"responses":{"200":{"description":"data_object_list_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/data-object/grid/configuration/save/{classId}":{"post":{"tags":["Data Object Grid"],"summary":"data_object_save_grid_configuration_summary","description":"data_object_save_grid_configuration_description","operationId":"data_object_save_grid_configuration","parameters":[{"name":"classId","in":"path","description":"Class Id of the data object","required":true,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filter":{"oneOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_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/data-object/grid/configuration/set-as-favorite/{configurationId}/{folderId}":{"post":{"tags":["Data Object Grid"],"summary":"data_object_set_grid_configuration_as_favorite_summary","description":"data_object_set_grid_configuration_as_favorite_description","operationId":"data_object_set_grid_configuration_as_favorite","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}},{"name":"folderId","in":"path","description":"FolderId of the folderId","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_set_grid_configuration_as_favorite_response"},"default":{"description":"400 - Bad Request
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/data-object/grid/configuration/update/{configurationId}":{"put":{"tags":["Data Object Grid"],"summary":"data_object_update_grid_configuration_summary","description":"data_object_update_grid_configuration_description","operationId":"data_object_update_grid_configuration","parameters":[{"name":"configurationId","in":"path","description":"ConfigurationId of the configurationId","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId","pageSize","name","description","columns"],"properties":{"folderId":{"type":"integer","example":1},"pageSize":{"type":"integer","example":1},"name":{"type":"string"},"description":{"type":"string"},"shareGlobal":{"type":"boolean","example":true},"setAsFavorite":{"type":"boolean","example":true},"saveFilter":{"type":"boolean","example":true},"sharedUsers":{"type":"object","example":[42,1337]},"sharedRoles":{"type":"object","example":[42,1337]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filter":{"oneOf":[{"$ref":"#/components/schemas/Filter"},{"type":"null"}],"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_update_grid_configuration_success_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/data-object/grid/available-columns":{"get":{"tags":["Data Object Grid"],"summary":"data_object_get_available_grid_columns_summary","description":"data_object_get_available_grid_columns_description","operationId":"data_object_get_available_grid_columns","parameters":[{"name":"classId","in":"query","description":"Identifies the class name for which the columns should be retrieved.","required":false,"schema":{"type":"string","example":"EV"}},{"name":"folderId","in":"query","description":"folderId","required":false,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_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
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/data-object/grid/available-columns-for-relation":{"get":{"tags":["Data Object Grid"],"summary":"data_object_get_available_grid_columns_for_relation_summary","description":"data_object_get_available_grid_columns_for_relation_description","operationId":"data_object_get_available_grid_columns_for_relation","parameters":[{"name":"classId","in":"query","description":"Identifies the class name for which the columns should be retrieved.","required":false,"schema":{"type":"string","example":"EV"}},{"name":"relationField","in":"query","description":"relationField as dot notation, e.g. \"myBlock.mySubRelationField\"","required":false,"schema":{"type":"string","example":"myRelationField"}}],"responses":{"200":{"description":"data_object_get_available_grid_columns_success_for_relation_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","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/data-objects/grid/{classId}":{"post":{"tags":["Data Object Grid"],"summary":"data_object_get_grid_summary","description":"data_object_get_grid_description","operationId":"data_object_get_grid","parameters":[{"name":"classId","in":"path","description":"Identifies the class name for which the the grid should be build.","required":true,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderId"],"properties":{"folderId":{"type":"integer","example":1},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_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","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/data-objects/grid/transformers/services/phpcode":{"get":{"tags":["Data Object Grid"],"summary":"data_object_get_phpcode_transformers_summary","description":"data_object_get_phpcode_transformers_description","operationId":"data_object_get_phpcode_transformers","responses":{"200":{"description":"data_object_get_phpcode_transformers_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/PhpCodeTransformer"}}},"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/data-objects/{id}/layout":{"get":{"tags":["Data Objects"],"summary":"data_object_get_layout_by_id_summary","description":"data_object_get_layout_by_id_description","operationId":"data_object_get_layout_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"layoutId","in":"query","description":"ID to get specific layout","required":false,"schema":{"type":"string","example":"Todo"}}],"responses":{"200":{"description":"data_object_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/data-objects":{"patch":{"tags":["Data Objects"],"summary":"data_object_patch_by_id_summary","description":"data_object_patch_by_id_description","operationId":"data_object_patch_by_id","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"required":["id"],"properties":{"id":{"description":"Data Object ID","type":"integer","example":83},"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \"someFieldKey\": \"someValue\" }"}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"data_object_patch_by_id_success_response"},"201":{"description":"data_object_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/data-objects/folder":{"patch":{"tags":["Data Objects"],"summary":"data_object_patch_folder_by_id_summary","description":"data_object_patch_folder_by_id_description","operationId":"data_object_patch_folder_by_id","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data","classId"],"properties":{"data":{"type":"array","items":{"required":["folderId"],"properties":{"folderId":{"description":"Folder ID","type":"integer","example":2},"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"locked":{"type":["string","null"]},"childrenSortBy":{"type":["string","null"]},"childrenSortOrder":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \"someFieldKey\": \"someValue\" }"}},"type":"object"}},"filters":{"$ref":"#/components/schemas/ExportAllFilter"},"classId":{"type":"string","example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"data_object_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/data-objects/format-path":{"post":{"tags":["Data Objects"],"summary":"data_object_format_path_summary","description":"data_object_format_path_description","operationId":"data_object_format_path","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["objectId","targets"],"properties":{"objectId":{"type":"integer","example":1},"targets":{"type":"object","example":"{\"object_10\":{\"id\":10,\"type\":\"object\",\"label\":\"/Product\n Data/Cars/jaguar/E-Type/coupé\",\"path\":\"/Product Data/Cars/jaguar/E-Type/coupé\",\n \"nicePathKey\":\"object_10\"}}"},"fieldName":{"description":"Fieldname for the PathFormatter. Given as Dot Notation","type":"string","example":"attributes.Bodywork.numberOfDoors"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_format_path_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/FormatedPath"}}},"type":"object"}}}},"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/data-objects/preview/{id}":{"get":{"tags":["Data Objects"],"summary":"data_object_preview_by_id_summary","description":"data_object_preview_by_id_description","operationId":"data_object_preview_by_id","parameters":[{"name":"id","in":"path","description":"Id of the data object","required":true,"schema":{"type":"integer","example":83}},{"name":"site","in":"query","description":"Site ID","required":false,"schema":{"type":"integer","example":42}}],"responses":{"302":{"description":"data_object_preview_by_id_success_response","headers":{"Location":{"description":"Redirect location","required":true,"schema":{"type":"string","format":"uri"}}}},"default":{"description":"302 - Redirect
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/data-objects/{sourceId}/replace/{targetId}":{"post":{"tags":["Data Objects"],"summary":"data_object_replace_content_summary","description":"data_object_replace_content_description","operationId":"data_object_replace_content","parameters":[{"name":"sourceId","in":"path","description":"SourceId of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"targetId","in":"path","description":"TargetId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"data_object_replace_content_success_response"},"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/data-objects/select-options":{"post":{"tags":["Data Objects"],"summary":"data_object_get_select_options_summary","description":"data_object_get_select_options_description","operationId":"data_object_get_select_options","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["objectId","fieldName","context"],"properties":{"objectId":{"type":"integer","example":1},"fieldName":{"type":"string"},"changedData":{"type":"object","example":"{\"Input\":\"new value\"}"},"context":{"type":"object","example":"{\"containerType\":\"object\",\"fieldname\":\"select\",\"objectId\":40,\"layoutId\":\"0\"}"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_get_select_options_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/SelectOption"}}},"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/data-objects/tree":{"get":{"tags":["Data Objects"],"summary":"data_object_get_tree_summary","description":"data_object_get_tree_description","operationId":"data_object_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter data objects by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"series = empty AND color=\"red\""}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"/path/to/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"className","in":"query","description":"When provided, the search is executed on the specific data object class index.","required":false,"schema":{"type":"string","example":"Car"}},{"name":"classIds","in":"query","description":"Filter results based on the provided class IDs.","required":false,"schema":{"type":"string","example":"[\"Car\"]"}}],"responses":{"200":{"description":"data_object_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/DataObject"},{"$ref":"#/components/schemas/DataObjectFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/dependencies/{elementType}/{id}":{"get":{"tags":["Dependencies"],"summary":"Get all dependencies for provided element.","description":"Get paginated dependencies.\n Pass dependency mode to get either all elements that depend on the provided element\n or all dependencies for the provided element.","operationId":"dependency_get_collection_by_element_type","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"dependencyMode","in":"query","description":"Dependency mode","required":true,"schema":{"type":"string","enum":["required_by","requires"],"example":"required_by"}}],"responses":{"200":{"description":"Paginated dependencies with total count as header param","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Dependency"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/documents/add/{parentId}":{"post":{"tags":["Documents"],"summary":"document_add_summary","description":"document_add_description","operationId":"document_add","parameters":[{"name":"parentId","in":"path","description":"ParentId of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentAddParameters"}}}},"responses":{"200":{"description":"document_add_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of created document element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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"}]}}}}}}},"/pimcore-studio/api/documents/{id}/clone/{parentId}":{"post":{"tags":["Documents"],"summary":"document_clone_summary","description":"document_clone_description","operationId":"document_clone","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"parentId","in":"path","description":"ParentId of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCloneParameters"}}}},"responses":{"200":{"description":"document_clone_success_response"},"201":{"description":"document_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/documents/{id}/convert/{type}":{"post":{"tags":["Documents"],"summary":"document_convert_summary","description":"document_convert_description","operationId":"document_convert","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"type","in":"path","description":"Document type to convert to","required":true,"schema":{"type":"string","example":"page"}}],"responses":{"200":{"description":"document_convert_success_response"},"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/documents/doc-types/add":{"post":{"tags":["Documents"],"summary":"document_doc_type_add_summary","description":"document_doc_type_add_description","operationId":"document_doc_type_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocTypeAddParameters"}}}},"responses":{"200":{"description":"document_doc_type_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocType"}}}},"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/documents/doc-types/{id}":{"put":{"tags":["Documents"],"summary":"document_doc_type_update_by_id_summary","description":"document_doc_type_update_by_id_description","operationId":"document_doc_type_update_by_id","parameters":[{"name":"id","in":"path","description":"The Id of the DocType to update","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocTypeUpdateParameters"}}}},"responses":{"200":{"description":"document_doc_type_update_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocType"}}}},"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"}]}}}}}},"delete":{"tags":["Documents"],"summary":"document_doc_type_delete_summary","description":"document_doc_type_delete_description","operationId":"document_doc_type_delete","parameters":[{"name":"id","in":"path","description":"The Id of the DocType to delete","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"document_doc_type_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/documents/doc-types/types":{"get":{"tags":["Documents"],"summary":"document_doc_type_type_list_summary","description":"document_doc_type_type_list_description","operationId":"document_doc_type_type_list","responses":{"200":{"description":"document_doc_type_type_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocTypeType"}}},"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/documents/doc-types":{"get":{"tags":["Documents"],"summary":"document_doc_type_list_summary","description":"document_doc_type_list_description","operationId":"document_doc_type_list","parameters":[{"name":"type","in":"query","description":"Filter results by docType type","required":false,"schema":{"type":"string","example":"page"}}],"responses":{"200":{"description":"document_doc_type_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocType"}}},"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/documents/types":{"get":{"tags":["Documents"],"summary":"document_get_types_summary","description":"document_get_types_description","operationId":"document_get_types","responses":{"200":{"description":"document_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/DocumentType"}}},"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/documents/{id}":{"get":{"tags":["Documents"],"summary":"document_get_by_id_summary","description":"document_get_by_id_description","operationId":"document_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDetail"}}}},"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":["Documents"],"summary":"document_update_by_id_summary","description":"document_update_by_id_description","operationId":"document_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"parentId":{"type":["integer","null"],"minimum":1},"index":{"type":["integer","null"],"minimum":0},"key":{"type":["string","null"]},"task":{"type":"string","enum":["autoSave","publish","save","unpublish","version"]},"locked":{"type":["string","null"]},"published":{"type":["boolean","null"]},"editableData":{"type":["object","null"],"example":"{ \"someFieldKey\": \"someValue\" }"},"settingsData":{"type":["object","null"],"example":{"title":"Some Title","description":"Some Description","prettyUrl":"pretty/url","controller":"App\\Controller\\PageController","template":"@app/template.html.twig","contentMainDocumentId":123,"contentMainDocumentPath":"/path/to/main/document","supportsContentMain":false,"missingRequiredEditable":false,"staticGeneratorEnabled":false,"staticGeneratorLifetime":123456,"staticLastGenerated":1700000000,"url":"https://example.com/"}},"missingRequiredEditable":{"type":["boolean","null"]},"appendEditables":{"type":["boolean","null"]},"properties":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateElementProperty"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"document_update_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDetail"}}}},"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/documents/{id}/page/check-pretty-url":{"post":{"tags":["Documents"],"summary":"document_page_check_pretty_url_summary","description":"document_page_check_pretty_url_description","operationId":"document_page_check_pretty_url","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPrettyUrl"}}}},"responses":{"200":{"description":"document_page_check_pretty_url_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/documents/{id}/page/stream/preview":{"get":{"tags":["Documents"],"summary":"document_page_stream_preview_summary","description":"document_page_stream_preview_description","operationId":"document_page_stream_preview","parameters":[{"name":"id","in":"path","description":"Id of the page","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_page_stream_preview_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"}}}},"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/documents/get-available-controllers":{"get":{"tags":["Documents"],"summary":"document_available_controllers_list_summary","description":"document_available_controllers_list_description","operationId":"document_available_controllers_list","responses":{"200":{"description":"document_available_controllers_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentController"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/documents/get-available-templates":{"get":{"tags":["Documents"],"summary":"document_available_templates_list_summary","description":"document_available_templates_list_description","operationId":"document_available_templates_list","responses":{"200":{"description":"document_available_templates_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTemplate"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/documents/{id}/page-snippet/change-main-document":{"put":{"tags":["Documents"],"summary":"document_page_snippet_change_main_document_summary","description":"document_page_snippet_change_main_document_description","operationId":"document_page_snippet_change_main_document","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeMainDocument"}}}},"responses":{"200":{"description":"document_page_snippet_change_main_document_success_response"},"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/documents/page-snippet/{id}/area-block/render":{"post":{"tags":["Documents"],"summary":"document_page_snippet_area_block_render_summary","description":"document_page_snippet_area_block_render_description","operationId":"document_page_snippet_area_block_render","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","realName","index","blockStateStack","areablockConfig","areablockData"],"properties":{"name":{"type":["string","null"]},"realName":{"type":["string","null"]},"index":{"type":["integer","null"],"minimum":0},"blockStateStack":{"type":["object","null"],"example":"[{\"blocks\": [], \"indexes\": []}]"},"areaBlockConfig":{"type":["object","null"],"example":"[]"},"areaBlockData":{"type":["object","null"],"example":"[]"}},"type":"object"}}}},"responses":{"200":{"description":"document_page_snippet_area_block_render_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderAreaBlockData"}}}},"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/documents/renderlet/render":{"get":{"tags":["Documents"],"summary":"document_renderlet_render_summary","description":"document_renderlet_render_description","operationId":"document_renderlet_render","parameters":[{"name":"id","in":"query","description":"ElementId of the renderlet element","required":true,"schema":{"type":"integer","example":83}},{"name":"type","in":"query","description":"Type of the renderlet element.","required":true,"schema":{"type":"string","example":"data-object"}},{"name":"controller","in":"query","description":"Renderlet controller action","required":true,"schema":{"type":"string","example":"App/Controller\\Renderlet\\MyRenderletController::renderAction"}},{"name":"parentDocumentId","in":"query","description":"Parent document id of the renderlet","required":false,"schema":{"type":"integer","example":83}},{"name":"template","in":"query","description":"Renderlet template","required":false,"schema":{"type":"string","example":"App/Template/Renderlet/my_template.html.twig"}}],"responses":{"200":{"description":"document_renderlet_render_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"renderlet.html.twig\""}}},"content":{"text/html":{"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
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/documents/{sourceId}/replace/{targetId}":{"post":{"tags":["Documents"],"summary":"document_replace_content_summary","description":"document_replace_content_description","operationId":"document_replace_content","parameters":[{"name":"sourceId","in":"path","description":"SourceId of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"targetId","in":"path","description":"TargetId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_replace_content_success_response"},"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/documents/sites/list-available":{"get":{"tags":["Documents"],"summary":"documents_list_available_sites_summary","description":"documents_list_available_sites_description","operationId":"documents_list_available_sites","parameters":[{"name":"excludeMainSite","in":"query","description":"Exclude main site from the list","schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"documents_list_available_sites_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}},"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/documents/site/{id}":{"post":{"tags":["Documents"],"summary":"document_update_site_summary","description":"document_update_site_description","operationId":"document_update_site","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSite"}}}},"responses":{"200":{"description":"document_update_site_success_response"},"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"}]}}}}}},"delete":{"tags":["Documents"],"summary":"document_delete_site_summary","description":"document_delete_site_description","operationId":"document_delete_site","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_delete_site_success_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/documents/site/{documentId}":{"get":{"tags":["Documents"],"summary":"document_get_site_summary","description":"document_get_site_description","operationId":"document_get_site","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_get_site_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteDetailData"}}}},"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/documents/translations/{id}/add/{translationId}":{"post":{"tags":["Documents"],"summary":"document_add_translation_summary","description":"document_add_translation_description","operationId":"document_add_translation","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"translationId","in":"path","description":"TranslationId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_add_translation_success_response"},"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/documents/translations/{id}/delete/{translationId}":{"delete":{"tags":["Documents"],"summary":"document_delete_translation_summary","description":"document_delete_translation_description","operationId":"document_delete_translation","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"translationId","in":"path","description":"TranslationId of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_delete_translation_success_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/documents/translations/{id}":{"get":{"tags":["Documents"],"summary":"document_get_translations_summary","description":"document_get_translations_description","operationId":"document_get_translations","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"document_get_translations_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTranslationLinks"}}}},"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/documents/translations/{id}/get-parent/{language}":{"get":{"tags":["Documents"],"summary":"document_get_translation_parent_by_language_summary","description":"document_get_translation_parent_by_language_description","operationId":"document_get_translation_parent_by_language","parameters":[{"name":"id","in":"path","description":"Id of the document","required":true,"schema":{"type":"integer","example":83}},{"name":"language","in":"path","description":"Language code for the translation parent","required":true,"schema":{"type":"string","example":"en"}}],"responses":{"200":{"description":"document_get_translation_parent_by_language_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTranslationParent"}}}},"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/documents/tree":{"get":{"tags":["Documents"],"summary":"document_get_tree_summary","description":"document_get_tree_description","operationId":"document_get_tree","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"parentId","in":"query","description":"Filter documents by parent id.","required":false,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"idSearchTerm","in":"query","description":"Filter assets/data-objects by matching ids. As a wildcard * can be used","required":false,"schema":{"type":"string","example":83}},{"name":"pqlQuery","in":"query","description":"Pql query filter","required":false,"schema":{"type":"string","example":"id = 69"}},{"name":"excludeFolders","in":"query","description":"Filter folders from result.","required":false,"schema":{"type":"boolean","example":false}},{"name":"path","in":"query","description":"Filter by path.","required":false,"schema":{"type":"string","example":"/path/to/folder"}},{"name":"pathIncludeParent","in":"query","description":"Include the parent item in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"pathIncludeDescendants","in":"query","description":"Include all descendants in the result.","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"document_get_tree_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/Document"}}},"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/elements/{elementType}/delete/{id}":{"delete":{"tags":["Elements"],"summary":"element_delete_summary","description":"element_delete_description","operationId":"element_delete","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"element_delete_success_response"},"201":{"description":"element_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
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/elements/{elementType}/delete-info/{id}":{"get":{"tags":["Elements"],"summary":"element_get_delete_info_summary","description":"element_get_delete_info_description","operationId":"element_get_delete_info","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"element_get_delete_info_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInfo"}}}},"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/elements/{elementType}/folder/{parentId}":{"post":{"tags":["Elements"],"summary":"element_folder_create_summary","description":"element_folder_create_description","operationId":"element_folder_create","parameters":[{"name":"parentId","in":"path","description":"ParentId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderData"}}}},"responses":{"200":{"description":"element_folder_create_success_response"},"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/elements/{elementType}/context-permissions/":{"get":{"tags":["Elements"],"summary":"element_get_context_permissions_summary","description":"element_get_context_permissions_description","operationId":"element_get_context_permissions","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"element_get_context_permissions_success_response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"}},"example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}}}},"default":{"description":"400 - Bad Request
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/elements/{elementType}/location/{id}/{perspectiveId}":{"get":{"tags":["Elements"],"summary":"element_get_tree_location_summary","description":"element_get_tree_location_description","operationId":"element_get_tree_location","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"element_get_tree_location_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationData"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/elements/{elementType}/path":{"get":{"tags":["Elements"],"summary":"element_get_id_by_path_summary","description":"element_get_id_by_path_description","operationId":"element_get_id_by_path","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"elementPath","in":"query","description":"Filter elements by matching element path.","required":true,"schema":{"type":"string","example":"path/to/element"}}],"responses":{"200":{"description":"element_get_id_by_path_response_description","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of the element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/elements/{elementType}/subtype/{id}":{"get":{"tags":["Elements"],"summary":"element_get_subtype_summary","description":"element_get_subtype_description","operationId":"element_get_subtype","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"element_get_subtype_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subtype"}}}},"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/elements/usage/{elementType}/{id}":{"get":{"tags":["Elements"],"summary":"element_get_usage_summary","description":"element_get_usage_description","operationId":"element_get_usage","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"sortBy","in":"query","description":"Sort by field.","required":false,"schema":{"type":"string","enum":["id","path","type"],"example":null}}],"responses":{"200":{"description":"element_get_usage_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementUsage"}}}},"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/elements/usage/replace/{elementType}/{id}":{"post":{"tags":["Elements"],"summary":"element_usage_replace_summary","description":"element_usage_replace_description","operationId":"element_usage_replace","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"targetType":{"type":"string","enum":["data-object","object","asset","document"],"example":"data-object"},"targetId":{"type":"integer","example":"8"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ElementUsageBaseItem"}}},"type":"object"}}}},"responses":{"200":{"description":"element_usage_replace_success_response","content":{"application/json":{"schema":{"required":["jobRunId"],"properties":{"jobRunId":{"title":"jobRunId","description":"ID of created jobRun","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"201 - Created
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/elements/{elementType}/resolve":{"get":{"tags":["Elements"],"summary":"element_resolve_by_search_term_summary","description":"element_resolve_by_search_term_description","operationId":"element_resolve_by_search_term","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"searchTerm","in":"query","description":"Search term to filter elements by.","required":true,"schema":{"type":"string","example":"83"}}],"responses":{"200":{"description":"element_resolve_response_description","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of the element","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/emails/blocklist":{"get":{"tags":["E-Mails"],"summary":"email_blocklist_get_collection_summary","description":"email_blocklist_get_collection_description","operationId":"email_blocklist_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"email","in":"query","description":"Email address to be filtered by","required":false,"schema":{"type":"string","example":"mail@mail.com"}}],"responses":{"200":{"description":"email_blocklist_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/BlocklistEntry"}}},"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"}]}}}}}},"post":{"tags":["E-Mails"],"summary":"email_blocklist_add_summary","description":"email_blocklist_add_description","operationId":"email_blocklist_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAddressParameter"}}}},"responses":{"200":{"description":"email_blocklist_add_success_response"},"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"}]}}}}}},"delete":{"tags":["E-Mails"],"summary":"email_blocklist_delete_summary","description":"email_blocklist_delete_description","operationId":"email_blocklist_delete","parameters":[{"name":"email","in":"query","description":" Email address to be deleted from blocklist","required":false,"schema":{"type":"string","example":"mail@mail.com"}}],"responses":{"200":{"description":"email_blocklist_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/emails":{"get":{"tags":["E-Mails"],"summary":"email_log_get_collection_summary","description":"email_log_get_collection_description","operationId":"email_log_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"email_log_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/EmailLogEntry"}}},"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/emails/{id}":{"get":{"tags":["E-Mails"],"summary":"email_log_get_by_id_summary","description":"email_log_get_by_id_description","operationId":"email_log_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailLogEntryDetail"}}}},"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":["E-Mails"],"summary":"email_log_delete_summary","description":"email_log_delete_description","operationId":"email_log_delete","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_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/emails/{id}/html":{"get":{"tags":["E-Mails"],"summary":"email_log_get_html_summary","description":"email_log_get_html_description","operationId":"email_log_get_html","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_get_html_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry HTML data.","type":"string","example":"

Some email HTML 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/emails/{id}/params":{"get":{"tags":["E-Mails"],"summary":"email_log_get_params_summary","description":"email_log_get_params_description","operationId":"email_log_get_params","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_get_params_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry parameters","type":"array","items":{"$ref":"#/components/schemas/EmailLogEntryParameter"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/emails/{id}/text":{"get":{"tags":["E-Mails"],"summary":"email_log_get_text_summary","description":"email_log_get_text_description","operationId":"email_log_get_text","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_get_text_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Email log entry text data.","type":"string","example":"Some email text content"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/emails/{id}/forward":{"post":{"tags":["E-Mails"],"summary":"email_log_forward_by_id_summary","description":"email_log_forward_by_id_description","operationId":"email_log_forward_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAddressParameter"}}}},"responses":{"200":{"description":"email_log_forward_by_id_success_response"},"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/emails/{id}/resend":{"post":{"tags":["E-Mails"],"summary":"email_log_resend_by_id_summary","description":"email_log_resend_by_id_description","operationId":"email_log_resend_by_id","parameters":[{"name":"id","in":"path","description":"Id of the E-Mail","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"email_log_resend_by_id_success_response"},"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/emails/test":{"post":{"tags":["E-Mails"],"summary":"email_send_test_summary","description":"email_send_test_description","operationId":"email_send_test","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailParameters"}}}},"responses":{"200":{"description":"email_send_test_success_response"},"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/execution-engine/abort/{jobRunId}":{"post":{"tags":["Execution Engine"],"summary":"execution_engine_abort_job_run_by_id_summary","description":"execution_engine_abort_job_run_by_id_description","operationId":"execution_engine_abort_job_run_by_id","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/execution-engine/hide":{"post":{"tags":["Execution Engine"],"summary":"execution_engine_hide_job_runs_summary","description":"execution_engine_hide_job_runs_description","operationId":"execution_engine_hide_job_runs","requestBody":{"content":{"application/json":{"schema":{"properties":{"jobRunIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/execution-engine/running-jobs":{"post":{"tags":["Execution Engine"],"summary":"execution_engine_list_jobs_summary","description":"execution_engine_list_jobs_description","operationId":"execution_engine_list_jobs","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"type\":\"state\", \"filterValue\": \"running\"},{\"type\":\"id\", \"filterValue\": 5}]"},"sortFilter":{"type":"object","example":"{\"key\":\"id\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"execution_engine_list_jobs_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/JobRun"}}},"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/export/download/csv/{jobRunId}":{"get":{"tags":["Export"],"summary":"export_download_csv_summary","description":"export_download_csv_description","operationId":"export_download_csv","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"export_download_csv_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/csv":{"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"}]}}}}}},"delete":{"tags":["Export"],"summary":"export_delete_csv_summary","description":"export_delete_csv_description","operationId":"export_delete_csv","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/export/csv":{"post":{"tags":["Export"],"summary":"export_csv_summary","description":"export_csv_description","operationId":"export_csv","requestBody":{"content":{"application/json":{"schema":{"properties":{"elements":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"},"delimiter":{"type":"string","example":";"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"}},"type":"object"}}}},"responses":{"201":{"description":"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/export/csv/folder":{"post":{"tags":["Export"],"summary":"export_csv_folder_summary","description":"export_csv_folder_description","operationId":"export_csv_folder","requestBody":{"content":{"application/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[1]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/ExportAllFilter"},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"},"delimiter":{"type":"string","example":";"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"},"classId":{"type":["string","null"],"example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"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/export/download/xlsx/{jobRunId}":{"get":{"tags":["Export"],"summary":"export_download_xlsx_summary","description":"export_download_xlsx_description","operationId":"export_download_xlsx","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"export_download_xlsx_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"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"}]}}}}}},"delete":{"tags":["Export"],"summary":"export_delete_xlsx_summary","description":"export_delete_xlsx_description","operationId":"export_delete_xlsx","parameters":[{"name":"jobRunId","in":"path","description":"JobRunId of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/export/xlsx":{"post":{"tags":["Export"],"summary":"export_xlsx_summary","description":"export_xlsx_description","operationId":"export_xlsx","requestBody":{"content":{"application/json":{"schema":{"properties":{"elements":{"type":"array","items":{"type":"integer"},"example":[83]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"}},"type":"object"}}}},"responses":{"201":{"description":"export_xlsx_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/export/xlsx/folder":{"post":{"tags":["Export"],"summary":"export_xlsx_folder_summary","description":"export_xlsx_folder_description","operationId":"export_xlsx_folder","requestBody":{"content":{"application/json":{"schema":{"properties":{"folders":{"type":"array","items":{"type":"integer"},"example":[1]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/ExportAllFilter"},"config":{"properties":{"header":{"type":"string","enum":["id","custom_report_config","custom_report_to_export","element_class_id","element_to_export","element_type","folder_to_export","grid_export_data","grid_export_data_info","config","columns","filters","delimiter","header","no_header","title","name","\r\n","array","int","string","bool"],"example":"title"}},"type":"object"},"elementType":{"type":"string","enum":["data-object","object","asset","document"],"example":"asset"},"classId":{"type":["string","null"],"example":"CAR"}},"type":"object"}}}},"responses":{"201":{"description":"export_xlsx_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/gdpr/export-data/{id}":{"get":{"tags":["GDPR Data Extractor"],"summary":"gdpr_export_summary","description":"gdpr_export_description","operationId":"gdpr_export","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"providerKey","in":"query","description":"The key of the single provider to export","required":true,"schema":{"type":"string","example":"pimcore_users"}}],"responses":{"200":{"description":"gdpr_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"example.jpg\""}}},"content":{"*/*":{"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/gdpr/providers":{"get":{"tags":["GDPR Data Extractor"],"summary":"gdpr_list_providers_summary","description":"gdpr_list_providers_description","operationId":"gdpr_list_providers","responses":{"200":{"description":"gdpr_list_providers_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/GdprDataProvider"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/gdpr/search":{"post":{"tags":["GDPR Data Extractor"],"summary":"gdpr_search_data_summary","description":"gdpr_search_data_description","operationId":"gdpr_search_data","parameters":[{"name":"provider","in":"query","description":"Define the data provider to search in.","required":false,"schema":{"type":"string","example":"assets"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"type\":\"firstname\", \"filterValue\": \"John\"},{\"type\":\"lastname\", \"filterValue\": \"Doe\"},{\"type\":\"email\", \"filterValue\": \"john.doe@mail.com\"},{\"type\":\"id\", \"filterValue\": 1}]"},"sortFilter":{"type":"object","example":"{\"key\":\"id\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"gdpr_search_data_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/GdprDataRow"}}},"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
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/mercure/auth":{"post":{"tags":["Mercure"],"summary":"mercure_create_cookie_summary","description":"mercure_create_cookie_description","operationId":"mercure_create_cookie","responses":{"200":{"description":"mercure_create_cookie_success_response"},"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/assets/{id}/custom-metadata":{"get":{"tags":["Metadata"],"summary":"asset_custom_metadata_get_by_id_summary","description":"asset_custom_metadata_get_by_id_description","operationId":"asset_custom_metadata_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the asset","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"asset_custom_metadata_get_by_id_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomMetadata"}}},"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/metadata":{"post":{"tags":["Metadata"],"summary":"metadata_get_collection_summary","description":"metadata_get_collection_description","operationId":"metadata_get_collection","requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"filter":{"type":["string","null"],"example":"author"}},"type":"object"}}}},"responses":{"200":{"description":"metadata_get_collection_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PredefinedMetadata"}}},"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/notes":{"post":{"tags":["Notes"],"summary":"note_get_collection_summary","description":"note_get_collection_description","operationId":"note_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["page","pageSize"],"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"sortOrder":{"description":"Sort order (asc or desc).","type":"string","enum":["ASC","DESC"],"example":"ASC"},"sortBy":{"description":"Sort by field. Only works in combination with sortOrder.","type":"string","enum":["id","type","cId","cType","cPath","date","title","description","locked"],"example":"id"},"filter":{"description":"Filter for notes","type":"string","example":""},"fieldFilters":{"description":"Filter for specific fields, will be json decoded to an array. e.g.\n [{\"operator\":\"like\",\"value\":\"John\",\"field\":\"name\",\"type\":\"string\"}]","type":"object","example":"[{\"operator\":\"like\",\"value\":\"consent-given\",\"field\":\"type\",\"type\":\"string\"}]"}},"type":"object"}}}},"responses":{"200":{"description":"note_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/Note"}}},"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/notes/{id}":{"delete":{"tags":["Notes"],"summary":"note_delete_by_id_summary","description":"note_delete_by_id_description","operationId":"note_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"note_delete_by_id_success_description"},"default":{"description":"400 - Bad Request
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/notes/{elementType}/{id}":{"get":{"tags":["Notes"],"summary":"note_element_get_collection_summary","description":"note_element_get_collection_description","operationId":"note_element_get_collection","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":50}},{"name":"sortBy","in":"query","description":"Sort by field. Only works in combination with sortOrder.","required":false,"schema":{"type":"string","enum":["id","type","cId","cType","cPath","date","title","description","locked"],"example":"id"}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"filter","in":"query","description":"Filter for notes","required":false,"schema":{"type":"string","example":"notes"}},{"name":"fieldFilters","in":"query","description":"Filter for specific fields, will be json decoded to an array. e.g.\n [{\"operator\":\"like\",\"value\":\"John\",\"field\":\"name\",\"type\":\"string\"}]","required":false,"schema":{"type":"string","example":"[{\"operator\":\"like\",\"value\":\"John\",\"field\":\"name\", \"type\":\"string\"}]"}}],"responses":{"200":{"description":"note_element_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/Note"}}},"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"}]}}}}}},"post":{"tags":["Notes"],"summary":"note_element_create_summary","description":"note_element_create_description","operationId":"note_element_create","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNote"}}}},"responses":{"200":{"description":"note_element_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"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/notes/type/{elementType}":{"get":{"tags":["Notes"],"summary":"note_element_get_type_collection_summary","description":"note_element_get_type_collection_description","operationId":"note_element_get_type_collection","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"note_element_get_type_collection_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NoteType"}}},"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/notifications":{"post":{"tags":["Notifications"],"summary":"notification_get_collection_summary","description":"notification_get_collection_description","operationId":"notification_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"key\":\"creationDate\", \"type\":\"date\", \"filterValue\":{\"operator\": \"on\", \"value\": \"08/20/2024\"}},{\"key\":\"title\", \"type\":\"like\", \"filterValue\": \"notification\"},{\"key\":\"type\", \"type\":\"equals\", \"filterValue\": \"info\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"creationDate\", \"direction\":\"DESC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"notification_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/NotificationListItem"}}},"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"}]}}}}}},"delete":{"tags":["Notifications"],"summary":"notification_delete_all_summary","description":"notification_delete_all_description","operationId":"notification_delete_all","responses":{"200":{"description":"notification_delete_all_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/notifications/{id}":{"get":{"tags":["Notifications"],"summary":"notification_get_by_id_summary","description":"notification_get_by_id_description","operationId":"notification_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"notification_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}},"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"}]}}}}}},"post":{"tags":["Notifications"],"summary":"notification_read_by_id_summary","description":"notification_read_by_id_description","operationId":"notification_read_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"notification_read_by_id_success_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"}]}}}}}},"delete":{"tags":["Notifications"],"summary":"notification_delete_by_id_summary","description":"notification_delete_by_id_description","operationId":"notification_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the notification","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"notification_delete_by_id_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/notifications/unread-count":{"get":{"tags":["Notifications"],"summary":"notification_get_unread_count_summary","description":"notification_get_unread_count_description","operationId":"notification_get_unread_count","responses":{"200":{"description":"notification_get_unread_count_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCount"}}}},"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/notifications/recipients":{"get":{"tags":["Notifications"],"summary":"notification_get_recipients_summary","description":"notification_get_recipients_description","operationId":"notification_get_recipients","responses":{"200":{"description":"notification_get_recipients_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/Recipient"}}},"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/notifications/send":{"post":{"tags":["Notifications"],"summary":"notification_send_summary","description":"notification_send_description","operationId":"notification_send","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationParameters"}}}},"responses":{"200":{"description":"notification_send_success_response"},"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/perspectives/configuration":{"post":{"tags":["Perspectives"],"summary":"perspective_create_summary","description":"perspective_create_description","operationId":"perspective_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPerspectiveConfig"}}}},"responses":{"200":{"description":"perspective_create_success_response"},"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/perspectives/configurations":{"get":{"tags":["Perspectives"],"summary":"perspective_get_config_collection_summary","description":"perspective_get_config_collection_description","operationId":"perspective_get_config_collection","responses":{"200":{"description":"perspective_get_config_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/PerspectiveConfig"}}},"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/perspectives/configuration/{perspectiveId}":{"get":{"tags":["Perspectives"],"summary":"perspective_get_config_by_id_summary","description":"perspective_get_config_by_id_description","operationId":"perspective_get_config_by_id","parameters":[{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"studio_default_perspective"}}],"responses":{"200":{"description":"perspective_get_config_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspectiveConfigDetail"}}}},"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"}]}}}}}},"put":{"tags":["Perspectives"],"summary":"perspective_update_config_by_id_summary","description":"perspective_update_config_by_id_description","operationId":"perspective_update_config_by_id","parameters":[{"name":"perspectiveId","in":"path","description":"Update perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavePerspectiveConfig"}}}},"responses":{"200":{"description":"perspective_update_config_by_id_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"}]}}}}}},"delete":{"tags":["Perspectives"],"summary":"perspective_delete_summary","description":"perspective_delete_description","operationId":"perspective_delete","parameters":[{"name":"perspectiveId","in":"path","description":"Get perspective by matching Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"perspective_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/perspectives/widgets/{widgetType}/configuration":{"post":{"tags":["Perspectives"],"summary":"perspective_widget_create_summary","description":"perspective_widget_create_description","operationId":"perspective_widget_create","parameters":[{"name":"widgetType","in":"path","description":"Create widget by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"perspective_widget_create_success_response"},"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/perspectives/widgets/configurations":{"get":{"tags":["Perspectives"],"summary":"perspective_widget_get_config_collection_summary","description":"perspective_widget_get_config_collection_description","operationId":"perspective_widget_get_config_collection","parameters":[{"name":"skipWrapperWidgets","in":"query","description":"Skip wrapper widget configurations","required":false,"schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"perspective_widget_get_config_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/WidgetConfig"}}},"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/perspectives/widgets/{widgetType}/configuration/{widgetId}":{"get":{"tags":["Perspectives"],"summary":"perspective_widget_get_config_by_id_summary","description":"perspective_widget_get_config_by_id_description","operationId":"perspective_widget_get_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"responses":{"200":{"description":"perspective_widget_get_config_by_id_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Data of the widget configuration","type":"string","example":"Test content"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}},"put":{"tags":["Perspectives"],"summary":"perspective_widget_update_config_by_id_summary","description":"perspective_widget_update_config_by_id_description","operationId":"perspective_widget_update_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Update widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Update widget by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"perspective_widget_update_config_by_id_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"}]}}}}}},"delete":{"tags":["Perspectives"],"summary":"perspective_widget_delete_summary","description":"perspective_widget_delete_description","operationId":"perspective_widget_delete","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"element_tree"}}],"responses":{"200":{"description":"perspective_widget_delete_success_response"},"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/perspectives/widgets/types":{"get":{"tags":["Perspectives"],"summary":"perspective_widget_get_type_collection_summary","description":"perspective_widget_get_type_collection_description","operationId":"perspective_widget_get_type_collection","responses":{"200":{"description":"perspective_widget_get_type_collection_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WidgetType"}}},"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/properties":{"get":{"tags":["Properties"],"summary":"property_get_collection_summary","description":"property_get_collection_description","operationId":"property_get_collection","parameters":[{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":false,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":"properties"}}],"responses":{"200":{"description":"property_get_collection_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PredefinedProperty"}}},"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/property":{"post":{"tags":["Properties"],"summary":"property_create_summary","description":"property_create_description","operationId":"property_create","responses":{"200":{"description":"property_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedProperty"}}}},"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/properties/{id}":{"put":{"tags":["Properties"],"summary":"property_update_summary","description":"property_update_description","operationId":"property_update","parameters":[{"name":"id","in":"path","description":"Id of the property","required":true,"schema":{"type":"string","example":"alpha-numerical"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePredefinedProperty"}}}},"responses":{"200":{"description":"property_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedProperty"}}}},"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":["Properties"],"summary":"property_delete_summary","description":"property_delete_description","operationId":"property_delete","parameters":[{"name":"id","in":"path","description":"Id of the property","required":true,"schema":{"type":"string","example":"alpha-numerical"}}],"responses":{"200":{"description":"property_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/properties/{elementType}/{id}":{"get":{"tags":["Properties"],"summary":"property_get_collection_for_element_by_type_and_id_summary","description":"property_get_collection_for_element_by_type_and_id_description","operationId":"property_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"property_get_collection_for_element_by_type_and_id_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ElementProperty"}}},"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/recycle-bin/items":{"post":{"tags":["Recycle Bin"],"summary":"recycle_bin_get_collection_summary","description":"recycle_bin_get_collection_description","operationId":"recycle_bin_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"key\":\"date\", \"type\":\"date\", \"filterValue\":{\"operator\": \"on\", \"value\": \"08/20/2024\"}},{\"key\":\"path\", \"type\":\"like\", \"filterValue\": \"/path/to/element\"},{\"key\":\"type\", \"type\":\"equals\", \"filterValue\": \"asset\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"date\", \"direction\":\"DESC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"recycle_bin_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/RecycleBin"}}},"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/recycle-bin/delete":{"delete":{"tags":["Recycle Bin"],"summary":"recycle_bin_delete_items_summary","description":"recycle_bin_delete_items_description","operationId":"recycle_bin_delete_items","requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"recycle_bin_delete_items_success_response"},"201":{"description":"recycle_bin_delete_items_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
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/recycle-bin/flush":{"delete":{"tags":["Recycle Bin"],"summary":"recycle_bin_flush_summary","description":"recycle_bin_flush_description","operationId":"recycle_bin_flush","responses":{"200":{"description":"recycle_bin_flush_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/recycle-bin/restore":{"post":{"tags":["Recycle Bin"],"summary":"recycle_bin_restore_items_summary","description":"recycle_bin_restore_items_description","operationId":"recycle_bin_restore_items","requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"recycle_bin_restore_items_success_response"},"201":{"description":"recycle_bin_restore_items_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
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/role/clone/{id}":{"post":{"tags":["Role Management"],"summary":"role_clone_by_id_summary","operationId":"role_clone_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","example":"Cloned Role"}},"type":"object"}}}},"responses":{"200":{"description":"role_clone_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/role/folder":{"post":{"tags":["Role Management"],"summary":"role_folder_create_summary","operationId":"role_folder_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"role_folder_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/role":{"post":{"tags":["Role Management"],"summary":"role_create_summary","operationId":"role_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"role_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/role/folder/{id}":{"delete":{"tags":["Role Management"],"summary":"role_folder_delete_by_id_summary","operationId":"role_folder_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the folder","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/role/{id}":{"get":{"tags":["Role Management"],"summary":"role_get_by_id_summary","operationId":"role_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"role_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedRole"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}},"put":{"tags":["Role Management"],"summary":"role_update_by_id_summary","operationId":"role_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the Role","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRole"}}}},"responses":{"200":{"description":"role_update_by_id_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedRole"}}}},"default":{"description":"400 - Bad Request
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":["Role Management"],"summary":"role_delete_by_id_summary","operationId":"role_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the role","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/roles":{"get":{"tags":["Role Management"],"summary":"role_get_collection_summary","description":"role_get_collection_description","operationId":"role_get_collection","responses":{"200":{"description":"role_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/SimpleRole"}}},"type":"object"}}}},"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/roles/with-permission":{"get":{"tags":["Role Management"],"summary":"role_list_with_permission_summary","description":"role_list_with_permission_description","operationId":"role_list_with_permission","parameters":[{"name":"permission","in":"query","description":"List roles with this permission","required":true,"schema":{"type":"string","example":"assets"}}],"responses":{"200":{"description":"role_list_with_permission_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/SimpleRole"}}},"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/roles/tree":{"get":{"tags":["Role Management"],"summary":"role_get_tree_summary","operationId":"role_get_tree","parameters":[{"name":"parentId","in":"query","description":"Filter roles by parent id.","required":true,"schema":{"type":"integer","minimum":0,"example":0}}],"responses":{"200":{"description":"role_get_tree_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/TreeNode"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/role/search":{"get":{"tags":["Role Management"],"summary":"role_search_summary","description":"role_search_description","operationId":"role_search","parameters":[{"name":"searchQuery","in":"query","description":"Query to search for a role. This can be a part of role name or ID.","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"role_search_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/SimpleRole"}}},"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/schedules/{id}":{"delete":{"tags":["Schedule"],"summary":"schedule_delete_by_id_summary","description":"schedule_delete_by_id_description","operationId":"schedule_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the schedule","required":true,"schema":{"type":"integer","example":123}}],"responses":{"200":{"description":"schedule_delete_by_id_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/schedules/{elementType}/{id}":{"get":{"tags":["Schedule"],"summary":"schedule_get_collection_for_element_by_type_and_id_summary","description":"schedule_get_collection_for_element_by_type_and_id_description","operationId":"schedule_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"schedule_get_collection_for_element_by_type_and_id_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}},"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"}]}}}}}},"put":{"tags":["Schedule"],"summary":"schedule_update_for_element_by_type_and_id_summary","description":"schedule_update_for_element_by_type_and_id_description","operationId":"schedule_update_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSchedule"}}},"type":"object"}}}},"responses":{"200":{"description":"schedule_update_for_element_by_type_and_id_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}},"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"}]}}}}}},"post":{"tags":["Schedule"],"summary":"schedule_create_for_element_by_type_and_id_summary","description":"schedule_create_for_element_by_type_and_id_description","operationId":"schedule_create_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"schedule_create_for_element_by_type_and_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"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/search/configuration/assets":{"get":{"tags":["Search"],"summary":"asset_get_search_configuration_summary","description":"asset_get_search_configuration_description","operationId":"asset_get_search_configuration","responses":{"200":{"description":"asset_get_search_configuration_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedConfiguration"}}}},"default":{"description":"400 - Bad Request
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/search/assets":{"post":{"tags":["Search"],"summary":"asset_get_search_summary","description":"asset_get_search_description","operationId":"asset_get_search","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"asset_get_search_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/search/configuration/data-objects":{"get":{"tags":["Search"],"summary":"data_object_get_search_configuration_summary","description":"data_object_get_search_configuration_description","operationId":"data_object_get_search_configuration","parameters":[{"name":"classId","in":"query","description":"Class Id of the data object","required":false,"schema":{"type":"string","example":"EV"}}],"responses":{"200":{"description":"data_object_get_search_configuration_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/search/data-objects":{"post":{"tags":["Search"],"summary":"data_object_get_search_summary","description":"data_object_get_search_description","operationId":"data_object_get_search","parameters":[{"name":"classId","in":"query","description":"Class Id of the data object","required":false,"schema":{"type":"string","example":"EV"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"data_object_get_search_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/search/documents":{"post":{"tags":["Search"],"summary":"document_get_search_summary","description":"document_get_search_description","operationId":"document_get_search","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["columns"],"properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"filters":{"$ref":"#/components/schemas/Filter"}},"type":"object"}}}},"responses":{"200":{"description":"dcocument_get_search_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"required":["id","columns","isLocked","permissions"],"type":"array","items":{"properties":{"id":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnData"}},"isLocked":{"type":"boolean"},"permissions":{"$ref":"#/components/schemas/Permissions"}},"type":"object"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/search/preview/{elementType}/{id}":{"get":{"tags":["Search"],"summary":"simple_search_preview_get_summary","description":"simple_search_preview_get_description","operationId":"simple_search_preview_get","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"simple_search_preview_get_success_response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AssetSearchPreview"},{"$ref":"#/components/schemas/DataObjectSearchPreview"},{"$ref":"#/components/schemas/DocumentSearchPreview"}]}}}},"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/search":{"get":{"tags":["Search"],"summary":"simple_search_get_summary","description":"simple_search_get_description","operationId":"simple_search_get","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"searchTerm","in":"query","description":"simple_search_get_search_term_parameter","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"simple_search_get_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/SimpleSearchResult"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/settings/admin":{"get":{"tags":["Settings Admin"],"summary":"admin_settings_get_summary","description":"admin_settings_get_description","operationId":"admin_settings_get","responses":{"200":{"description":"admin_settings_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSettings"}}}},"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/settings/admin/save":{"post":{"tags":["Settings Admin"],"summary":"admin_settings_update_summary","description":"admin_settings_update_description","operationId":"admin_settings_update","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminSettings"}}}},"responses":{"200":{"description":"admin_settings_update_success_response"},"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/setting/admin/thumbnail":{"get":{"tags":["Settings Admin"],"summary":"setting_admin_thumbnail_summary","operationId":"setting_admin_thumbnail","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSettingsThumbnailPath"}}}},"default":{"description":"400 - Bad Request
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
429 - Too Many Requests","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/settings/available-countries":{"get":{"tags":["Settings"],"summary":"settings_country_collection_summary","description":"settings_country_collection_description","operationId":"settings_country_collection","responses":{"200":{"description":"settings_country_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/AvailableCountry"}}},"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/settings":{"get":{"tags":["Settings"],"summary":"system_settings_get_summary","description":"system_settings_get_description","operationId":"system_settings_get","responses":{"200":{"description":"system_settings_get_success_response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"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"}]}}}}}},"put":{"tags":["Settings"],"summary":"settings_update_summary","description":"settings_update_description","operationId":"settings_update","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"general":{"properties":{"valid_languages":{"description":"Valid language codes (ISO 639-1)","type":"array","items":{"type":"string"},"example":["en","de","fr"]},"fallback_languages":{"description":"Language fallback mapping (e.g., {\"de\": \"en\", \"fr\": \"en\"})","type":"object","example":{"de":"en","fr":"en"}},"required_languages":{"description":"Required language codes (ISO 639-1)","type":"array","items":{"type":"string"},"example":["en"]},"default_language":{"description":"Default system language","type":"string","example":"en"},"domain":{"description":"Main domain for the system","type":"string","example":""},"redirect_to_maindomain":{"description":"Redirect to main domain","type":"boolean","example":false},"debug_admin_translations":{"description":"Enable translation debugging","type":"boolean","example":false}},"type":"object"},"objects":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep object versions","type":"integer"},"steps":{"description":"Number of version steps to keep for objects","type":"integer","example":10}},"type":"object"}},"type":"object"},"assets":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep asset versions","type":"integer"},"steps":{"description":"Number of version steps to keep for assets","type":"integer","example":10}},"type":"object"}},"type":"object"},"documents":{"properties":{"versions":{"properties":{"days":{"description":"Number of days to keep document versions","type":"integer"},"steps":{"description":"Number of version steps to keep for documents","type":"integer","example":10}},"type":"object"},"error_pages":{"properties":{"default":{"description":"Default error page","type":"string","example":""},"localized":{"description":"Localized error page IDs (e.g., {\"en\": \"1\", \"de\": \"2\"})","type":"object","example":{"en":"","de":""}}},"type":"object"}},"type":"object"},"email":{"properties":{"debug":{"properties":{"email_addresses":{"description":"Debug email addresses","type":"array","items":{"type":"string"},"example":["debug@example.com"]}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Updated system settings"},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/settings/adapter/image":{"get":{"tags":["Settings"],"summary":"settings_image_adapter_check_summary","description":"settings_image_adapter_check_description","operationId":"settings_image_adapter_check","responses":{"200":{"description":"settings_image_adapter_check_success_response"},"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/settings/active-bundles":{"get":{"tags":["Settings"],"summary":"active_bundles_get_summary","description":"active_bundles_get_description","operationId":"active_bundles_get","responses":{"200":{"description":"active_bundles_get_success_response","content":{"application/json":{"schema":{"required":["bundles"],"properties":{"bundles":{"title":"Active Bundles","description":"List of active and installed bundles in the system.","type":"array","items":{"$ref":"#/components/schemas/ActiveBundle"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/settings/ping":{"get":{"tags":["Settings"],"summary":"ping_action_summary","description":"ping_action_description","operationId":"ping_action","responses":{"200":{"description":"ping_action_success_response"},"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"}]}}}}}}},"/settings/adapter/video":{"get":{"tags":["Settings"],"summary":"settings_video_adapter_check_summary","description":"settings_video_adapter_check_description","operationId":"settings_video_adapter_check","responses":{"200":{"description":"settings_video_adapter_check_success_response"},"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/tags":{"get":{"tags":["Tags"],"summary":"tag_get_collection_summary","description":"tag_get_collection_description","operationId":"tag_get_collection","parameters":[{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}},{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":false,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"filter","in":"query","description":"Filter for properties","required":false,"schema":{"type":"string","example":"properties"}},{"name":"parentId","in":"query","description":"Filter tags by parent id.","required":false,"schema":{"type":"integer","minimum":0,"example":1}}],"responses":{"200":{"description":"tag_get_collection_success_response","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"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/tag":{"post":{"tags":["Tags"],"summary":"tag_create_summary","description":"tag_create_description","operationId":"tag_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagParameters"}}}},"responses":{"200":{"description":"tag_create_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"default":{"description":"400 - Bad Request
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/tags/{id}":{"get":{"tags":["Tags"],"summary":"tag_get_by_id_summary","description":"tag_get_by_id_description","operationId":"tag_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"tag_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"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":["Tags"],"summary":"tag_update_by_id_summary","description":"tag_update_by_id_description","operationId":"tag_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagParameters"}}}},"responses":{"200":{"description":"tag_update_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"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":["Tags"],"summary":"tag_delete_by_id_summary","description":"tag_delete_by_id_description","operationId":"tag_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the tag","required":true,"schema":{"type":"integer","example":10}}],"responses":{"200":{"description":"tag_delete_by_id_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of deleted tag","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/tags/assign/{elementType}/{id}/{tagId}":{"post":{"tags":["Tags for Element"],"summary":"tag_assign_to_element_summary","description":"tag_assign_to_element_description","operationId":"tag_assign_to_element","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"tagId","in":"path","description":"TagId of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"default":{"description":"400 - Bad Request
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/tags/batch/{operation}/{elementType}/{id}":{"post":{"tags":["Tags for Element"],"summary":"tag_batch_operation_to_elements_by_type_and_id_summary","description":"tag_batch_operation_to_elements_by_type_and_id_description","operationId":"tag_batch_operation_to_elements_by_type_and_id","parameters":[{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"operation","in":"path","description":"Execute operation based on provided type.","required":true,"schema":{"type":"string","enum":["assign","replace"],"example":"assign"}}],"responses":{"201":{"description":"tag_batch_operation_to_elements_by_type_and_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
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/tags/{elementType}/{id}":{"get":{"tags":["Tags for Element"],"summary":"tag_get_collection_for_element_by_type_and_id_summary","description":"tag_get_collection_for_element_by_type_and_id_description","operationId":"tag_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"tag_get_collection_for_element_by_type_and_id_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/Tag"}}},"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/tags/{elementType}/{id}/{tagId}":{"delete":{"tags":["Tags for Element"],"summary":"tag_unassign_from_element_summary","description":"tag_unassign_from_element_description","operationId":"tag_unassign_from_element","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"tagId","in":"path","description":"TagId of the tag","required":true,"schema":{"type":"integer","example":83}}],"responses":{"default":{"description":"400 - Bad Request
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/thumbnails/image":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_image_get_collection_summary","description":"thumbnail_image_get_collection_description","operationId":"thumbnail_image_get_collection","responses":{"200":{"description":"thumbnail_image_get_collection_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Thumbnail"}}},"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/thumbnails/image/config":{"post":{"tags":["Asset Thumbnails"],"summary":"thumbnail_image_create_summary","description":"thumbnail_image_create_description","operationId":"thumbnail_image_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailConfig"}}}},"responses":{"200":{"description":"thumbnail_image_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageThumbnailConfigDetail"}}}},"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/thumbnails/image/config/{name}":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_image_get_by_name_summary","description":"thumbnail_image_get_by_name_description","operationId":"thumbnail_image_get_by_name","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"thumbnail_image_get_by_name_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageThumbnailConfigDetail"}}}},"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":["Asset Thumbnails"],"summary":"thumbnail_image_update_summary","description":"thumbnail_image_update_description","operationId":"thumbnail_image_update","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThumbnailConfig"}}}},"responses":{"200":{"description":"thumbnail_image_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageThumbnailConfigDetail"}}}},"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":["Asset Thumbnails"],"summary":"thumbnail_image_delete_summary","description":"thumbnail_image_delete_description","operationId":"thumbnail_image_delete","parameters":[{"name":"name","in":"path","description":"Image thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"thumbnail_image_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/thumbnails/image/tree":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_image_get_tree_summary","description":"thumbnail_image_get_tree_description","operationId":"thumbnail_image_get_tree","responses":{"200":{"description":"thumbnail_image_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ThumbnailConfigurationData"},{"$ref":"#/components/schemas/ThumbnailConfigurationFolderData"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/thumbnails/video":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_video_get_collection_summary","description":"thumbnail_video_get_collection_description","operationId":"thumbnail_video_get_collection","responses":{"200":{"description":"thumbnail_video_get_collection_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Thumbnail"}}},"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/thumbnails/video/config":{"post":{"tags":["Asset Thumbnails"],"summary":"thumbnail_video_create_summary","description":"thumbnail_video_create_description","operationId":"thumbnail_video_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThumbnailConfig"}}}},"responses":{"200":{"description":"thumbnail_video_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoThumbnailConfigDetail"}}}},"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/thumbnails/video/config/{name}":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_video_get_by_name_summary","description":"thumbnail_video_get_by_name_description","operationId":"thumbnail_video_get_by_name","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"thumbnail_video_get_by_name_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoThumbnailConfigDetail"}}}},"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":["Asset Thumbnails"],"summary":"thumbnail_video_update_summary","description":"thumbnail_video_update_description","operationId":"thumbnail_video_update","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThumbnailConfig"}}}},"responses":{"200":{"description":"thumbnail_video_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoThumbnailConfigDetail"}}}},"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":["Asset Thumbnails"],"summary":"thumbnail_video_delete_summary","description":"thumbnail_video_delete_description","operationId":"thumbnail_video_delete","parameters":[{"name":"name","in":"path","description":"Video thumbnail configuration name","required":true,"schema":{"type":"string","example":"content"}}],"responses":{"200":{"description":"thumbnail_video_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/thumbnails/video/tree":{"get":{"tags":["Asset Thumbnails"],"summary":"thumbnail_video_get_tree_summary","description":"thumbnail_video_get_tree_description","operationId":"thumbnail_video_get_tree","responses":{"200":{"description":"thumbnail_video_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ThumbnailConfigurationData"},{"$ref":"#/components/schemas/ThumbnailConfigurationFolderData"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/translations/available-locales":{"get":{"tags":["Translation"],"summary":"translation_get_available_locales_summary","description":"translation_get_available_locales_description","operationId":"translation_get_available_locales","responses":{"200":{"description":"translation_get_available_locales_success_response","content":{"application/json":{"schema":{"type":"array","items":{"required":["local","displayName"],"properties":{"locale":{"title":"locale","description":"Locale code.","type":"string","example":"de_de"},"displayName":{"title":"Display Name","description":"The display name of the locale.","type":"string","example":"Deutsch (Deutschland)"}},"type":"object"}}}}},"default":{"description":"400 - Bad Request
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/translations/{domain}/cleanup":{"delete":{"tags":["Translation"],"summary":"translation_cleanup_by_domain_summary","description":"translation_cleanup_by_domain_description","operationId":"translation_cleanup_by_domain","parameters":[{"name":"domain","in":"path","description":"Domain of the translation, to be cleaned up","required":true,"schema":{"type":"string","example":"admin"}}],"responses":{"200":{"description":"translation_cleanup_by_domain_success_description"},"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/translations/create":{"post":{"tags":["Translation"],"summary":"translation_create_summary","description":"translation_create_description","operationId":"translation_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTranslation"}}}},"responses":{"200":{"description":"translation_create_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/translations/csv-settings":{"post":{"tags":["Translation"],"summary":"translation_determine_csv_settings_for_import_summary","description":"translation_determine_csv_settings_for_import_description","operationId":"translation_determine_csv_settings_for_import","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["sample"],"properties":{"sample":{"description":"Sample CSV content (first few lines)","type":"string","example":"name,value\\n\"John Doe\",123\\n\"Jane Smith\",456"}},"type":"object"}}}},"responses":{"200":{"description":"translation_determine_csv_settings_for_import_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvSettings"}}}},"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/translations/{key}":{"delete":{"tags":["Translation"],"summary":"translation_delete_by_key_summary","description":"translation_delete_by_key_description","operationId":"translation_delete_by_key","parameters":[{"name":"key","in":"path","description":"Delete translations by matching key","required":true,"schema":{"type":"string","example":"some_key"}},{"name":"domain","in":"query","description":"Domain of the translation, defaults to \"studio\"","required":false,"schema":{"type":"string","example":"studio"}}],"responses":{"200":{"description":"translation_delete_by_key_success_description"},"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/translations/domains":{"get":{"tags":["Translation"],"summary":"translation_get_domains_summary","description":"translation_get_domains_description","operationId":"translation_get_domains","responses":{"200":{"description":"translation_get_domains_success_response","content":{"application/json":{"schema":{"type":"array","items":{"required":["domain","isFrontendDomain"],"properties":{"domain":{"title":"Domain","description":"The domain name.","type":"string","example":"admin"},"isFrontendDomain":{"title":"Is Frontend Domain","description":"If the domain is a frontend or admin domain.","type":"boolean","example":false}},"type":"object"}}}}},"default":{"description":"400 - Bad Request
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/translations/export":{"post":{"tags":["Translation"],"summary":"translation_export_list_summary","description":"translation_export_list_description","operationId":"translation_export_list","parameters":[{"name":"domain","in":"query","description":"Domain to filter translations by","required":false,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"columnFilters":{"type":"object","example":"[{\"key\":\"de\", \"type\":\"translationLike\", \"filterValue\": \"%car%\"},{\"type\":\"search\", \"filterValue\": \"search term\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"key\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"translation_export_list_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"studio_translations.csv\""}}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/translations/{domain}/import":{"post":{"tags":["Translation"],"summary":"translation_import_csv_summary","description":"translation_import_csv_description","operationId":"translation_import_csv","parameters":[{"name":"domain","in":"path","description":"Domain of the translation for import","required":true,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file","csvSettings"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"},"csvSettings":{"description":"Settings for CSV import","properties":{"delimiter":{"type":"string","example":";"},"quoteChar":{"type":"string","example":"\""},"escapeChar":{"type":"string","example":"\\"},"lineTerminator":{"type":"string","example":""}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"translation_import_csv_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeltaItem"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/translations/list":{"post":{"tags":["Translation"],"summary":"translation_get_list_summary","description":"translation_get_list_description","operationId":"translation_get_list","parameters":[{"name":"domain","in":"query","description":"Domain to filter translations by","required":false,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"key\":\"de\", \"type\":\"translationLike\", \"filterValue\": \"%car%\"},{\"type\":\"search\", \"filterValue\": \"search term\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"de\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"translation_get_list_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/Translations"}}},"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/translations":{"post":{"tags":["Translation"],"summary":"translation_get_collection_summary","description":"translation_get_collection_description","operationId":"translation_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Translation"}}}},"responses":{"200":{"description":"translation_get_collection_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Translation"}}}},"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/translations/{domain}":{"put":{"tags":["Translation"],"summary":"translation_update_summary","description":"translation_update_description","operationId":"translation_update","parameters":[{"name":"domain","in":"path","description":"Domain of the translation, to be updated","required":true,"schema":{"type":"string","example":"studio"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTranslation"}}},"type":"object"}}}},"responses":{"200":{"description":"translation_update_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/unit/quantity-value/units/collection":{"post":{"tags":["Units"],"summary":"unit_quantity_value_units_collection_summary","description":"unit_quantity_value_units_collection_description","operationId":"unit_quantity_value_units_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\":\"name\",\"type\":\"metadata.object\",\"filterValue\":1}]"},"sortFilter":{"type":"object","example":"{\"key\":\"id\",\"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"unit_quantity_value_units_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/QuantityValueUnit"}}},"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/unit/quantity-value/convert-all":{"get":{"tags":["Units"],"summary":"unit_quantity_value_convert_all_summary","description":"unit_quantity_value_convert_all_description","operationId":"unit_quantity_value_convert_all","parameters":[{"name":"fromUnitId","in":"query","description":"Id of the unit to convert from","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"type":"number","format":"number","example":3.14},"example":5}],"responses":{"200":{"description":"unit_quantity_value_convert_all_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertedQuantityValues"}}}},"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/unit/quantity-value/convert":{"get":{"tags":["Units"],"summary":"unit_quantity_value_convert_summary","description":"unit_quantity_value_convert_description","operationId":"unit_quantity_value_convert","parameters":[{"name":"fromUnitId","in":"query","description":"Id of the unit to convert from","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"toUnitId","in":"query","description":"Id of the unit to convert to","required":true,"schema":{"type":"string","example":"Example string"}},{"name":"value","in":"query","description":"Value to convert.","required":true,"schema":{"type":"number","format":"number","example":3.14},"example":5}],"responses":{"200":{"description":"unit_quantity_value_convert_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Converted value","example":2,"anyOf":[{"type":"number"},{"type":"integer"}]}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/unit/quantity-value/units":{"post":{"tags":["Units"],"summary":"unit_quantity_value_units_create_summary","description":"unit_quantity_value_units_create_description","operationId":"unit_quantity_value_units_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUnitParameters"}}}},"responses":{"200":{"description":"unit_quantity_value_units_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuantityValueUnit"}}}},"default":{"description":"400 - Bad Request
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/unit/quantity-value/units/{id}":{"put":{"tags":["Units"],"summary":"unit_quantity_value_units_update_summary","description":"unit_quantity_value_units_update_description","operationId":"unit_quantity_value_units_update","parameters":[{"name":"id","in":"path","description":"unit_quantity_value_units_update_param_id","required":true,"schema":{"type":"string","example":"mm"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUnitParameters"}}}},"responses":{"200":{"description":"unit_quantity_value_units_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuantityValueUnit"}}}},"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":["Units"],"summary":"unit_quantity_value_units_delete_summary","description":"unit_quantity_value_units_delete_description","operationId":"unit_quantity_value_units_delete","parameters":[{"name":"id","in":"path","description":"unit_quantity_value_units_delete_param_id","required":true,"schema":{"type":"string","example":"mm"}}],"responses":{"200":{"description":"unit_quantity_value_units_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/unit/quantity-value/units/export":{"get":{"tags":["Units"],"summary":"unit_quantity_value_units_export_summary","description":"unit_quantity_value_units_export_description","operationId":"unit_quantity_value_units_export","responses":{"200":{"description":"unit_quantity_value_units_export_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"quantityvalue_unit_export.json\""}}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"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/unit/quantity-value/units/import":{"post":{"tags":["Units"],"summary":"unit_quantity_value_units_import_summary","description":"unit_quantity_value_units_import_description","operationId":"unit_quantity_value_units_import","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"JSON file containing quantity value unit definitions","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"unit_quantity_value_units_import_success_response"},"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/unit/quantity-value/unit-list":{"get":{"tags":["Units"],"summary":"unit_quantity_value_list_summary","description":"unit_quantity_value_list_description","operationId":"unit_quantity_value_list","responses":{"200":{"description":"unit_quantity_value_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/QuantityValueUnit"}}},"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/user/clone/{id}":{"post":{"tags":["User Management"],"summary":"user_clone_by_id_summary","operationId":"user_clone_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","example":"Cloned User"}},"type":"object"}}}},"responses":{"200":{"description":"user_clone_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/user/":{"post":{"tags":["User Management"],"summary":"user_create_summary","operationId":"user_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"user_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/user/folder":{"post":{"tags":["User Management"],"summary":"user_folder_create_summary","operationId":"user_folder_create","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["parentId","name"],"properties":{"parentId":{"type":["integer","null"],"minimum":1},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"user_folder_create_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeNode"}}}},"default":{"description":"400 - Bad Request
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/user/current-user-information":{"get":{"tags":["User Management"],"summary":"user_get_current_information_summary","operationId":"user_get_current_information","responses":{"200":{"description":"user_get_current_information_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInformation"}}}},"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/user/{id}":{"get":{"tags":["User Management"],"summary":"user_get_by_id_summary","operationId":"user_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"user_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"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"}]}}}}}},"put":{"tags":["User Management"],"summary":"user_update_by_id_summary","operationId":"user_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"}}}},"responses":{"200":{"description":"user_update_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}},"delete":{"tags":["User Management"],"summary":"user_delete_by_id_summary","operationId":"user_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/user/folder/{id}":{"delete":{"tags":["User Management"],"summary":"user_folder_delete_by_id_summary","operationId":"user_folder_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user-folder","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/user/image/{id}":{"get":{"tags":["User Management"],"summary":"user_get_image_summary","operationId":"user_get_image","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"user_get_image_success_response","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"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"}]}}}}}},"delete":{"tags":["User Management"],"summary":"user_image_delete_by_id_summary","description":"user_image_delete_by_id_description","operationId":"user_image_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"user_image_delete_by_id_success_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/users/default-key-bindings":{"get":{"tags":["User Management"],"summary":"user_default_key_bindings_summary","description":"user_default_key_bindings_description","operationId":"user_default_key_bindings","responses":{"200":{"description":"user_default_key_bindings_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/KeyBinding"}}},"type":"object"}}}},"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/user/available-permissions":{"get":{"tags":["User Management"],"summary":"user_get_available_permissions_summary","operationId":"user_get_available_permissions","responses":{"200":{"description":"user_get_available_permissions_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/UserPermission"}}},"type":"object"}}}},"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/users":{"get":{"tags":["User Management"],"summary":"user_get_collection_summary","description":"user_get_collection_description","operationId":"user_get_collection","responses":{"200":{"description":"user_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/SimpleUser"}}},"type":"object"}}}},"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/users/with-permission":{"get":{"tags":["User Management"],"summary":"user_list_with_permission_summary","description":"user_list_with_permission_description","operationId":"user_list_with_permission","parameters":[{"name":"permission","in":"query","description":"List users with this permission","required":true,"schema":{"type":"string","example":"assets"}},{"name":"includeCurrentUser","in":"query","description":"Include current user in the list","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":" user_list_with_permission_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/SimpleUser"}}},"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/user/reset-password":{"post":{"tags":["User Management"],"summary":"user_reset_password_summary","operationId":"user_reset_password","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPassword"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
405 - Method Not Allowed
415 - Unsupported Media Type
422 - Unprocessable Content
429 - Too Many Requests","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/user/search":{"get":{"tags":["User Management"],"summary":"user_search_summary","description":"user_search_description","operationId":"pimcore_studio_api_user_search","parameters":[{"name":"searchQuery","in":"query","description":"Query to search for an user. This can be a part of username, firstname, lastname, email or ID.","required":false,"schema":{"type":"string","example":"Example string"}}],"responses":{"200":{"description":"user_search_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/SimpleUser"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/user/token-link/{id}":{"post":{"tags":["User Management"],"summary":"user_token_link_get_summary","description":"user_token_link_get_description","operationId":"user_token_link_get","parameters":[{"name":"id","in":"path","description":"Id of the user","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenLink"}}}},"responses":{"200":{"description":"user_token_link_get_success_response","content":{"application/json":{"schema":{"required":["link"],"properties":{"link":{"title":"Token link URL","description":"Token link URL including the generated token as parameter.","type":"string","example":"https://example.com/login?token=abcdef"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/user/active-perspective/{perspectiveId}":{"put":{"tags":["User Management"],"summary":"user_update_active_perspective_summary","operationId":"user_update_active_perspective","parameters":[{"name":"perspectiveId","in":"path","description":"Set active perspective by Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"user_update_active_perspective_success_response"},"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/user/{id}/password":{"put":{"tags":["User Management"],"summary":"user_update_password_by_id_summary","operationId":"user_update_password_by_id","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["password","passwordConfirmation"],"properties":{"password":{"type":"string"},"passwordConfirmation":{"type":"string"},"oldPassword":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/user/update-profile":{"put":{"tags":["User Management"],"summary":"user_update_profile_summary","description":"user_update_profile_description","operationId":"user_update_profile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserProfile"}}}},"responses":{"200":{"description":"user_update_profile_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInformation"}}}},"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/user/upload-image/{id}":{"post":{"tags":["User Management"],"summary":"user_upload_image_summary","operationId":"user_upload_image","parameters":[{"name":"id","in":"path","description":"Id of the User","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["userImage"],"properties":{"userImage":{"description":"User image to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Success"},"default":{"description":"400 - Bad Request
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/users/tree":{"get":{"tags":["User Management"],"summary":"user_get_tree_summary","operationId":"user_get_tree","parameters":[{"name":"parentId","in":"query","description":"Filter users by parent id.","required":true,"schema":{"type":"integer","minimum":0,"example":0}}],"responses":{"200":{"description":"user_get_tree_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/TreeNode"}}},"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/versions/{id}/asset/download":{"get":{"tags":["Versions"],"summary":"version_asset_download_by_id_summary","description":"version_asset_download_by_id_description","operationId":"version_asset_download_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_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/versions/{id}/image/stream":{"get":{"tags":["Versions"],"summary":"version_image_stream_by_id_summary","description":"version_image_stream_by_id_description","operationId":"version_image_stream_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_image_stream_by_id_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/versions/{id}/pdf/stream":{"get":{"tags":["Versions"],"summary":"version_pdf_stream_by_id_summary","description":"version_pdf_stream_by_id_description","operationId":"version_pdf_stream_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_pdf_stream_by_id_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
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/versions/{id}":{"get":{"tags":["Versions"],"summary":"version_get_by_id_summary","description":"version_get_by_id_description","operationId":"version_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_get_by_id_success_response","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AssetVersion"},{"$ref":"#/components/schemas/DataObjectVersion"},{"$ref":"#/components/schemas/DocumentVersion"}]}}}},"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"}]}}}}}},"put":{"tags":["Versions"],"summary":"version_update_by_id_summary","description":"version_update_by_id_description","operationId":"version_update_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVersion"}}}},"responses":{"200":{"description":"version_update_by_id_success_response"},"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"}]}}}}}},"post":{"tags":["Versions"],"summary":"version_publish_by_id_summary","description":"version_publish_by_id_description","operationId":"version_publish_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_publish_by_id_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"ID of published version","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}},"delete":{"tags":["Versions"],"summary":"version_delete_by_id_summary","description":"version_delete_by_id_description","operationId":"version_delete_by_id","parameters":[{"name":"id","in":"path","description":"Id of the version","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_delete_by_id_success_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/versions/{elementType}/{id}":{"get":{"tags":["Versions"],"summary":"version_get_collection_for_element_by_type_and_id_summary","description":"version_get_collection_for_element_by_type_and_id_description","operationId":"version_get_collection_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":10}}],"responses":{"200":{"description":"version_get_collection_for_element_by_type_and_id_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/Version"}}},"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"}]}}}}}},"delete":{"tags":["Versions"],"summary":"version_cleanup_for_element_by_type_and_id_summary","description":"version_cleanup_for_element_by_type_and_id_description","operationId":"version_cleanup_for_element_by_type_and_id","parameters":[{"name":"elementType","in":"path","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}},{"name":"id","in":"path","description":"Id of the ID of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"version_cleanup_for_element_by_type_and_id_success_response","content":{"application/json":{"schema":{"required":["ids"],"properties":{"ids":{"title":"IDs","description":"IDs of deleted versions","type":"array","items":{"type":"integer","example":420}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/website-settings/add":{"post":{"tags":["Website Settings"],"summary":"website_settings_add_summary","description":"website_settings_add_description","operationId":"website_settings_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteSettingsAdd"}}}},"responses":{"200":{"description":"website_settings_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteSetting"}}}},"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/website-settings":{"post":{"tags":["Website Settings"],"summary":"website_settings_get_collection_summary","description":"website_settings_get_collection_description","operationId":"website_settings_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"key\":\"creationDate\", \"type\":\"date\", \"filterValue\":{\"operator\": \"on\", \"value\": \"08/20/2024\"}},{\"key\":\"name\", \"type\":\"like\", \"filterValue\": \"SettingsName\"},{\"key\":\"type\", \"type\":\"equals\", \"filterValue\": \"text\"}]"},"sortFilter":{"type":"object","example":"{\"key\":\"name\", \"direction\":\"DESC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"website_settings_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/WebsiteSetting"}}},"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/website-settings/{id}":{"put":{"tags":["Website Settings"],"summary":"website_settings_update_summary","description":"website_settings_update_description","operationId":"website_settings_update","parameters":[{"name":"id","in":"path","description":"Id of the website setting","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteSettingsUpdate"}}}},"responses":{"200":{"description":"website_settings_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteSetting"}}}},"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":["Website Settings"],"summary":"website_settings_delete_summary","description":"website_settings_delete_description","operationId":"website_settings_delete","parameters":[{"name":"id","in":"path","description":"Id of the website setting","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"website_settings_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/website-settings/types":{"get":{"tags":["Website Settings"],"summary":"website_settings_list_types_summary","description":"website_settings_list_types_description","operationId":"website_settings_list_types","responses":{"200":{"description":"website_settings_list_types_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteSettingsType"}}},"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/workflows/details":{"get":{"tags":["Workflows"],"summary":"workflow_get_details_summary","description":"workflow_get_details_description","operationId":"workflow_get_details","parameters":[{"name":"elementId","in":"query","description":"ID of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"elementType","in":"query","description":"Filter elements by matching element type.","required":true,"schema":{"type":"string","enum":["asset","document","data-object"],"example":"data-object"}}],"responses":{"200":{"description":"workflow_get_details_success_response","content":{"application/json":{"schema":{"required":["items","layoutId"],"properties":{"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/WorkflowDetails"}},"layoutId":{"title":"layoutId","type":"string"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/workflows/action":{"post":{"tags":["Workflows"],"summary":"workflow_action_submit_summary","description":"workflow_action_submit_description","operationId":"workflow_action_submit","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitAction"}}}},"responses":{"200":{"description":"workflow_action_submit_success_response","content":{"application/json":{"schema":{"properties":{"workflowName":{"title":"workflowName","type":"string","example":"MyAwesomeWorkflow"},"actionName":{"title":"actionName","type":"string","example":"MyAwesomeAction"},"actionType":{"title":"actionType","type":"string","example":"transition"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/copilot/actions/automation/{name}/run":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_automation_run_summary","description":"bundle_copilot_actions_automation_run_description","operationId":"bundle_copilot_actions_automation_run","parameters":[{"name":"name","in":"path","description":"The name of the automation action configuration to run","required":true,"schema":{"type":"string","example":"CarVariantGenerator"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["context","environmentVariables"],"properties":{"context":{"description":"Context in which the action is run.","type":"string","example":"{\"subject\":{\"id\":81,\"type\":\"object\",\"subType\":\"object\"},\"selectedElements\":null,\"tags\":[\"object\",\"object_car\"]}"},"environmentVariables":{"description":"Json encoded key value pairs of environment variables to set for the action.","type":"string","example":"{\"Published\":false,\"Variants\":[{\"Color\":\"grey\",\"ProductionYear\":1987}]}"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_copilot_actions_automation_run_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCopilotJobRunId"}}}},"default":{"description":"201 - Created
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/copilot/actions/interaction/{name}/{interactionId}/apply":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_interaction_chat_apply_summary","description":"bundle_copilot_actions_interaction_chat_apply_description","operationId":"bundle_copilot_actions_interaction_chat_apply","parameters":[{"name":"name","in":"path","description":"The name of the interaction action configuration to run","required":true,"schema":{"type":"string","example":"OpenAITextGeneration"}},{"name":"interactionId","in":"path","description":"The id of the chat interaction","required":true,"schema":{"type":"integer","example":9875567}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["context","result"],"properties":{"context":{"description":"Context in which the action is run.","type":"string","example":"{\"subject\":{\"id\":81,\"type\":\"object\",\"subType\":\"object\"},\"selectedElements\":null,\"tags\":[\"object\",\"object_car\"]}"},"language":{"description":"The language of the field to be updated.","type":"string","default":"","example":"en"},"result":{"description":"The result that should be applied.","type":"string","example":"The Cobra is a masterpiece ... "}},"type":"object"}}}},"responses":{"200":{"description":"bundle_copilot_actions_interaction_chat_apply_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/copilot/actions/interaction/{name}/{interactionId}/initial":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_interaction_chat_initial_summary","description":"bundle_copilot_actions_interaction_chat_initial_description","operationId":"bundle_copilot_actions_interaction_chat_initial","parameters":[{"name":"name","in":"path","description":"The name of the interaction action configuration to run","required":true,"schema":{"type":"string","example":"OpenAITextGeneration"}},{"name":"interactionId","in":"path","description":"The id of the chat interaction","required":true,"schema":{"type":"integer","example":9875567}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["context"],"properties":{"context":{"description":"Context in which the action is run.","type":"string","example":"{\"subject\":{\"id\":81,\"type\":\"object\",\"subType\":\"object\"},\"selectedElements\":null,\"tags\":[\"object\",\"object_car\"]}"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_copilot_actions_interaction_chat_initial_success_response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BundleCopilotActionInteractionChatHistory"}}}}},"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/copilot/actions/interaction/{name}/{interactionId}/prompt":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_interaction_chat_prompt_summary","description":"bundle_copilot_actions_interaction_chat_prompt_description","operationId":"bundle_copilot_actions_interaction_chat_prompt","parameters":[{"name":"name","in":"path","description":"The name of the interaction action configuration to run","required":true,"schema":{"type":"string","example":"OpenAITextGeneration"}},{"name":"interactionId","in":"path","description":"The id of the chat interaction","required":true,"schema":{"type":"integer","example":9875567}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["context","prompt"],"properties":{"context":{"description":"Context in which the action is run.","type":"string","example":"{\"subject\":{\"id\":81,\"type\":\"object\",\"subType\":\"object\"},\"selectedElements\":null,\"tags\":[\"object\",\"object_car\"]}"},"prompt":{"description":"The prompt message from the user.","type":"string","example":"Please create a more compact description of the object than the one provided."}},"type":"object"}}}},"responses":{"200":{"description":"bundle_copilot_actions_interaction_chat_prompt_success_response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BundleCopilotActionInteractionChatHistory"}}}}},"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/copilot/actions/interaction/{name}/execute":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_interaction_one_step_summary","description":"bundle_copilot_actions_interaction_one_step_description","operationId":"bundle_copilot_actions_interaction_one_step","parameters":[{"name":"name","in":"path","description":"The name of the interaction action configuration to run","required":true,"schema":{"type":"string","example":"HFTranslationPrompt"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["context","result"],"properties":{"context":{"description":"Context in which the action is run.","type":"string","example":"{\"subject\":{\"id\":81,\"type\":\"object\",\"subType\":\"object\"},\"selectedElements\":null,\"tags\":[\"object\",\"object_car\"]}"},"inputContent":{"description":"The content passed to the action.","type":"string","example":"The Cobra is a masterpiece ... "}},"type":"object"}}}},"responses":{"200":{"description":"bundle_copilot_actions_interaction_one_step_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCopilotActionInteractionOneStep"}}}},"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/copilot/actions":{"get":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_actions_summary","description":"bundle_copilot_actions_description","operationId":"bundle_copilot_actions","responses":{"200":{"description":"bundle_copilot_actions_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/BundleCopilotAction"}}},"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/copilot/job-run/{id}/cancel":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_job_run_cancel_summary","description":"bundle_copilot_job_run_cancel_description","operationId":"bundle_copilot_job_run_cancel","parameters":[{"name":"id","in":"path","description":"Id of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_copilot_job_run_cancel_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/copilot/job-runs":{"get":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_job_runs_summary","description":"bundle_copilot_job_runs_description","operationId":"bundle_copilot_job_runs","parameters":[{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":50}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"sortBy","in":"query","description":"Sort by field.","required":false,"schema":{"type":"string","enum":["id","ownerId","state","currentstep","currentmessage","context","creationdate","modificationdate"],"example":null}}],"responses":{"200":{"description":"bundle_copilot_job_runs_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/BundleCopilotJobRun"}}},"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/copilot/job-runs/running":{"get":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_job_runs_running_summary","description":"bundle_copilot_job_runs_running_description","operationId":"bundle_copilot_job_runs_running","parameters":[{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":50}},{"name":"sortOrder","in":"query","description":"Sort order (asc or desc).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"example":"ASC"}},{"name":"sortBy","in":"query","description":"Sort by field.","required":false,"schema":{"type":"string","enum":["id","ownerId","state","currentstep","currentmessage","context","creationdate","modificationdate"],"example":null}}],"responses":{"200":{"description":"bundle_copilot_job_runs_running_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/BundleCopilotJobRun"}}},"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/copilot/job-run/{id}/progress":{"get":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_job_run_progress_summary","description":"bundle_copilot_job_run_progress_description","operationId":"bundle_copilot_job_run_progress","parameters":[{"name":"id","in":"path","description":"Id of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_copilot_job_run_progress_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCopilotJobRunProgress"}}}},"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/copilot/job-run/{id}/rerun":{"post":{"tags":["Bundle Copilot"],"summary":"bundle_copilot_job_run_rerun_summary","description":"bundle_copilot_job_run_rerun_description","operationId":"bundle_copilot_job_run_rerun","parameters":[{"name":"id","in":"path","description":"Id of the JobRun","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_copilot_job_run_rerun_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleCopilotJobRun"}}}},"default":{"description":"201 - Created
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/data-hub/config/add":{"post":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_add_summary","description":"bundle_data_hub_config_add_description","operationId":"bundle_data_hub_config_add","parameters":[{"name":"name","in":"query","description":"The name of the configuration","required":true,"schema":{"type":"string","example":"assets"}},{"name":"type","in":"query","description":"Type of the adapter","required":true,"schema":{"type":"string","example":"graphql"}},{"name":"path","in":"query","description":"Configuration path","required":false,"schema":{"type":"string","example":""}}],"responses":{"201":{"description":"bundle_data_hub_config_add_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/data-hub/config/clone":{"post":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_clone_summary","description":"bundle_data_hub_config_clone_description","operationId":"bundle_data_hub_config_clone","parameters":[{"name":"name","in":"query","description":"The name of the new configuration","required":true,"schema":{"type":"string","example":"assets_copy"}},{"name":"originalName","in":"query","description":"The name of the configuration to clone","required":true,"schema":{"type":"string","example":"assets"}}],"responses":{"201":{"description":"bundle_data_hub_config_clone_success_response"},"default":{"description":"201 - Created
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/data-hub/config":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_collection_summary","description":"bundle_data_hub_config_collection_description","operationId":"bundle_data_hub_config_collection","responses":{"200":{"description":"bundle_copilot_actions_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubConfiguration"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/data-hub/config/delete/{name}":{"delete":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_delete_summary","description":"bundle_data_hub_config_delete_description","operationId":"bundle_data_hub_config_delete","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_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/data-hub/config/{name}/export":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_export_summary","description":"bundle_data_hub_config_export_description","operationId":"bundle_data_hub_config_export","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_config_export_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/data-hub/config/{name}":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_get_summary","description":"bundle_data_hub_config_get_description","operationId":"bundle_data_hub_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_config_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubConfigurationDetail"}}}},"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":["Bundle Data Hub"],"summary":"bundle_data_hub_config_update_summary","description":"bundle_data_hub_config_update_description","operationId":"bundle_data_hub_config_update","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubUpdateConfiguration"}}}},"responses":{"200":{"description":"bundle_data_hub_config_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubUpdateConfigurationResponse"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/data-hub/config/import":{"post":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_config_import_summary","description":"bundle_data_hub_config_import_description","operationId":"bundle_data_hub_config_import","requestBody":{"description":"Configuration file to import","required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"JSON configuration file","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"bundle_data_hub_config_import_success_response"},"default":{"description":"201 - Created
400 - Bad Request
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/data-hub/graphql/explorer/{clientname}":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_graphql_explorer_summary","description":"bundle_data_hub_graphql_explorer_description","operationId":"bundle_data_hub_graphql_explorer","parameters":[{"name":"clientname","in":"path","description":"Clientname of the client","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_graphql_explorer_success_response","content":{"text/html":{"schema":{"description":"GraphQL Explorer HTML interface","type":"string","example":"..."}}}},"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/data-hub/graphql/explorer-url/{name}":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_graphql_explorer_url_summary","description":"bundle_data_hub_graphql_explorer_url_description","operationId":"bundle_data_hub_graphql_explorer_url","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_graphql_explorer_url_success_response","content":{"application/json":{"schema":{"required":["explorerUrl"],"properties":{"explorerUrl":{"title":"explorerUrl","description":"The GraphQL Explorer URL for the specified configuration","type":"string","example":"/pimcore-datahub-webservices/explorer/my-config"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/data-hub/thumbnails":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_thumbnails_collection_summary","description":"bundle_data_hub_thumbnails_collection_description","operationId":"bundle_data_hub_thumbnails_collection","responses":{"200":{"description":"bundle_data_hub_thumbnails_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/BundleDataHubThumbnail"}}},"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/data-hub/users":{"get":{"tags":["Bundle Data Hub"],"summary":"bundle_data_hub_users_collection_summary","description":"bundle_data_hub_users_collection_description","operationId":"bundle_data_hub_users_collection","parameters":[{"name":"type","in":"query","description":"Filter by user type (user or role)","required":false,"schema":{"type":"string","default":"user","enum":["user","role"]}}],"responses":{"200":{"description":"bundle_data_hub_users_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/BundleDataHubPermissionUser"}}},"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/personalization/target-groups":{"get":{"tags":["Bundle Personalization"],"summary":"bundle_personalization_target_group_list_summary","description":"bundle_personalization_target_group_list_description","operationId":"bundle_personalization_target_group_list","parameters":[{"name":"includeDefault","in":"query","description":"If true, default target group is included in the response","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"bundle_personalization_target_group_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundlePersonalizationTargetGroup"}}},"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/enterprise-subscription-tools/license/":{"get":{"tags":["Bundle Enterprise Subscription Tools"],"summary":"bundle_enterprise_subscription_tools_license_summary","description":"bundle_enterprise_subscription_tools_license_description","operationId":"bundle_enterprise_subscription_tools_license","responses":{"200":{"description":"bundle_enterprise_subscription_tools_license_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleEnterpriseSubscriptionToolsLicenseInformation"}}}},"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/amdcd/configs/list":{"get":{"tags":["Bundle Asset Metadata Class Definitions"],"summary":"bundle_amdcd_configs_list_summary","description":"bundle_amdcd_configs_list_description","operationId":"bundle_amdcd_configs_list","responses":{"200":{"description":"bundle_amdcd_configs_list_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/AMDCDListConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/amdcd/configs/tree":{"get":{"tags":["Bundle Asset Metadata Class Definitions"],"summary":"bundle_amdcd_configs_tree_summary","description":"bundle_amdcd_configs_tree_description","operationId":"bundle_amdcd_configs_tree","responses":{"200":{"description":"bundle_amdcd_configs_tree_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/AMDCDSimpleConfig"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/statistics-explorer/custom-reports/data-sources/{dataSource}/fields":{"get":{"tags":["Bundle Statistics Explorer"],"summary":"bundle_statistics_explorer_custom_reports_data_sources_fields_summary","description":"bundle_statistics_explorer_custom_reports_data_sources_fields_description","operationId":"bundle_statistics_explorer_custom_reports_data_sources_fields","parameters":[{"name":"dataSource","in":"path","description":"The data source to retrieve the fields for","required":true,"schema":{"type":"string","example":"db_assets"}}],"responses":{"200":{"description":"bundle_statistics_explorer_custom_reports_data_sources_fields_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleStatisticsExplorerDataSourceFields"}}}},"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/statistics-explorer/custom-reports/data-sources/{dataSource}/fields/settings":{"post":{"tags":["Bundle Statistics Explorer"],"summary":"bundle_statistics_explorer_custom_reports_data_sources_fields_settings_summary","description":"bundle_statistics_explorer_custom_reports_data_sources_fields_settings_description","operationId":"bundle_statistics_explorer_custom_reports_data_sources_fields_settings","parameters":[{"name":"dataSource","in":"path","description":"The data source to retrieve the fields for","required":true,"schema":{"type":"string","example":"db_assets"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["statisticsMode","aggregations","columns"],"properties":{"statisticsMode":{"description":"The statistics mode to be used.","type":"string","example":"list"},"aggregations":{"description":"The aggregations to be applied.","type":"array","items":{"$ref":"#/components/schemas/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}},"columns":{"description":"The columns to be included in the result.","type":"array","items":{"$ref":"#/components/schemas/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}}},"type":"object"}}}},"responses":{"200":{"description":"bundle_statistics_explorer_custom_reports_data_sources_fields_settings_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/BundleStatisticsExplorerDataSourceFieldsDefinition"}}},"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/statistics-explorer/custom-reports/data-sources":{"get":{"tags":["Bundle Statistics Explorer"],"summary":"bundle_statistics_explorer_custom_reports_data_sources_summary","description":"bundle_statistics_explorer_custom_reports_data_sources_description","operationId":"bundle_statistics_explorer_custom_reports_data_sources","responses":{"200":{"description":"bundle_statistics_explorer_custom_reports_data_sources_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/BundleStatisticsExplorerDataSource"}}},"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/portal-engine/collection":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_add_summary","description":"bundle_portal_engine_collection_add_description","operationId":"bundle_portal_engine_collection_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name","portalId"],"properties":{"name":{"type":"string"},"portalId":{"type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collection_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineCollection"}}}},"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/portal-engine/collection/{collectionId}":{"delete":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_delete_collection_summary","description":"bundle_portal_engine_delete_collection_description","operationId":"bundle_portal_engine_delete_collection","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"translation_delete_by_key_success_description"},"default":{"description":"400 - Bad Request
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"}]}}}}}},"patch":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_update_summary","description":"bundle_portal_engine_collection_update_description","operationId":"bundle_portal_engine_collection_update","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collection_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineCollection"}}}},"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/portal-engine/collection/list":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_list_summary","description":"bundle_portal_engine_collection_list_description","operationId":"bundle_portal_engine_collection_list","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"type\":\"search\", \"filterValue\": \"search term\"},{\"type\":\"showAll\", \"filterValue\": true}]"},"sortFilter":{"type":"object","example":"{\"key\":\"portal\", \"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collection_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"$ref":"#/components/schemas/PortalEngineCollection"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/collection/list-portals":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_list_portals_summary","description":"bundle_portal_engine_collection_list_portals_description","operationId":"bundle_portal_engine_collection_list_portals","responses":{"200":{"description":"bundle_portal_engine_collection_list_portals_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/PortalEngineCollectionPortal"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/collection/{collectionId}/share-list":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_share_list_summary","description":"bundle_portal_engine_collection_share_list_description","operationId":"bundle_portal_engine_collection_share_list","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_portal_engine_collection_share_list_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/PortalEngineCollectionShareListItem"}}},"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"}]}}}}}},"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_share_list_update_summary","description":"bundle_portal_engine_collection_share_list_update_description","operationId":"bundle_portal_engine_collection_share_list_update","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["shareListItems"],"properties":{"shareListItems":{"type":"array","items":{"$ref":"#/components/schemas/PortalEngineCollectionShareListItem"}}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collection_share_list_update_success_response"},"default":{"description":"400 - Bad Request
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/bundle/portal-engine/collection/{collectionId}/tree/add/{rootNodeId}":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_tree_add_summary","description":"bundle_portal_engine_collections_tree_add_description","operationId":"bundle_portal_engine_collections_tree_add","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"rootNodeId","in":"path","description":"RootNodeId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["elementIds"],"properties":{"elementIds":{"type":"object","example":[123,456]}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collections_tree_add_success_response"},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/portal-engine/collection/{collectionId}/tree/delete/{rootNodeId}":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_tree_delete_elements_summary","description":"bundle_portal_engine_collections_tree_delete_elements_description","operationId":"bundle_portal_engine_collections_tree_delete_elements","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"rootNodeId","in":"path","description":"RootNodeId of the element","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["elementIds"],"properties":{"elementIds":{"type":"object","example":[123,456]}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_collections_tree_delete_elements_success_response"},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/portal-engine/collection/{collectionId}/tree-information":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_tree_information_summary","description":"bundle_portal_engine_collections_tree_information_description","operationId":"bundle_portal_engine_collections_tree_information","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_portal_engine_collections_tree_information_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineTreeInformation"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
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/bundle/portal-engine/collection/{collectionId}/tree-items":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_tree_items_summary","description":"bundle_portal_engine_collections_tree_items_description","operationId":"bundle_portal_engine_collections_tree_items","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","example":1}},{"name":"pageSize","in":"query","description":"How many results to return","required":true,"schema":{"type":"integer","example":30}},{"name":"node","in":"query","description":"Node is for items to list","required":true,"schema":{"type":"integer","example":30}},{"name":"filter","in":"query","description":"When provided, the items are filtered by value.","required":false,"schema":{"type":"string","example":"some-search-term"}}],"responses":{"200":{"description":"bundle_portal_engine_collections_tree_items_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BundlePortalEngineDataObject"},{"$ref":"#/components/schemas/BundlePortalEngineAsset"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/portal-engine/collection/{collectionId}/tree-root-nodes":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_tree_root_nodes_summary","description":"bundle_portal_engine_collections_tree_root_nodes_description","operationId":"bundle_portal_engine_collections_tree_root_nodes","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_portal_engine_collections_tree_root_nodes_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/PortalEngineTreeFolder"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/portal-engine/collections/check-user-assignment":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collections_user_assignment_check_summary","description":"bundle_portal_engine_collections_user_assignment_check_description","operationId":"bundle_portal_engine_collections_user_assignment_check","responses":{"200":{"description":"bundle_portal_engine_collections_user_assignment_check_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineAdminUserAssignment"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/portal-engine/collection/{collectionId}/user-search":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_collection_user_search_summary","description":"bundle_portal_engine_collection_user_search_description","operationId":"bundle_portal_engine_collection_user_search","parameters":[{"name":"collectionId","in":"path","description":"CollectionId of the element","required":true,"schema":{"type":"integer","example":83}},{"name":"searchQuery","in":"query","description":"Term to filter user groups","required":false,"schema":{"type":"string","example":"deal"}},{"name":"excludeIds","in":"query","description":"Comma-separated list of IDs excluded from the search result","required":false,"schema":{"type":"string","example":"1,2,3"}}],"responses":{"200":{"description":"bundle_portal_engine_collection_user_search_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/PortalEngineCollectionUserGroup"}}},"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/bundle/portal-engine/index-management":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_index_management_list_summary","description":"bundle_portal_engine_index_management_list_description","operationId":"bundle_portal_engine_index_management_list","responses":{"200":{"description":"bundle_portal_engine_index_management_list_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/IndexStat"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/index-management/queue-item-count":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_index_management_queue_count_summary","description":"bundle_portal_engine_index_management_queue_count_description","operationId":"bundle_portal_engine_index_management_queue_count","responses":{"200":{"description":"bundle_portal_engine_index_management_queue_count_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueItemCount"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/index-management/re-index":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_index_management_re_index_summary","description":"bundle_portal_engine_index_management_re_index_description","operationId":"bundle_portal_engine_index_management_re_index","responses":{"200":{"description":"bundle_portal_engine_index_management_re_index_success_response"},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
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/bundle/portal-engine/index-management/update-index":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_index_management_update_index_summary","description":"bundle_portal_engine_index_management_update_index_description","operationId":"bundle_portal_engine_index_management_update_index","responses":{"200":{"description":"bundle_portal_engine_index_management_update_index_success_response"},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
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/bundle/portal-engine/wizard/create-portal":{"post":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_create_portal_summary","description":"bundle_portal_engine_wizard_create_portal_description","operationId":"bundle_portal_engine_wizard_create_portal","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["portalName","domain","availableLanguages"],"properties":{"portalName":{"type":"string"},"domain":{"type":"string"},"availableLanguages":{"type":"array","items":{"type":"string"},"example":["de","en"]},"logo":{"type":"string"},"loginBackgroundImage":{"type":"string"},"objectPools":{"type":"array","items":{"$ref":"#/components/schemas/PortalEngineWizardObjectPool"}},"assetPools":{"type":"array","items":{"$ref":"#/components/schemas/PortalEngineWizardAssetPool"}}},"type":"object"}}}},"responses":{"200":{"description":"bundle_portal_engine_wizard_create_portal_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineWizardStartResponse"}}}},"default":{"description":"400 - Bad Request
400 - Bad Request
401 - Unauthorized
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/bundle/portal-engine/wizard/custom-layouts/{classId}":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_class_custom_layouts_summary","description":"bundle_portal_engine_wizard_class_custom_layouts_description","operationId":"bundle_portal_engine_wizard_class_custom_layouts","parameters":[{"name":"classId","in":"path","description":"Class ID","required":true,"schema":{"type":"string","example":"CAR"}}],"responses":{"200":{"description":"bundle_portal_engine_wizard_class_custom_layouts_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/PortalEngineWizardCustomLayout"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/wizard/available-formats":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_available_formats_summary","description":"bundle_portal_engine_wizard_available_formats_description","operationId":"bundle_portal_engine_wizard_available_formats","responses":{"200":{"description":"bundle_portal_engine_wizard_available_formats_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/PortalEngineWizardFormat"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/wizard/icons":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_icons_summary","description":"bundle_portal_engine_wizard_icons_description","operationId":"bundle_portal_engine_wizard_icons","responses":{"200":{"description":"bundle_portal_engine_wizard_icons_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/PortalEngineIcon"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/wizard/available-thumbnails":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_available_thumbnails_summary","description":"bundle_portal_engine_wizard_available_thumbnails_description","operationId":"bundle_portal_engine_wizard_available_thumbnails","responses":{"200":{"description":"bundle_portal_engine_wizard_available_thumbnails_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/PortalEngineWizardThumbnail"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/portal-engine/wizard/{tmpStoreKey}/status":{"get":{"tags":["Bundle Portal Engine"],"summary":"bundle_portal_engine_wizard_status_summary","description":"bundle_portal_engine_wizard_status_description","operationId":"bundle_portal_engine_wizard_status","parameters":[{"name":"tmpStoreKey","in":"path","description":"Temporary store key returned by the wizard start endpoint.","required":true,"schema":{"type":"string","example":"portal-engine_wizard_650a9242c8b1d"}}],"responses":{"200":{"description":"bundle_portal_engine_wizard_status_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalEngineWizardStatusResponse"}}}},"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/bundle/data-hub-file-export/config/{name}":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_config_get_summary","description":"bundle_data_hub_file_export_config_get_description","operationId":"bundle_data_hub_file_export_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_file_export_config_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportConfigurationDetail"}}}},"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":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_config_update_summary","description":"bundle_data_hub_file_export_config_update_description","operationId":"bundle_data_hub_file_export_config_update","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportUpdateConfiguration"}}}},"responses":{"200":{"description":"bundle_data_hub_file_export_config_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportUpdateConfigurationResponse"}}}},"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":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_config_delete_summary","description":"bundle_data_hub_file_export_config_delete_description","operationId":"bundle_data_hub_file_export_config_delete","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_file_export_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/data-hub-file-export/exporter-services":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_exporter_services_summary","description":"bundle_data_hub_file_export_exporter_services_description","operationId":"bundle_data_hub_file_export_exporter_services","responses":{"200":{"description":"bundle_data_hub_file_export_exporter_services_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/BundleDataHubFileExportExporterService"}}},"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/data-hub-file-export/exporter-types":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_exporter_types_summary","description":"bundle_data_hub_file_export_exporter_types_description","operationId":"bundle_data_hub_file_export_exporter_types","responses":{"200":{"description":"bundle_data_hub_file_export_exporter_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/BundleDataHubFileExportExporterType"}}},"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/data-hub-file-export/thumbnails":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_thumbnails_summary","description":"bundle_data_hub_file_export_thumbnails_description","operationId":"bundle_data_hub_file_export_thumbnails","responses":{"200":{"description":"bundle_data_hub_file_export_thumbnails_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportThumbnailCollection"}}}},"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/data-hub-file-export/validate-cron":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_validate_cron_summary","description":"bundle_data_hub_file_export_validate_cron_description","operationId":"bundle_data_hub_file_export_validate_cron","parameters":[{"name":"cron_expression","in":"query","description":"The cron expression to validate","required":false,"schema":{"type":"string","example":"*/5 * * * *"}}],"responses":{"200":{"description":"bundle_data_hub_file_export_validate_cron_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportCronValidationResult"}}}},"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/data-hub-file-export/export/cancel":{"put":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_export_cancel_summary","description":"bundle_data_hub_file_export_export_cancel_description","operationId":"bundle_data_hub_file_export_export_cancel","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configName"],"properties":{"configName":{"description":"Configuration name","type":"string","example":"my-file-export"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_data_hub_file_export_export_cancel_success_response"},"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/data-hub-file-export/export/progress":{"get":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_export_progress_summary","description":"bundle_data_hub_file_export_export_progress_description","operationId":"bundle_data_hub_file_export_export_progress","parameters":[{"name":"config_name","in":"query","description":"Configuration name","required":true,"schema":{"type":"string","example":"my-file-export"}}],"responses":{"200":{"description":"bundle_data_hub_file_export_export_progress_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportExportProgress"}}}},"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/data-hub-file-export/export/start":{"put":{"tags":["Bundle Data Hub File Export"],"summary":"bundle_data_hub_file_export_export_start_summary","description":"bundle_data_hub_file_export_export_start_description","operationId":"bundle_data_hub_file_export_export_start","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubFileExportStartExport"}}}},"responses":{"200":{"description":"bundle_data_hub_file_export_export_start_success_response"},"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/data-hub-simple-rest/config/{name}":{"get":{"tags":["Bundle Data Hub Simple Rest"],"summary":"bundle_data_hub_simple_rest_config_get_summary","description":"bundle_data_hub_simple_rest_config_get_description","operationId":"bundle_data_hub_simple_rest_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_simple_rest_config_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubSimpleRestConfigurationDetail"}}}},"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":["Bundle Data Hub Simple Rest"],"summary":"bundle_data_hub_simple_rest_config_update_summary","description":"bundle_data_hub_simple_rest_config_update_description","operationId":"bundle_data_hub_simple_rest_config_update","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubSimpleRestUpdateConfiguration"}}}},"responses":{"200":{"description":"bundle_data_hub_simple_rest_config_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubSimpleRestUpdateConfigurationResponse"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/data-hub-simple-rest/config/{name}/label-list":{"get":{"tags":["Bundle Data Hub Simple Rest"],"summary":"bundle_data_hub_simple_rest_config_get_label_list_summary","description":"bundle_data_hub_simple_rest_config_get_label_list_description","operationId":"bundle_data_hub_simple_rest_config_get_label_list","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_simple_rest_config_get_label_list_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/BundleDataHubSimpleRestLabel"}}},"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/data-hub-simple-rest/queue/item-count":{"get":{"tags":["Bundle Data Hub Simple Rest"],"summary":"bundle_data_hub_simple_rest_queue_get_item_count_summary","description":"bundle_data_hub_simple_rest_queue_get_item_count_description","operationId":"bundle_data_hub_simple_rest_queue_get_item_count","responses":{"200":{"description":"bundle_data_hub_simple_rest_queue_get_item_count_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubSimpleRestQueueItemCount"}}}},"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/data-hub-simple-rest/thumbnails":{"get":{"tags":["Bundle Data Hub Simple Rest"],"summary":"bundle_data_hub_simple_rest_thumbnails_collection_summary","description":"bundle_data_hub_simple_rest_thumbnails_collection_description","operationId":"bundle_data_hub_simple_rest_thumbnails_collection","responses":{"200":{"description":"bundle_data_hub_simple_rest_thumbnails_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/BundleDataHubSimpleRestThumbnail"}}},"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/data-hub-webhooks/config/{name}":{"get":{"tags":["Bundle Data Hub Webhooks"],"summary":"bundle_data_hub_webhooks_config_get_summary","description":"bundle_data_hub_webhooks_config_get_description","operationId":"bundle_data_hub_webhooks_config_get","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"bundle_data_hub_webhooks_config_get_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubWebhooksConfigurationDetail"}}}},"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":["Bundle Data Hub Webhooks"],"summary":"bundle_data_hub_webhooks_config_update_summary","description":"bundle_data_hub_webhooks_config_update_description","operationId":"bundle_data_hub_webhooks_config_update","parameters":[{"name":"name","in":"path","description":"Name of the configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubWebhooksUpdateConfiguration"}}}},"responses":{"200":{"description":"bundle_data_hub_webhooks_config_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubWebhooksUpdateConfigurationResponse"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
404 - Not Found
405 - Method Not Allowed
409 - Conflict
415 - Unsupported Media Type
422 - Unprocessable Content","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/data-hub-webhooks/config/test-subscribers":{"post":{"tags":["Bundle Data Hub Webhooks"],"summary":"bundle_data_hub_webhooks_config_test_subscribers_summary","description":"bundle_data_hub_webhooks_config_test_subscribers_description","operationId":"bundle_data_hub_webhooks_config_test_subscribers","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubWebhooksTestSubscribersParameters"}}}},"responses":{"200":{"description":"bundle_data_hub_webhooks_config_test_subscribers_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleDataHubWebhooksTestSubscribersResponse"}}}},"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/web-to-print/{documentId}/cancel-generation":{"post":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_cancel_generation_process_summary","description":"bundle_web_to_print_cancel_generation_process_description","operationId":"bundle_web_to_print_cancel_generation_process","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_cancel_generation_process_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/bundle/web-to-print/{documentId}/check-pdf-dirty":{"get":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_get_pdf_dirty_summary","description":"bundle_web_to_print_get_pdf_dirty_description","operationId":"bundle_web_to_print_get_pdf_dirty","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_get_pdf_dirty_success_response","content":{"application/json":{"schema":{"required":["isDirty"],"properties":{"isDirty":{"title":"isDirty","description":"True if document changed since the last PDF generation","type":"boolean","example":true}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/web-to-print/{documentId}/pdf-download":{"get":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_pdf_download_summary","description":"bundle_web_to_print_pdf_download_description","operationId":"bundle_web_to_print_pdf_download","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_pdf_download_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"attachment; filename=\"someGeneratedDocument.pdf\""}}},"content":{"application/pdf":{"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
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/web-to-print/{documentId}/generation-process-data":{"get":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_get_generation_process_data_summary","description":"bundle_web_to_print_get_generation_process_data_description","operationId":"bundle_web_to_print_get_generation_process_data","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_get_generation_process_data_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleWebToPrintGenerateProcessData"}}}},"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/bundle/web-to-print/{documentId}/processing-options":{"get":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_get_processing_options_summary","description":"bundle_web_to_print_get_processing_options_description","operationId":"bundle_web_to_print_get_processing_options","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_get_processing_options_success_response","content":{"application/json":{"schema":{"required":["options"],"properties":{"options":{"title":"Processing Options","description":"Processing options used for PDF generation.","type":"array","items":{"$ref":"#/components/schemas/BundleWebToPrintProcessingOption"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/bundle/web-to-print/{documentId}/start-generation":{"post":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_start_generation_process_summary","description":"bundle_web_to_print_start_generation_process_description","operationId":"bundle_web_to_print_start_generation_process","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"author":{"type":["string","null"]},"title":{"type":["string","null"]},"printermarks":{"type":["boolean","null"]},"addOverprint":{"type":["boolean","null"]},"links":{"type":["boolean","null"]},"bookmarks":{"type":["boolean","null"]},"tags":{"type":["boolean","null"]},"javaScriptMode":{"type":["string","null"]},"viewerPreference":{"type":["string","null"]},"colorspace":{"type":["string","null"]},"encryption":{"type":["string","null"]},"loglevel":{"type":["string","null"]},"enableDebugMode":{"type":["boolean","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_web_to_print_start_generation_process_success_response"},"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/bundle/web-to-print/{documentId}/pdf-stream":{"get":{"tags":["Bundle Web To Print"],"summary":"bundle_web_to_print_pdf_stream_summary","description":"bundle_web_to_print_pdf_stream_description","operationId":"bundle_web_to_print_pdf_stream","parameters":[{"name":"documentId","in":"path","description":"DocumentId of the web to print document","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_web_to_print_pdf_stream_success_response","headers":{"Content-Disposition":{"description":"Content-Disposition header","schema":{"type":"string","example":"inline; filename=\"someGeneratedDocument.pdf\""}}},"content":{"application/pdf":{"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
500 - Internal Server Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error"},{"$ref":"#/components/schemas/DevError"}]}}}}}}},"/pimcore-studio/api/bundle/data-quality-management/color-settings":{"get":{"tags":["Bundle Data Quality Management"],"summary":"bundle_data_quality_management_color_settings_list_summary","description":"bundle_data_quality_management_color_settings_list_description","operationId":"bundle_data_quality_management_color_settings_list","responses":{"200":{"description":"bundle_data_quality_management_color_settings_list_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleDataQualityManagementColorSettings"}}},"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/data-quality-management/detail-widget/{id}/{locale}":{"get":{"tags":["Bundle Data Quality Management"],"summary":"bundle_data_quality_management_detail_widget_get_summary","description":"bundle_data_quality_management_detail_widget_get_description","operationId":"bundle_data_quality_management_detail_widget_get","parameters":[{"name":"id","in":"path","description":"Id of the data-object","required":true,"schema":{"type":"integer","example":83}},{"name":"locale","in":"path","description":"Local used for detail translations","required":true,"schema":{"type":"string","example":"en"}}],"responses":{"200":{"description":"bundle_data_quality_management_detail_widget_get_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleDataQualityManagementDetailWidget"}}},"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/bundle/backend-power-tools/aet/class-definition/common-relation-fields":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_common_relation_fields_summary","description":"bundle_backend_power_tools_aet_list_common_relation_fields_description","operationId":"bundle_backend_power_tools_aet_list_common_relation_fields","parameters":[{"name":"classId","in":"query","description":"Class ID to retrieve common relation fields for","required":true,"schema":{"type":"string","example":"Car"}},{"name":"relationField","in":"query","description":"Relation field name to find common fields across related classes","required":true,"schema":{"type":"string","example":"manufacturer"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_list_common_relation_fields_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETClassDefinitionField"}}},"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/backend-power-tools/aet/class-definition/fields":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_class_definition_fields_summary","description":"bundle_backend_power_tools_aet_list_class_definition_fields_description","operationId":"bundle_backend_power_tools_aet_list_class_definition_fields","parameters":[{"name":"classId","in":"query","description":"Class ID to retrieve fields for","required":true,"schema":{"type":"string","example":"Car"}},{"name":"onlySimpleValueFields","in":"query","description":"Only return simple value fields","required":false,"schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_list_class_definition_fields_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETClassDefinitionField"}}},"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/backend-power-tools/aet/configuration/{configurationId}/clone":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_clone_configuration_summary","description":"bundle_backend_power_tools_aet_clone_configuration_description","operationId":"bundle_backend_power_tools_aet_clone_configuration","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationName"],"properties":{"configurationName":{"description":"Name for the cloned configuration","type":"string","example":"My Cloned Tree"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_clone_configuration_success_description"},"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/backend-power-tools/aet/configuration":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_create_configuration_summary","description":"bundle_backend_power_tools_aet_create_configuration_description","operationId":"bundle_backend_power_tools_aet_create_configuration","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationName"],"properties":{"configurationName":{"description":"Name of the new configuration","type":"string","example":"My Custom Tree"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_create_configuration_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationId"}}}},"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/backend-power-tools/aet/configuration/default-perspective":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_default_perspective_configurations_summary","description":"bundle_backend_power_tools_aet_default_perspective_configurations_description","operationId":"bundle_backend_power_tools_aet_default_perspective_configurations","parameters":[{"name":"openAlternativeElementTrees","in":"query","description":"Comma-separated list of open alternative element tree IDs","required":false,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_default_perspective_configurations_success_description","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETDefaultPerspectiveConfigurationItem"}}}}},"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/backend-power-tools/aet/configuration/{configurationId}":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_get_configuration_summary","description":"bundle_backend_power_tools_aet_get_configuration_description","operationId":"bundle_backend_power_tools_aet_get_configuration","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_get_configuration_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationData"}}}},"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"}]}}}}}},"put":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_update_configuration_summary","description":"bundle_backend_power_tools_aet_update_configuration_description","operationId":"bundle_backend_power_tools_aet_update_configuration","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationName","data"],"properties":{"configurationName":{"description":"Name of the configuration","type":"string","example":"My Custom Tree"},"data":{"description":"JSON encoded configuration data","type":"string","example":"{\"general\":{},\"dataSource\":{},\"treeLevels\":[]}"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_update_configuration_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationModificationDate"}}}},"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 Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_delete_configuration_summary","description":"bundle_backend_power_tools_aet_delete_configuration_description","operationId":"bundle_backend_power_tools_aet_delete_configuration","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_delete_configuration_success_description"},"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/backend-power-tools/aet/configuration/{configurationId}/export":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_export_configuration_summary","description":"bundle_backend_power_tools_aet_export_configuration_description","operationId":"bundle_backend_power_tools_aet_export_configuration","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_export_configuration_success_description"},"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/backend-power-tools/aet/configuration/{configurationId}/details":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_get_configuration_details_summary","description":"bundle_backend_power_tools_aet_get_configuration_details_description","operationId":"bundle_backend_power_tools_aet_get_configuration_details","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_get_configuration_details_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationDetails"}}}},"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/backend-power-tools/aet/configuration/import":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_import_configuration_summary","description":"bundle_backend_power_tools_aet_import_configuration_description","operationId":"bundle_backend_power_tools_aet_import_configuration","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"JSON file with alternative element tree configuration","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_import_configuration_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationId"}}}},"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/backend-power-tools/aet/configuration/list":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_configuration_admin_summary","description":"bundle_backend_power_tools_aet_list_configuration_admin_description","operationId":"bundle_backend_power_tools_aet_list_configuration_admin","responses":{"200":{"description":"bundle_backend_power_tools_aet_list_configuration_admin_success_description","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationListItem"}}}}},"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/backend-power-tools/aet/grid/batch-edit-ids":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_grid_batch_edit_ids_summary","description":"bundle_backend_power_tools_aet_grid_batch_edit_ids_description","operationId":"bundle_backend_power_tools_aet_grid_batch_edit_ids","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationId","language"],"properties":{"configurationId":{"description":"Alternative Element Tree Configuration ID","type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"},"language":{"description":"Language for the listing","type":"string","example":"en"},"filter":{"description":"Filter expression","type":["string","null"],"example":null},"path":{"description":"Base path for the listing","type":["string","null"],"example":"/"},"fields":{"description":"Fields to include in the response","type":["array","null"],"items":{"type":"string"}},"selectedItems":{"description":"Pre-selected item IDs","type":["array","null"],"items":{"type":"integer"}},"query":{"description":"Search query string","type":["string","null"],"example":null},"start":{"description":"Offset to start from","type":"integer","example":0},"limit":{"description":"Maximum number of results","type":"integer","example":50},"sort":{"description":"JSON-encoded sort configuration","type":["string","null"],"example":"[{\"property\":\"id\",\"direction\":\"ASC\"}]"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_grid_batch_edit_ids_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETGridBatchEditIds"}}}},"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/backend-power-tools/aet/grid/export-jobs":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_grid_export_jobs_summary","description":"bundle_backend_power_tools_aet_grid_export_jobs_description","operationId":"bundle_backend_power_tools_aet_grid_export_jobs","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationId","language"],"properties":{"configurationId":{"description":"Alternative Element Tree Configuration ID","type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"},"language":{"description":"Language for the listing","type":"string","example":"en"},"filter":{"description":"Filter expression","type":["string","null"],"example":null},"path":{"description":"Base path for the listing","type":["string","null"],"example":"/"},"fields":{"description":"Fields to include in the response","type":["array","null"],"items":{"type":"string"}},"selectedItems":{"description":"Pre-selected item IDs","type":["array","null"],"items":{"type":"integer"}},"query":{"description":"Search query string","type":["string","null"],"example":null},"start":{"description":"Offset to start from","type":"integer","example":0},"limit":{"description":"Maximum number of results","type":"integer","example":50},"sort":{"description":"JSON-encoded sort configuration","type":["string","null"],"example":"[{\"property\":\"id\",\"direction\":\"ASC\"}]"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_grid_export_jobs_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETGridExportJobs"}}}},"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/backend-power-tools/aet/grid/listing":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_grid_listing_summary","description":"bundle_backend_power_tools_aet_grid_listing_description","operationId":"bundle_backend_power_tools_aet_grid_listing","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["configurationId","language"],"properties":{"configurationId":{"description":"Alternative Element Tree Configuration ID","type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"},"language":{"description":"Language for the listing","type":"string","example":"en"},"filter":{"description":"Filter expression","type":["string","null"],"example":null},"path":{"description":"Base path for the listing","type":["string","null"],"example":"/"},"fields":{"description":"Fields to include in the response","type":["array","null"],"items":{"type":"string"}},"selectedItems":{"description":"Pre-selected item IDs","type":["array","null"],"items":{"type":"integer"}},"query":{"description":"Search query string","type":["string","null"],"example":null},"start":{"description":"Offset to start from","type":"integer","example":0},"limit":{"description":"Maximum number of results","type":"integer","example":50},"sort":{"description":"JSON-encoded sort configuration","type":["string","null"],"example":"[{\"property\":\"id\",\"direction\":\"ASC\"}]"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_grid_listing_success_description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETGridListing"}}}},"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/backend-power-tools/aet/configurations":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_configurations_summary","description":"bundle_backend_power_tools_aet_list_configurations_description","operationId":"bundle_backend_power_tools_aet_list_configurations","responses":{"200":{"description":"bundle_backend_power_tools_aet_list_configurations_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETTreeConfigurationItem"}}},"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/backend-power-tools/aet/data-object-classes":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_data_object_classes_summary","description":"bundle_backend_power_tools_aet_list_data_object_classes_description","operationId":"bundle_backend_power_tools_aet_list_data_object_classes","responses":{"200":{"description":"bundle_backend_power_tools_aet_list_data_object_classes_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETDataObjectClassItem"}}},"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/backend-power-tools/aet/precondition-filters":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_precondition_filters_summary","description":"bundle_backend_power_tools_aet_list_precondition_filters_description","operationId":"bundle_backend_power_tools_aet_list_precondition_filters","responses":{"200":{"description":"bundle_backend_power_tools_aet_list_precondition_filters_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETPreconditionFilterItem"}}},"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/backend-power-tools/aet/valid-languages":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_valid_languages_summary","description":"bundle_backend_power_tools_aet_list_valid_languages_description","operationId":"bundle_backend_power_tools_aet_list_valid_languages","responses":{"200":{"description":"bundle_backend_power_tools_aet_list_valid_languages_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETValidLanguageItem"}}},"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/backend-power-tools/aet/object-brick/fields":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_list_object_brick_fields_summary","description":"bundle_backend_power_tools_aet_list_object_brick_fields_description","operationId":"bundle_backend_power_tools_aet_list_object_brick_fields","parameters":[{"name":"objectBrick","in":"query","description":"Object brick key to retrieve fields for","required":true,"schema":{"type":"string","example":"MyObjectBrick"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_list_object_brick_fields_success_description","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETClassDefinitionField"}}},"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/backend-power-tools/aet/tree/{configurationId}/update/{objectId}":{"patch":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_patch_data_object_summary","description":"bundle_backend_power_tools_aet_patch_data_object_description","operationId":"bundle_backend_power_tools_aet_patch_data_object","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}},{"name":"objectId","in":"path","description":"ObjectId of the data-object","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","example":["Super car","red"]}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_aet_patch_data_object_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/bundle/backend-power-tools/aet/tree/{configurationId}/calculation-status":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_get_tree_calculation_status_summary","description":"bundle_backend_power_tools_aet_get_tree_calculation_status_description","operationId":"bundle_backend_power_tools_aet_get_tree_calculation_status","parameters":[{"name":"configurationId","in":"path","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_get_tree_calculation_status_response_description","content":{"application/json":{"schema":{"required":["inProgress"],"properties":{"inProgress":{"title":"inProgress","description":"True if a tree calculation is currently in progress","type":"boolean","example":true}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/bundle/backend-power-tools/aet/tree":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_aet_get_tree_summary","description":"bundle_backend_power_tools_aet_get_tree_description","operationId":"bundle_backend_power_tools_aet_get_tree","parameters":[{"name":"configurationId","in":"query","description":"Alternative Element Tree Configuration ID","required":true,"schema":{"type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"}},{"name":"path","in":"query","description":"Path of the current level","required":true,"schema":{"type":"string","example":"/"}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"start","in":"query","description":"From which result to start","required":true,"schema":{"type":"integer","example":0}},{"name":"limit","in":"query","description":"How many results to return","required":true,"schema":{"type":"integer","example":30}},{"name":"level","in":"query","description":"Current tree level.","required":false,"schema":{"type":"integer","example":0}},{"name":"filter","in":"query","description":"When provided, the items are filtered by value.","required":false,"schema":{"type":"string","example":"some-search-term"}}],"responses":{"200":{"description":"bundle_backend_power_tools_aet_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BundleBackendPowerToolsAETDataObject"},{"$ref":"#/components/schemas/BundleBackendPowerToolsAETVirtualFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/bundle/backend-power-tools/bl/add":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_add_summary","description":"bundle_backend_power_tools_bl_add_description","operationId":"bundle_backend_power_tools_bl_add","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string","example":"My bookmark list"},"sortBy":{"type":["string","null"],"example":"name"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_add_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsBookmarkList"}}}},"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/backend-power-tools/bl/":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_get_collection_summary","description":"bundle_backend_power_tools_bl_get_collection_description","operationId":"bundle_backend_power_tools_bl_get_collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filters":{"properties":{"page":{"type":"integer","example":1},"pageSize":{"type":"integer","example":50},"columnFilters":{"type":"object","example":"[{\"type\":\"search\", \"filterValue\": \"search term\"},{\"type\":\"showAll\", \"filterValue\": true}]"},"sortFilter":{"type":"object","example":"{\"key\":\"id\",\"direction\":\"ASC\"}"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_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/BundleBackendPowerToolsBookmarkList"}}},"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/backend-power-tools/bl/{id}":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_get_by_id_summary","description":"bundle_backend_power_tools_bl_get_by_id_description","operationId":"bundle_backend_power_tools_bl_get_by_id","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_backend_power_tools_bl_get_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsBookmarkList"}}}},"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 Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_delete_summary","description":"bundle_backend_power_tools_bl_delete_description","operationId":"bundle_backend_power_tools_bl_delete","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_backend_power_tools_bl_delete_success_response"},"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/bundle/backend-power-tools/bl/{id}/share/recipients":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_get_share_collection_summary","description":"bundle_backend_power_tools_bl_get_share_collection_description","operationId":"bundle_backend_power_tools_bl_get_share_collection","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"responses":{"200":{"description":"bundle_backend_power_tools_bl_get_share_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/BundleBackendPowerToolsShareRecipient"}}},"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"}]}}}}}},"patch":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_patch_share_list_summary","description":"bundle_backend_power_tools_bl_patch_share_list_description","operationId":"bundle_backend_power_tools_bl_patch_share_list","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["shares","deletedShares"],"properties":{"shares":{"type":"array","items":{"required":["userId","permission"],"properties":{"userId":{"description":"User ID","type":"integer","example":1},"permission":{"description":"User permission for share","type":"string","example":"edit"}},"type":"object"}},"deletedShares":{"description":"Array of user IDs whose shares are to be removed from the bookmark list.","type":"object","example":[5,7]}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_patch_share_list_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/BundleBackendPowerToolsShareRecipient"}}},"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/bundle/backend-power-tools/bl/{id}/share/users":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_get_user_collection_summary","description":"bundle_backend_power_tools_bl_get_user_collection_description","operationId":"bundle_backend_power_tools_bl_get_user_collection","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}},{"name":"searchTerm","in":"query","description":"Filter results by name","required":false,"schema":{"type":"string","example":"admin"}}],"responses":{"200":{"description":"bundle_backend_power_tools_bl_get_user_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/BundleBackendPowerToolsShareUser"}}},"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/bundle/backend-power-tools/bl/{id}/tree/folder":{"put":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_tree_rename_folder_summary","description":"bundle_backend_power_tools_bl_tree_rename_folder_description","operationId":"bundle_backend_power_tools_bl_tree_rename_folder","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderName","folderId"],"properties":{"folderName":{"type":"string","example":"Bookmark Folder"},"folderId":{"type":"integer","example":83}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_tree_rename_folder_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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"}]}}}}}},"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_tree_add_folder_summary","description":"bundle_backend_power_tools_bl_tree_add_folder_description","operationId":"bundle_backend_power_tools_bl_tree_add_folder","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["folderName","parentId"],"properties":{"folderName":{"type":"string","example":"Bookmark Folder"},"parentId":{"type":"integer","example":1}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_tree_add_folder_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/bundle/backend-power-tools/bl/{id}/tree/items":{"post":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_tree_add_update_items_summary","description":"bundle_backend_power_tools_bl_tree_add_update_items_description","operationId":"bundle_backend_power_tools_bl_tree_add_update_items","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["selectedNodes","elementSortOrder"],"properties":{"selectedNodes":{"description":"Selected nodes to add","type":"array","items":{"required":["elementId","elementType"],"properties":{"elementId":{"description":"Element ID","type":"integer","example":123},"elementType":{"description":"Element type","type":"string","example":"object"},"bookmarkListItemId":{"description":"Bookmark list item ID","type":["integer","null"],"example":1},"parentFolderId":{"description":"Parent folder ID","type":["integer","null"],"example":5},"copy":{"description":"Whether to copy the item","type":"boolean","example":false}},"type":"object"}},"elementSortOrder":{"description":"Sort order based on IDs which should be applied for tree manual sorting","type":["string","null"],"example":"1,2,newElement,3"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_tree_add_update_items_success_response"},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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 Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_tree_remove_items_summary","description":"bundle_backend_power_tools_bl_tree_remove_items_description","operationId":"bundle_backend_power_tools_bl_tree_remove_items","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["nodesToRemove"],"properties":{"nodesToRemove":{"description":"Selected nodes to remove from bookmark list","type":"array","items":{"required":["elementId","elementType","id"],"properties":{"elementId":{"description":"Element ID","type":"integer","example":123},"elementType":{"description":"Element type","type":"string","example":"object"},"id":{"description":"Bookmark list item ID","type":"integer","example":1}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_tree_remove_items_success_response"},"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/bundle/backend-power-tools/bl/{id}/tree":{"get":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_get_tree_summary","description":"bundle_backend_power_tools_bl_get_tree_description","operationId":"bundle_backend_power_tools_bl_get_tree","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}},{"name":"page","in":"query","description":"Page number","required":true,"schema":{"type":"integer","minimum":1,"example":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":true,"schema":{"type":"integer","minimum":1,"example":30}},{"name":"parentId","in":"query","description":"ID of the parent","required":true,"schema":{"type":"integer","example":0}},{"name":"elementType","in":"query","description":"Necessary to get data from default element trees by type.","required":false,"schema":{"type":"string","example":"asset"}},{"name":"searchTerm","in":"query","description":"Search term to filter elements.","required":false,"schema":{"type":"string","example":"search text"}}],"responses":{"200":{"description":"bundle_backend_power_tools_bl_get_tree_success_response","content":{"application/json":{"schema":{"required":["totalItems","items"],"properties":{"totalItems":{"title":"totalItems","type":"integer","example":666},"items":{"title":"items","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BundleBackendPowerToolsBLTreeAsset"},{"$ref":"#/components/schemas/BundleBackendPowerToolsBLTreeDataObject"},{"$ref":"#/components/schemas/BundleBackendPowerToolsBLTreeDocument"},{"$ref":"#/components/schemas/BundleBackendPowerToolsBLTreeFolder"},{"$ref":"#/components/schemas/Document"},{"$ref":"#/components/schemas/Image"},{"$ref":"#/components/schemas/AssetDocument"},{"$ref":"#/components/schemas/Audio"},{"$ref":"#/components/schemas/Video"},{"$ref":"#/components/schemas/Archive"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/AssetFolder"},{"$ref":"#/components/schemas/Unknown"},{"$ref":"#/components/schemas/DataObject"},{"$ref":"#/components/schemas/DataObjectFolder"}]}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/bundle/backend-power-tools/bl/update/{id}":{"put":{"tags":["Bundle Backend Power Tools"],"summary":"bundle_backend_power_tools_bl_update_summary","description":"bundle_backend_power_tools_bl_update_description","operationId":"bundle_backend_power_tools_bl_update","parameters":[{"name":"id","in":"path","description":"Id of the Bookmark List","required":true,"schema":{"type":"integer","example":83}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["name"],"properties":{"name":{"type":"string","example":"My bookmark list"},"sortBy":{"type":["string","null"],"example":"name"}},"type":"object"}}}},"responses":{"200":{"description":"bundle_backend_power_tools_bl_update_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleBackendPowerToolsBookmarkList"}}}},"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/studio-dashboards/dashboard":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_create_dashboard_config_summary","description":"dashboards_create_dashboard_config_description","operationId":"dashboards_create_dashboard_config","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"required":["name","menuShortcutGroup","shareGlobally","rows"],"properties":{"name":{"type":["string","null"]},"menuShortcutGroup":{"type":["string","null"]},"shareGlobally":{"type":["boolean","null"]},"rows":{"title":"Rows","description":"Define the rows of the dashboard.","type":"array","items":{"required":["layout_id","widgets"],"properties":{"layout_id":{"type":["string","null"]},"widgets":{"title":"Widgets","description":"Define the widgets of the row.","type":"array","items":{"required":["id","type","position"],"properties":{"id":{"type":["string","null"]},"type":{"type":["string","null"]},"position":{"type":["integer","null"],"minimum":1}},"type":"object"}}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_create_dashboard_config_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"Id of the created dashboard configuration","type":"string","example":"12345678-1234-1234-1234-123456789012"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/studio-dashboards/dashboard/{dashboardId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_get_dashboard_by_id_summary","description":"dashboards_get_dashboard_by_id_description","operationId":"dashboards_get_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"responses":{"200":{"description":"dashboards_get_dashboard_by_id_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardConfiguration"}}}},"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"}]}}}}}},"put":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_update_dashboard_config_by_id_summary","description":"dashboards_update_dashboard_config_by_id_description","operationId":"dashboards_update_dashboard_config_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Update dashboard by matching dashboard Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"required":["name","menuShortcutGroup","shareGlobally","rows"],"properties":{"name":{"type":["string","null"]},"menuShortcutGroup":{"type":["string","null"]},"shareGlobally":{"type":["boolean","null"]},"rows":{"title":"Rows","description":"Define the rows of the dashboard.","type":"array","items":{"required":["layout_id","widgets"],"properties":{"layout_id":{"type":["string","null"]},"widgets":{"title":"Widgets","description":"Define the widgets of the row.","type":"array","items":{"required":["id","type","position"],"properties":{"id":{"type":["string","null"]},"type":{"type":["string","null"]},"position":{"type":["integer","null"],"minimum":1}},"type":"object"}}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_update_dashboard_config_by_id_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"}]}}}}}},"delete":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_delete_dashboard_by_id_summary","description":"dashboards_delete_dashboard_by_id_description","operationId":"dashboards_delete_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Delete dashboard by matching dashboard Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}}],"responses":{"200":{"description":"dashboards_delete_dashboard_by_id_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/bundle/studio-dashboards/dashboard/{dashboardId}/export":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_export_dashboard_by_id_summary","description":"dashboards_export_dashboard_by_id_description","operationId":"dashboards_export_dashboard_by_id","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"responses":{"200":{"description":"dashboards_export_dashboard_by_id_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
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/bundle/studio-dashboards/dashboard/import/{dashboardId}":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_import_dashboard_summary","description":"dashboards_import_dashboard_description","operationId":"dashboards_import_dashboard","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":false,"schema":{"type":"string","example":"studio_default_dashboard"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"description":"CSV import file to upload","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_import_dashboard_success_response"},"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/bundle/studio-dashboards/dashboards":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_list_dashboards_summary","description":"dashboards_list_dashboards_description","operationId":"dashboards_list_dashboards","responses":{"200":{"description":"dashboards_list_dashboards_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/SimpleDashboard"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
401 - Unauthorized
403 - Forbidden
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/studio-dashboards/dashboard/{dashboardId}/update-menu-shortcut":{"put":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_dashboard_update_menu_shortcut_summary","description":"dashboards_dashboard_update_menu_shortcut_description","operationId":"dashboards_dashboard_update_menu_shortcut","parameters":[{"name":"dashboardId","in":"path","description":"Dashboard ID","required":true,"schema":{"type":"string","example":"studio_default_dashboard"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["shortcut"],"properties":{"shortcut":{"type":["string","null"]}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_dashboard_update_menu_shortcut_success_response"},"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/bundle/studio-dashboards/layout-options":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_get_layout_options_summary","description":"dashboards_get_layout_options_description","operationId":"dashboards_get_layout_options","responses":{"200":{"description":"dashboards_get_layout_options_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/LayoutOption"}}},"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/studio-dashboards/widgets/{widgetType}/configuration":{"post":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_create_summary","description":"dashboards_widget_create_description","operationId":"dashboards_widget_create","parameters":[{"name":"widgetType","in":"path","description":"Create widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]},"color":{"type":["string","null"]},"visualization":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_widget_create_success_response","content":{"application/json":{"schema":{"required":["id"],"properties":{"id":{"title":"id","description":"Id of the created widget configuration","type":"integer","example":66}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/studio-dashboards/widgets/configurations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_config_collection_summary","description":"dashboards_widget_get_config_collection_description","operationId":"dashboards_widget_get_config_collection","responses":{"200":{"description":"dashboards_widget_get_config_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/DashboardsWidgetConfig"}}},"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/studio-dashboards/widgets/{widgetType}/data/{widgetId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_data_by_id_summary","description":"dashboards_widget_get_data_by_id_description","operationId":"dashboards_widget_get_data_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"dashboards_widget_get_data_by_id_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Widget data","type":"string","example":"Some data defined by the widget resolver"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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/bundle/studio-dashboards/widgets/{widgetType}/configuration/{widgetId}":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_config_by_id_summary","description":"dashboards_widget_get_config_by_id_description","operationId":"dashboards_widget_get_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Filter widgets by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Filter widgets by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"dashboards_widget_get_config_by_id_success_response","content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"title":"data","description":"Data of the widget configuration","type":"string","example":"Widget configuration data"}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}},"put":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_update_config_by_id_summary","description":"dashboards_widget_update_config_by_id_description","operationId":"dashboards_widget_update_config_by_id","parameters":[{"name":"widgetId","in":"path","description":"Update widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Update widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["data"],"properties":{"data":{"properties":{"name":{"type":["string","null"]},"color":{"type":["string","null"]},"visualization":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"dashboards_widget_update_config_by_id_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"}]}}}}}},"delete":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_delete_summary","description":"dashboards_widget_delete_description","operationId":"dashboards_widget_delete","parameters":[{"name":"widgetId","in":"path","description":"Delete widget by matching widget Id","required":true,"schema":{"type":"string","example":"d061699e_da42_4075_b504_c2c93c687819"}},{"name":"widgetType","in":"path","description":"Delete widget by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"dashboards_widget_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/bundle/studio-dashboards/widgets/{widgetType}/configurations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_configuration_options_summary","description":"dashboards_widget_get_configuration_options_description","operationId":"dashboards_widget_get_configuration_options","parameters":[{"name":"widgetType","in":"path","description":"Filter options by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"dashboards_widget_get_configuration_options_success_response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardsWidgetConfigConfiguration"}}}},"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/studio-dashboards/widgets/types":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_type_collection_summary","description":"dashboards_widget_get_type_collection_description","operationId":"dashboards_widget_get_type_collection","responses":{"200":{"description":"dashboards_widget_get_type_collection_success_response","content":{"application/json":{"schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WidgetType"}}},"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/studio-dashboards/widgets/{widgetType}/visualizations":{"get":{"tags":["Bundle Studio Dashboards"],"summary":"dashboards_widget_get_visualization_collection_summary","description":"dashboards_widget_get_visualization_collection_description","operationId":"dashboards_widget_get_visualization_collection","parameters":[{"name":"widgetType","in":"path","description":"Filter options by matching widget type","required":true,"schema":{"type":"string","example":"wysiwyg"}}],"responses":{"200":{"description":"dashboards_widget_get_visualization_collection_success_response","content":{"application/json":{"schema":{"required":["visualizations"],"properties":{"visualizations":{"title":"Visualizations","description":"Dashboard widget visualization options.","type":"array","items":{"type":"string","example":"table"}}},"type":"object"}}}},"default":{"description":"400 - Bad Request
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"}]}}}}}}}},"components":{"schemas":{"AMDCDLayout":{"title":"AMDCD_Layout","required":["name","dataType","type","region","title","width","height","collapsible","collapsed","bodyStyle","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":["string","null"],"example":"pimcore_root"},"dataType":{"description":"Data Type","type":"string","example":"layout"},"type":{"description":"Type","type":["string","null"],"example":null},"region":{"description":"Region","type":["string","null"],"example":"center"},"title":{"description":"Title","type":["string","null"],"example":"MyLayout"},"width":{"description":"Width","type":"integer","example":0},"height":{"description":"Height","type":"integer","example":0},"collapsible":{"description":"Collapsible","type":"boolean","example":false},"collapsed":{"description":"Collapsed","type":"boolean","example":false},"bodyStyle":{"description":"Body Style","type":["string","null"],"example":"(float: left;)"},"children":{"description":"Children","type":"array","items":{"type":"object"},"example":"[{id: 1}]"}},"type":"object"},"AMDCDListConfig":{"title":"AMDCD_ListConfig","description":"List version of config","required":["name","title","prefix","iconCls","layoutDefinitions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Author"},"title":{"description":"title","type":"string","example":"Name of Author"},"prefix":{"description":"Prefix","type":"string","default":"","example":"amcd"},"iconCls":{"description":"Icon Class","type":"string","default":"pimcore_icon_settings","example":"pimcore_icon_settings"},"layoutDefinitions":{"oneOf":[{"$ref":"#/components/schemas/AMDCDLayout","description":"layoutDefinitions"},{"type":"null"}],"description":"layoutDefinitions"}},"type":"object"},"AMDCDSimpleConfig":{"title":"AMDCD_SimpleConfig","description":"Simple version of config","required":["name","type","iconCls","expandable","leaf"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Author"},"title":{"description":"title","type":"string","example":"Name of Author"},"type":{"description":"Type","type":"string","default":"config","example":"config"},"iconCls":{"description":"Icon Class","type":"string","default":"pimcore_icon_settings","example":"pimcore_icon_settings"},"expandable":{"description":"Is Expandable","type":"boolean","default":false,"example":false},"leaf":{"description":"Is Leaf","type":"boolean","default":true,"example":true}},"type":"object"},"ActiveBundle":{"title":"Active Bundle","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Bundle name","type":"string","example":"PimcoreStudioBackendBundle"}},"type":"object"},"AddPerspectiveConfig":{"title":"Add Perspective Config","required":["name"],"properties":{"name":{"description":"Name","type":"string","example":"Cars"}},"type":"object"},"AdminSettings":{"title":"Admin Settings","required":["branding","assets","writeable"],"properties":{"branding":{"$ref":"#/components/schemas/Branding","description":"Branding configuration"},"assets":{"$ref":"#/components/schemas/Assets","description":"Assets configuration"},"writeable":{"description":"Whether the settings are writeable","type":"boolean","example":true}},"type":"object"},"AdminSettingsThumbnailPath":{"title":"Admin Settings Thumbnail Path","required":["customLogoSmall","customLogo","loginScreenCustomBackgroundImage"],"properties":{"customLogoSmall":{"description":"Path to custom logo thumbnail","type":["string","null"],"example":"/Sample%20Content/Background%20Images/321/image_small.png"},"customLogo":{"description":"Path to custom logo thumbnail","type":["string","null"],"example":"/Sample%20Content/Background%20Images/321/image-thumb.png"},"loginScreenCustomBackgroundImage":{"description":"Path to custom background image","type":["string","null"],"example":"/Sample%20Content/Background%20Images/317/background.png"}},"type":"object"},"AdvancedColumnConfig":{"title":"Advanced Column Config","required":["advancedColumns"],"properties":{"advancedColumns":{"description":"advancedColumns","type":"array","items":{"required":["key","config"],"properties":{"key":{"description":"Type of the column, e.g. \"simpleField\", \"relationField\", \"staticText\"","type":"string","example":"simpleField"},"config":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/RelationFieldConfig"},{"$ref":"#/components/schemas/SimpleFieldConfig"},{"$ref":"#/components/schemas/StaticTextConfig"}]},"example":{"field":"name","relation":"manufacturer"}}},"type":"object"},"example":[{"key":"simpleField","config":{"field":"name"}}]},"transformers":{"description":"List if Transformers that should be applied","type":"array","items":{"$ref":"#/components/schemas/Transformer"}}},"type":"object"},"AllowedTransition":{"title":"AllowedTransition","required":["name","label","iconCls","objectLayout","unsavedChangesBehaviour","notes"],"properties":{"name":{"description":"name","type":"string","example":"start_workflow"},"label":{"description":"label","type":"string","example":"Start Workflow"},"iconCls":{"description":"iconCls","type":"string","example":"pimcore_workflow_start"},"objectLayout":{"description":"objectLayout","type":"boolean","example":false},"unsavedChangesBehaviour":{"description":"unsavedChangesBehaviour","type":"string","example":"warn"},"notes":{"description":"notes","type":"array","items":{"type":"object"},"example":{"commentEnabled":true,"commentRequired":true}}},"type":"object"},"Archive":{"title":"Archive","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"}]},"RenderAreaBlockData":{"title":"Area block render data for editmode","required":["editableDefinitions","htmlCode"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"editableDefinitions":{"description":"Dynamic array of editable definitions","type":"array","items":{"type":"object"},"example":"[{ \"id\": \"editable_1\", \"type\": \"text\", \"config\": { \"label\": \"Text\", \"defaultValue\": \"Default text\" }, \"data\": { \"text\": \"Some text\" } }]"},"htmlCode":{"description":"HTML code of the snippet","type":"string","example":"
Some text
"}},"type":"object"},"Asset":{"title":"Asset","required":["hasChildren","type","filename","mimeType","hasMetadata","hasWorkflowWithPermissions","fullPath","customAttributes","permissions","hasWorkflowAvailable"],"type":"object","allOf":[{"$ref":"#/components/schemas/Element"},{"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"hasWorkflowAvailable":{"description":"Has workflow available","type":"boolean","example":false},"hasChildren":{"description":"Has children","required":["hasChildren"],"type":"boolean","example":false},"type":{"description":"Type","type":"string","example":"image"},"filename":{"description":"Filename","type":"string","example":"cool.jpg"},"mimeType":{"description":"Mimetype","type":["string","null"],"example":"image/jpeg"},"hasMetadata":{"description":"Has metadata","type":"boolean","example":false},"hasWorkflowWithPermissions":{"description":"Workflow permissions","type":"boolean","example":false},"fullPath":{"description":"Full path","type":"string","example":"/path/to/asset.jpg"},"permissions":{"$ref":"#/components/schemas/AssetPermissions"}},"type":"object"}]},"AssetDocument":{"title":"Asset Document","required":["pageCount","imageThumbnailPath"],"type":"object","allOf":[{"$ref":"#/components/schemas/Asset"},{"properties":{"pageCount":{"description":"Page count","type":["integer","null"],"example":2},"imageThumbnailPath":{"description":"Path to image thumbnail","type":["string","null"],"example":"/path/to/document/imagethumbnail.jpg"}},"type":"object"}]},"AssetFolder":{"title":"Asset Folder","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"}]},"AssetPermissions":{"title":"Asset Permissions","type":"object","allOf":[{"$ref":"#/components/schemas/Permissions"}]},"AssetType":{"title":"Asset Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"image"}},"type":"object"},"AssetUploadInfo":{"title":"Asset Upload Info","required":["exists","assetId"],"properties":{"exists":{"description":"True if asset exists","type":"boolean","example":true},"assetId":{"description":"Id of existing asset","type":["integer","null"],"example":83}},"type":"object"},"AssetVersion":{"title":"AssetVersion","required":["type","fileName","creationDate","fileSize","mimeType","metadata","dimensions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"type":{"description":"asset type","type":"string","example":"image"},"fileName":{"description":"file name","type":"string","example":"myImageFile.png"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":["integer","null"],"example":1707312457},"fileSize":{"description":"file size","type":"integer","example":41862},"mimeType":{"description":"mime type","type":"string","example":"image/png"},"metadata":{"description":"Metadata","type":"array","items":{"$ref":"#/components/schemas/CustomMetadataVersion"}},"dimensions":{"$ref":"#/components/schemas/Dimensions","description":"dimensions"}},"type":"object"},"Assets":{"title":"Assets","required":["hide_edit_image","disable_tree_preview"],"properties":{"hide_edit_image":{"description":"Hide edit image button","type":"boolean","example":false},"disable_tree_preview":{"description":"Disable tree preview","type":"boolean","example":true}},"type":"object"},"Audio":{"title":"Audio","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"}]},"AuthenticationToken":{"title":"Authentication Token","description":"Token for authentication","required":["token"],"properties":{"token":{"description":"Token","type":"string","example":"abc123xyz"}},"type":"object"},"AvailableCountry":{"title":"Available Country","required":["name","code"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Country name","type":"string","example":"Austria"},"code":{"description":"Country ISO 3166-1 code","type":"string","example":"AT"}},"type":"object"},"BlocklistEntry":{"title":"Blocklist","required":["email","creationDate","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"email":{"description":"email address","type":"string","example":"email@pimcore.com"},"creationDate":{"description":"creation date","type":"integer","example":1707312457},"modificationDate":{"description":"modification date","type":["integer","null"],"example":1707312457}},"type":"object"},"EmailAddressParameter":{"title":"Blocklist","required":["email"],"properties":{"email":{"description":"email address","type":"string","example":"someEmail@email-domain.com"}},"type":"object"},"Branding":{"title":"Branding","required":["backgroundShade","brandColor","loginScreenCustomBackgroundImage"],"properties":{"backgroundShade":{"description":"Background shade","type":"string","example":"#CCCCCC"},"brandColor":{"description":"Brand color","type":"string","example":"#FFCC00"},"loginScreenCustomBackgroundImage":{"oneOf":[{"$ref":"#/components/schemas/RelatedElementData","description":"Custom image for login screen"},{"type":"null"}],"description":"Custom image for login screen","type":"object"},"customLogo":{"oneOf":[{"$ref":"#/components/schemas/RelatedElementData","description":"Custom logo"},{"type":"null"}],"description":"Custom logo","type":"object"}},"type":"object"},"BundleApplicationLoggerLogEntry":{"title":"Bundle Application Logger Log Entry","required":["id","priority","date","pid","message","fileObject","relatedElementData","component","source"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"priority":{"description":"Log priority level","type":"integer","example":2},"date":{"description":"Date","type":["string","null"],"example":"2023-10-01T12:00:00+00:00"},"pid":{"description":"PID","type":["integer","null"],"example":22},"message":{"description":"Message","type":["string","null"],"example":"Some Log Message"},"fileObject":{"description":"File object path","type":["string","null"],"example":"path/to/file.txt"},"relatedElementData":{"oneOf":[{"$ref":"#/components/schemas/RelatedElementData","description":"Data of related element"},{"type":"null"}],"description":"Data of related element","type":"object"},"component":{"description":"Component","type":["string","null"],"example":"SomeComponent::Class"},"source":{"description":"Source","type":["string","null"],"example":"Pimcore\\Bundle"}},"type":"object"},"BundleBackendPowerToolsAETClassDefinitionField":{"title":"Bundle Backend Power Tools AET Class Definition Field","required":["name","title","fieldType","adapterType"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Field name","type":"string","example":"color"},"title":{"description":"Field title","type":"string","example":"Color"},"fieldType":{"description":"Field type","type":"string","example":"select"},"adapterType":{"description":"Adapter type","type":"string","example":"SimpleValueAdapter"},"additionalData":{"description":"Additional data for the field","type":["object","null"]}},"type":"object"},"BundleBackendPowerToolsAETConfigurationData":{"title":"Bundle Backend Power Tools AET Configuration Data","required":["id","general","dataSource","treeLevels","isWritable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"},"general":{"description":"General configuration settings","type":"object"},"dataSource":{"description":"Data source configuration","type":"object"},"treeLevels":{"description":"Tree level definitions","type":"array","items":{"type":"object"}},"isWritable":{"description":"Whether the configuration is writable","type":"boolean","example":true}},"type":"object"},"BundleBackendPowerToolsAETConfigurationDetails":{"title":"Bundle Backend Power Tools AET Configuration Details","required":["progressIndicatorPollInterval","allowDragAndDrop","classId","className","paths"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"icon":{"description":"Icon CSS class or path","type":["string","null"],"example":"pimcore_icon_settings"},"progressIndicatorPollInterval":{"description":"Poll interval for progress indicator in ms","type":"integer","example":5000},"allowDragAndDrop":{"description":"Whether drag and drop is allowed","type":"boolean","example":false},"classId":{"description":"Class definition ID","type":"string","example":"Car"},"className":{"description":"Class name","type":"string","example":"Car"},"paths":{"description":"Path definitions for the tree","type":"array","items":{"type":"object"}}},"type":"object"},"BundleBackendPowerToolsAETConfigurationId":{"title":"Bundle Backend Power Tools AET Configuration ID","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"}},"type":"object"},"BundleBackendPowerToolsAETConfigurationListGroup":{"title":"Bundle Backend Power Tools AET Configuration List Group","required":["id","text","expandable","leaf","allowChildren","iconCls","group","children"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Group identifier","type":"string","example":"group_my_group"},"text":{"description":"Display name of the group","type":"string","example":"My Group"},"expandable":{"description":"Whether the node is expandable","type":"boolean","example":true},"leaf":{"description":"Whether the node is a leaf node","type":"boolean","example":false},"allowChildren":{"description":"Whether children are allowed","type":"boolean","example":true},"iconCls":{"description":"Icon CSS class","type":"string","example":"pimcore_icon_folder"},"group":{"description":"Group name","type":"string","example":"My Group"},"children":{"description":"Child configuration items","type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETConfigurationListItem"}}},"type":"object"},"BundleBackendPowerToolsAETConfigurationListItem":{"title":"Bundle Backend Power Tools AET Configuration List Item","required":["id","text","expandable","leaf","writable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"},"text":{"description":"Display name of the configuration","type":"string","example":"My Custom Tree"},"expandable":{"description":"Whether the node is expandable","type":"boolean","example":false},"leaf":{"description":"Whether the node is a leaf node","type":"boolean","example":true},"iconCls":{"description":"Icon CSS class","type":["string","null"],"example":"pimcore_icon_settings"},"icon":{"description":"Custom icon path","type":["string","null"]},"isWritable":{"description":"Whether the configuration is writable","type":"boolean","example":true}},"type":"object"},"BundleBackendPowerToolsAETConfigurationModificationDate":{"title":"Bundle Backend Power Tools AET Configuration Modification Date","required":["modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"modificationDate":{"description":"Modification date as unix timestamp","type":"integer","example":1700000000}},"type":"object"},"BundleBackendPowerToolsAETDataObject":{"title":"Bundle Backend Power Tools AET Data Object","required":["text","allowDrag","allowDrop"],"type":"object","allOf":[{"$ref":"#/components/schemas/DataObject"},{"properties":{"text":{"description":"Text","type":"string","example":"orange (/Path/to/element/)"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true}},"type":"object"}]},"BundleBackendPowerToolsAETDataObjectClassItem":{"title":"Bundle Backend Power Tools AET Data Object Class Item","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Class ID","type":"string","example":"CAR"},"name":{"description":"Class name","type":"string","example":"Car"}},"type":"object"},"BundleBackendPowerToolsAETDefaultPerspectiveConfigurationItem":{"title":"Bundle Backend Power Tools AET Default Perspective Configuration Item","required":["id","name","position","type","expanded","hidden","sort"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"019a962e_40b9_7889_ba79_88f5871047a3"},"name":{"description":"Configuration display name","type":"string","example":"My Custom Tree"},"position":{"description":"Panel position","type":"string","example":"right"},"type":{"description":"Tree type","type":"string","example":"alternative_element_tree"},"expanded":{"description":"Whether the tree is expanded","type":"boolean","example":false},"hidden":{"description":"Whether the tree is hidden","type":"boolean","example":false},"sort":{"description":"Sort order","type":"integer","example":0}},"type":"object"},"BundleBackendPowerToolsAETGridBatchEditIds":{"title":"Bundle Backend Power Tools AET Grid Batch Edit IDs","required":["jobs"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"jobs":{"description":"Array of element IDs for batch editing","type":"array","items":{"type":"integer"}}},"type":"object"},"BundleBackendPowerToolsAETGridExportJobs":{"title":"Bundle Backend Power Tools AET Grid Export Jobs","required":["jobs","fileHandle"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"jobs":{"description":"Chunked arrays of element IDs for export","type":"array","items":{"type":"array","items":{"type":"integer"}}},"fileHandle":{"description":"File handle for the export CSV","type":"string","example":"export-65f1a2b3c4d5e6.12345678"}},"type":"object"},"BundleBackendPowerToolsAETGridListing":{"title":"Bundle Backend Power Tools AET Grid Listing","required":["total","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"total":{"description":"Total number of items","type":"integer","example":100},"data":{"description":"Grid listing data","type":"array","items":{"type":"object"}}},"type":"object"},"BundleBackendPowerToolsAETPreconditionFilterItem":{"title":"Bundle Backend Power Tools AET Precondition Filter Item","required":["name","value"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Filter name","type":"string","example":"Tag Filter"},"value":{"description":"Filter class value","type":"string","example":"App\\PreconditionFilter\\TagFilter"}},"type":"object"},"BundleBackendPowerToolsAETTreeConfigurationItem":{"title":"Bundle Backend Power Tools AET Tree Configuration Item","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Configuration ID","type":"string","example":"1ee8ea3a_843a_6a10_b965_c5dc3c5dac9b"},"name":{"description":"Configuration display name","type":"string","example":"My Custom Tree"}},"type":"object"},"BundleBackendPowerToolsAETValidLanguageItem":{"title":"Bundle Backend Power Tools AET Valid Language Item","required":["key","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Language key","type":"string","example":"en"},"name":{"description":"Language display name","type":"string","example":"English"}},"type":"object"},"BundleBackendPowerToolsAETVirtualFolder":{"title":"Bundle Backend Power Tools AET Virtual Folder","required":["id","type","key","path","icon","allowDrag","allowDrop","hasChildren","level"],"properties":{"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"1f0a82ba_4398_61a8_a4c3_016155cfcb10"},"type":{"description":"Type","type":"string","example":"folder"},"key":{"description":"Key","type":"string","example":"City Car"},"path":{"description":"Path","type":"string","example":"/City Car/"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":true},"level":{"description":"Level of the folder","type":"integer","example":2}},"type":"object"},"BundleBackendPowerToolsAETWidgetConfig":{"title":"Bundle Backend Power Tools Alternative Element Tree Widget Config","required":["progressIndicatorPollInterval","label","classId","className","workspaces"],"type":"object","allOf":[{"$ref":"#/components/schemas/WidgetConfig"},{"properties":{"progressIndicatorPollInterval":{"description":"Progress indicator poll interval in ms","type":"integer","example":60000},"label":{"description":"Configuration label","type":["string","null"],"example":"My custom AET"},"classId":{"description":"Configuration class ID","type":["string","null"],"example":"CAR"},"className":{"description":"Configuration class name","type":["string","null"],"example":"Car"},"workspaces":{"description":"Workspaces","type":"array","items":{"$ref":"#/components/schemas/BundleBackendPowerToolsAETWidgetConfigPath"}}},"type":"object"}]},"BundleBackendPowerToolsAETWidgetConfigPath":{"title":"Bundle Backend Power Tools Alternative Element Tree Widget Config Path","required":["workspaceItem","include"],"properties":{"workspaceItem":{"$ref":"#/components/schemas/RelatedElementData","description":"Data of the workspace item"},"include":{"description":"Include workspace","type":"boolean","example":false}},"type":"object"},"BundleBackendPowerToolsBLTreeAsset":{"title":"Bundle Backend Power Tools BL Tree Asset","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#/components/schemas/Asset"},{"properties":{"text":{"description":"Text","type":"string","example":"key (/Path/to/element/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (/Path/to/element/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeDataObject":{"title":"Bundle Backend Power Tools BL Tree Data Object","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#/components/schemas/DataObject"},{"properties":{"text":{"description":"Text","type":"string","example":"key (/Path/to/element/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (/Path/to/element/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeDocument":{"title":"Bundle Backend Power Tools BL Tree Document","required":["text","itemId","originalId","uid","allowDrag","allowDrop","sortOrder"],"type":"object","allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"text":{"description":"Text","type":"string","example":"key (/Path/to/element/)"},"itemId":{"description":"Item ID in the tree","type":"integer","example":1},"originalId":{"description":"Original ID","type":"string","example":"83-object"},"uid":{"description":"UID","type":"string","example":"24-object-root"},"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"string","example":"key (/Path/to/element/)"}},"type":"object"}]},"BundleBackendPowerToolsBLTreeFolder":{"title":"Bundle Backend Power Tools BL Tree Folder","required":["id","originalId","uid","type","elementType","parentId","key","icon","allowDrag","allowDrop","hasChildren","sortOrder"],"properties":{"customAttributes":{"$ref":"#/components/schemas/CustomAttributes","description":"Custom attributes for the tree"},"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":83},"originalId":{"description":"Original ID","type":"string","example":"83-bookmark_folder"},"uid":{"description":"UID","type":"string","example":"24-bookmark_folder-root"},"type":{"description":"Type","type":"string","example":"folder"},"elementType":{"description":"ElementType","type":"string","example":"bookmark_folder"},"parentId":{"description":"Parent ID","type":"integer","example":0},"key":{"description":"Key","type":"string","example":"City Car"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"allowDrag":{"description":"Allow drag of this element","type":"boolean","example":false},"allowDrop":{"description":"Allow drop of new element","type":"boolean","example":false},"hasChildren":{"description":"Has children","type":"boolean","example":true},"sortOrder":{"description":"Sort order","type":"integer","example":0}},"type":"object"},"BundleBackendPowerToolsBookmarkList":{"title":"Bundle Backend Power Tools Bookmark List","required":["id","name","sortBy","owner","isOwner","itemCount","creationDate","shared","permission"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"name":{"description":"Name","type":"string","example":"My bookmark list"},"sortBy":{"description":"Sort by field","type":"string","example":"name"},"owner":{"description":"Owner username","type":"string","example":"admin"},"isOwner":{"description":"Is current user the owner","type":"boolean","example":true},"itemCount":{"description":"Number of items in the list","type":"integer","example":0},"creationDate":{"description":"Creation date timestamp","type":"integer","example":1760593921},"shared":{"description":"Is shared with other users","type":"boolean","example":false},"permission":{"description":"Permission level","type":"string","example":"edit"}},"type":"object"},"BundleBackendPowerToolsShareRecipient":{"title":"Bundle Backend Power Tools Share Recipient","required":["permission","recipientName","recipientId"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"permission":{"description":"Permission","type":"string","example":"edit"},"recipientName":{"description":"Recipient name","type":"string","example":"nameOfRecipient"},"recipientId":{"description":"Recipient Id","type":"integer","example":1}},"type":"object"},"BundleBackendPowerToolsShareUser":{"title":"Bundle Backend Power Tools Share User","required":["id","name","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User Id","type":"integer","example":1},"name":{"description":"User name","type":"string","example":"someAdminUser (Admin)"},"type":{"description":"Type","type":"string","example":"user"}},"type":"object"},"BundleCopilotAction":{"title":"Bundle Copilot Action","required":["title","jsAdapterName","jsConfig","icon","iconCls","context","searchTerms","category","labelClass"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"title":{"description":"Title","type":"string","example":"Car Variant Generator"},"jsAdapterName":{"description":"JS adapter name","type":"string","example":"automationActionAdapter"},"jsConfig":{"description":"JS configuration","type":"object","example":"{\"key\":\"value\"}"},"context":{"description":"Context","type":"array","items":{"type":"string"},"example":"[\"object_car\", \"object_car_selection\"]"},"searchTerms":{"description":"Search terms","type":"array","items":{"type":"string"},"example":"[\"Car Variant Generator\", \"Automation Action\"]"},"category":{"description":"Category","type":"string","example":"automation_action"},"labelClass":{"description":"Label class","type":"string","example":"blue"},"icon":{"description":"Icon","type":["string","null"],"example":"/bundles/pimcoreadmin/img/flat-color-icons/page.svg"},"iconCls":{"description":"Icon class","type":["string","null"],"example":"plugin_pimcore_automation_actions"}},"type":"object"},"BundleCopilotActionInteractionChatHistory":{"title":"Bundle Copilot Action Interaction Chat History","required":["content","role"],"properties":{"content":{"description":"Content","type":"string","example":"Generate a description for the classic ..."},"role":{"description":"Role","type":"string","example":"user"},"prompt":{"description":"Prompt","type":["string","null"],"example":""},"negativePrompt":{"description":"Negative prompt","type":["string","null"],"example":""},"imageMimeType":{"description":"Image mime type","type":["string","null"],"example":"image/jpeg"}},"type":"object"},"BundleCopilotActionInteractionOneStep":{"title":"Bundle Copilot Action Interaction One Step","required":["result"],"properties":{"result":{"description":"Result","type":"string","example":"The Cobra is a masterpiece of engineering..."}},"type":"object"},"BundleCopilotJobRun":{"title":"Bundle Copilot Job Run","required":["id","jobName","startedAt","lastUpdated","owner","state","currentMessage","canCancel"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":"3"},"jobName":{"description":"Job name","type":"string","example":"CarVariantGenerator"},"startedAt":{"description":"Job run started at","type":"integer","example":"1760355978"},"lastUpdated":{"description":"Job run last updated at","type":"integer","example":"1760355978"},"owner":{"description":"Job owner","type":"string","example":"admin"},"state":{"description":"Job state","type":"string","example":"finished"},"currentMessage":{"description":"Current log message","type":"string","example":"Job Run CarVariantGenerator (3) completed successfully."},"canCancel":{"description":"Job run can be cancelled","type":"boolean","example":"false"},"currentStep":{"description":"Current step nr","type":["integer","null"],"example":"1"}},"type":"object"},"BundleCopilotJobRunId":{"title":"Bundle Copilot Job Run Id","required":["id"],"properties":{"id":{"description":"Id","type":"integer","example":"3"}},"type":"object"},"BundleCopilotJobRunProgress":{"title":"Bundle Copilot Job Run Progress","required":["success","state","currentMessage","displayLogDetailLink","totalSteps","startedAt","lastUpdated","log"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"success":{"description":"Success state of job run","type":"boolean","example":"true"},"state":{"description":"Job state","type":"string","example":"finished"},"currentMessage":{"description":"Current log message","type":"string","example":"Job Run CarVariantGenerator (3) completed successfully."},"displayLogDetailLink":{"description":"Display log detail link","type":"boolean","example":"true"},"totalSteps":{"description":"Nr of total steps","type":"integer","example":"1"},"startedAt":{"description":"Job run started at","type":"integer","example":"1760355978"},"lastUpdated":{"description":"Job run last updated at","type":"integer","example":"1760355978"},"log":{"description":"Log","type":"array","items":{"type":"object","format":"string"},"example":"\n [{\"logMessage\": \"Job Run CarVariantGenerator (13) started.\",\"createdAt\": \"2024-01-01T12:00:00+00:00\"}]"},"currentStep":{"description":"Current step nr","type":["integer","null"],"example":"1"}},"type":"object"},"BundleCustomReportAdd":{"title":"Bundle Custom Report Add","required":["name"],"properties":{"name":{"description":"Name of the new custom report","type":"string","example":"myReport"}},"type":"object"},"BundleCustomReportClone":{"title":"Bundle Custom Report Clone","required":["newName"],"properties":{"newName":{"description":"New name the cloned custom report","type":"string","example":"myNewReport"}},"type":"object"},"BundleCustomReportUpdate":{"title":"Bundle Custom Report Update","required":["sql","dataSourceConfig","columnConfigurations","niceName","group","groupIconClass","iconClass","menuShortcut","reportClass","chartType","pieColumn","pieLabelColumn","xAxis","yAxis","sharedUserNames","sharedRoleNames","sharedGlobally"],"properties":{"sql":{"description":"Sql","type":"string","example":""},"columnConfigurations":{"description":"Configuration for columns to be displayed in report","type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsColumnConfigurationUpdate"}},"niceName":{"description":"Label/nice name of report","type":"string","example":"Attributes"},"group":{"description":"Group of the report","type":"string","example":"My Reports"},"groupIconClass":{"description":"Group icon class","type":"string","example":"pimcore_group_icon_attributes"},"iconClass":{"description":"Icon class","type":"string","example":"pimcore_icon_attributes"},"menuShortcut":{"description":"Whether the report has a shortcut in the menu","type":"boolean","example":true},"reportClass":{"description":"Report class of custom report implementation","type":"string","example":""},"chartType":{"description":"Chart type","type":"string","example":"pie"},"sharedUserNames":{"description":"Array with user names the report is shared with","type":"array","items":{"type":"string"},"example":"[\"admin\", \"superuser\"]"},"sharedRoleNames":{"description":"Array with roles the report is shared with","type":"array","items":{"type":"string"},"example":"[\"role\", \"role2\"]"},"sharedGlobally":{"description":"Whether the report is shared globally","type":"boolean","example":false},"dataSourceConfig":{"description":"Configuration for data source. Content of array depends on selected adapter/data source","type":"array","items":{"type":"object"},"example":[{"sql":"carClass","from":"object_localized_CAR_en","where":"objectType = 'actual-car'","groupby":"carClass","orderby":"","orderbydir":null,"type":"sql"}]},"pieColumn":{"description":"Data column for pie chart","type":["string","null"],"example":"count(*)"},"pieLabelColumn":{"description":"Label of data column for pie chart","type":["string","null"],"example":"attributesAvailable"},"xAxis":{"description":"X axis column names","type":["string","null"],"example":"attributesAvailable"},"yAxis":{"description":"Y axis column information","type":["array","null"],"items":{"type":"string"},"example":"[\"attributesAvailable\", \"count(*)\"]"}},"type":"object"},"BundleCustomReportsChartData":{"title":"Bundle Custom Reports Chart Data","required":["data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"Chart data depending on the adapter in the report configuration.","type":"object"}},"type":"object"},"BundleCustomReportsColumnConfiguration":{"title":"Bundle Custom Reports Column Configuration","required":["disableOrderBy","disableFilterable","disableDropdownFilterable","disableLabel"],"type":"object","allOf":[{"$ref":"#/components/schemas/BundleCustomReportsColumnConfigurationUpdate"},{"properties":{"name":{"description":"Name","type":"string","example":"attributesAvailable"},"display":{"description":"Display column","type":"boolean","example":true},"export":{"description":"Whether the column should be included in exports","type":"boolean","example":true},"order":{"description":"Order","type":"boolean","example":true},"label":{"description":"Label/display name of column","type":"string","example":"Attributes"},"action":{"description":"Action of the column","type":"string","example":"openObject"},"id":{"description":"Id","type":"string","example":"401-3"},"width":{"description":"Width of the column","type":["integer","null"],"example":200},"displayType":{"description":"Display type of the column","type":["string","null"],"example":"text"},"filterType":{"description":"Type of the filter","type":["string","null"],"example":"numeric"},"filterDrilldown":{"description":"Drilldown filter","type":["string","null"],"example":"only_filter"},"disableOrderBy":{"description":"Disable order by","type":"boolean","example":false},"disableFilterable":{"description":"Disable filterable","type":"boolean","example":false},"disableDropdownFilterable":{"description":"Disable dropdown filterable","type":"boolean","example":false},"disableLabel":{"description":"Disable label","type":"boolean","example":false}},"type":"object"}]},"BundleCustomReportsColumnConfigurationUpdate":{"title":"Bundle Custom Reports Column Configuration Update Data","required":["name","display","export","order","label","action","id","width","displayType","filterType","filterDrilldown"],"properties":{"name":{"description":"Name","type":"string","example":"attributesAvailable"},"display":{"description":"Display column","type":"boolean","example":true},"export":{"description":"Whether the column should be included in exports","type":"boolean","example":true},"order":{"description":"Order","type":"boolean","example":true},"label":{"description":"Label/display name of column","type":"string","example":"Attributes"},"action":{"description":"Action of the column","type":"string","example":"openObject"},"id":{"description":"Id","type":"string","example":"401-3"},"width":{"description":"Width of the column","type":["integer","null"],"example":200},"displayType":{"description":"Display type of the column","type":["string","null"],"example":"text"},"filterType":{"description":"Type of the filter","type":["string","null"],"example":"numeric"},"filterDrilldown":{"description":"Drilldown filter","type":["string","null"],"example":"only_filter"}},"type":"object"},"BundleCustomReportsColumnInformation":{"title":"Bundle Custom Reports Column Information","required":["name","disableOrderBy","disableFilterable","disableDropdownFilterable","disableLabel"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"attributesAvailable"},"disableOrderBy":{"description":"Disable order by","type":"boolean","example":false},"disableFilterable":{"description":"Disable filterable","type":"boolean","example":false},"disableDropdownFilterable":{"description":"Disable dropdown filterable","type":"boolean","example":false},"disableLabel":{"description":"Disable label","type":"boolean","example":false}},"type":"object"},"BundleCustomReportsConfigurationTreeNode":{"title":"Bundle Custom Reports Configuration Tree Node","required":["id","text","cls","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"Quality_Attributes"},"text":{"description":"text","type":"string","example":"Quality_Attributes"},"cls":{"description":"css class","type":"string","example":"pimcore_treenode_disabled"},"writeable":{"description":"writeable","type":"boolean","example":true}},"type":"object"},"BundleCustomReportsDataSourceConfig":{"title":"Bundle Custom Reports Data Source Config","required":["configuration"],"properties":{"configuration":{"description":"Configuration for data source. Content of array depends on selected adapter/data source","type":"object","example":{"sql":"carClass","from":"object_localized_CAR_en","where":"objectType = 'actual-car'","groupby":"carClass","orderby":"","orderbydir":null,"type":"sql"}}},"type":"object"},"BundleCustomReportsDetails":{"title":"Bundle Custom Reports Details","required":["name","sql","dataSourceConfig","columnConfigurations","niceName","group","groupIconClass","iconClass","menuShortcut","reportClass","chartType","pieColumn","pieLabelColumn","xAxis","yAxis","modificationDate","creationDate","sharedUserNames","sharedRoleNames","sharedGlobally","writeable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":"string","example":"Quality_Attributes"},"sql":{"description":"Sql","type":"string","example":""},"columnConfigurations":{"description":"Configuration for columns to be displayed in report","type":"array","items":{"$ref":"#/components/schemas/BundleCustomReportsColumnConfiguration"}},"niceName":{"description":"Label/nice name of report","type":"string","example":"Attributes"},"group":{"description":"Group of the report","type":"string","example":"My Reports"},"groupIconClass":{"description":"Group icon class","type":"string","example":"pimcore_group_icon_attributes"},"iconClass":{"description":"Icon class","type":"string","example":"pimcore_icon_attributes"},"menuShortcut":{"description":"Whether the report has a shortcut in the menu","type":"boolean","example":true},"reportClass":{"description":"Report class of custom report implementation","type":"string","example":""},"chartType":{"description":"Chart type","type":"string","example":"pie"},"modificationDate":{"description":"Modification date time stamp","type":"integer","example":1736762668},"creationDate":{"description":"Creation date time stamp","type":"integer","example":1567409307},"sharedUserNames":{"description":"Array with user names the report is shared with","type":"array","items":{"type":"string"},"example":"[\"admin\", \"superuser\"]"},"sharedRoleNames":{"description":"Array with roles the report is shared with","type":"array","items":{"type":"string"},"example":"[\"role\", \"role2\"]"},"sharedGlobally":{"description":"Whether the report is shared globally","type":"boolean","example":false},"writeable":{"description":"Whether the report is writeable","type":"boolean","example":true},"dataSourceConfig":{"description":"Configuration for data source. Content of array depends on selected adapter/data source","type":["object","null"],"example":[]},"pieColumn":{"description":"Data column for pie chart","type":["string","null"],"example":"count(*)"},"pieLabelColumn":{"description":"Label of data column for pie chart","type":["string","null"],"example":"attributesAvailable"},"xAxis":{"description":"X axis column names","type":["string","null"],"example":"attributesAvailable"},"yAxis":{"description":"Y axis column information","type":["array","null"],"items":{"type":"string"},"example":"[\"attributesAvailable\", \"count(*)\"]"}},"type":"object"},"BundleCustomReportsDrillDownOption":{"title":"Bundle Custom Reports Drill Down Option","description":"Drill down option data for custom reports","required":["name","value"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"name","example":"Full-Size","anyOf":[{"type":"string"},{"type":"integer"},{"type":"float"}]},"value":{"description":"value","example":"Full-Size","anyOf":[{"type":"string"},{"type":"integer"},{"type":"float"},{"type":"null"}]}},"type":"object"},"BundleCustomReportsSaveWidgetConfig":{"title":"Bundle Custom Reports Save Widget Config","required":["customReportName"],"type":"object","allOf":[{"$ref":"#/components/schemas/CreateWidgetConfig"},{"properties":{"customReportName":{"description":"Report Configuration Name","type":"string","example":"Quality_Attributes"},"showLegend":{"description":"Show Legend","type":"boolean","example":true}},"type":"object"}]},"BundleCustomReportsTreeNode":{"title":"Bundle Custom Reports Tree Node","required":["name","niceName","iconClass","group","groupIconClass","menuShortcut","reportClass","hasDataSourceConfig"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"report name","type":"string","example":"Quality_Attributes"},"niceName":{"description":"nice name","type":"string","example":"Attributes"},"iconClass":{"description":"icon class","type":"string","example":"pimcore_icon_attributes"},"group":{"description":"group","type":"string","example":"Quality"},"groupIconClass":{"description":"group icon class","type":"string","example":"pimcore_group_icon_attributes"},"menuShortcut":{"description":"menu shortcut","type":"boolean","example":true},"reportClass":{"description":"report class","type":"string","example":""},"hasDataSourceConfig":{"description":"Whether the report has a data source configuration.","type":"boolean","example":false}},"type":"object"},"BundleCustomReportsWidgetConfig":{"title":"Bundle Custom Reports Widget Config","required":["color","customReportName","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig"},{"properties":{"color":{"description":" Color","type":"string","example":"#FF5733"},"customReportName":{"description":"Report Configuration Name","type":"string","example":"Quality_Attributes"},"isWriteable":{"description":"Is Writeable","type":"boolean","example":true},"showLegend":{"description":"Show Legend","type":"boolean","example":true}},"type":"object"}]},"BundleDataHubConfiguration":{"title":"Bundle Data Hub Configuration","required":["id","text","type","iconCls","expandable","leaf","adapter","writable","permissions","studioColumnConfig"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"string","example":"assets"},"text":{"description":"Text","type":"string","example":"assets"},"type":{"description":"Type","type":"string","example":"config"},"iconCls":{"description":"iconCls","type":"string","example":"plugin_pimcore_datahub_icon_graphql"},"expandable":{"description":"Expandable","type":"boolean","example":"false"},"leaf":{"description":"Leaf","type":"boolean","example":"true"},"permissions":{"description":"Permissions","type":["object","null"],"example":"{\"delete\": true, \"update\": true}"},"allowChildren":{"description":"Allow children","type":"boolean","example":"false"},"group":{"description":"Group","type":["string","null"],"example":"General Folder"},"children":{"description":"Children","type":["array","null"],"items":{"$ref":"#/components/schemas/BundleDataHubConfiguration"}},"adapter":{"description":"Adapter","type":["string","null"],"example":"graphql"},"writable":{"description":"Writable","type":"boolean","example":"true"},"studioColumnConfig":{"description":"Has Studio Column Configuration","type":"boolean","example":"false"}},"type":"object"},"BundleDataHubConfigurationDetail":{"title":"Bundle Data Hub Configuration Detail","required":["name","configuration","userPermissions","supportedGraphQLQueryDataTypes","supportedGraphQLMutationDataTypes","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"assets"},"configuration":{"description":"Configuration data","type":"object"},"userPermissions":{"description":"User permissions","type":"object","example":{"update":true,"delete":true}},"supportedGraphQLQueryDataTypes":{"description":"Supported GraphQL query data types","type":"array","items":{"type":"string"}},"supportedGraphQLMutationDataTypes":{"description":"Supported GraphQL mutation data types","type":"array","items":{"type":"string"}},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubFileExportConfigurationDetail":{"title":"Bundle Data Hub File Export Configuration Detail","required":["name","configuration","userPermissions","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"my-file-export"},"configuration":{"description":"Configuration data","type":"object"},"userPermissions":{"description":"User permissions","type":"object","example":{"update":true,"delete":true}},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubFileExportCronValidationResult":{"title":"Bundle Data Hub File Export Cron Validation Result","required":["isValid","message"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isValid":{"description":"Whether the cron expression is valid","type":"boolean","example":true},"message":{"description":"Validation error message (empty if valid)","type":"string","example":""}},"type":"object"},"BundleDataHubFileExportExportProgress":{"title":"Bundle Data Hub File Export Export Progress","required":["isRunning","totalItems","processedItems","progress"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"isRunning":{"description":"Whether the export is currently running","type":"boolean","example":true},"totalItems":{"description":"Total number of items to export","type":"integer","example":100},"processedItems":{"description":"Number of items already processed","type":"integer","example":42},"progress":{"description":"Progress ratio (0.0 to 1.0)","type":"number","format":"float","example":0.42}},"type":"object"},"BundleDataHubFileExportExporterService":{"title":"Bundle Data Hub File Export Exporter Service","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Exporter service identifier","type":"string","example":"my_exporter_service"}},"type":"object"},"BundleDataHubFileExportExporterType":{"title":"Bundle Data Hub File Export Exporter Type","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Exporter type name","type":"string","example":"CSV"}},"type":"object"},"BundleDataHubFileExportStartExport":{"title":"Bundle Data Hub File Export Start Export","required":["configName"],"properties":{"configName":{"description":"Configuration name to export","type":"string","example":"my-file-export"},"onlyQueueItems":{"description":"Only process queued items","type":"boolean","example":false}},"type":"object"},"BundleDataHubFileExportThumbnailCollection":{"title":"Bundle Data Hub File Export Thumbnail Collection","required":["imageThumbnails","videoThumbnails"],"properties":{"imageThumbnails":{"description":"Image thumbnail configurations","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubFileExportThumbnailItem"}},"videoThumbnails":{"description":"Video thumbnail configurations","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubFileExportThumbnailItem"}}},"type":"object"},"BundleDataHubFileExportThumbnailItem":{"title":"Bundle Data Hub File Export Thumbnail Item","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Thumbnail configuration name (empty string for none/original)","type":"string","example":"content"},"text":{"description":"Display text","type":"string","example":"content - Content Thumbnail"}},"type":"object"},"BundleDataHubFileExportUpdateConfiguration":{"title":"Bundle Data Hub File Export Update Configuration","required":["data"],"properties":{"data":{"description":"Configuration data containing general, schema, workspaceSettings, workspaces, deliveryDestination, triggerForDelivery, executionConfig, and permissions","type":"object","example":{"general":{"active":false,"type":"fileExport","name":"my-export","description":"","group":""},"schema":{"classId":"Product","thumbnailImage":null,"thumbnailVideo":null,"columns":[{"key":"id","fieldtype":"system","type":"system.id","locale":null},{"key":"name","fieldtype":"input","type":"dataobject.adapter","locale":"en","config":[]}]},"workspaceSettings":{"customExportService":""},"workspaces":{"object":[{"read":true,"cpath":"/Products"}]},"deliveryDestination":{"filetype":"CSV","delimiter":";","dateFormat":"","filename":"export","conflictStrategy":"overwrite","transmitter":"localDirectory","transmitter_localDirectory":{"directory":"/path/to/export"}},"triggerForDelivery":{"saveHookType":""},"executionConfig":{"cronDefinitionFullExport":"","cronDefinitionQueueOnly":""},"permissions":{"user":[{"id":1,"name":"John Doe","read":true}],"role":[{"id":2,"name":"Editor","update":true}]}}},"saveType":{"description":"Save type, use \"reset\" to reset export tracking data","type":["string","null"],"example":"regular"}},"type":"object"},"BundleDataHubFileExportUpdateConfigurationResponse":{"title":"Bundle Data Hub File Export Update Configuration Response","required":["modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"modificationDate":{"description":"New modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubPermissionUser":{"title":"Bundle Data Hub Permission User","required":["id","text","elementType"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User or Role ID","type":"integer","example":42},"text":{"description":"User or Role name","type":"string","example":"admin"},"elementType":{"description":"Element type","type":"string","example":"user"}},"type":"object"},"BundleDataHubSimpleRestConfigurationDetail":{"title":"Bundle Data Hub Simple Rest Configuration Detail","required":["name","configuration","userPermissions","modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"my-rest-config"},"configuration":{"description":"Configuration data","type":"object"},"userPermissions":{"description":"User permissions","type":"object","example":{"update":true,"delete":true}},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubSimpleRestLabel":{"title":"Bundle Data Hub Simple Rest Label","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Label key from the search index","type":"string","example":"dimensionData.height"}},"type":"object"},"BundleDataHubSimpleRestQueueItemCount":{"title":"Bundle Data Hub Simple Rest Queue Item Count","required":["count"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"count":{"description":"Number of items in the indexing queue","type":"integer","example":42}},"type":"object"},"BundleDataHubSimpleRestThumbnail":{"title":"Bundle Data Hub Simple Rest Thumbnail","required":["name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Thumbnail configuration name","type":"string","example":"content"}},"type":"object"},"BundleDataHubSimpleRestUpdateConfiguration":{"title":"Bundle Data Hub Simple Rest Update Configuration","required":["data","modificationDate"],"properties":{"data":{"description":"Configuration data containing general, schema, deliverySettings, workspaces, labelSettings, and permissions","type":"object","example":{"general":{"active":true,"type":"Simple Rest Service","name":"test","description":"Test Description","group":"Test Group"},"schema":{"assets":{"enabled":"on","allowOriginalImage":"on","thumbnails":["cart","events_header"]},"dataObjectClasses":[{"id":"car","columns":[{"key":"id","fieldtype":"system","type":"system.id","locale":null},{"key":"someImage","fieldtype":"image","type":"dataobject.adapter","locale":"de","config":[]}]}]},"deliverySettings":{"apikey":"key1\nkey2"},"workspaces":{"asset":[{"read":false,"cpath":"/Assets"}],"object":[{"read":true,"cpath":"/Products"}]},"labelSettings":[{"id":"dimensionData.height","en":"Height","useInAggs":true}],"permissions":{"user":[{"id":1,"name":"John Doe","read":true}],"role":[{"id":2,"name":"Editor","update":true}]}}},"modificationDate":{"description":"Client-side modification date timestamp for conflict detection","type":"integer","example":1768215191}},"type":"object"},"BundleDataHubSimpleRestUpdateConfigurationResponse":{"title":"Bundle Data Hub Simple Rest Update Configuration Response","required":["modificationDate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"modificationDate":{"description":"New modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubThumbnail":{"title":"Bundle Data Hub Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Thumbnail ID","type":"string","example":"content"},"text":{"description":"Thumbnail name","type":"string","example":"content"}},"type":"object"},"BundleDataHubUpdateConfiguration":{"title":"Bundle Data Hub Update Configuration","required":["data","modificationDate"],"properties":{"data":{"description":"JSON-encoded configuration containing general, schema, security, workspaces, and permissions","type":"string","example":"{\"general\":{\"active\":true,\"type\":\"GraphQL\",\"name\":\"assets\",\"description\":\"\",\"group\":\"GQL\"},\"schema\":{\"queryEntities\":[],\"mutationEntities\":[],\"specialEntities\":[]},\"security\":{\"method\":\"datahub_apikey\",\"apikey\":\"your-key\",\"skipPermissionCheck\":false,\"disableIntrospection\":false},\"workspaces\":{\"asset\":[],\"document\":[],\"object\":[]},\"permissions\":{\"user\":[],\"role\":[]}}"},"modificationDate":{"description":"Client-side modification date timestamp for conflict detection","type":"integer","example":1768215191}},"type":"object"},"BundleDataHubUpdateConfigurationResponse":{"title":"Bundle Data Hub Update Configuration Response","required":["modificationDate"],"properties":{"modificationDate":{"description":"New modification date timestamp","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubWebhooksConfigurationDetail":{"title":"Bundle Data Hub Webhooks Configuration Detail","required":["name","configuration","userPermissions","modificationDate","documentTypes","assetTypes","imageData","videoData","events","workflows"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Configuration name","type":"string","example":"my_webhook"},"configuration":{"description":"Full configuration data","type":"object"},"userPermissions":{"description":"User permissions","type":"object","example":{"update":true,"delete":true}},"modificationDate":{"description":"Modification date timestamp","type":"integer","example":1705075200},"documentTypes":{"description":"Available document types","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksLabelItem"}},"assetTypes":{"description":"Available asset types","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksLabelItem"}},"imageData":{"description":"Available image thumbnail configurations","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksIdLabelItem"}},"videoData":{"description":"Available video thumbnail configurations","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksIdLabelItem"}},"events":{"description":"Available webhook event types","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksIdLabelItem"}},"workflows":{"description":"Available workflows","type":"array","items":{"$ref":"#/components/schemas/BundleDataHubWebhooksIdLabelItem"}}},"type":"object"},"BundleDataHubWebhooksIdLabelItem":{"title":"Bundle Data Hub Webhooks Id Label Item","required":["id","label"],"properties":{"id":{"description":"Identifier","type":"string","example":"pimcore.dataobject.postAdd"},"label":{"description":"Display label","type":"string","example":"Data Object - Post Add"}},"type":"object"},"BundleDataHubWebhooksLabelItem":{"title":"Bundle Data Hub Webhooks Label Item","required":["label"],"properties":{"label":{"description":"Label","type":"string","example":"Page"}},"type":"object"},"BundleDataHubWebhooksTestSubscribersParameters":{"title":"Bundle Data Hub Webhooks Test Subscribers Parameters","required":["subscribers"],"properties":{"subscribers":{"description":"List of subscriber URLs to test","type":"array","items":{"type":"string"},"example":["https://webhook.site/example-uuid"]}},"type":"object"},"BundleDataHubWebhooksTestSubscribersResponse":{"title":"Bundle Data Hub Webhooks Test Subscribers Response","required":["success","errors"],"properties":{"success":{"description":"Whether all subscribers are reachable","type":"boolean","example":true},"errors":{"description":"Error messages from unreachable subscribers","type":"array","items":{"type":"string"}}},"type":"object"},"BundleDataHubWebhooksUpdateConfiguration":{"title":"Bundle Data Hub Webhooks Update Configuration","required":["configuration","modificationDate"],"properties":{"configuration":{"description":"Configuration object containing general, eventsSchema, subscribersSettings, workspaces, and permissions","type":"object","example":{"general":{"active":true,"name":"my_webhook"},"subscribersSettings":{"subscribers":["https://example.com/webhook"],"customHeaders":[]},"eventsSchema":{"events":["pimcore.dataobject.postAdd"]},"workspaces":{"asset":[],"object":[],"document":[]},"permissions":{"user":[],"role":[]}}},"modificationDate":{"description":"Client-side modification date timestamp for optimistic locking","type":"integer","example":1705075200}},"type":"object"},"BundleDataHubWebhooksUpdateConfigurationResponse":{"title":"Bundle Data Hub Webhooks Update Configuration Response","required":["modificationDate"],"properties":{"modificationDate":{"description":"New modification date timestamp after save","type":"integer","example":1705075200}},"type":"object"},"BundleDataQualityManagementColorSettings":{"title":"Bundle Data Quality Management Color Settings","required":["mark","fontColor","backgroundColor"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"mark":{"description":"Mark","type":"string","example":"A"},"fontColor":{"description":"Hex code of the font color","type":"string","example":"#104400"},"backgroundColor":{"description":"Hex code of the background color","type":"string","example":"#DAECB8"}},"type":"object"},"BundleDataQualityManagementDetailWidget":{"title":"Bundle Data Quality Management Detail Widget","required":["name","title","mark","score","rules","lastUpdated"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Data quality field name","type":"string","example":"textsAvailable"},"title":{"description":"Data quality field title","type":"string","example":"Texts Available"},"mark":{"description":"Mark for the data quality field","type":["string","null"],"example":"C"},"score":{"description":"Score for the data quality field","type":["number","null"],"format":"float","example":"0.66"},"rules":{"description":"Array of rule details","type":"array","items":{"$ref":"#/components/schemas/BundleDataQualityManagementRule"}},"lastUpdated":{"description":"Last updated timestamp","type":["integer","null"],"example":1752670892}},"type":"object"},"BundleDataQualityManagementRule":{"title":"Bundle Data Quality Management Rule Data","required":["title","suggestion","valid"],"properties":{"title":{"description":"Title of the rule","type":"string","example":"Completeness"},"suggestion":{"description":"Suggestion","type":"string","example":"Fill in some required fields"},"valid":{"description":"Is rule valid","type":"boolean","example":true}},"type":"object"},"BundleEnterpriseSubscriptionToolsLicenseInformation":{"title":"Bundle Enterprise Subscription Tools License Information","required":["success","instanceId","legacyInstanceId","environment","instanceCode"],"properties":{"success":{"description":"Whether license check was successful or not","type":"boolean","example":"true"},"instanceId":{"description":"Instance Id","type":"string","example":"4q7D8Gce"},"legacyInstanceId":{"description":"Legacy Instance Id","type":"string","example":"a79ba4252e2e"},"environment":{"description":"Environment","type":"string","example":"dev"},"instanceCode":{"description":"Instance Code","type":"string","example":"ZTNiMGM0NDI5OGZjMWMxN"}},"type":"object"},"BundlePersonalizationTargetGroup":{"title":"Bundle Personalization Target Group","required":["id","active","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id","type":"integer","example":83},"active":{"description":"Is group active","type":"boolean","example":true},"name":{"description":"Name of the group","type":"string","example":"regular-customer"}},"type":"object"},"BundlePortalEngineAsset":{"title":"Bundle Portal Engine Asset","required":["allowDrag","allowDrop","collectionId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Asset"},{"properties":{"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"collectionId":{"description":"Collection ID","type":"number","example":5}},"type":"object"}]},"BundlePortalEngineDataObject":{"title":"Bundle Portal Engine Data Object","required":["allowDrag","allowDrop","collectionId"],"type":"object","allOf":[{"$ref":"#/components/schemas/DataObject"},{"properties":{"allowDrag":{"description":"Allow drag","type":"boolean","example":true},"allowDrop":{"description":"Allow drop","type":"boolean","example":true},"collectionId":{"description":"Collection ID","type":"number","example":5}},"type":"object"}]},"BundleSeoRedirect":{"title":"Bundle Seo Redirect","required":["id","type","source","sourceSite","passThroughParameters","target","targetSite","statusCode","priority","regex","active","expiry","creationDate","modificationDate","userOwner","userModification"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":["integer","null"],"example":1},"type":{"description":"Type of redirect","type":"string","example":"auto_create"},"source":{"description":"Source URL","type":["string","null"],"example":"/old-path"},"sourceSite":{"description":"ID of the source site","type":["integer","null"],"example":1},"passThroughParameters":{"description":"Whether to pass through parameters","type":"boolean","example":true},"target":{"description":"Target URL","type":["string","null"],"example":"/new-path"},"targetSite":{"description":"ID of the target site","type":["integer","null"],"example":1},"statusCode":{"description":"Status code","type":"integer","example":301},"priority":{"description":"Priority","type":"integer","example":8},"regex":{"description":"Whether the redirect uses regex","type":["boolean","null"],"example":true},"active":{"description":"Whether the redirect is active","type":"boolean","example":true},"expiry":{"description":"Expiry date in timestamp format","type":["integer","null"],"example":1712345678},"creationDate":{"description":"Creation date in timestamp format","type":["integer","null"],"example":1712345678},"modificationDate":{"description":"Modification date in timestamp format","type":["integer","null"],"example":1712345678},"userOwner":{"description":"ID of the user who owns the redirect","type":["integer","null"],"example":1},"userModification":{"description":"ID of the user who last modified the redirect","type":["integer","null"],"example":1}},"type":"object"},"BundleSeoRedirectAdd":{"title":"Bundle Seo Redirect Add","required":["type","source","target"],"properties":{"type":{"description":"Type of redirect","type":"string","example":"entire_uri"},"source":{"description":"Source URL","type":["string","null"],"example":"/old-path"},"target":{"description":"Target URL","type":["string","null"],"example":"/new-path"}},"type":"object"},"BundleSeoRedirectStatus":{"title":"Bundle Seo Redirect Status","required":["code","label"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"code":{"description":"Status code","type":"integer","example":301},"label":{"description":"Status label","type":"string","example":"Moved Permanently"}},"type":"object"},"BundleSeoRedirectUpdate":{"title":"Bundle Seo Redirect Update","required":["type","sourceSite","source","targetSite","target","statusCode","priority","regex","active","passThroughParameters","expiry"],"properties":{"type":{"description":"Type of redirect","type":"string","example":"entire_uri"},"sourceSite":{"description":"ID of the source site","type":["integer","null"],"example":1},"source":{"description":"Source URL","type":["string","null"],"example":"/old-path"},"targetSite":{"description":"ID of the target site","type":["integer","null"],"example":1},"target":{"description":"Target URL","type":["string","null"],"example":"/new-path"},"statusCode":{"description":"Status code","type":"integer","example":301},"priority":{"description":"Priority","type":"integer","example":8},"regex":{"description":"Whether the redirect uses regex","type":"boolean","example":false},"active":{"description":"Whether the redirect is active","type":"boolean","example":true},"passThroughParameters":{"description":"Whether to pass through parameters","type":"boolean","example":false},"expiry":{"description":"Expiry date in timestamp format","type":["integer","null"],"example":1712345678}},"type":"object"},"BundleSeoRedirectImportStats":{"title":"Bundle Seo Redirects Import Statistics","required":["total","imported","created","updated","errored","errors"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"total":{"description":"Number of total redirects","type":"integer","example":20},"imported":{"description":"Number of imported redirects","type":"integer","example":15},"created":{"description":"Number of created redirects","type":"integer","example":10},"updated":{"description":"Number of updated redirects","type":"integer","example":5},"errored":{"description":"Number of errored redirects","type":"integer","example":2},"errors":{"description":"List of errors where index is the index of import line","type":"array","items":{"type":"object","example":{"3":"Invalid source URL","5":"Target URL already exists"}}}},"type":"object"},"BundleStatisticsExplorerDataSource":{"title":"Bundle Statistics Explorer Data Source","required":["value","label","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"value":{"description":"Value","type":"string","example":"db_assets"},"label":{"description":"Label","type":"string","example":"[DB] Assets"},"type":{"description":"Type","type":"string","example":"MYSQL"}},"type":"object"},"BundleStatisticsExplorerDataSourceFields":{"title":"Bundle Statistics Explorer Data Source Fields","required":["data","operators"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"data":{"description":"data","type":"array","items":{"type":"object"},"example":"[{\"key1\":\"value1\", \"key2\": \"value2\"}, {\"key1\":\"value1\", \"key2\": \"value2\"}]"},"operators":{"description":"operators","type":"array","items":{"type":"object"},"example":"[{\"key1\":\"value1\", \"key2\": \"value2\"}, {\"key1\":\"value1\", \"key2\": \"value2\"}]"}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsDefinition":{"title":"Bundle Statistics Explorer Data Source Fields Definition","required":["label","name","typeGroup","fields"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"label":{"description":"label","type":"string","example":"creationDate"},"name":{"description":"name","type":"string","example":"creationDate"},"typeGroup":{"description":"typeGroup","type":"string","example":"numeric"},"fields":{"description":"fields","type":"array","items":{"type":"object"},"example":"[{\"key1\":\"value1\", \"key2\": \"value2\"}, {\"key1\":\"value1\", \"key2\": \"value2\"}]"}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsSettings":{"title":"Bundle Statistics Explorer Data Source Fields Settings","required":["statisticsMode","aggregations","columns"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"statisticsMode":{"description":"statisticsMode","type":"string","enum":["list","statistic"],"example":"list"},"aggregations":{"description":"aggregations","type":"array","items":{"$ref":"#/components/schemas/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}},"columns":{"description":"columns","type":"array","items":{"$ref":"#/components/schemas/BundleStatisticsExplorerDataSourceFieldsSettingsArray"}}},"type":"object"},"BundleStatisticsExplorerDataSourceFieldsSettingsArray":{"title":"Bundle Statistics Explorer Data Source Fields Settings Array","required":["id","label","typeGroup","value"],"properties":{"id":{"description":"id","type":"string","example":"extModel2097-7"},"label":{"description":"label","type":"string","example":"creationDate"},"typeGroup":{"description":"typeGroup","type":"string","example":"numeric"},"value":{"description":"value","type":"string","example":"creationDate"}},"type":"object"},"BundleWebToPrintGenerateProcessData":{"title":"Bundle Web To Print Generate Process Data","required":["active","downloadAvailable","date","message","statusUpdate"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"active":{"description":"Whether a PDF generation process is currently active","type":"boolean","example":true},"downloadAvailable":{"description":"Whether the generated PDF is available for download","type":"boolean","example":false},"statusUpdate":{"description":"Status update information","type":["array","null"],"items":{"type":"string"},"example":["Processing page 1 of 5","Rendering images"]},"date":{"description":"Last generation date","type":["string","null"],"example":"2025-11-05 14:30"},"message":{"description":"Last generation message","type":["string","null"],"example":"PDF generation completed successfully"}},"type":"object"},"BundleWebToPrintProcessingOption":{"title":"Bundle Web To Print Processing Option","required":["name","label","type","value","values"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Option name","type":"string","example":"dpi"},"label":{"description":"Option label","type":"string","example":"dpi"},"type":{"description":"Option type","type":"string","example":"select"},"value":{"description":"Option value","example":"Some value","oneOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"},{"type":"null"}]},"values":{"description":"Available option values","type":["array","null"],"items":{"oneOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}]},"example":[72,150,300,600]}},"type":"object"},"CsvSettings":{"title":"CSV Settings","required":["delimiter","quoteChar","escapeChar","lineTerminator"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"delimiter":{"description":"Field delimiter character","type":"string","example":";"},"quoteChar":{"description":"Quote character for fields","type":"string","example":"\""},"escapeChar":{"description":"Escape character","type":"string","example":"\\"},"lineTerminator":{"description":"Line terminator character","type":"string","example":""}},"type":"object"},"ChangeMainDocument":{"title":"Change Main Document","required":["mainDocumentPath"],"properties":{"mainDocumentPath":{"description":"Main document path","type":["string","null"],"example":"/path/to/main/document"}},"type":"object"},"UpdateTagParameters":{"title":"Change Tag Parameters","description":"Parameters for changing a tag","properties":{"parentId":{"description":"Parent id","type":["integer","null"],"example":0},"name":{"description":"Tag name","type":["string","null"],"example":"tag 1"}},"type":"object"},"CheckPrettyUrl":{"title":"Check Pretty URL","required":["prettyUrl"],"properties":{"prettyUrl":{"description":"Pretty URL to check","type":"string","example":"/my-pretty-url"}},"type":"object"},"ClassDefinitionIdentifierData":{"title":"Class Definition Identifier Data","required":["suggestedId","existingIds"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"suggestedId":{"description":"Suggested unique ID for the new class definition","type":"string","example":"AP"},"existingIds":{"description":"Array of existing class definition IDs","type":"array","items":{"type":"string"},"example":["AP","CP","MP"]}},"type":"object"},"ClassDefinitionList":{"title":"Class Definition List Item","required":["id","name","title","icon","group"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of class definition","type":"string","example":"AP"},"name":{"description":"Name of class definition","type":"string","example":"AccessoryPart"},"title":{"description":"Title","type":"string","example":"Accessory Part"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"group":{"description":"Group","type":["string","null"],"example":"system"}},"type":"object"},"ClassDefinitionObjectBrickData":{"title":"Class Definition Object Brick Data","required":["key","fieldName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the object brick","type":"string","example":"SaleInformation"},"fieldName":{"description":"Name of class definition field","type":"string","example":"saleInformation"}},"type":"object"},"ClassDefinitionTreeNodeFolder":{"title":"Class Definition Tree Node Folder","required":["children"],"type":"object","allOf":[{"$ref":"#/components/schemas/ClassDefinitionList"},{"properties":{"children":{"description":"Child nodes","type":"array","items":{"$ref":"#/components/schemas/ClassDefinitionTreeNode"}}},"type":"object"}]},"ClassDefinitionTreeNode":{"title":"Class Definition Tree Node Item","required":["enableGridLocking","hasBrickField"],"type":"object","allOf":[{"$ref":"#/components/schemas/ClassDefinitionList"},{"properties":{"enableGridLocking":{"description":"Enable grid locking","type":"boolean","example":false},"hasBrickField":{"description":"Has brick field","type":"boolean","example":false}},"type":"object"}]},"AvailableVisibleField":{"title":"Class definition Visible Field","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Field key","type":"string","example":"id"}},"type":"object"},"ClassDefinitionFolderItem":{"title":"Class in data object folder","required":["id","name","inheritance"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of class","type":"string","example":"NE"},"name":{"description":"Name of class","type":"string","example":"News"},"inheritance":{"description":"Inheritance allowed","type":"boolean","example":"true"}},"type":"object"},"ClassLayoutCompact":{"title":"Class layout data in compact format to be used for e.g. listing in workspaces","required":["id","name","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of layout","type":"string","example":"CAR_0"},"name":{"description":"Name","type":"string","example":"Car"},"type":{"description":"Whether it is the default layout","type":"string","example":"main"}},"type":"object"},"ClassDefinition":{"title":"ClassDefinition","required":["id","name","title","description","creationDate","modificationDate","userOwner","parentClass","implementsInterfaces","listingParentClass","useTraits","listingUseTraits","encryption","allowInherit","allowVariants","showVariants","icon","group","showAppLoggerTab","linkGeneratorReference","previewGeneratorReference","compositeIndices","showFieldLookup","propertyVisibility","enableGridLocking","blockedVarsForExport","isWriteable"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Id of class definition","type":"string","example":"AP"},"name":{"description":"Name of class definition","type":"string","example":"AccessoryPart"},"title":{"description":"Title","type":"string","example":"Accessory Part"},"description":{"description":"Description","type":"string","example":"This class represents an accessory part"},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1700000000},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1700000000},"userOwner":{"description":"User id of owner","type":"integer","example":1},"parentClass":{"description":"Namespace of parent class","type":"string","example":"App\\Model\\DataObject\\AccessoryPart"},"implementsInterfaces":{"description":"Interface implementations","type":"string","example":"App\\Model\\DataObject\\Interface"},"listingParentClass":{"description":"List of parent class","type":"string","example":"App\\Model\\DataObject\\Listing"},"useTraits":{"description":"Traits usage","type":"string","example":"App\\Model\\DataObject\\Trait"},"listingUseTraits":{"description":"Traits usage listing","type":"string","example":"App\\Model\\DataObject\\ListingTrait"},"encryption":{"description":"Whether encryption is ued","type":"boolean","example":true},"allowInherit":{"description":"Whether inheritance is allowed","type":"boolean","example":true},"allowVariants":{"description":"Whether variants are allowed","type":"boolean","example":true},"showVariants":{"description":"Whether variants are visible in the tree","type":"boolean","example":true},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"icon"},"showAppLoggerTab":{"description":"Show application logger tab","type":"boolean","example":true},"linkGeneratorReference":{"description":"Namespace of link generator","type":"string","example":"App\\Model\\DataObject\\LinkGenerator"},"previewGeneratorReference":{"description":"Namespace of preview generator","type":"string","example":"App\\Model\\DataObject\\PreviewGenerator"},"compositeIndices":{"description":"Composite indices","type":"object","example":[]},"showFieldLookup":{"description":"Show field lookup","type":"boolean","example":true},"propertyVisibility":{"description":"Visibility of properties for grid, search, ...","type":"object","example":[]},"enableGridLocking":{"description":"Whether grid locking is enabled","type":"boolean","example":true},"blockedVarsForExport":{"description":"Blocked variables for export","type":"array","items":{"type":"string"},"example":[]},"isWriteable":{"description":"Whether the class definition can be written to","type":"boolean","example":true},"group":{"description":"Group","type":["string","null"],"example":"system"}},"type":"object"},"Collection":{"title":"Classification Store Collection","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":"string","example":"value"},"groups":{"description":"List of Group IDs in collection","type":"object"}},"type":"object"},"KeyLayout":{"title":"Classification Store Collection","required":["id","name","description","definition"],"properties":{"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":"string","example":"value"},"definition":{"description":"Layout Definition","type":"object"}},"type":"object"},"ClassificationStoreStoreConfig":{"title":"Classification Store Configuration","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"}},"type":"object"},"Group":{"title":"Classification Store Group","required":["id","name"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":["string","null"],"example":"value"}},"type":"object"},"CollectionLayout":{"title":"Classification Store Group Layout","required":["groups"],"properties":{"groups":{"description":"Groups","type":"array","items":{"$ref":"#/components/schemas/GroupLayout"}}},"type":"object"},"GroupLayout":{"title":"Classification Store Group Layout","required":["id","name","keys"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":42},"name":{"description":"Name","type":"string","example":"value"},"description":{"description":"Description","type":["string","null"],"example":"value"},"keys":{"description":"Description","type":"array","items":{"$ref":"#/components/schemas/KeyLayout"}}},"type":"object"},"KeyGroupRelation":{"title":"Classification Store KeyGroupRelation","required":["keyId","groupId","keyName","groupName"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"keyId":{"description":"Key ID","type":"integer","example":42},"groupId":{"description":"Group ID","type":"integer","example":42},"keyName":{"description":"Key Name","type":"string","example":"value"},"groupName":{"description":"Group Name","type":"string","example":"value"},"keyDescription":{"description":"Key Description","type":["string","null"],"example":"value"},"groupDescription":{"description":"Key Description","type":["string","null"],"example":"value"}},"type":"object"},"ColumnSchema":{"title":"Column","required":["key","locale","group"],"properties":{"key":{"description":"Key of the Column","type":"string","example":"id"},"locale":{"description":"Locale of the Column","type":["string","null"],"example":"de"},"group":{"description":"Define the group structure","type":"object","example":["system"]}},"type":"object"},"ConfigLayoutDefinition":{"title":"Config Layout Definition","required":["name","type","region","title","width","height","collapsible","collapsed","bodyStyle","datatype","children","locked","fieldtype","layout","border","icon","labelWidth","labelAlign"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"name":{"description":"Name","type":["string","null"],"example":null},"type":{"description":"Type","type":["string","null"],"example":null},"region":{"description":"Region","type":["string","null"],"example":null},"title":{"description":"Title","type":["string","null"],"example":null},"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":null},"datatype":{"description":"Data Type","type":"string","example":"layout"},"children":{"description":"Children","type":"array","items":{"type":"object"},"example":[]},"locked":{"description":"Locked","type":"boolean","example":false},"fieldtype":{"description":"Field Type","type":"string","example":"panel"},"layout":{"description":"Layout","type":["string","null"],"example":null},"border":{"description":"Border","type":"boolean","example":false},"icon":{"description":"Icon","type":["string","null"],"example":null},"labelWidth":{"description":"Label Width","type":"integer","example":100},"labelAlign":{"description":"Label Align","type":"string","example":"left"}},"type":"object"},"ConvertedQuantityValue":{"title":"Converted quantity values","required":["unitAbbreviation","unitLongName","convertedValue"],"properties":{"unitAbbreviation":{"description":"Unit Abbreviation","type":"string","example":"m"},"unitLongName":{"description":"Unit Long Name","type":"string","example":"Meter"},"convertedValue":{"description":"Converted Values","type":"number","format":"float","example":160}},"type":"object"},"ConvertedQuantityValues":{"title":"Converted quantity values","required":["originalValue","fromUnitId","convertedValues"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"originalValue":{"description":"Original Value","example":5,"anyOf":[{"type":"float"},{"type":"integer"}]},"fromUnitId":{"description":"From Unit Id","type":"string","example":"m"},"convertedValues":{"description":"Converted Values","type":"array","items":{"$ref":"#/components/schemas/ConvertedQuantityValue"}}},"type":"object"},"SaveElementTreeWidgetConfig":{"title":"Create Element Tree Widget Config","required":["id","name","icon","contextPermissions","elementType","rootFolder","showRoot","classes","pql","pageSize"],"properties":{"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"contextPermissions":{"description":"Context Permissions","type":"object","example":{"add":true,"addFolder":true,"changeChildrenSortBy":true,"copy":true,"cut":true,"delete":true,"lock":true,"lockAndPropagate":true,"paste":true,"publish":true,"refresh":true,"rename":true,"searchAndMove":true,"unlock":true,"unlockAndPropagate":true,"unpublish":true}},"elementType":{"description":"Element Type","type":"string","example":"data-object"},"rootFolder":{"description":"Root Folder","type":"string","example":"/Product Data/Cars"},"showRoot":{"description":"Show Root","type":"boolean","example":false},"classes":{"description":"Classes","type":"object","example":["CAR"]},"pql":{"description":"PQL","type":["string","null"],"example":null},"pageSize":{"description":"Page size","type":["integer","null"],"example":20}},"type":"object"},"CreateNotificationsWidgetConfig":{"title":"Create Notifications Widget Config","required":["page","pageSize","dateFilterValue","dateFilterOperator","senderFilter","typeFilter","onlyUnread"],"type":"object","allOf":[{"$ref":"#/components/schemas/CreateWidgetConfig"},{"properties":{"page":{"description":"Page","type":"integer","example":1},"pageSize":{"description":"Page Size","type":"integer","example":1},"dateFilterValue":{"description":"Date Filter Value","type":["string","null"],"example":"08/20/2024"},"dateFilterOperator":{"description":"Date Filter Operator","type":["string","null"],"example":"on"},"senderFilter":{"description":"Sender Filter ","type":["integer","null"],"example":20},"typeFilter":{"description":"Type Filter ","type":["string","null"],"example":"info"},"onlyUnread":{"description":"Filter Only Unread Notifications ","type":"boolean","example":false}},"type":"object"}]},"SavePerspectiveConfig":{"title":"Create Perspective Config","required":["icon","contextPermissions","widgetsLeft","widgetsRight","widgetsBottom","expandedLeft","expandedRight"],"type":"object","allOf":[{"$ref":"#/components/schemas/AddPerspectiveConfig"},{"properties":{"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"contextPermissions":{"description":"Context Permissions","type":"object"},"widgetsLeft":{"description":"Widgets Left","type":"object","example":{"widget_id":"widget_type"}},"widgetsRight":{"description":"Widgets Right","type":"object","example":{"widget_id":"widget_type"}},"widgetsBottom":{"description":"Widgets Bottom","type":"object","example":{"widget_id":"widget_type"}},"expandedLeft":{"description":"Left Expanded Widget","type":["string","null"],"example":"widget_id"},"expandedRight":{"description":"Right Expanded Widget","type":["string","null"],"example":"widget_id"}},"type":"object"}]},"CreateRecentlyModifiedWidgetConfig":{"title":"Create Recently Modified Widget Config","required":["elementType"],"type":"object","allOf":[{"$ref":"#/components/schemas/CreateWidgetConfig"},{"properties":{"elementType":{"description":"Element Type","type":"string","example":"asset"}},"type":"object"}]},"CreateTagParameters":{"title":"Create Tag Parameters","description":"Parameters for creating a new tag","properties":{"parentId":{"description":"Parent id","type":"integer","example":0},"name":{"description":"Tag name","type":"string","example":"tag 1"}},"type":"object"},"CreateThumbnailConfig":{"title":"Create Thumbnail Config","required":["name"],"properties":{"name":{"description":"Thumbnail configuration name","type":"string","example":"my-thumbnail"}},"type":"object"},"CreateUnitParameters":{"title":"Create Unit Parameters","required":["id"],"properties":{"id":{"description":"Unique unit ID","type":"string","example":"mm"},"abbreviation":{"description":"Abbreviation","type":["string","null"],"example":"mm"},"longname":{"description":"Long name","type":["string","null"],"example":"Millimeter"},"group":{"description":"Group","type":["string","null"],"example":"Length"},"baseunit":{"description":"Base unit ID","type":["string","null"],"example":"m"},"factor":{"description":"Conversion factor","type":["number","null"],"example":0.001},"conversionOffset":{"description":"Conversion offset","type":["number","null"],"example":null},"converter":{"description":"Converter service class","type":["string","null"],"example":null},"reference":{"description":"Reference","type":["string","null"],"example":null}},"type":"object"},"CreateWidgetConfig":{"title":"Create Widget Config","required":["id","name","icon","color","visualization"],"properties":{"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"My Widget"},"icon":{"oneOf":[{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},{"type":"null"}],"description":"Icon"},"color":{"description":"Color","type":"string","example":"#FF5733"},"visualization":{"description":"Visualization","type":["string","null"],"example":"table"}},"type":"object"},"CreateWysiwygWidgetConfig":{"title":"Create Wysiwyg Widget Config","required":["wysiwyg"],"type":"object","allOf":[{"$ref":"#/components/schemas/CreateWidgetConfig"},{"properties":{"wysiwyg":{"description":"Wysiwyg Content","type":["string","null"],"example":"

Hello 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":"
...
"}},"type":"object"},"Thumbnail":{"title":"Thumbnail","required":["id","text"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"pimcore_system_treepreview"},"text":{"description":"text","type":"string","example":"original"}},"type":"object"},"ThumbnailConfigurationData":{"title":"Thumbnail Configuration Data","required":["writeable"],"type":"object","allOf":[{"$ref":"#/components/schemas/SettingsConfigurationData"},{"properties":{"writeable":{"description":"Is configuration writeable","type":"boolean","example":true}},"type":"object"}]},"ThumbnailConfigurationFolderData":{"title":"Thumbnail Configuration Folder Data","required":["children"],"type":"object","allOf":[{"$ref":"#/components/schemas/SettingsConfigurationData"},{"properties":{"children":{"description":"Child nodes","type":"array","items":{"$ref":"#/components/schemas/ThumbnailConfigurationData"}}},"type":"object"}]},"ThumbnailCollection":{"title":"ThumbnailCollection","required":["items"],"properties":{"items":{"description":"items","type":"array","items":{"$ref":"#/components/schemas/Thumbnail"}}},"type":"object"},"TokenLink":{"title":"TokenLink","description":"Token link parameters","required":["tokenLoginUrl"],"properties":{"tokenLoginUrl":{"description":"Token login URL","type":"string","example":"https://example.com/login"}},"type":"object"},"Transformer":{"title":"Transformer","required":["key"],"properties":{"key":{"description":"Key of the Transformer","type":"string","example":"uppercase"},"config":{"description":"Configuration for the transformer","type":"object"}},"type":"object"},"Translation":{"title":"Translation","description":"Translation Scheme for API","required":["locale","keys"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"keys":{"description":"Keys for Translation - Fallback will be applied to all Keys automatically","type":"array","items":{"type":"string","example":"not_your_typical_key"}},"useFallback":{"description":"Apply Fallback Language. Used only if no keys are defined","type":"boolean","example":true}},"type":"object"},"CreateTranslation":{"title":"Translation Create","description":"Translation Create Scheme for API","required":["translationData"],"properties":{"errorOnDuplicate":{"description":"Throw an error on duplicate key","type":"boolean","example":false},"translationData":{"description":"Translation Data","type":"array","items":{"$ref":"#/components/schemas/CreateTranslationData"}}},"type":"object"},"TranslationData":{"title":"Translation Data","description":"Translation Data Scheme for API","required":["locale","translation"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"translation":{"description":"Translation","type":"string","example":"some_translated_string"}},"type":"object"},"CreateTranslationData":{"title":"Translation Data for create","description":"Translation Data Scheme for create endpoint of the API","required":["key","type"],"properties":{"key":{"description":"Key","type":"string","example":"my_translation_key"},"type":{"description":"Type","type":"string","example":"simple"},"domain":{"description":"Domain","type":"string","example":"studio"}},"type":"object"},"UpdateTranslation":{"title":"Translation Update","description":"Translation Update Scheme for API","required":["key","type","translationData"],"properties":{"key":{"description":"Key of the translation","type":"string","example":"car"},"type":{"description":"Type of the translation","type":["string","null"],"example":"simple"},"translationData":{"description":"Translation Data","type":"array","items":{"$ref":"#/components/schemas/TranslationData"}}},"type":"object"},"TranslationDeltaValues":{"title":"Translation delta values","description":"Translation delta values","required":["locale","currentTranslation","importTranslation"],"properties":{"locale":{"description":"Locale","type":"string","example":"en"},"currentTranslation":{"description":"Current translation","type":"string","example":"some translation"},"importTranslation":{"description":"Imported translation","type":"string","example":"some translation updated"}},"type":"object"},"Translations":{"title":"Translations","description":"Translations including all languages and keys","required":["key","translations","type"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the translation","type":"string","example":"car"},"translations":{"description":"List of translations for the given key","type":"array","items":{"type":"object","example":{"en":"Car","de":"Auto","fr":"Voiture"}}},"type":{"description":"Type simple or custom","type":"string","example":"simple"}},"type":"object"},"TreeLevelData":{"title":"Tree Level Data","required":["level","elementId","pageNumber"],"properties":{"parentId":{"description":"Parent ID","type":"integer","example":1},"elementId":{"description":"Element ID","type":"integer","example":66},"pageNumber":{"description":"Page Number","type":"integer","example":1}},"type":"object"},"TreeNode":{"title":"Tree Node","description":"One node in the a tree","required":["id","name","type","hasChildren"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Unique Identifier","type":"integer","example":"1"},"name":{"description":"Name of the tree node","type":"string","example":"admin"},"type":{"description":"Is ether folder or a specific item in the folder","type":"string","example":"user"},"hasChildren":{"description":"If a folder has sub items","type":"boolean","example":true}},"type":"object"},"TwoFactorAuth":{"title":"Two Factor Authentication Data","description":"Two Factor Authentication Data for a User","required":["required","enabled","type","active"],"properties":{"required":{"description":"Required","type":"boolean","example":true},"enabled":{"description":"Enabled","type":"boolean","example":true},"type":{"description":"Type","type":"string","example":"totp"},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"ConvertParameters":{"title":"Unit Convert Parameters","required":["fromUnitId","toUnitId","value"],"properties":{"fromUnitId":{"description":"From Unit Id","type":"string","example":"m"},"toUnitId":{"description":"To Unit Id","type":"string","example":"mm"},"value":{"description":"Value","example":5,"anyOf":[{"type":"float"},{"type":"integer"}]}},"type":"object"},"Unknown":{"title":"Unknown","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"}]},"UnreadCount":{"title":"Unread Count","required":["unreadNotificationsCount"],"properties":{"unreadNotificationsCount":{"description":"Count of unread notifications","type":"integer","example":1}},"type":"object"},"UpdateAdminSettings":{"title":"Update Admin Settings","required":["branding","assets"],"properties":{"branding":{"$ref":"#/components/schemas/Branding","description":"Branding configuration"},"assets":{"$ref":"#/components/schemas/Assets","description":"Assets configuration"}},"type":"object"},"UpdateSite":{"title":"Update Site","required":["mainDomain","domains","errorDocument","localizedErrorDocuments","redirectToMainDomain"],"properties":{"mainDomain":{"description":"Main domain","type":"string","example":"main_site"},"domains":{"description":"Domains","type":"array","items":{"type":"string"},"example":["other_domain"]},"errorDocument":{"description":"Error document","type":"string","example":"path/to/error/document"},"localizedErrorDocuments":{"description":"Localized error documents","type":"object","example":{"en":"path/to/en/error/document","de":"path/to/de/error/document"}},"redirectToMainDomain":{"description":"Redirect to main domain","type":"boolean","example":false}},"type":"object"},"UpdateThumbnailConfig":{"title":"Update Thumbnail Config","required":["settings","medias","mediaOrder"],"properties":{"settings":{"description":"Thumbnail settings configuration","type":"object","example":{"description":"My thumbnail description","group":"Areas","format":"SOURCE","quality":95,"highResolution":0,"preserveColor":false,"forceProcessICCProfiles":false,"preserveMetaData":false,"rasterizeSVG":false,"preserveAnimation":false,"downloadable":false}},"medias":{"description":"Media configurations with transformation items","type":"object","example":{"default":[{"method":"scaleByWidth","arguments":{"width":1140,"forceResize":false}}]}},"mediaOrder":{"description":"Media configurations order","type":"object","example":{"default":0,"(max-width: 940px)":1}}},"type":"object"},"UpdateUnitParameters":{"title":"Update Unit Parameters","properties":{"abbreviation":{"description":"Abbreviation","type":["string","null"],"example":"mm"},"longname":{"description":"Long name","type":["string","null"],"example":"Millimeter"},"group":{"description":"Group","type":["string","null"],"example":"Length"},"baseunit":{"description":"Base unit ID","type":["string","null"],"example":"m"},"factor":{"description":"Conversion factor","type":["number","null"],"example":0.001},"conversionOffset":{"description":"Conversion offset","type":["number","null"],"example":null},"converter":{"description":"Converter service class","type":["string","null"],"example":null},"reference":{"description":"Reference","type":["string","null"],"example":null}},"type":"object"},"UpdateRole":{"title":"Update User Role","description":"Contains all information about a role that can be updated.","required":["name","classes","parentId","permissions","docTypes","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"name":{"description":"Name of Folder or Role","type":["string","null"],"example":"admin"},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"docTypes":{"description":"List of document types for the role","type":"object","example":["1","2"]},"websiteTranslationLanguagesEdit":{"type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"type":"object","example":["de"]},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"object","example":["studio_default_perspective","some_otherPerspective_Id"]}},"type":"object"},"UpdateCustomMetadata":{"title":"UpdateCustomMetadata","required":["name","language","type","data"],"properties":{"name":{"description":"Name","type":"string","example":"custom_metadata"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":"string","example":"input"},"data":{"description":"Data","type":["mixed","null"],"example":"data"}},"type":"object"},"UpdateCustomSettings":{"title":"UpdateCustomSettings","required":["key","value"],"properties":{"key":{"description":"Key","type":"string","example":"my_custom_setting_key"},"value":{"description":"Value","type":["mixed","null"],"example":"data"}},"type":"object"},"UpdateElementProperty":{"title":"UpdateDataProperty","required":["key","data","type","inheritable"],"properties":{"key":{"description":"key","type":"string","example":"Mister Proper"},"data":{"description":"data","type":["mixed","null"],"example":"123"},"type":{"description":"type","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false}},"type":"object"},"UpdatePredefinedProperty":{"title":"UpdatePredefinedProperty","required":["name","key","type","ctype","inheritable"],"properties":{"name":{"description":"name","type":"string","example":"Mister Proper"},"description":{"description":"description","type":["string","null"],"example":"Detailed description of the property"},"key":{"description":"key","type":"string","example":"Key for referencing"},"type":{"description":"type","type":"string","example":"text"},"data":{"description":"data","type":["string","null"],"example":"test"},"config":{"description":"config","type":["string","null"],"example":"comma,separated,values"},"ctype":{"description":"ctype","type":"string","example":"document"},"inheritable":{"description":"inheritable","type":"boolean","example":false}},"type":"object"},"UpdateSchedule":{"title":"UpdateSchedule","required":["id","date","active"],"properties":{"id":{"description":"Id of schedule, if null a new one will be created","type":["integer","null"],"example":666},"date":{"description":"Date of schedule","type":"integer","example":1634025600},"action":{"description":"Action","type":["string","null"],"enum":["publish","delete"],"example":"publish"},"version":{"description":"Version ID","type":["integer","null"],"example":987},"active":{"description":"Active","type":"boolean","example":true}},"type":"object"},"UpdateVersion":{"title":"UpdateVersion","properties":{"public":{"description":"Public","type":["boolean","null"],"example":null},"note":{"description":"Note","type":["string","null"],"example":null}},"type":"object"},"UpdateUser":{"title":"User","description":"User Schema to update a User.","required":["email","firstname","lastname","admin","active","classes","docTypes","closeWarning","allowDirtyClose","contentLanguages","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthenticationRequired","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","perspectives"],"properties":{"email":{"description":"Email of the User","type":["string","null"],"example":""},"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"admin":{"description":"If User is admin","type":"boolean","example":false},"active":{"description":"If User is active","type":"boolean","example":true},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"docTypes":{"description":"Allowed Document types to create","type":"object","example":["3","5"]},"closeWarning":{"description":"Show Close Warning","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#/components/schemas/KeyBinding"}},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Date Time Locale for the User","type":"string","example":""},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"parentId":{"description":"Parent ID","type":"integer","example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"roles":{"description":"ID List of roles the user is assigned","type":"object","example":[12,14]},"twoFactorAuthenticationRequired":{"description":"Two Factor Authentication Enabled","type":"boolean","example":false},"websiteTranslationLanguagesEdit":{"description":"Website Translation Languages Edit","type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"description":"Website Translation Languages View","type":"object","example":["de"]},"welcomeScreen":{"description":"Show welcome Screen","type":"boolean","example":true},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"perspectives":{"description":"Allowed studio perspectives","type":"object","example":["studio_default_perspective","some_otherPerspective_Id"]}},"type":"object"},"User":{"title":"User","description":"Contains all information about a user","required":["id","name","email","firstname","lastname","active","admin","classes","docTypes","closeWarning","allowDirtyClose","contentLanguages","hasImage","keyBindings","language","memorizeTabs","parentId","permissions","roles","twoFactorAuthentication","websiteTranslationLanguagesEdit","websiteTranslationLanguagesView","welcomeScreen","assetWorkspaces","dataObjectWorkspaces","documentWorkspaces","objectDependencies","perspectives"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID of the User","type":"integer","example":"1"},"name":{"description":"Name of Folder or User","type":["string","null"],"example":"admin"},"email":{"description":"Email of the User","type":["string","null"],"example":""},"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"active":{"description":"If a User is active","type":"boolean","example":true},"admin":{"description":"If User is admin","type":"boolean","example":false},"classes":{"description":"Classes the user is allows to see","type":"object","example":["CAR"]},"docTypes":{"description":"Allowed doc types to create","type":"array","items":{"type":"string"}},"closeWarning":{"description":"Show close warning","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"hasImage":{"description":"If User has an Image","type":"boolean","example":true},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#/components/schemas/KeyBinding"}},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Locale for dateTime","type":["string","null"],"example":""},"lastLogin":{"description":"Timestamp of the last login","type":["integer","null"],"example":"1718757677"},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"parentId":{"description":"Parent ID","type":["integer","null"],"example":2},"permissions":{"description":"List of permissions for the user","type":"object","example":["objects","documents"]},"roles":{"description":"ID List of roles the user is assigned","type":"object","example":[12,14]},"twoFactorAuthentication":{"$ref":"#/components/schemas/TwoFactorAuth","description":"Two Factor Authentication"},"websiteTranslationLanguagesEdit":{"description":"Website Translation Languages Edit","type":"object","example":["de","en"]},"websiteTranslationLanguagesView":{"description":"Website Translation Languages View","type":"object","example":["de"]},"welcomeScreen":{"description":"Show Welcome Screen","type":"boolean","example":true},"assetWorkspaces":{"description":"Asset Workspace","type":"array","items":{"$ref":"#/components/schemas/UserWorkspace"}},"dataObjectWorkspaces":{"description":"Data Object Workspace","type":"array","items":{"$ref":"#/components/schemas/UserDataObjectWorkspace"}},"documentWorkspaces":{"description":"Document Workspace","type":"array","items":{"$ref":"#/components/schemas/UserDocumentWorkspace"}},"objectDependencies":{"$ref":"#/components/schemas/ObjectDependencies","description":"Object Dependencies"},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#/components/schemas/PerspectiveConfig"}}},"type":"object"},"UserDataObjectWorkspace":{"title":"User Document Workspace","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserWorkspace"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true},"localizedEdit":{"description":"Localized Edit","type":["string","null"],"example":"default"},"localizedView":{"description":"Localized View","type":["string","null"],"example":"default"},"layouts":{"description":"Layouts","type":["string","null"],"example":"CAR"}},"type":"object"}]},"UserDocumentWorkspace":{"title":"User Document Workspace","required":["save","unpublish"],"type":"object","allOf":[{"$ref":"#/components/schemas/UserWorkspace"},{"properties":{"save":{"description":"Save","type":"boolean","example":true},"unpublish":{"description":"Unpublish","type":"boolean","example":true}},"type":"object"}]},"UserInformation":{"title":"User Information","description":"Information about the user","required":["id","username","email","firstname","lastname","permissions","isAdmin","classes","docTypes","language","dateTimeLocale","welcomeScreen","memorizeTabs","allowDirtyClose","hasImage","contentLanguages","keyBindings","twoFactorAuthentication","activePerspective","perspectives","allowedLanguagesForEditingWebsiteTranslations","allowedLanguagesForViewingWebsiteTranslations"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"User ID","type":"integer","example":1},"username":{"description":"Username","type":"string","example":"admin"},"email":{"description":"Email","type":["string","null"],"example":""},"firstname":{"description":"Firstname","type":["string","null"],"example":""},"lastname":{"description":"Lastname","type":["string","null"],"example":""},"permissions":{"description":"Permissions","type":"array","items":{"type":"string","example":"clear_cache"}},"isAdmin":{"description":"If user is an admin user","type":"boolean","example":false},"classes":{"description":"Allowed classes to create","type":"array","items":{"type":"string"}},"docTypes":{"description":"Allowed doc types to create","type":"array","items":{"type":"string"}},"language":{"description":"User Language","type":"string","example":"en"},"dateTimeLocale":{"description":"Locale for dateTime","type":["string","null"],"example":""},"welcomeScreen":{"description":"Welcome Screen","type":"boolean","example":true},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"allowDirtyClose":{"description":"Allow Dirty Close","type":"boolean","example":true},"hasImage":{"description":"Has Image","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"allowedLanguagesForEditingWebsiteTranslations":{"description":"List of valid website Languages to edit.","type":"array","items":{"type":"string"},"example":["de","en"]},"allowedLanguagesForViewingWebsiteTranslations":{"description":"List of valid website Languages to view.","type":"array","items":{"type":"string"},"example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#/components/schemas/KeyBinding"}},"twoFactorAuthentication":{"$ref":"#/components/schemas/TwoFactorAuth","description":"Two Factor Authentication"},"activePerspective":{"description":"Active studio perspective ID","type":["string","null"],"example":"studio_default_perspective"},"perspectives":{"description":"Allowed studio perspectives","type":"array","items":{"$ref":"#/components/schemas/PerspectiveConfig"}}},"type":"object"},"ObjectDependencies":{"title":"User Object Dependencies","description":"User Object Dependencies","required":["hasHidden","dependencies"],"properties":{"dependencies":{"description":"Dependencies to objects","type":"array","items":{"$ref":"#/components/schemas/UserDependency"}},"hasHidden":{"description":"If is has hidden dependencies","type":"boolean","example":true}},"type":"object"},"UserPermission":{"title":"User Permission","description":"A permission for a user or role","required":["key","category"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key of the Permission","type":"string","example":"objects"},"category":{"description":"Category of the Permission","type":"string","example":"Datahub"}},"type":"object"},"UpdateUserProfile":{"title":"User Profile","description":"Schema to update a current User Profile.","required":["firstname","lastname","email","language","dateTimeLocale","welcomeScreen","memorizeTabs","contentLanguages","keyBindings"],"properties":{"firstname":{"description":"Firstname of the User","type":["string","null"],"example":""},"lastname":{"description":"Lastname of the User","type":["string","null"],"example":""},"email":{"description":"Email of the User","type":["string","null"],"example":""},"language":{"description":"Language of the User","type":"string","example":"de"},"dateTimeLocale":{"description":"Date Time Locale for the User","type":"string","example":""},"welcomeScreen":{"description":"Show Welcome Screen","type":"boolean","example":true},"memorizeTabs":{"description":"Memorize Tabs","type":"boolean","example":true},"contentLanguages":{"description":"List of available content Language already sorted.","type":"object","example":["de","en"]},"keyBindings":{"description":"Key Bindings","type":"array","items":{"$ref":"#/components/schemas/KeyBinding"}}},"type":"object"},"UserWorkspace":{"title":"User Workspace","description":"Workspace of a user","required":["cid","cpath","list","view","publish","delete","rename","create","settings","versions","properties"],"properties":{"cid":{"description":"ID of the element","type":"integer","example":"1"},"cpath":{"description":"Path of the element","type":"string","example":"/path/to/element"},"list":{"description":"List Permission","type":"boolean","example":true},"view":{"description":"View Permission","type":"boolean","example":true},"publish":{"description":"Publish Permission","type":"boolean","example":true},"delete":{"description":"Delete Permission","type":"boolean","example":true},"rename":{"description":"Rename Permission","type":"boolean","example":true},"create":{"description":"Create Permission","type":"boolean","example":true},"settings":{"description":"Settings Permission","type":"boolean","example":true},"versions":{"description":"Versions Permission","type":"boolean","example":true},"properties":{"description":"Properties Permission","type":"boolean","example":true}},"type":"object"},"Version":{"title":"Version","required":["id","cid","ctype","note","date","public","published","versionCount","autosave","user"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"version ID","type":"integer","example":2},"cid":{"description":"element ID","type":"integer","example":10},"ctype":{"description":"element type","type":"string","example":"object"},"note":{"description":"note","type":"string","example":"some note"},"date":{"description":"date","type":"integer","example":1712823182},"public":{"description":"public","type":"boolean","example":false},"published":{"description":"published","type":"boolean","example":false},"versionCount":{"description":"version count","type":"integer","example":10},"autosave":{"description":"autosave","type":"boolean","example":false},"user":{"$ref":"#/components/schemas/VersionUser","description":"user"},"scheduled":{"description":"scheduled","type":["integer","null"],"example":null}},"type":"object"},"Dimensions":{"title":"VersionDimensions","properties":{"width":{"description":"width","type":["integer","null"],"example":1920},"height":{"description":"height","type":["integer","null"],"example":1080}},"type":"object"},"VersionUser":{"title":"VersionUser","properties":{"id":{"description":"ID","type":["integer","null"],"example":2},"name":{"description":"name","type":["string","null"],"example":"John Doe"}},"type":"object"},"Video":{"title":"Video","type":"object","allOf":[{"$ref":"#/components/schemas/Asset"},{"properties":{"duration":{"description":"Duration","type":["number","null"],"format":"float","example":43560.5},"width":{"description":"Width","type":["integer","null"],"example":1920},"height":{"description":"Height","type":["integer","null"],"example":1080},"imageThumbnailPath":{"description":"Path to Image Thumbnail","type":["string","null"],"example":"/path/to/video/imagethumbnail.jpg"}},"type":"object"}]},"VideoThumbnailConfigDetail":{"title":"Video Thumbnail Config Detail","required":["settings","writeable","medias"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"settings":{"$ref":"#/components/schemas/VideoThumbnailSettings","description":"Thumbnail settings"},"writeable":{"description":"Is configuration writeable","type":"boolean","example":true},"medias":{"description":"Media query configurations with transformation items","type":"object","example":{"default":[{"method":"scaleByHeight","arguments":{"height":300}}],"500K":[{"method":"scaleByHeight","arguments":{"height":500}}]}}},"type":"object"},"VideoThumbnailSettings":{"title":"Video Thumbnail Settings","required":["name","description","group","videoBitrate","audioBitrate","modificationDate","creationDate","filenameSuffix"],"properties":{"name":{"description":"Thumbnail name","type":"string","example":"content"},"description":{"description":"Thumbnail description","type":["string","null"],"example":"thumbnail for content videos"},"group":{"description":"Thumbnail group","type":["string","null"],"example":""},"videoBitrate":{"description":"Video bitrate in kbps","type":["integer","null"],"example":450},"audioBitrate":{"description":"Audio bitrate in kbps","type":["integer","null"],"example":128},"modificationDate":{"description":"Modification date timestamp","type":["integer","null"],"example":1769430880},"creationDate":{"description":"Creation date timestamp","type":["integer","null"],"example":1565353556},"filenameSuffix":{"description":"Filename suffix","type":["string","null"],"example":null}},"type":"object"},"VideoType":{"title":"Video Type","required":["key"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"key","type":"string","example":"image"}},"type":"object"},"WebsiteSetting":{"title":"Website Setting","required":["id","name","type","data"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"ID","type":"integer","example":1},"name":{"description":"Name","type":"string","example":"site_title"},"language":{"description":"Language","type":"string","example":"en"},"type":{"description":"Type","type":["string","null"],"example":"text"},"data":{"description":"Data","example":"Some text data","anyOf":[{"type":"string"},{"type":"boolean"},{"$ref":"#/components/schemas/WebsiteSettingsObjectData"},{"type":"null"}]},"siteId":{"description":"Site ID","type":["integer","null"],"example":1},"creationDate":{"description":"Creation date","type":["integer","null"],"example":null},"modificationDate":{"description":"Modification date","type":["integer","null"],"example":null}},"type":"object"},"WebsiteSettingsAdd":{"title":"Website Settings Add","required":["name","type"],"properties":{"name":{"description":"Name","type":"string","example":"New Custom Setting"},"type":{"description":"Type","type":"string","example":"document"}},"type":"object"},"WebsiteSettingsObjectData":{"title":"Website Settings Object Data","required":["id","fullPath"],"properties":{"id":{"description":"element id","type":"integer","example":1020},"fullPath":{"description":"element fullPath","type":"string","example":"/path/to/object"}},"type":"object"},"WebsiteSettingsType":{"title":"Website Settings Type","required":["key","title"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"key":{"description":"Key","type":"string","example":"boolean"},"title":{"description":"Title","type":"string","example":"Checkbox"}},"type":"object"},"WebsiteSettingsUpdate":{"title":"Website Settings Update","required":["name","language","data","siteId"],"properties":{"name":{"description":"Name","type":"string","example":"Updated Setting Title"},"language":{"description":"Language","type":"string","example":"en"},"data":{"description":"Data","example":"{\"id\": 136,\"fullPath\": \"/de\"}","anyOf":[{"type":"string"},{"type":"boolean"},{"$ref":"#/components/schemas/WebsiteSettingsObjectData"},{"type":"null"}]},"siteId":{"description":"Site ID","type":["integer","null"],"example":1}},"type":"object"},"WidgetConfig":{"title":"Widget Config","required":["id","name","widgetType","icon","onlyWrapper"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"Widget ID","type":"string","example":"5026c239_eb75_499a_8576_841bca283350"},"name":{"description":"Name","type":"string","example":"Cars"},"widgetType":{"description":"Widget Type","type":"string","example":"element_trees"},"icon":{"$ref":"#/components/schemas/ElementIcon","description":"Icon"},"onlyWrapper":{"description":"If widget is only wrapper of another configuration","type":"boolean","example":false}},"type":"object"},"WidgetType":{"title":"WidgetType","required":["id"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"id":{"description":"id","type":"string","example":"info"}},"type":"object"},"WorkflowDetails":{"title":"WorkflowDetails","required":["workflowName","workflowLabel","workflowStatus","graph","workflowLayoutId","allowedTransitions","globalActions"],"properties":{"additionalAttributes":{"description":"AdditionalAttributes","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}},"workflowName":{"description":"workflowName","type":"string","example":"simple_asset"},"workflowLabel":{"description":"workflowLabel","type":"string","example":"Sample Asset Workflow"},"workflowStatus":{"description":"workflowStatus","type":"array","items":{"$ref":"#/components/schemas/WorkflowStatus"}},"graph":{"description":"graph","type":"string","example":"..."},"workflowLayoutId":{"description":"workflowLayoutId","type":["string","null"],"example":"someWorkflowLayoutId"},"allowedTransitions":{"description":"allowedTransitions","type":"array","items":{"$ref":"#/components/schemas/AllowedTransition"}},"globalActions":{"description":"globalActions","type":"array","items":{"$ref":"#/components/schemas/GlobalAction"}}},"type":"object"},"WorkflowStatus":{"title":"WorkflowStatus","required":["color","colorInverted","title","label","layoutId","visibleInDetail"],"properties":{"color":{"description":"color","type":"string","example":"#3572b0"},"colorInverted":{"description":"colorInverted","type":"boolean","example":false},"title":{"description":"borderColor","type":"string","example":"#ffa500"},"label":{"description":"label","type":"string","example":"Edit Images"},"layoutId":{"description":"layoutId","type":["string","null"],"example":"someStatusLayoutId"},"visibleInDetail":{"description":"visibleInDetail","type":"boolean","example":true}},"type":"object"},"WysiwygWidgetConfig":{"title":"Wysiwyg Widget Config","required":["color","wysiwyg","isWriteable"],"type":"object","allOf":[{"$ref":"#/components/schemas/DashboardsWidgetConfig"},{"properties":{"color":{"description":"Widget Color","type":"string","example":"#FF5733"},"wysiwyg":{"description":"Wysiwyg Content","type":["string","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"}]} ================================================ FILE: assets/studio/build/api/openapi-config.ts ================================================ /** * Pimcore * * This source file is available under two different licenses: * - Pimcore Open Core License (POCL) * - Pimcore Commercial License (PCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org) * @license https://github.com/pimcore/studio-ui-bundle/blob/1.x/LICENSE.md POCL and PCL */ import { type ConfigFile } from '@rtk-query/codegen-openapi' import { EndpointMatcherFunction } from '@rtk-query/codegen-openapi/lib/types'; const pathMatcher = (pattern: RegExp): EndpointMatcherFunction => { return (name, definition) => { return pattern.test(definition.path); } } const config: ConfigFile = { schemaFile: './docs.jsonopenapi.json', apiFile: '@pimcore/studio-ui-bundle/api', apiImport: 'api', outputFiles: { '../../js/src/modules/config/config-api-slice.gen.ts': { filterEndpoints: pathMatcher(/bundle\/data-hub\/config/i) }, '../../js/src/modules/config/users-api-slice.gen.ts': { filterEndpoints: pathMatcher(/bundle\/data-hub\/users/i) }, '../../js/src/modules/graphql/graphql-api-slice.gen.ts': { filterEndpoints: pathMatcher(/bundle\/data-hub\/graphql/i) }, '../../js/src/modules/operators/thumbnails-api-slice.gen.ts': { filterEndpoints: pathMatcher(/bundle\/data-hub\/thumbnails/i) }, }, exportName: 'api', hooks: true, tag: true } export default config ================================================ FILE: assets/studio/dist/.gitkeep ================================================ ================================================ FILE: assets/studio/eslint.config.mjs ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import tseslint from 'typescript-eslint' import js from '@eslint/js' import globals from 'globals' import stylistic from '@stylistic/eslint-plugin' import reactPlugin from 'eslint-plugin-react' import jsxA11y from 'eslint-plugin-jsx-a11y' import importPlugin from 'eslint-plugin-import' import promisePlugin from 'eslint-plugin-promise' import nPlugin from 'eslint-plugin-n' import headerPluginRaw from 'eslint-plugin-header' import { fileURLToPath } from 'url' import path from 'path' const __filename = fileURLToPath(import.meta.url) const __dirname = path.dirname(__filename) // eslint-plugin-header v3.x has no schema defined; ESLint v9 defaults to [] // which blocks all options. Patch in a permissive schema as a workaround. const headerPlugin = { ...headerPluginRaw, rules: { ...headerPluginRaw.rules, header: { ...headerPluginRaw.rules.header, meta: { ...headerPluginRaw.rules.header.meta, schema: { type: 'array' } } } } } export default tseslint.config( // 1. Ignore patterns { ignores: ['**/*.gen.ts'] }, // 2. Main config for all TS/TSX/JS/JSX source files { files: ['**/*.{js,jsx,ts,tsx}'], extends: [ js.configs.recommended, ...tseslint.configs.recommended ], plugins: { '@stylistic': stylistic, react: reactPlugin, 'jsx-a11y': jsxA11y, import: importPlugin, promise: promisePlugin, n: nPlugin, header: headerPlugin }, languageOptions: { globals: { ...globals.browser, ...globals.es2021 }, parserOptions: { project: true, tsconfigRootDir: __dirname, ecmaFeatures: { jsx: true } } }, settings: { react: { version: 'detect' } }, rules: { // ----------------------------------------------------------------------- // React rules (from plugin:react/recommended) // ----------------------------------------------------------------------- ...reactPlugin.configs.flat.recommended.rules, // ----------------------------------------------------------------------- // jsx-a11y rules (from plugin:jsx-a11y/recommended) // ----------------------------------------------------------------------- ...jsxA11y.flatConfigs.recommended.rules, // ----------------------------------------------------------------------- // import rules (subset from eslint-config-standard) // ----------------------------------------------------------------------- 'import/export': 'error', 'import/first': 'error', 'import/no-absolute-path': ['error', { esmodule: true, commonjs: true, amd: false }], 'import/no-duplicates': 'error', 'import/no-named-default': 'error', 'import/no-webpack-loader-syntax': 'error', // ----------------------------------------------------------------------- // promise rules (subset from eslint-config-standard) // ----------------------------------------------------------------------- 'promise/param-names': 'error', // ----------------------------------------------------------------------- // n rules (subset from eslint-config-standard) // ----------------------------------------------------------------------- 'n/handle-callback-err': ['error', '^(err|error)$'], 'n/no-callback-literal': 'error', 'n/no-deprecated-api': 'error', 'n/no-exports-assign': 'error', 'n/no-new-require': 'error', 'n/no-path-concat': 'error', 'n/process-exit-as-throw': 'error', // ----------------------------------------------------------------------- // Standard JS style rules (from eslint-config-standard) // Base ESLint rules that are not superseded by @typescript-eslint/* // ----------------------------------------------------------------------- 'no-var': 'warn', 'object-shorthand': ['warn', 'properties'], 'accessor-pairs': ['error', { setWithoutGet: true, enforceForClassMembers: true }], 'array-bracket-spacing': ['error', 'never'], 'array-callback-return': ['error', { allowImplicit: false, checkForEach: false }], 'arrow-spacing': ['error', { before: true, after: true }], 'comma-style': ['error', 'last'], 'computed-property-spacing': ['error', 'never', { enforceForClassMembers: true }], 'constructor-super': 'error', 'curly': ['error', 'multi-line'], 'default-case-last': 'error', 'dot-location': ['error', 'property'], 'eol-last': 'error', 'eqeqeq': ['error', 'always', { null: 'ignore' }], 'generator-star-spacing': ['error', { before: true, after: true }], 'new-cap': ['error', { newIsCap: true, capIsNew: false, properties: true }], 'new-parens': 'error', 'no-array-constructor': 'off', // superseded by @typescript-eslint/no-array-constructor 'no-async-promise-executor': 'error', 'no-caller': 'error', 'no-case-declarations': 'error', 'no-class-assign': 'error', 'no-compare-neg-zero': 'error', 'no-cond-assign': 'error', 'no-const-assign': 'error', 'no-constant-condition': ['error', { checkLoops: false }], 'no-control-regex': 'error', 'no-debugger': 'error', 'no-delete-var': 'error', 'no-dupe-args': 'error', 'no-dupe-keys': 'error', 'no-duplicate-case': 'error', 'no-empty': ['error', { allowEmptyCatch: true }], 'no-empty-character-class': 'error', 'no-empty-pattern': 'error', 'no-eval': 'error', 'no-ex-assign': 'error', 'no-extend-native': 'error', 'no-extra-bind': 'error', 'no-extra-boolean-cast': 'error', 'no-fallthrough': 'error', 'no-floating-decimal': 'error', 'no-func-assign': 'error', 'no-global-assign': 'error', 'no-import-assign': 'error', 'no-invalid-regexp': 'error', 'no-irregular-whitespace': 'error', 'no-iterator': 'error', 'no-labels': ['error', { allowLoop: true }], 'no-lone-blocks': 'error', 'no-misleading-character-class': 'error', 'no-multi-str': 'error', 'no-new': 'error', 'no-new-func': 'error', 'no-new-object': 'error', 'no-new-wrappers': 'error', 'no-obj-calls': 'error', 'no-octal': 'error', 'no-octal-escape': 'error', 'no-proto': 'error', 'no-prototype-builtins': 'error', 'no-regex-spaces': 'error', 'no-return-assign': ['error', 'except-parens'], 'no-self-assign': ['error', { props: true }], 'no-self-compare': 'error', 'no-sequences': 'error', 'no-setter-return': 'error', 'no-shadow-restricted-names': 'error', 'no-sparse-arrays': 'error', 'no-template-curly-in-string': 'error', 'no-this-before-super': 'error', 'no-undef-init': 'error', 'no-unexpected-multiline': 'error', 'no-unmodified-loop-condition': 'error', 'no-unneeded-ternary': ['error', { defaultAssignment: false }], 'no-unreachable': 'error', 'no-unreachable-loop': 'error', 'no-unsafe-finally': 'error', 'no-unsafe-negation': 'error', 'no-unused-private-class-members': 'error', 'no-useless-backreference': 'error', 'no-useless-call': 'error', 'no-useless-catch': 'error', 'no-useless-computed-key': 'error', 'no-useless-escape': 'error', 'no-useless-rename': 'error', 'no-useless-return': 'error', 'no-whitespace-before-property': 'error', 'no-with': 'error', 'object-curly-newline': ['error', { multiline: true, consistent: true }], 'object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }], 'one-var': ['error', { initialized: 'never' }], 'operator-linebreak': ['error', 'after', { overrides: { '?': 'before', ':': 'before', '|>': 'before' } }], 'padded-blocks': ['error', { blocks: 'never', switches: 'never', classes: 'never' }], 'prefer-const': ['error', { destructuring: 'all' }], 'prefer-promise-reject-errors': 'error', 'prefer-regex-literals': ['error', { disallowRedundantWrapping: true }], 'quote-props': ['error', 'as-needed'], 'rest-spread-spacing': ['error', 'never'], 'semi-spacing': ['error', { before: false, after: true }], 'space-in-parens': ['error', 'never'], 'space-unary-ops': ['error', { words: true, nonwords: false }], 'spaced-comment': ['error', 'always', { line: { markers: ['*package', '!', '/', ',', '='] }, block: { balanced: true, markers: ['*package', '!', ',', ':', '::', 'flow-include'], exceptions: ['*'] } }], 'symbol-description': 'error', 'template-curly-spacing': ['error', 'never'], 'template-tag-spacing': ['error', 'never'], 'unicode-bom': ['error', 'never'], 'use-isnan': ['error', { enforceForSwitchCase: true, enforceForIndexOf: true }], 'valid-typeof': ['error', { requireStringLiterals: true }], 'wrap-iife': ['error', 'any', { functionPrototypeMethods: true }], 'yield-star-spacing': ['error', 'both'], 'yoda': ['error', 'never'], // Turn off base rules superseded by @typescript-eslint/* equivalents 'camelcase': 'off', 'dot-notation': 'off', 'no-implied-eval': 'off', 'no-loss-of-precision': 'off', 'no-redeclare': 'off', 'no-throw-literal': 'off', 'no-unused-vars': 'off', 'no-unused-expressions': 'off', '@typescript-eslint/no-unused-expressions': 'off', 'no-useless-constructor': 'off', 'no-void': ['error', { allowAsStatement: true }], // ----------------------------------------------------------------------- // @stylistic rules (replaces the 17 formatting rules removed from // @typescript-eslint v8, previously wired through standard-with-typescript) // ----------------------------------------------------------------------- '@stylistic/block-spacing': ['error', 'always'], '@stylistic/brace-style': ['error', '1tbs', { allowSingleLine: true }], '@stylistic/comma-dangle': ['error', { arrays: 'never', objects: 'never', imports: 'never', exports: 'never', functions: 'never', enums: 'ignore', generics: 'ignore', tuples: 'ignore' }], '@stylistic/comma-spacing': ['error', { before: false, after: true }], '@stylistic/function-call-spacing': ['error', 'never'], '@stylistic/indent': ['error', 2, { SwitchCase: 1, VariableDeclarator: 1, outerIIFEBody: 1, MemberExpression: 1, FunctionDeclaration: { parameters: 1, body: 1 }, FunctionExpression: { parameters: 1, body: 1 }, CallExpression: { arguments: 1 }, ArrayExpression: 1, ObjectExpression: 1, ImportDeclaration: 1, flatTernaryExpressions: false, ignoreComments: false, ignoredNodes: [ 'TemplateLiteral *', 'JSXElement', 'JSXElement > *', 'JSXAttribute', 'JSXIdentifier', 'JSXNamespacedName', 'JSXMemberExpression', 'JSXSpreadAttribute', 'JSXExpressionContainer', 'JSXOpeningElement', 'JSXClosingElement', 'JSXFragment', 'JSXOpeningFragment', 'JSXClosingFragment', 'JSXText', 'JSXEmptyExpression', 'JSXSpreadChild' ], offsetTernaryExpressions: true }], '@stylistic/key-spacing': ['error', { beforeColon: false, afterColon: true }], '@stylistic/keyword-spacing': ['error', { before: true, after: true }], '@stylistic/lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }], '@stylistic/member-delimiter-style': ['error', { multiline: { delimiter: 'none' }, singleline: { delimiter: 'comma', requireLast: false } }], '@stylistic/object-curly-spacing': ['error', 'always'], '@stylistic/quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: 'never' }], '@stylistic/semi': ['error', 'never'], '@stylistic/space-before-blocks': ['error', 'always'], '@stylistic/space-before-function-paren': ['error', 'always'], '@stylistic/space-infix-ops': 'error', '@stylistic/type-annotation-spacing': 'error', // ----------------------------------------------------------------------- // @typescript-eslint type-aware rules (from standard-with-typescript) // ----------------------------------------------------------------------- // no-explicit-any / no-unused-vars: turned off — pre-existing widespread usage; // address in a dedicated cleanup PR '@typescript-eslint/no-explicit-any': 'off', '@typescript-eslint/no-unused-vars': 'off', 'no-unused-vars': 'off', // ----------------------------------------------------------------------- '@typescript-eslint/consistent-type-assertions': ['error', { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' }], '@typescript-eslint/consistent-type-definitions': ['error', 'interface'], '@typescript-eslint/consistent-type-exports': 'off', '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports', disallowTypeAnnotations: true, fixStyle: 'inline-type-imports' }], '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, allowDirectConstAssertionInArrowFunctions: true }], '@typescript-eslint/method-signature-style': 'error', '@typescript-eslint/naming-convention': ['error', { selector: 'variableLike', leadingUnderscore: 'allow', trailingUnderscore: 'allow', format: ['camelCase', 'PascalCase', 'UPPER_CASE'] }], '@typescript-eslint/no-array-constructor': 'error', '@typescript-eslint/no-base-to-string': 'off', '@typescript-eslint/no-confusing-void-expression': ['error', { ignoreArrowShorthand: false, ignoreVoidOperator: false }], '@typescript-eslint/no-dynamic-delete': 'error', '@typescript-eslint/no-extraneous-class': ['error', { allowWithDecorator: true }], '@typescript-eslint/no-floating-promises': 'error', '@typescript-eslint/no-for-in-array': 'error', '@typescript-eslint/no-invalid-void-type': 'error', '@typescript-eslint/no-misused-new': 'error', '@typescript-eslint/no-misused-promises': 'off', '@typescript-eslint/no-namespace': 'error', '@typescript-eslint/no-non-null-asserted-optional-chain': 'error', '@typescript-eslint/no-non-null-assertion': 'off', '@typescript-eslint/no-this-alias': ['error', { allowDestructuring: true }], '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error', '@typescript-eslint/no-unnecessary-type-assertion': 'error', '@typescript-eslint/no-unnecessary-type-constraint': 'error', '@typescript-eslint/no-unsafe-argument': 'error', '@typescript-eslint/non-nullable-type-assertion-style': 'error', '@typescript-eslint/prefer-function-type': 'error', '@typescript-eslint/prefer-includes': 'error', '@typescript-eslint/prefer-nullish-coalescing': ['error', { ignoreConditionalTests: false, ignoreMixedLogicalExpressions: false }], '@typescript-eslint/prefer-optional-chain': 'error', '@typescript-eslint/prefer-readonly': 'error', '@typescript-eslint/prefer-reduce-type-parameter': 'error', '@typescript-eslint/prefer-return-this-type': 'error', '@typescript-eslint/promise-function-async': 'error', '@typescript-eslint/require-array-sort-compare': ['error', { ignoreStringArrays: true }], '@typescript-eslint/restrict-plus-operands': ['error', { skipCompoundAssignments: false }], '@typescript-eslint/restrict-template-expressions': ['error', { allowNumber: true }], '@typescript-eslint/return-await': ['error', 'always'], '@typescript-eslint/strict-boolean-expressions': 'off', '@typescript-eslint/triple-slash-reference': ['error', { lib: 'never', path: 'never', types: 'never' }], '@typescript-eslint/unbound-method': 'off', // v8: renamed no-var-requires → no-require-imports '@typescript-eslint/no-require-imports': 'error', // v8: ban-types split into targeted rules '@typescript-eslint/no-unsafe-function-type': 'error', '@typescript-eslint/no-wrapper-object-types': 'error', '@typescript-eslint/no-empty-object-type': ['error', { allowInterfaces: 'always' }], // v8: no-throw-literal renamed to only-throw-error '@typescript-eslint/only-throw-error': 'error', // v8: prefer-ts-expect-error deprecated in favour of ban-ts-comment option '@typescript-eslint/ban-ts-comment': ['error', { 'ts-expect-error': 'allow-with-description' }], // ----------------------------------------------------------------------- // header (license block check) // ----------------------------------------------------------------------- 'header/header': [2, 'block', [ '*', ' * This source file is available under the terms of the', ' * Pimcore Open Core License (POCL)', ' * Full copyright and license information is available in', ' * LICENSE.md which is distributed with this source code.', ' *', ' * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com)', ' * @license Pimcore Open Core License (POCL)', ' ' ], 2], // ----------------------------------------------------------------------- // React JSX rules (from original .eslintrc.js) // ----------------------------------------------------------------------- 'react/jsx-boolean-value': 'error', 'react/jsx-closing-bracket-location': 'error', 'react/jsx-curly-spacing': ['error', 'always'], 'react/jsx-equals-spacing': 'error', 'react/jsx-first-prop-new-line': 'error', 'react/jsx-indent-props': ['error', 2], 'react/jsx-indent': ['error', 2], 'react/jsx-key': 'error', 'react/jsx-max-props-per-line': ['error', { maximum: 1 }], 'react/jsx-no-literals': 'off', 'react/jsx-no-target-blank': 'error', 'react/jsx-pascal-case': 'error', 'react/jsx-sort-props': 'error', 'react/jsx-tag-spacing': 'error', 'react/jsx-no-constructed-context-values': 'error', 'react/jsx-wrap-multilines': ['error', { declaration: 'parens-new-line', assignment: 'parens-new-line', return: 'parens-new-line', arrow: 'parens-new-line', condition: 'parens-new-line', logical: 'parens-new-line', prop: 'ignore' }], // ----------------------------------------------------------------------- // Misc // ----------------------------------------------------------------------- 'max-lines': ['error', { max: 300 }] } }, // 3. Node environment for config files themselves { files: ['eslint.config.{js,mjs,cjs}', '.eslintrc.{js,cjs}'], languageOptions: { globals: { ...globals.node } } } ) ================================================ FILE: assets/studio/js/src/components/base-detail-view/base-detail-view.styles.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { createStyles } from 'antd-style' export const useStyles = createStyles(({ css }) => { return { formWrapper: css` display: contents; > form { display: flex; flex-direction: column; flex: 1; min-height: 0; } ` } }) ================================================ FILE: assets/studio/js/src/components/base-detail-view/base-detail-view.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { type ReactNode } from 'react' import { Tabs, FormKit, Content, ContentLayout, type formInstanceType } from '@pimcore/studio-ui-bundle/components' import { useStyles } from './base-detail-view.styles' export interface TabItem { key: string label: string children: ReactNode /** When true, the tab content fills full height without a scrollable Panel wrapper. */ fullHeight?: boolean } export interface BaseDetailViewProps { toolbar: ReactNode tabs: TabItem[] isLoading: boolean form: formInstanceType initialValues: any onValuesChange: (changedValues: any, allValues: any) => void disabled?: boolean requestId?: string } export function BaseDetailView ({ toolbar, tabs, isLoading, form, initialValues, onValuesChange, disabled = false, requestId }: BaseDetailViewProps): React.JSX.Element { const { styles } = useStyles() const enhancedTabs = tabs.map((tab) => ({ ...tab, children: tab.fullHeight === true ? tab.children : ( { tab.children } ) })) return ( {!isLoading && (
)} ) } ================================================ FILE: assets/studio/js/src/components/base-detail-view/components/config-toolbar/config-toolbar.styles.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { createStyles } from 'antd-style' export const useStyles = createStyles(({ css, token }) => { return { divider: css` height: ${token.fontSizeLG}px; align-self: center; margin-top: 0 !important; margin-bottom: 0 !important; margin-inline: ${token.marginXXS}px; ` } }) ================================================ FILE: assets/studio/js/src/components/base-detail-view/components/config-toolbar/config-toolbar.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { type ReactNode } from 'react' import { Button, ButtonGroup, Divider, Tooltip, Toolbar, IconButton, Space } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { ExportButton } from '../../../../modules/config/components/export-button' import { useStyles } from './config-toolbar.styles' export interface ConfigToolbarProps { configName: string isWriteable: boolean isLoading: boolean isSaving: boolean isDirty: boolean onSave: () => void onRefresh: () => void onDelete: () => void additionalButtons?: ReactNode[] leftAdditionalContent?: ReactNode } export function ConfigToolbar ({ configName, isWriteable, isLoading, isSaving, isDirty, onSave, onRefresh, onDelete, additionalButtons = [], leftAdditionalContent }: ConfigToolbarProps): React.JSX.Element { const { t } = useTranslation() const { styles } = useStyles() const saveButton = ( ) const rightButtons: ReactNode[] = [ ...additionalButtons, !isWriteable ? ( {saveButton} ) : saveButton ] return ( {leftAdditionalContent !== undefined && ( <> {leftAdditionalContent} )} ) } ================================================ FILE: assets/studio/js/src/components/base-detail-view/components/config-toolbar/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './config-toolbar' ================================================ FILE: assets/studio/js/src/components/base-detail-view/hooks/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './use-detail-view' ================================================ FILE: assets/studio/js/src/components/base-detail-view/hooks/use-detail-view.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { useEffect, useState, useMemo, useRef } from 'react' import { Form, useMessage, type formInstanceType } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { ApiError, trackError, isApiErrorData } from '@pimcore/studio-ui-bundle/modules/app' import { isNil } from 'lodash' export interface UseDetailViewProps { configName: string configData: TBackendConfig | undefined modificationDate: number | undefined isLoading: boolean requestId: string | undefined transformToForm: (backendConfig: TBackendConfig, configName: string) => TFormValues transformToBackend: (formValues: TFormValues, existingConfig: TBackendConfig) => TBackendConfig onSave: (updatedConfig: TBackendConfig, modificationDate: number) => Promise<{ modificationDate?: number }> onChange: (isDirty: boolean) => void successMessageKey?: string } export interface UseDetailViewReturn { form: formInstanceType isDirty: boolean initialValues: TFormValues handleSave: () => void handleValuesChange: () => void } export function useDetailView, TBackendConfig extends Record> ({ configName, configData, modificationDate, isLoading, requestId, transformToForm, transformToBackend, onSave, onChange, successMessageKey = 'save-success' }: UseDetailViewProps): UseDetailViewReturn { const [form] = Form.useForm() const { t } = useTranslation() const messageApi = useMessage() const [isDirty, setIsDirty] = useState(false) const modificationDateRef = useRef(0) const isSavingRef = useRef(false) const initialValues = useMemo(() => { return transformToForm((configData ?? {}) as TBackendConfig, configName) }, [configData, configName]) useEffect(() => { if (isLoading || isNil(configData)) return form.setFieldsValue(initialValues) setIsDirty(false) onChange(false) if (!isSavingRef.current) { modificationDateRef.current = modificationDate ?? 0 } }, [requestId, initialValues, modificationDate, isLoading]) const handleValuesChange = (): void => { setIsDirty(true) onChange(true) } const handleSave = (): void => { if (isSavingRef.current) { return } form.validateFields().then(async (values) => { isSavingRef.current = true try { const mergedValues: TFormValues = { ...initialValues, ...values as TFormValues } const updatedConfig = transformToBackend(mergedValues, (configData ?? {}) as TBackendConfig) const response = await onSave(updatedConfig, modificationDateRef.current) if (!isNil(response?.modificationDate)) { modificationDateRef.current = response.modificationDate } setIsDirty(false) onChange(false) void messageApi.success(t(successMessageKey)) } catch (error) { if (isApiErrorData(error)) { trackError(new ApiError(error)) } } finally { isSavingRef.current = false } }).catch((error) => { console.error('Validation failed:', error) void messageApi.error(t('data-hub.save-validation-error')) }) } return { form, isDirty, initialValues, handleSave, handleValuesChange } } ================================================ FILE: assets/studio/js/src/components/base-detail-view/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './base-detail-view' export * from './components/config-toolbar' export * from './hooks' ================================================ FILE: assets/studio/js/src/config/service-ids.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ /** * Service IDs for the Data Hub Bundle * Centralized location for all dependency injection service identifiers */ export const bundleServiceIds = { 'DataHub/DynamicTypes/Adapter/Registry': 'DataHub/DynamicTypes/Adapter/Registry', 'DataHub/DynamicTypes/Adapter/GraphQL': 'DataHub/DynamicTypes/Adapter/GraphQL', 'DataHub/DynamicTypes/Operator/GraphQL/QueryRegistry': 'DataHub/DynamicTypes/Operator/GraphQL/QueryRegistry', 'DataHub/DynamicTypes/Operator/GraphQL/MutationRegistry': 'DataHub/DynamicTypes/Operator/GraphQL/MutationRegistry', // Query Operators 'DataHub/DynamicTypes/Operator/Alias': 'DataHub/DynamicTypes/Operator/Alias', 'DataHub/DynamicTypes/Operator/Concatenator': 'DataHub/DynamicTypes/Operator/Concatenator', 'DataHub/DynamicTypes/Operator/DateFormatter': 'DataHub/DynamicTypes/Operator/DateFormatter', 'DataHub/DynamicTypes/Operator/ElementCounter': 'DataHub/DynamicTypes/Operator/ElementCounter', 'DataHub/DynamicTypes/Operator/Substring': 'DataHub/DynamicTypes/Operator/Substring', 'DataHub/DynamicTypes/Operator/Text': 'DataHub/DynamicTypes/Operator/Text', 'DataHub/DynamicTypes/Operator/Thumbnail': 'DataHub/DynamicTypes/Operator/Thumbnail', 'DataHub/DynamicTypes/Operator/ThumbnailHtml': 'DataHub/DynamicTypes/Operator/ThumbnailHtml', 'DataHub/DynamicTypes/Operator/TranslateValue': 'DataHub/DynamicTypes/Operator/TranslateValue', 'DataHub/DynamicTypes/Operator/Trimmer': 'DataHub/DynamicTypes/Operator/Trimmer', // Mutation Operators 'DataHub/DynamicTypes/Operator/IfEmpty': 'DataHub/DynamicTypes/Operator/IfEmpty', 'DataHub/DynamicTypes/Operator/LocaleCollector': 'DataHub/DynamicTypes/Operator/LocaleCollector', 'DataHub/DynamicTypes/Operator/LocaleSwitcher': 'DataHub/DynamicTypes/Operator/LocaleSwitcher' } as const ================================================ FILE: assets/studio/js/src/main.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ // eslint-disable-next-line header/header ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/base-column-editor.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useCallback, useEffect, useImperativeHandle, useMemo, useState, forwardRef } from 'react' import { Empty, Tag } from 'antd' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { Button, Content, ContentLayout, Dropdown, Flex, IconButton, IconTextButton, Space, Spin, StackList, Toolbar, type StackListProps } from '@pimcore/studio-ui-bundle/components' import { LanguageSelectionContext, LanguageSelectionWithProvider } from '@pimcore/studio-ui-bundle/modules/data-object' import { useUser } from '@pimcore/studio-ui-bundle/modules/auth' import { isNil } from 'lodash' import { ColumnEditorItemBody } from './column-editor-item' import { ColumnLocaleControl } from './column-locale-control' import { useColumnEditorState } from './use-column-editor-state' import { ADVANCED_COLUMN_TYPE, type ColumnEditorHandle, type SchemaColumn, type AdvancedEditorColumn } from './types' const getColumnLabel = (col: AdvancedEditorColumn): string => { if (col.key === '') return '' return col.key } export interface BaseColumnEditorProps { entity: string classDefinitionId?: string columns: SchemaColumn[] onApply: (columns: SchemaColumn[]) => void onCancel: () => void /** When true, the Apply/Discard/Add-column toolbar is hidden (used in split migration view). */ hideToolbar?: boolean /** Service ID of the DynamicTypePipelineRegistry to use for source fields. */ sourceFieldsRegistryId: string /** Service ID of the DynamicTypePipelineRegistry to use for transformers. */ transformersRegistryId: string /** The currently selected preview language. When provided, the LanguageSelection is controlled externally. */ language?: string /** Called when the user changes the preview language inside the modal. */ onLanguageChange?: (language: string) => void } export const BaseColumnEditor = forwardRef( function BaseColumnEditor ({ entity, classDefinitionId, columns, onApply, onCancel, hideToolbar = false, sourceFieldsRegistryId, transformersRegistryId, language, onLanguageChange }: BaseColumnEditorProps, ref): React.JSX.Element { const { t } = useTranslation() const user = useUser() // Own the language state here. Initialize once from the prop, falling back to // the user's first content language. This is the single source of truth — // no synchronization effects needed. const initialLanguage = language ?? (user.contentLanguages as string[] | undefined)?.[0] ?? 'en' const [currentLanguage, setCurrentLanguage] = useState(initialLanguage) const [hasLocalizedFields, setHasLocalizedFields] = useState(false) // On mount, persist the resolved initial language to the parent so that // entities that have never had a language set get one saved immediately. useEffect(() => { onLanguageChange?.(currentLanguage) }, []) const handleLanguageChange = useCallback((lang: string) => { setCurrentLanguage(lang) onLanguageChange?.(lang) }, [onLanguageChange]) // Build a stable context value to pass to the provider. const languageContextValue = useMemo(() => ({ currentLanguage, setCurrentLanguage: handleLanguageChange, hasLocalizedFields, setHasLocalizedFields }), [currentLanguage, handleLanguageChange, hasLocalizedFields]) const { draft, isLoading, objectId, addColumnMenu, openElementSelector, handleAddColumnOfType, handlePipelineChange, handleRemove, handleApply, handleDiscard, handleLocaleChange, handleReorder, getColumns } = useColumnEditorState({ entity, classDefinitionId, columns, onApply, onCancel }) useImperativeHandle(ref, () => ({ getColumns, addColumn: handleAddColumnOfType }), [getColumns, handleAddColumnOfType]) const stackItems: StackListProps['items'] = draft.map(col => { const isAdvanced = col.type === ADVANCED_COLUMN_TYPE const label = getColumnLabel(col) return { id: col._id, sortable: true, type: isAdvanced ? 'collapse' as const : 'default' as const, children: isAdvanced ? { !isNil(col.pipeline?.title) ? String(col.pipeline?.title) : label } : { label }, ...(isAdvanced ? { body: col.pipelineConfig !== undefined ? ( ) : } : {}), renderRightToolbar: ( { col.localizable === true && isAdvanced && ( { handleLocaleChange(col._id, locale) } } value={ col.locale } /> ) } { handleRemove(col._id) } } theme='secondary' /> ) } }) if (isLoading) { return ( ) } return ( { t('data-hub.column-config-modal.add-column') } ) } renderTopBar={ ( ) } > { draft.length === 0 && ( ) } { draft.length > 0 && ( { handleReorder(items.map(item => String(item.id))) } } sortable /> ) } ) } ) ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/column-config-modal.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useCallback, useRef, useState } from 'react' import { Dropdown, Flex, IconTextButton, Modal, ModalTitle, useAlertModal } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { api, type GridColumnConfiguration } from '@pimcore/studio-ui-bundle/api/data-object' import { useClassDefinitions } from '@pimcore/studio-ui-bundle/modules/data-object' import { MigrationModal } from '../migration-modal' import { useAddColumnDropdown } from './use-add-column-dropdown' import { type ColumnEditorHandle, type SchemaColumn } from './types' /** * Props passed from ColumnConfigModal down to the consumer's renderEditor callback. * The consumer must forward `ref` to their editor component so ColumnConfigModal * can imperatively call `getColumns()` on confirm. */ export interface EditorRenderProps { ref: React.Ref> classDefinitionId: string columns: TColumns[] entity: string /** True in the split migration view — the editor should hide its own Apply/Discard toolbar. */ hideToolbar: boolean onApply: (columns: TColumns[]) => void onCancel: () => void /** The currently persisted preview language for this entity. */ language?: string /** Called when the user changes the preview language so the adapter can persist it. */ onLanguageChange?: (language: string) => void } export interface ColumnConfigModalProps { entity: string /** * The numeric Pimcore class definition ID (e.g. "EV", "42"). * When omitted the ID is resolved from the class name via useClassDefinitions(). */ classDefinitionId?: string columns: TColumns[] /** * Legacy ExtJS column configuration blob. When present, the migration flow is shown. * When absent (undefined), the normal new-format editor modal is shown. */ columnConfig?: Record open: boolean /** Already-translated modal title string. */ title: string onApply: (columns: TColumns[]) => void onCancel: () => void /** The currently persisted preview language for this entity. */ language?: string /** Called when the user changes the preview language so the adapter can persist it. */ onLanguageChange?: (language: string) => void /** * Render prop that returns the adapter-specific column editor element. * The consumer MUST forward the `ref` to their editor component (forwardRef). * * @example * renderEditor={(props) => } */ renderEditor: (props: EditorRenderProps) => React.ReactNode } /** * Generic ColumnConfigModal for Data Hub adapter bundles. * * Handles both the new-format path (plain Modal + editor) and the legacy * migration path (MigrationModal with split view). The adapter-specific * editor is injected via the `renderEditor` render prop. */ export const ColumnConfigModal = ({ entity, classDefinitionId, columns, columnConfig, open, title, onApply, onCancel, language, onLanguageChange, renderEditor }: ColumnConfigModalProps): React.JSX.Element => { const { t } = useTranslation() const alertModal = useAlertModal() const { getByName } = useClassDefinitions() const resolvedClassId: string = React.useMemo(() => { if (classDefinitionId !== undefined) return classDefinitionId return getByName(entity)?.id ?? entity }, [classDefinitionId, entity, getByName]) const [migratedColumns, setMigratedColumns] = useState([]) const [isMigrated, setIsMigrated] = useState(false) const columnEditorRef = useRef>(null) const isLegacy = columnConfig !== undefined && !isMigrated const { data: availableFieldsData } = api.endpoints.dataObjectGetAvailableGridColumns.useQuery( { classId: resolvedClassId, folderId: 1 }, { skip: !isLegacy } ) const availableFields: GridColumnConfiguration[] = availableFieldsData?.columns ?? [] const handleAddColumn = useCallback((column: GridColumnConfiguration): void => { columnEditorRef.current?.addColumn(column) }, []) const addColumnMenu = useAddColumnDropdown(availableFields, handleAddColumn) const commitMigration = (cols: TColumns[]): void => { setMigratedColumns(cols) setIsMigrated(true) } const handleConfirmMigration = (): void => { const cols = columnEditorRef.current?.getColumns() ?? migratedColumns if (cols.length === 0) { alertModal.warn({ title: t('data-hub.migration-modal.confirm-empty-columns-title'), content: t('data-hub.migration-modal.confirm-empty-columns-content'), okText: t('data-hub.migration-modal.confirm-empty-columns-ok'), cancelText: t('data-hub.migration-modal.confirm-empty-columns-cancel'), okCancel: true, onOk: () => { commitMigration(cols) } }) return } commitMigration(cols) } const handleCancel = (): void => { setIsMigrated(false) onCancel() } const modalTitle = ( { title } ) if (!isLegacy) { return ( { renderEditor({ ref: columnEditorRef, classDefinitionId: resolvedClassId, columns: isMigrated ? migratedColumns : columns, entity, hideToolbar: false, language, onLanguageChange, onApply: (updatedColumns) => { onApply(updatedColumns) handleCancel() }, onCancel: handleCancel }) } ) } return ( { t('data-hub.column-config-modal.add-column') } } title={ title } > { renderEditor({ ref: columnEditorRef, classDefinitionId: resolvedClassId, columns: migratedColumns, entity, hideToolbar: true, language, onLanguageChange, onApply: (cols) => { setMigratedColumns(cols) }, onCancel: () => {} }) } ) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/column-editor-item.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { type AdvancedEditorColumn } from './types' import { ColumnPipelineForm } from './column-pipeline-form' export interface ColumnEditorItemBodyProps { column: AdvancedEditorColumn entity: string objectId: number | null onPipelineChange: (id: string, pipeline: Record) => void /** Service ID of the DynamicTypePipelineRegistry to use for source fields. */ sourceFieldsRegistryId: string /** Service ID of the DynamicTypePipelineRegistry to use for transformers. */ transformersRegistryId: string } export const ColumnEditorItemBody = ({ column, entity, objectId, onPipelineChange, sourceFieldsRegistryId, transformersRegistryId }: ColumnEditorItemBodyProps): React.JSX.Element => { return ( { onPipelineChange(column._id, pipeline) } } sourceFieldsRegistryId={ sourceFieldsRegistryId } transformersRegistryId={ transformersRegistryId } value={ column.pipeline } /> ) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/column-locale-control.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { LanguageSelection } from '@pimcore/studio-ui-bundle/components' import { useUser } from '@pimcore/studio-ui-bundle/modules/auth' export interface ColumnLocaleControlProps { value: string | null | undefined onChange: (locale: string | null) => void } export const ColumnLocaleControl = ({ value, onChange }: ColumnLocaleControlProps): React.JSX.Element => { const user = useUser() const languages: string[] = [ '-', ...(Array.isArray(user.contentLanguages) ? (user.contentLanguages as string[]) : []) ] const selected = value ?? '-' return ( { onChange(lang === '-' ? null : lang) } } selectedLanguage={ selected } /> ) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/column-pipeline-form.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useEffect, useState } from 'react' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { Box, Form, Input, Pipeline, PipelineConfigProvider, SplitLayout } from '@pimcore/studio-ui-bundle/components' import { isEqual } from 'lodash' import { type AdvancedEditorColumn } from './types' import { ColumnPreview } from './column-preview' export interface ColumnPipelineFormProps { column?: AdvancedEditorColumn entity?: string config?: Record objectId?: number | null value?: Record onChange?: (value: Record) => void /** Service ID of the DynamicTypePipelineRegistry to use for source fields. */ sourceFieldsRegistryId: string /** Service ID of the DynamicTypePipelineRegistry to use for transformers. */ transformersRegistryId: string } export const ColumnPipelineForm = ({ column, entity, config, objectId, value, onChange, sourceFieldsRegistryId, transformersRegistryId }: ColumnPipelineFormProps): React.JSX.Element => { const { t } = useTranslation() const [form] = Form.useForm() const [liveValue, setLiveValue] = useState>(value ?? {}) useEffect(() => { form.setFieldValue('value', value ?? {}) }, [value]) const onValuesChange = (changedValues: Record): void => { const newPipelineValue = form.getFieldValue('value') as Record if (newPipelineValue !== undefined && !isEqual(liveValue, newPipelineValue)) { setLiveValue(newPipelineValue) onChange?.(newPipelineValue) } } return (
) }, { id: 'fields', component: ( ), size: 50 } } rightItem={ { children: ( ), size: 50 } } withDivider /> ) }, { id: 'preview', component: ( { column !== undefined && ( ) } ) } ] } value={ value ?? {} } />
) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/column-preview.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useEffect, useRef, useState } from 'react' import { useTranslation, serviceIds, useInjection } from '@pimcore/studio-ui-bundle/app' import { Box, Flex, Grid, GridContentRenderer, Text } from '@pimcore/studio-ui-bundle/components' import { type DynamicTypeGridCellRegistry } from '@pimcore/studio-ui-bundle/modules/element' import { useLanguageSelection } from '@pimcore/studio-ui-bundle/modules/data-object' import { api, type AdvancedColumnConfig } from '@pimcore/studio-ui-bundle/api/data-object' import { createColumnHelper } from '@tanstack/react-table' import { type AdvancedEditorColumn } from './types' export interface ColumnPreviewProps { column: AdvancedEditorColumn objectId: number | null pipelineValue?: Record } const columnHelper = createColumnHelper() const PreviewGrid = ({ value }: { value: Array<{ type: string, value: any }> }): React.JSX.Element => { const advancedGridCellRegistry = useInjection( serviceIds['DynamicTypes/AdvancedGridCellRegistry'] ) const columns = value.map((item, index) => { const isAdvancedCellType = advancedGridCellRegistry.hasDynamicType(item.type) const safeKey = `${item.type.replace(/\./g, '_')}-${index}` return columnHelper.accessor(safeKey, { header: item.type, meta: { editable: false, type: isAdvancedCellType ? item.type : 'dataobject.adapter', config: { ...(isAdvancedCellType ? {} : { dataObjectType: item.type, dataObjectConfig: {} }) } } }) }) const row: Record = {} value.forEach((item, index) => { const safeKey = `${item.type.replace(/\./g, '_')}-${index}` row[safeKey] = item.value }) return ( ) } const PreviewResult = ({ column, objectId, pipelineValue }: { column: AdvancedEditorColumn, objectId: number, pipelineValue?: Record }): React.JSX.Element => { const { t } = useTranslation() const { currentLanguage } = useLanguageSelection() const pipeline = (pipelineValue !== undefined && Object.keys(pipelineValue).length > 0) ? pipelineValue : column.pipeline // Resolve locale: explicit per-column override > global language (only for localizable columns) const resolvedLocale = column.localizable === true ? (column.locale ?? currentLanguage) : undefined const { data, error, isFetching } = api.endpoints.dataObjectGetGridPreview.useQuery({ body: { objectId, column: { type: column.type, key: column.key, locale: resolvedLocale, config: pipeline !== undefined ? { advancedColumns: pipeline.sourceFields ?? [], transformers: pipeline.transformers } as unknown as AdvancedColumnConfig : undefined } } }) // Keep the last successful data so re-fetches don't flash "no data" const lastData = useRef(data) if (data !== undefined) lastData.current = data if (error !== undefined) { const message = 'error' in (error as object) ? (error as any).error : t('data-hub.column-config-modal.preview.error') return { message } } if (isFetching && lastData.current === undefined) { return { t('data-hub.column-config-modal.preview.loading') } } const value = lastData.current?.value if (value === undefined || value === null || !Array.isArray(value) || value.length === 0) { return { t('data-hub.column-config-modal.preview.no-data') } } return } export const ColumnPreview = ({ column, objectId, pipelineValue }: ColumnPreviewProps): React.JSX.Element => { const { t } = useTranslation() // Debounce pipeline changes so the previous result stays visible during edits const [debouncedPipelineValue, setDebouncedPipelineValue] = useState(pipelineValue) useEffect(() => { const timer = setTimeout(() => { setDebouncedPipelineValue(pipelineValue) }, 300) return () => { clearTimeout(timer) } }, [pipelineValue]) return ( { t('grid.advanced-column.preview') }: { objectId === null ? ( { t('data-hub.column-config-modal.preview.placeholder') } ) : ( ) } ) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './column-config-modal' export * from './use-add-column-dropdown' export * from './types' export * from './column-preview' export * from './column-pipeline-form' export * from './column-editor-item' export * from './column-locale-control' export * from './base-column-editor' ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/types.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { type GridColumnConfiguration } from '@pimcore/studio-ui-bundle/api/data-object' /** * Persisted column shape shared across all Data Hub adapter bundles. * For advanced columns (type === ADVANCED_COLUMN_TYPE), `key` holds the user-defined title. */ export interface SchemaColumn { key: string fieldtype: string type: string /** Adapter-specific persisted column data (e.g. { advancedColumns, transformers } for advanced columns). */ config?: Record locale?: string | null } /** * Imperative handle exposed by adapter-specific column editor components via forwardRef. * Allows ColumnConfigModal to imperatively read the current draft and add a column. */ export interface ColumnEditorHandle { /** Returns the current list of columns from the editor draft. */ getColumns: () => TColumns[] /** Programmatically adds a column from the available-columns list. */ addColumn: (column: GridColumnConfiguration) => void } /** * The special column key that identifies an advanced/pipeline column. * Advanced columns have a pipeline (sourceFields + transformers) instead of a direct field mapping. */ export const ADVANCED_COLUMN_KEY = 'advanced' /** * The column type registered by the backend for advanced/pipeline columns. * Used as the reliable discriminator when loading persisted columns, because the key * is now set to the user-defined title rather than the hardcoded sentinel 'advanced'. */ export const ADVANCED_COLUMN_TYPE = 'dataobject.advanced' /** * Frontend-only draft column type used by adapter column editors that support * advanced (pipeline) columns. Extends the base persisted shape with working-state * fields that are never written to the backend directly. */ export interface AdvancedEditorColumn { /** Frontend-only unique id for list keying. */ _id: string key: string fieldtype: string type: string /** Persisted column config blob (e.g. { advancedColumns, transformers } for advanced columns). */ config?: Record /** * Frontend-only pipeline schema fetched from the available-columns API. * Drives what source field types are available in the pipeline form. * Never persisted. */ pipelineConfig?: Record /** * Draft pipeline value: { title, sourceFields, transformers }. * Present only for advanced columns (type === ADVANCED_COLUMN_TYPE). * Never persisted directly — on save, title becomes the column key and * sourceFields/transformers are packed into config.advancedColumns/config.transformers. */ pipeline?: Record /** Whether this column supports per-column locale selection. */ localizable?: boolean locale?: string | null } /** * Converts a persisted SchemaColumn into an AdvancedEditorColumn draft. * For advanced columns (type === ADVANCED_COLUMN_TYPE) the persisted config is * unpacked into the frontend `pipeline` working state, and the column key * (which holds the user title) is mapped to pipeline.title. */ export const advancedFromSchemaColumn = (col: SchemaColumn): AdvancedEditorColumn => ({ _id: crypto.randomUUID(), key: col.key, fieldtype: col.fieldtype, type: col.type, config: col.config, pipeline: col.type === ADVANCED_COLUMN_TYPE ? { // New format: key holds the title. Legacy format: key === 'advanced', title was a separate field. title: col.key !== ADVANCED_COLUMN_KEY ? col.key : (col as any).title, sourceFields: (col.config?.advancedColumns ?? []).map((sf: Record) => ({ ...sf, config: sf.config ?? {} })), transformers: col.config?.transformers } : undefined, locale: col.locale }) /** * Converts an AdvancedEditorColumn draft back to a persisted SchemaColumn. * For advanced columns the frontend `pipeline` is packed into config.advancedColumns + config.transformers. */ export const advancedToSchemaColumn = (col: AdvancedEditorColumn): SchemaColumn => ({ key: col.type === ADVANCED_COLUMN_TYPE && col.pipeline?.title !== undefined && col.pipeline.title !== '' ? col.pipeline.title as string : col.key, fieldtype: col.fieldtype, type: col.type, config: col.pipeline !== undefined ? { advancedColumns: (col.pipeline.sourceFields ?? []).map((sf: Record) => ({ ...sf, config: sf.config ?? {} })), transformers: col.pipeline.transformers } : col.config, locale: col.locale }) ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/use-add-column-dropdown.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { useMemo } from 'react' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { type ItemType } from '@pimcore/studio-ui-bundle/components' import { type GridColumnConfiguration } from '@pimcore/studio-ui-bundle/api/data-object' import { isNil, isEmpty } from 'lodash' export interface AddColumnDropdownMenu { items: ItemType[] } /** * Builds a nested Ant Design dropdown menu from a flat list of GridColumnConfiguration entries. */ export const useAddColumnDropdown = ( availableColumns: GridColumnConfiguration[], onMenuItemClick: (column: GridColumnConfiguration) => void ): AddColumnDropdownMenu => { const { t } = useTranslation() return useMemo((): AddColumnDropdownMenu => { const groupTree: Record = {} let menuIndex = 0 availableColumns.forEach((column) => { let normalizedGroups: Array = [] if (Array.isArray(column.group)) { const hasNestedArrays = column.group.some((item: any) => Array.isArray(item)) if (hasNestedArrays) { normalizedGroups = column.group } else { normalizedGroups = [column.group as unknown as string[]] } } else if (typeof column.group === 'string') { normalizedGroups = [column.group] } else { normalizedGroups = [String(column.group)] } normalizedGroups.forEach((groupPath) => { let groupParts: string[] if (typeof groupPath === 'string') { groupParts = groupPath.split('.') } else if (Array.isArray(groupPath)) { groupParts = groupPath.map((part: any) => String(part)) } else { groupParts = [String(groupPath)] } let currentLevel = groupTree groupParts.forEach((part, index) => { if (isNil(currentLevel[part])) { currentLevel[part] = { items: [], subGroups: {} } } if (index === groupParts.length - 1) { currentLevel[part].items.push(column) } else { currentLevel = currentLevel[part].subGroups } }) }) }) const convertTreeToMenuItems = (tree: Record): ItemType[] => { return Object.entries(tree).map(([groupName, groupData]) => { const menuItem: any = { key: `group-${menuIndex++}`, label: t(groupName) } const subGroupItems = !isEmpty(Object.keys(groupData.subGroups as Record)) ? convertTreeToMenuItems(groupData.subGroups as Record) : [] const columnItems: ItemType[] = groupData.items.map((column: GridColumnConfiguration) => { let translationKey = column.key if (!isNil(column.config) && 'fieldDefinition' in column.config) { const fieldDefinition = column.config.fieldDefinition as Record translationKey = fieldDefinition?.title ?? column.key } return { key: column.key, label: t(translationKey), onClick: () => { onMenuItemClick(column) } } }) const allChildren = [...subGroupItems, ...columnItems] if (allChildren.length > 0) menuItem.children = allChildren return menuItem as ItemType }) } return { items: convertTreeToMenuItems(groupTree) } }, [availableColumns, t, onMenuItemClick]) } ================================================ FILE: assets/studio/js/src/modules/config/components/column-config-modal/use-column-editor-state.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { useState, useEffect, useRef, useCallback, useMemo } from 'react' import { useElementSelector, SelectionType } from '@pimcore/studio-ui-bundle/modules/element' import { api, type GridColumnConfiguration } from '@pimcore/studio-ui-bundle/api/data-object' import { useClassDefinitions } from '@pimcore/studio-ui-bundle/modules/data-object' import { isNil } from 'lodash' import { advancedFromSchemaColumn, advancedToSchemaColumn, ADVANCED_COLUMN_TYPE, type AdvancedEditorColumn, type SchemaColumn } from './types' import { useAddColumnDropdown, type AddColumnDropdownMenu } from './use-add-column-dropdown' const SYSTEM_COLUMNS = [ { key: 'id', type: 'system.id', group: ['system'] as string[], config: [] as never[] }, { key: 'fullpath', type: 'system.string', group: ['system'] as string[], config: [] as never[] } ] interface UseColumnEditorStateOptions { entity: string classDefinitionId?: string columns: SchemaColumn[] onApply: (columns: SchemaColumn[]) => void onCancel: () => void } interface UseColumnEditorStateResult { draft: AdvancedEditorColumn[] isLoading: boolean objectId: number | null availableFields: GridColumnConfiguration[] addColumnMenu: AddColumnDropdownMenu openElementSelector: () => void handleAddColumnOfType: (column: GridColumnConfiguration) => void handlePipelineChange: (id: string, pipeline: Record) => void handleRemove: (id: string) => void handleApply: () => void handleDiscard: () => void handleLocaleChange: (id: string, locale: string | null) => void handleReorder: (ids: string[]) => void getColumns: () => SchemaColumn[] } export const useColumnEditorState = ({ entity, classDefinitionId, columns, onApply, onCancel }: UseColumnEditorStateOptions): UseColumnEditorStateResult => { const { getByName } = useClassDefinitions() const resolvedClassId = useMemo(() => { if (!isNil(classDefinitionId)) return classDefinitionId return getByName(entity)?.id ?? entity }, [classDefinitionId, entity, getByName]) const { data, isLoading } = api.endpoints.dataObjectGetAvailableGridColumns.useQuery({ classId: resolvedClassId, folderId: 1 }) const [draft, setDraft] = useState(() => columns.map(advancedFromSchemaColumn) ) useEffect(() => { setDraft(columns.map(advancedFromSchemaColumn)) }, [columns]) const [objectId, setObjectId] = useState(null) const hasManualSelection = useRef(false) const { data: gridData } = api.endpoints.dataObjectGetGrid.useQuery( { classId: resolvedClassId, body: { folderId: 1, columns: SYSTEM_COLUMNS, filters: { includeDescendants: true, page: 1, pageSize: 1 } } }, { skip: resolvedClassId === undefined } ) useEffect(() => { if (hasManualSelection.current) return const firstItem = gridData?.items?.[0] if (firstItem?.id !== undefined) { setObjectId(firstItem.id as number) } }, [gridData?.items]) const { open: openElementSelector } = useElementSelector({ selectionType: SelectionType.Single, areas: { object: true, asset: false, document: false }, config: { objects: { allowedTypes: ['object'], ...(entity !== undefined ? { allowedClasses: [entity] } : {}) } }, onFinish: (event) => { const item = event?.items?.[0] if (item !== undefined) { hasManualSelection.current = true setObjectId(item.data.id) } } }) const availableFields: GridColumnConfiguration[] = data?.columns ?? [] useEffect(() => { if (availableFields.length === 0) return setDraft(prev => prev.map(col => { const available = availableFields.find(f => f.key === col.key || (col.type === ADVANCED_COLUMN_TYPE && f.type === col.type) ) if (available === undefined) return col return { ...col, localizable: col.localizable ?? available.localizable, pipelineConfig: col.pipelineConfig ?? (available.config as Record | undefined) } })) }, [availableFields]) const handleAddColumnOfType = useCallback((column: GridColumnConfiguration): void => { setDraft(prev => [...prev, { _id: crypto.randomUUID(), key: column.key, fieldtype: column.key, type: column.type, pipelineConfig: column.config as Record | undefined, localizable: column.localizable }]) }, []) const addColumnMenu = useAddColumnDropdown(availableFields, handleAddColumnOfType) const handlePipelineChange = (id: string, pipeline: Record): void => { setDraft(prev => prev.map(col => col._id === id ? { ...col, pipeline } : col )) } const handleRemove = (id: string): void => { setDraft(prev => prev.filter(col => col._id !== id)) } const handleApply = (): void => { onApply(draft.filter(col => col.key !== '').map(advancedToSchemaColumn)) } const handleDiscard = (): void => { setDraft(columns.map(advancedFromSchemaColumn)) onCancel() } const handleLocaleChange = (id: string, locale: string | null): void => { setDraft(prev => prev.map(c => c._id === id ? { ...c, locale } : c)) } const handleReorder = (ids: string[]): void => { setDraft(prev => { return ids .map(id => prev.find(col => col._id === id)) .filter((col): col is AdvancedEditorColumn => col !== undefined) }) } return { draft, isLoading, objectId, availableFields, addColumnMenu, openElementSelector, handleAddColumnOfType, handlePipelineChange, handleRemove, handleApply, handleDiscard, handleLocaleChange, handleReorder, getColumns: () => draft.filter(col => col.key !== '').map(advancedToSchemaColumn) } } ================================================ FILE: assets/studio/js/src/modules/config/components/config-sidebar/components/config-sidebar-toolbar/toolbar.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { Toolbar, DropdownButton, Dropdown, type DropdownProps, IconButton, Icon, Flex, Tooltip } from '@pimcore/studio-ui-bundle/components' import { container, useTranslation } from '@pimcore/studio-ui-bundle/app' import { bundleServiceIds } from '../../../../../../config/service-ids' import { type DynamicTypeDataHubAdapterRegistry } from '../../../../dynamic-types/dynamic-type-data-hub-adapter-registry' import { ImportButton } from '../../../import-button/import-button' import { type BundleDataHubConfiguration } from '../../../../config-api-slice.gen' interface ConfigSidebarToolbarProps { onAdd: (adapterType: string) => void onRefresh: () => Promise<{ data?: { items?: BundleDataHubConfiguration[] } }> handleOpenConfig: (config: BundleDataHubConfiguration) => void isFetching: boolean } export const ConfigSidebarToolbar = ({ onAdd, onRefresh, handleOpenConfig, isFetching }: ConfigSidebarToolbarProps): React.JSX.Element => { const { t } = useTranslation() const adapterRegistry = container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/Registry']) const adapters = adapterRegistry.getDynamicTypes() const dropdownItems: DropdownProps['menu']['items'] = adapters.map((adapter) => ({ key: adapter.id, label: t(adapter.getNameTranslationKey()), icon: , onClick: () => { onAdd(adapter.id) } })) return ( {t('new')} ) } ================================================ FILE: assets/studio/js/src/modules/config/components/config-sidebar/config-sidebar.styles.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { createStyles } from 'antd-style' export const useStyles = createStyles(({ css }) => { return { treeContainer: css` .ant-tree-list-holder-inner { align-items: start; } .ant-tree-node-content-wrapper { white-space: nowrap; } ` } }) ================================================ FILE: assets/studio/js/src/modules/config/components/config-sidebar/config-sidebar.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useEffect, useState, useMemo } from 'react' import { isNil, isUndefined } from 'lodash' import { Content, ContentLayout, Icon, SearchInput, TreeElement, type TreeDataItem } from '@pimcore/studio-ui-bundle/components' import { container, useTranslation } from '@pimcore/studio-ui-bundle/app' import { type BundleDataHubConfiguration } from '../../config-api-slice-enhanced' import { ConfigSidebarToolbar } from './components/config-sidebar-toolbar/toolbar' import { type DynamicTypeDataHubAdapterRegistry } from '../../dynamic-types/dynamic-type-data-hub-adapter-registry' import { bundleServiceIds } from '../../../../config/service-ids' import { useConfigContext } from '../../providers/config-provider' import { useDataHubConfig } from '../../hooks/use-data-hub-config' import { findConfigById, filterConfigsRecursive } from '../../utils/tree-helpers' import { hasValidAdapter } from '../../utils/adapter-helpers' import { getExportUrl } from '../../utils/get-export-url' import { useStyles } from './config-sidebar.styles' interface ConfigSidebarProps { handleOpenConfig: (config: BundleDataHubConfiguration) => void } export const ConfigSidebar = ({ handleOpenConfig }: ConfigSidebarProps): React.JSX.Element => { const { configurationsData, isLoading, isFetching, refetch, expandedKeys, setExpandedKeys } = useConfigContext() const [configListData, setConfigListData] = useState([]) const [filteredData, setFilteredData] = useState([]) const [searchValue, setSearchValue] = useState('') const [treeKey, setTreeKey] = useState(0) const { handleAdd, handleClone, handleDelete } = useDataHubConfig({ refetch }) useEffect(() => { if (!isNil(configurationsData?.items)) { setConfigListData(configurationsData.items) setFilteredData(configurationsData.items) setTreeKey(prev => prev + 1) } }, [configurationsData]) useEffect(() => { if (searchValue === '') { setFilteredData(configListData) } else { setFilteredData(filterConfigsRecursive(configListData, searchValue)) } }, [searchValue, configListData]) const { t } = useTranslation() const { styles } = useStyles() const adapterRegistry = container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/Registry']) const getTreeItemIcon = (item: BundleDataHubConfiguration): React.JSX.Element | undefined => { if (item.allowChildren === true) { return } const adapterType = item.adapter as string | undefined if (isUndefined(adapterType)) { return undefined } const adapter = adapterRegistry.getDynamicType(adapterType, false) return isUndefined(adapter) ? undefined : } const getTreeItemActions = (item: BundleDataHubConfiguration): Array<{ key: string, icon: string }> => { if (item.allowChildren === true) { return [] } const actions: Array<{ key: string, icon: string }> = [ { key: 'clone', icon: 'copy-03' }, { key: 'export', icon: 'export' } ] // Only add delete action if writeable if (item.writable) { actions.push({ key: 'delete', icon: 'trash' }) } return actions } const transformToTreeData = (items: BundleDataHubConfiguration[] | null): TreeDataItem[] => { if (isNil(items)) { return [] } return items .filter((item) => { if (item.allowChildren === true) return true return hasValidAdapter(item.adapter as string | undefined, adapterRegistry) }) .sort((a, b) => { return a.text.localeCompare(b.text, undefined, { sensitivity: 'base' }) }) .map((item) => { return { key: isUndefined(item.id) ? '' : String(item.id), title: item.text, icon: getTreeItemIcon(item), children: isUndefined(item.children) ? undefined : transformToTreeData(item.children), isLeaf: item.leaf, actions: getTreeItemActions(item), allowDrag: false, allowDrop: false } }) } const treeData = useMemo(() => transformToTreeData(filteredData), [filteredData]) const handleAddWrapper = (adapterType: string): void => { handleAdd(adapterType, handleOpenConfig) } const handleCloneWrapper = (key: string): void => { const config = findConfigById(key, configListData) if (!isNil(config)) { handleClone(config, handleOpenConfig) } } const handleDeleteWrapper = (key: string): void => { const config = findConfigById(key, configListData) if (!isNil(config)) { handleDelete(config) } } const handleExportWrapper = (key: string): void => { const config = findConfigById(key, configListData) if (!isNil(config)) { window.location.href = getExportUrl(config.text) } } const handleActionsClick = (key: string, action: string): void => { switch (action) { case 'clone': handleCloneWrapper(key) break case 'export': handleExportWrapper(key) break case 'delete': handleDeleteWrapper(key) break } } const handleTreeItemClick = (key: string): void => { const config = findConfigById(key, configListData) if (!isNil(config)) { if (config.allowChildren === true) { const currentKeys = expandedKeys if (!isNil(currentKeys) && currentKeys.includes(key)) { setExpandedKeys(currentKeys.filter(k => k !== key)) } else { setExpandedKeys([...currentKeys, key]) } } else { handleOpenConfig(config) } } } return ( } > { setSearchValue(e.target.value) } } placeholder={ t('search') } withoutAddon /> { setExpandedKeys(keys as string[]) } } onSelected={ (key) => { handleTreeItemClick(String(key)) } } treeData={ treeData } /> ) } ================================================ FILE: assets/studio/js/src/modules/config/components/export-button/export-button.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { IconButton, Tooltip } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { getExportUrl } from '../../utils/get-export-url' interface ExportButtonProps { configName: string disabled?: boolean } export const ExportButton = ({ configName, disabled }: ExportButtonProps): React.JSX.Element => { const { t } = useTranslation() const handleExport = (): void => { window.location.href = getExportUrl(configName) } return ( ) } ================================================ FILE: assets/studio/js/src/modules/config/components/export-button/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export { ExportButton } from './export-button' ================================================ FILE: assets/studio/js/src/modules/config/components/field-width-container.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { type ReactNode } from 'react' import { useFieldWidth } from '@pimcore/studio-ui-bundle/modules/element' interface FieldWidthContainerProps { children: ReactNode } export const FieldWidthContainer = ({ children }: FieldWidthContainerProps): React.JSX.Element => { const fieldWidth = useFieldWidth() return (
{children}
) } ================================================ FILE: assets/studio/js/src/modules/config/components/import-button/import-button.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { ImportModal, IconButton, Tooltip } from '@pimcore/studio-ui-bundle/components' import { getPrefix } from '@pimcore/studio-ui-bundle/api' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { type BundleDataHubConfiguration } from '../../config-api-slice.gen' import { findConfigInTree } from '../../utils/tree-helpers' import { isUndefined } from 'lodash' interface ImportResponse { success: boolean type: string name: string } interface ImportButtonProps { onRefresh: () => Promise<{ data?: { items?: BundleDataHubConfiguration[] } }> handleOpenConfig: (config: BundleDataHubConfiguration) => void disabled?: boolean } export const ImportButton = ({ onRefresh, handleOpenConfig, disabled = false }: ImportButtonProps): React.JSX.Element => { const { t } = useTranslation() const handleImportSuccess = async (data: ImportResponse): Promise => { const { data: updatedData } = await onRefresh() if (!isUndefined(updatedData?.items)) { const importedConfig = findConfigInTree(updatedData.items, (item) => !isUndefined(item.id) && item.id === data.name ) if (!isUndefined(importedConfig)) { handleOpenConfig(importedConfig) } } } return ( ) } ================================================ FILE: assets/studio/js/src/modules/config/components/migration-modal/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './migration-modal' ================================================ FILE: assets/studio/js/src/modules/config/components/migration-modal/migration-modal.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { type ReactNode, useState } from 'react' import { Alert, Button, CodeEditor, Flex, Modal, ModalTitle, Space, Toolbar } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { stringifyYaml } from '../../../../sdk/utils/yaml' export interface MigrationModalProps { /** Controls modal visibility */ open: boolean /** Modal title — already translated by the consumer */ title: string /** Icon name rendered in the modal title bar (defaults to "settings") */ iconName?: string /** The raw legacy config object — serialized to YAML internally for the read-only reference pane */ legacyConfig: Record /** * Optional toolbar slot rendered left-aligned in the split-view toolbar. * Use this to provide an "Add column" / "Add field" dropdown specific to your editor. */ renderToolbarLeft?: ReactNode /** * Called when the user clicks "Confirm Migration". * The consumer is responsible for reading the current state from its editor * (e.g. via an imperative ref) and persisting it before or after this callback. */ onConfirm: () => void /** * Called when the user closes the modal from either the initial legacy view * (X button or Cancel in the initial toolbar) or from the split migration view * (Cancel button returns to the initial view — the modal stays open). * To close the modal entirely from the initial view, this should set `open` to false. */ onClose: () => void /** * The new-format editor component rendered in the left pane during migration. * The consumer is responsible for wiring this up with its own state / ref. */ children: ReactNode } /** * MigrationModal — generic split-view migration shell for Data Hub adapters. * * Manages two visual states internally: * 1. **Initial legacy view** (`isMigrating = false`): shows the legacy config as * read-only YAML with a warning alert and a "Start Migration" button. * 2. **Split migration view** (`isMigrating = true`): left pane renders `children` * (the consumer's new editor), right pane shows the legacy YAML as reference. * Toolbar provides Cancel (returns to initial view) and Confirm Migration. */ export const MigrationModal = ({ open, title, iconName = 'settings', legacyConfig, renderToolbarLeft, onConfirm, onClose, children }: MigrationModalProps): React.JSX.Element => { const { t } = useTranslation() const [isMigrating, setIsMigrating] = useState(false) const yamlValue = stringifyYaml(legacyConfig) const modalTitle = ( { title } ) // ── Initial legacy view ────────────────────────────────────────────────── if (!isMigrating) { return ( ) } // ── Split migration view ───────────────────────────────────────────────── return ( { setIsMigrating(false) } } open={ open } size="XL" title={ modalTitle } > { /* Left — new editor supplied by consumer */ } { children }
{ /* Right — legacy config (read-only YAML reference) */ } { renderToolbarLeft } ) } ================================================ FILE: assets/studio/js/src/modules/config/components/tabs/config-tab-content.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useCallback } from 'react' import { type BundleDataHubConfiguration } from '../../config-api-slice-enhanced' import { isUndefined, isNil } from 'lodash' import { container } from '@pimcore/studio-ui-bundle/app' import { bundleServiceIds } from '../../../../config/service-ids' import { type DynamicTypeDataHubAdapterRegistry } from '../../dynamic-types/dynamic-type-data-hub-adapter-registry' interface ConfigTabContentProps { config: BundleDataHubConfiguration onDelete: () => void modifiedConfigs: string[] setModifiedConfigs: React.Dispatch> isActive: boolean } export const ConfigTabContent = ({ config, onDelete, modifiedConfigs, setModifiedConfigs, isActive }: ConfigTabContentProps): React.JSX.Element => { const adapterRegistry = container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/Registry']) const handleChange = useCallback((isDirty: boolean) => { setModifiedConfigs((prev) => { const isCurrentlyModified = prev.includes(config.id) if (isDirty && !isCurrentlyModified) { return [...prev, config.id] } else if (!isDirty && isCurrentlyModified) { return prev.filter(id => id !== config.id) } return prev }) }, [config.id, setModifiedConfigs]) const adapterType = config.adapter as string | undefined if (isUndefined(adapterType)) { return
Unknown adapter type
} try { const adapter = adapterRegistry.getDynamicType(adapterType, false) if (isNil(adapter)) { return
Adapter not found: {adapterType}
} return adapter.renderDetailView({ configName: config.text, configId: config.id, isActive, hasStudioColumnConfig: config.studioColumnConfig, onChange: handleChange, onDelete }) } catch (err) { console.error('Error rendering form:', err) return
Error rendering adapter form
} } ================================================ FILE: assets/studio/js/src/modules/config/components/tabs/config-tabs.styles.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { createStyles } from 'antd-style' export const useStyles = createStyles(({ css, token }) => { return { tabsContainer: css` height: 100%; .ant-tabs-content-holder { flex: 1; min-height: 0; overflow: hidden; } .ant-tabs-content, .ant-tabs-tabpane { height: 100%; } `, tabs: css` .ant-tabs-tab { padding: ${token.paddingSM}px ${token.paddingXXS}px !important; } ` } }) ================================================ FILE: assets/studio/js/src/modules/config/components/tabs/config-tabs.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useMemo, useCallback } from 'react' import { Tabs, Content, Icon } from '@pimcore/studio-ui-bundle/components' import { type BundleDataHubConfiguration } from '../../config-api-slice-enhanced' import { isUndefined, isNil } from 'lodash' import { ConfigTabContent } from './config-tab-content' import { useStyles } from './config-tabs.styles' import { container } from '@pimcore/studio-ui-bundle/app' import { type DynamicTypeDataHubAdapterRegistry } from '../../dynamic-types/dynamic-type-data-hub-adapter-registry' import { bundleServiceIds } from '../../../../config/service-ids' import { useDataHubConfig } from '../../hooks/use-data-hub-config' import { useConfigContext } from '../../providers/config-provider' interface ConfigTabsProps { openedConfigs: BundleDataHubConfiguration[] activeTabKey: string | undefined configurationsData?: { items: BundleDataHubConfiguration[] } onChangeTab: (key: string) => void onCloseTab: (key: string) => void modifiedConfigs: string[] setModifiedConfigs: React.Dispatch> } const TabItem = ({ config }: { config: BundleDataHubConfiguration }): React.JSX.Element | null => { const adapterRegistry = container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/Registry']) const adapterType = config.adapter as string | undefined if (isUndefined(adapterType)) { return null } const adapter = adapterRegistry.getDynamicType(adapterType, false) return isUndefined(adapter) ? null : } export const ConfigTabs = ({ openedConfigs, activeTabKey, configurationsData, onChangeTab, onCloseTab, modifiedConfigs, setModifiedConfigs }: ConfigTabsProps): React.JSX.Element => { const { styles } = useStyles() const { refetch } = useConfigContext() const { handleDelete } = useDataHubConfig({ refetch }) const handleDeleteConfig = useCallback((configId: string): void => { const config = openedConfigs.find(c => c.id === configId) if (!isNil(config)) { handleDelete(config, () => { onCloseTab(configId) }) } }, [openedConfigs, handleDelete, onCloseTab]) const tabItems = useMemo(() => { // Recursively collect all config IDs from the tree const collectConfigIds = (items: BundleDataHubConfiguration[]): Set => { const ids = new Set() items.forEach(item => { ids.add(item.id) if (!isNil(item.children)) { collectConfigIds(item.children).forEach(id => ids.add(id)) } }) return ids } const existingConfigIds = isNil(configurationsData?.items) ? new Set() : collectConfigIds(configurationsData.items) return openedConfigs .filter(config => !isNil(existingConfigIds) && existingConfigIds.has(config.id)) .map((config) => ({ key: config.id, label: `${config.text} ${modifiedConfigs.includes(config.id) ? '*' : ''}`, icon: , children: { handleDeleteConfig(config.id) } } setModifiedConfigs={ setModifiedConfigs } /> })) }, [configurationsData, openedConfigs, modifiedConfigs, setModifiedConfigs, activeTabKey, handleDeleteConfig]) if (isUndefined(activeTabKey)) { return } return ( ) } ================================================ FILE: assets/studio/js/src/modules/config/config-api-slice-enhanced.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { api as baseApi } from './config-api-slice.gen' export const api = baseApi.enhanceEndpoints({ addTagTypes: ['DataHubConfigs'], endpoints: { bundleDataHubConfigCollection: { providesTags: ['DataHubConfigs'] }, bundleDataHubConfigAdd: { invalidatesTags: ['DataHubConfigs'] }, bundleDataHubConfigClone: { invalidatesTags: ['DataHubConfigs'] }, bundleDataHubConfigDelete: { invalidatesTags: ['DataHubConfigs'] }, bundleDataHubConfigGet: { providesTags: [] }, bundleDataHubConfigExport: { providesTags: (result, error, arg) => [{ type: 'DataHubConfigs', id: arg.name }] }, bundleDataHubConfigImport: { invalidatesTags: ['DataHubConfigs'] }, bundleDataHubConfigUpdate: { invalidatesTags: ['DataHubConfigs'] } } }) export type * from './config-api-slice.gen' export const { useBundleDataHubConfigCollectionQuery, useBundleDataHubConfigAddMutation, useBundleDataHubConfigCloneMutation, useBundleDataHubConfigDeleteMutation, useBundleDataHubConfigGetQuery, useBundleDataHubConfigExportQuery, useBundleDataHubConfigImportMutation, useBundleDataHubConfigUpdateMutation } = api ================================================ FILE: assets/studio/js/src/modules/config/config-api-slice.gen.ts ================================================ import { api } from "@pimcore/studio-ui-bundle/api"; export const addTagTypes = ["Bundle Data Hub"] as const; const injectedRtkApi = api .enhanceEndpoints({ addTagTypes, }) .injectEndpoints({ endpoints: (build) => ({ bundleDataHubConfigAdd: build.mutation< BundleDataHubConfigAddApiResponse, BundleDataHubConfigAddApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/add`, method: "POST", params: { name: queryArg.name, type: queryArg["type"], path: queryArg.path, }, }), invalidatesTags: ["Bundle Data Hub"], }), bundleDataHubConfigClone: build.mutation< BundleDataHubConfigCloneApiResponse, BundleDataHubConfigCloneApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/clone`, method: "POST", params: { name: queryArg.name, originalName: queryArg.originalName, }, }), invalidatesTags: ["Bundle Data Hub"], }), bundleDataHubConfigCollection: build.query< BundleDataHubConfigCollectionApiResponse, BundleDataHubConfigCollectionApiArg >({ query: () => ({ url: `/pimcore-studio/api/bundle/data-hub/config`, }), providesTags: ["Bundle Data Hub"], }), bundleDataHubConfigDelete: build.mutation< BundleDataHubConfigDeleteApiResponse, BundleDataHubConfigDeleteApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/delete/${queryArg.name}`, method: "DELETE", }), invalidatesTags: ["Bundle Data Hub"], }), bundleDataHubConfigExport: build.query< BundleDataHubConfigExportApiResponse, BundleDataHubConfigExportApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/${queryArg.name}/export`, }), providesTags: ["Bundle Data Hub"], }), bundleDataHubConfigGet: build.query< BundleDataHubConfigGetApiResponse, BundleDataHubConfigGetApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/${queryArg.name}`, }), providesTags: ["Bundle Data Hub"], }), bundleDataHubConfigUpdate: build.mutation< BundleDataHubConfigUpdateApiResponse, BundleDataHubConfigUpdateApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/${queryArg.name}`, method: "PUT", body: queryArg.bundleDataHubUpdateConfiguration, }), invalidatesTags: ["Bundle Data Hub"], }), bundleDataHubConfigImport: build.mutation< BundleDataHubConfigImportApiResponse, BundleDataHubConfigImportApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/config/import`, method: "POST", body: queryArg.body, }), invalidatesTags: ["Bundle Data Hub"], }), }), overrideExisting: false, }); export { injectedRtkApi as api }; export type BundleDataHubConfigAddApiResponse = /** status 201 bundle_data_hub_config_add_success_response */ void; export type BundleDataHubConfigAddApiArg = { /** The name of the configuration */ name: string; /** Type of the adapter */ type: string; /** Configuration path */ path?: string; }; export type BundleDataHubConfigCloneApiResponse = /** status 201 bundle_data_hub_config_clone_success_response */ void; export type BundleDataHubConfigCloneApiArg = { /** The name of the new configuration */ name: string; /** The name of the configuration to clone */ originalName: string; }; export type BundleDataHubConfigCollectionApiResponse = /** status 200 bundle_copilot_actions_success_response */ { totalItems: number; items: BundleDataHubConfiguration[]; }; export type BundleDataHubConfigCollectionApiArg = void; export type BundleDataHubConfigDeleteApiResponse = /** status 200 bundle_data_hub_config_delete_success_response */ void; export type BundleDataHubConfigDeleteApiArg = { /** Name of the configuration */ name: string; }; export type BundleDataHubConfigExportApiResponse = /** status 200 bundle_data_hub_config_export_success_response */ void; export type BundleDataHubConfigExportApiArg = { /** Name of the configuration */ name: string; }; export type BundleDataHubConfigGetApiResponse = /** status 200 bundle_data_hub_config_get_success_response */ BundleDataHubConfigurationDetail; export type BundleDataHubConfigGetApiArg = { /** Name of the configuration */ name: string; }; export type BundleDataHubConfigUpdateApiResponse = /** status 200 bundle_data_hub_config_update_success_response */ BundleDataHubUpdateConfigurationResponse; export type BundleDataHubConfigUpdateApiArg = { /** Name of the configuration */ name: string; bundleDataHubUpdateConfiguration: BundleDataHubUpdateConfiguration; }; export type BundleDataHubConfigImportApiResponse = /** status 201 bundle_data_hub_config_import_success_response */ void; export type BundleDataHubConfigImportApiArg = { /** Configuration file to import */ body: { /** JSON configuration file */ file: Blob; }; }; export type Error = { /** Message */ message: string; }; export type DevError = { /** Message */ message: string; /** Details */ details: string; }; export type BundleDataHubConfiguration = { /** AdditionalAttributes */ additionalAttributes?: { [key: string]: string | number | boolean | object; }; /** ID */ id: string; /** Text */ text: string; /** Type */ type: string; /** iconCls */ iconCls: string; /** Expandable */ expandable: boolean; /** Leaf */ leaf: boolean; /** Permissions */ permissions: any; /** Allow children */ allowChildren?: boolean; /** Group */ group?: any; /** Children */ children?: BundleDataHubConfiguration[]; /** Adapter */ adapter: any; /** Writable */ writable: boolean; /** Has Studio Column Configuration */ studioColumnConfig: boolean; }; export type BundleDataHubConfigurationDetail = { /** AdditionalAttributes */ additionalAttributes?: { [key: string]: string | number | boolean | object; }; /** Configuration name */ name: string; /** Configuration data */ configuration: object; /** User permissions */ userPermissions: object; /** Supported GraphQL query data types */ supportedGraphQLQueryDataTypes: string[]; /** Supported GraphQL mutation data types */ supportedGraphQLMutationDataTypes: string[]; /** Modification date timestamp */ modificationDate: number; }; export type BundleDataHubUpdateConfigurationResponse = { /** New modification date timestamp */ modificationDate: number; }; export type BundleDataHubUpdateConfiguration = { /** JSON-encoded configuration containing general, schema, security, workspaces, and permissions */ data: string; /** Client-side modification date timestamp for conflict detection */ modificationDate: number; }; export const { useBundleDataHubConfigAddMutation, useBundleDataHubConfigCloneMutation, useBundleDataHubConfigCollectionQuery, useBundleDataHubConfigDeleteMutation, useBundleDataHubConfigExportQuery, useBundleDataHubConfigGetQuery, useBundleDataHubConfigUpdateMutation, useBundleDataHubConfigImportMutation, } = injectedRtkApi; ================================================ FILE: assets/studio/js/src/modules/config/config-container.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useState } from 'react' import { ConfigLayout } from '@pimcore/studio-ui-bundle/components' import { ConfigSidebar } from './components/config-sidebar/config-sidebar' import { ConfigTabs } from './components/tabs/config-tabs' import { useBundleDataHubConfigCollectionQuery } from './config-api-slice-enhanced' import { useTabManager } from './hooks/use-tab-manager' import { ConfigProvider } from './providers/config-provider' export const ConfigContainer = (): React.JSX.Element => { const { data: configurationsData, isLoading, isFetching, refetch } = useBundleDataHubConfigCollectionQuery() const { openedConfigs, activeTabKey, handleOpenConfig, handleCloseTab, handleChangeTab } = useTabManager() const [expandedKeys, setExpandedKeys] = useState([]) const [modifiedConfigs, setModifiedConfigs] = useState([]) return ( ) } } rightItem={ { children: ( ) } } /> ) } ================================================ FILE: assets/studio/js/src/modules/config/dynamic-types/adapters/dynamic-type-data-hub-adapter-graphql.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { injectable } from '@pimcore/studio-ui-bundle/app' import type { ElementIcon } from '@pimcore/studio-ui-bundle/modules/widget-manager' import { DynamicTypeDataHubAdapterAbstract, type DataHubAdapterDetailViewProps } from '../dynamic-type-data-hub-adapter-abstract' import { GraphQLDetailView } from '../../../graphql/components/graphql-detail-view' @injectable() export class DynamicTypeDataHubAdapterGraphQL extends DynamicTypeDataHubAdapterAbstract { readonly id = 'graphql' getIcon (): ElementIcon { return { type: 'name', value: 'graphql', colorToken: 'colorCodingViolet4' } } renderDetailView (props: DataHubAdapterDetailViewProps): React.JSX.Element { return } } ================================================ FILE: assets/studio/js/src/modules/config/dynamic-types/dynamic-type-data-hub-adapter-abstract.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import type React from 'react' import { injectable } from '@pimcore/studio-ui-bundle/app' import type { ElementIcon } from '@pimcore/studio-ui-bundle/modules/widget-manager' export interface DataHubAdapterDetailViewProps { configName: string configId: string isActive: boolean hasStudioColumnConfig: boolean onChange: (isDirty: boolean) => void onDelete: () => void } @injectable() export abstract class DynamicTypeDataHubAdapterAbstract { abstract readonly id: string abstract getIcon (): ElementIcon abstract renderDetailView (props: DataHubAdapterDetailViewProps): React.JSX.Element getNameTranslationKey (): string { return `data-hub.adapter.${this.id}` } } ================================================ FILE: assets/studio/js/src/modules/config/dynamic-types/dynamic-type-data-hub-adapter-registry.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { injectable } from '@pimcore/studio-ui-bundle/app' import { DynamicTypeRegistryAbstract } from '@pimcore/studio-ui-bundle/modules/element' import { type DynamicTypeDataHubAdapterAbstract } from './dynamic-type-data-hub-adapter-abstract' @injectable() export class DynamicTypeDataHubAdapterRegistry extends DynamicTypeRegistryAbstract {} ================================================ FILE: assets/studio/js/src/modules/config/dynamic-types/index.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ export * from './dynamic-type-data-hub-adapter-abstract' export * from './dynamic-type-data-hub-adapter-registry' export * from './adapters/dynamic-type-data-hub-adapter-graphql' ================================================ FILE: assets/studio/js/src/modules/config/hooks/use-data-hub-config.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { useCallback, useEffect } from 'react' import { useFormModal } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { isNil, isUndefined, has, isString } from 'lodash' import { useBundleDataHubConfigAddMutation, useBundleDataHubConfigCloneMutation, useBundleDataHubConfigDeleteMutation, type BundleDataHubConfiguration, type BundleDataHubConfigCollectionApiResponse } from '../config-api-slice-enhanced' import { findConfigInTree } from '../utils/tree-helpers' import { ApiError, trackError } from '@pimcore/studio-ui-bundle/modules/app' interface UseDataHubConfigReturn { handleAdd: (adapterType: string, onSuccess?: (config: BundleDataHubConfiguration) => void) => void handleClone: (config: BundleDataHubConfiguration, onSuccess?: (config: BundleDataHubConfiguration) => void) => void handleDelete: (config: BundleDataHubConfiguration, onSuccess?: () => void) => void } interface UseDataHubConfigProps { refetch: () => Promise<{ data?: BundleDataHubConfigCollectionApiResponse }> } export const useDataHubConfig = ({ refetch }: UseDataHubConfigProps): UseDataHubConfigReturn => { const { t } = useTranslation() const modal = useFormModal() const [addConfig, { error: addError }] = useBundleDataHubConfigAddMutation() const [cloneConfig, { error: cloneError }] = useBundleDataHubConfigCloneMutation() const [deleteConfig, { error: deleteError }] = useBundleDataHubConfigDeleteMutation() const validateConfigName = async (_rule: any, value: string): Promise => { if (!isString(value) || value.trim().length === 0) { throw new Error(t('data-hub.config.name-required')) } if (value.length < 3) { throw new Error(t('data-hub.config.name-min-length')) } if (value.length > 80) { throw new Error(t('data-hub.config.name-max-length')) } if (!/^[a-zA-Z0-9_-]+$/.test(value)) { throw new Error(t('data-hub.config.name-pattern')) } await Promise.resolve() } useEffect(() => { if (!isNil(addError)) { trackError(new ApiError(addError)) } }, [addError]) useEffect(() => { if (!isNil(cloneError)) { trackError(new ApiError(cloneError)) } }, [cloneError]) useEffect(() => { if (!isNil(deleteError)) { const apiError = new ApiError(deleteError) trackError(apiError) } }, [deleteError]) const handleAdd = useCallback(( adapterType: string, onSuccess?: (config: BundleDataHubConfiguration) => void ): void => { modal.input({ label: t('data-hub.add.name'), rule: { required: true, validator: validateConfigName }, onOk: async (value: string) => { const result = await addConfig({ name: value, type: adapterType }) if (has(result, 'error')) { return } const { data: updatedData } = await refetch() if (!isUndefined(updatedData?.items)) { const addedConfig = findConfigInTree(updatedData.items, (item) => !isUndefined(item.id) && item.id === value ) if (!isUndefined(addedConfig) && !isNil(onSuccess)) { onSuccess(addedConfig) } } } }) }, [addConfig, refetch, modal]) const handleClone = useCallback(( config: BundleDataHubConfiguration, onSuccess?: (config: BundleDataHubConfiguration) => void ): void => { if (isNil(config)) return modal.input({ label: t('data-hub.clone.name'), rule: { required: true, validator: validateConfigName }, onOk: async (value: string) => { const configId = String(config.id ?? '') const result = await cloneConfig({ name: value, originalName: configId }) if (has(result, 'error')) { return } const { data: updatedData } = await refetch() if (!isUndefined(updatedData?.items)) { const clonedConfig = findConfigInTree(updatedData.items, (item) => !isUndefined(item.id) && item.id === value ) if (!isUndefined(clonedConfig) && !isNil(onSuccess)) { onSuccess(clonedConfig) } } } }) }, [cloneConfig, refetch, modal]) const handleDelete = useCallback(( config: BundleDataHubConfiguration, onSuccess?: () => void ): void => { if (isNil(config)) return modal.confirm({ title: t('delete'), content: t('data-hub.delete.confirm', { name: config.text }), onOk: async () => { const configId = String(config.id ?? '') const result = await deleteConfig({ name: configId }) if (has(result, 'error')) { return } await refetch() if (!isNil(onSuccess)) { onSuccess() } } }) }, [deleteConfig, refetch, modal]) return { handleAdd, handleClone, handleDelete } } ================================================ FILE: assets/studio/js/src/modules/config/hooks/use-tab-manager.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { useState, useCallback } from 'react' import { type BundleDataHubConfiguration } from '../config-api-slice.gen' interface UseTabManagerReturn { openedConfigs: BundleDataHubConfiguration[] activeTabKey: string | undefined handleOpenConfig: (config: BundleDataHubConfiguration) => void handleCloseTab: (key: string) => void handleChangeTab: (key: string) => void } export const useTabManager = (): UseTabManagerReturn => { const [openedConfigs, setOpenedConfigs] = useState([]) const [activeTabKey, setActiveTabKey] = useState(undefined) const handleOpenConfig = useCallback((config: BundleDataHubConfiguration): void => { const isAlreadyOpened = openedConfigs.some(item => item.id === config.id) if (!isAlreadyOpened) { setOpenedConfigs(prev => [...prev, config]) } setActiveTabKey(config.id) }, [openedConfigs]) const handleCloseTab = useCallback((key: string): void => { setOpenedConfigs(prev => { const targetIndex = prev.findIndex((tab) => tab?.id === key) const updatedConfigs = prev.filter((config) => config.id !== key) if (key === activeTabKey) { const prevTab = prev[targetIndex - 1] const nextTab = prev[targetIndex + 1] setActiveTabKey(prevTab?.id ?? nextTab?.id) } return updatedConfigs }) }, [activeTabKey]) const handleChangeTab = useCallback((key: string): void => { setActiveTabKey(key) }, []) return { openedConfigs, activeTabKey, handleOpenConfig, handleCloseTab, handleChangeTab } } ================================================ FILE: assets/studio/js/src/modules/config/index.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { container, type AbstractModule } from '@pimcore/studio-ui-bundle' import { serviceIds } from '@pimcore/studio-ui-bundle/app' import { type MainNavRegistry } from '@pimcore/studio-ui-bundle/modules/app' import { type WidgetRegistry } from '@pimcore/studio-ui-bundle/modules/widget-manager' import { ConfigContainer } from './config-container' import { type DynamicTypeDataHubAdapterRegistry } from './dynamic-types/dynamic-type-data-hub-adapter-registry' import { bundleServiceIds } from '../../config/service-ids' export const DataHubModule: AbstractModule = { onInit: (): void => { const adapterRegistry = container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/Registry']) adapterRegistry.registerDynamicType(container.get(bundleServiceIds['DataHub/DynamicTypes/Adapter/GraphQL'])) const widgetRegistryService = container.get(serviceIds.widgetManager) const mainNavRegistryService = container.get(serviceIds.mainNavRegistry) widgetRegistryService.registerWidget({ name: 'data-hub-configuration', component: ConfigContainer }) mainNavRegistryService.registerMainNavItem({ path: 'AutomationIntegration/DataHub', label: 'data-hub.configuration', order: 100, permission: 'plugin_datahub_config', perspectivePermission: 'automationIntegration.dataHubConfiguration', className: 'item-style-modifier', widgetConfig: { name: 'Data Hub Configuration', id: 'data-hub-configuration', component: 'data-hub-configuration', config: { translationKey: 'data-hub.configuration', icon: { type: 'name', value: 'datahub' } } } }) } } ================================================ FILE: assets/studio/js/src/modules/config/providers/config-provider.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { createContext, useContext, type ReactNode } from 'react' import { type BundleDataHubConfigCollectionApiResponse } from '../config-api-slice-enhanced' import { isUndefined } from 'lodash' interface ConfigContextValue { configurationsData?: BundleDataHubConfigCollectionApiResponse isLoading: boolean isFetching: boolean refetch: () => Promise<{ data?: BundleDataHubConfigCollectionApiResponse }> expandedKeys: string[] setExpandedKeys: (keys: string[]) => void } const ConfigContext = createContext(undefined) interface ConfigProviderProps { children: ReactNode value: ConfigContextValue } export const ConfigProvider = ({ children, value }: ConfigProviderProps): React.JSX.Element => { return ( {children} ) } export const useConfigContext = (): ConfigContextValue => { const context = useContext(ConfigContext) if (isUndefined(context)) { throw new Error('useConfigContext must be used within ConfigProvider') } return context } ================================================ FILE: assets/studio/js/src/modules/config/users-api-slice.gen.ts ================================================ import { api } from "@pimcore/studio-ui-bundle/api"; export const addTagTypes = ["Bundle Data Hub"] as const; const injectedRtkApi = api .enhanceEndpoints({ addTagTypes, }) .injectEndpoints({ endpoints: (build) => ({ bundleDataHubUsersCollection: build.query< BundleDataHubUsersCollectionApiResponse, BundleDataHubUsersCollectionApiArg >({ query: (queryArg) => ({ url: `/pimcore-studio/api/bundle/data-hub/users`, params: { type: queryArg["type"] }, }), providesTags: ["Bundle Data Hub"], }), }), overrideExisting: false, }); export { injectedRtkApi as api }; export type BundleDataHubUsersCollectionApiResponse = /** status 200 bundle_data_hub_users_collection_success_response */ { totalItems: number; items: BundleDataHubPermissionUser[]; }; export type BundleDataHubUsersCollectionApiArg = { /** Filter by user type (user or role) */ type?: "user" | "role"; }; export type BundleDataHubPermissionUser = { /** AdditionalAttributes */ additionalAttributes?: { [key: string]: string | number | boolean | object; }; /** User or Role ID */ id: number; /** User or Role name */ text: string; /** Element type */ elementType: string; }; export type Error = { /** Message */ message: string; }; export type DevError = { /** Message */ message: string; /** Details */ details: string; }; export const { useBundleDataHubUsersCollectionQuery } = injectedRtkApi; ================================================ FILE: assets/studio/js/src/modules/config/utils/adapter-helpers.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { type DynamicTypeDataHubAdapterRegistry } from '../dynamic-types/dynamic-type-data-hub-adapter-registry' import { isUndefined } from 'lodash' export const hasValidAdapter = ( adapterType: string | undefined, adapterRegistry: DynamicTypeDataHubAdapterRegistry ): boolean => { if (isUndefined(adapterType)) return false return adapterRegistry.hasDynamicType(adapterType) } ================================================ FILE: assets/studio/js/src/modules/config/utils/get-export-url.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { getPrefix } from '@pimcore/studio-ui-bundle/api' export const getExportUrl = (configName: string): string => { return `${getPrefix()}/bundle/data-hub/config/${configName}/export` } ================================================ FILE: assets/studio/js/src/modules/config/utils/tree-helpers.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { type BundleDataHubConfiguration } from '../config-api-slice.gen' import { isUndefined, isNil, isArray } from 'lodash' export const findConfigById = ( id: string, items: BundleDataHubConfiguration[] | undefined | null ): BundleDataHubConfiguration | null => { if (isNil(items) || !Array.isArray(items)) { return null } for (const item of items) { if (!isNil(item.id) && String(item.id) === String(id)) return item if (!isUndefined(item.children) && !isNil(item.children)) { const found = findConfigById(id, item.children) if (!isNil(found)) return found } } return null } export const findConfigInTree = ( items: BundleDataHubConfiguration[] | undefined | null, predicate: (item: BundleDataHubConfiguration) => boolean ): BundleDataHubConfiguration | undefined => { if (isNil(items) || !Array.isArray(items)) { return undefined } for (const item of items) { if (predicate(item)) return item if (!isUndefined(item.children)) { const found = findConfigInTree(item.children, predicate) if (!isUndefined(found)) return found } } return undefined } export const filterConfigsRecursive = ( items: BundleDataHubConfiguration[] | undefined | null, searchValue: string ): BundleDataHubConfiguration[] => { if (!isArray(items)) { return [] } return items.reduce((acc, item) => { const matchesSearch = item.text.toLowerCase().includes(searchValue.toLowerCase()) const filteredChildren = filterConfigsRecursive(item.children, searchValue) if (matchesSearch || filteredChildren.length > 0) { acc.push({ ...item, children: filteredChildren.length > 0 ? filteredChildren : item.children }) } return acc }, []) } ================================================ FILE: assets/studio/js/src/modules/graphql/components/backend-types.ts ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ // Backend configuration types export interface BackendWorkspace { cpath: string create: boolean read: boolean update: boolean delete: boolean } export interface BackendPermission { id?: number name?: string role?: string user?: string read?: boolean update?: boolean delete?: boolean } export interface BackendSchemaEntity { id: string name: string [key: string]: any } export interface BackendSpecialEntity { name: string readAllowed: boolean createAllowed: boolean updateAllowed: boolean deleteAllowed: boolean readPossible?: boolean createPossible?: boolean updatePossible?: boolean deletePossible?: boolean } export interface BackendConfiguration { general?: { active: boolean description: string group: string writeable?: boolean [key: string]: any } security?: { method: string apikey: string | string[] skipPermissionCheck: boolean disableIntrospection: boolean [key: string]: any } workspaces?: { document?: BackendWorkspace[] asset?: BackendWorkspace[] object?: BackendWorkspace[] } permissions?: { role?: BackendPermission[] user?: BackendPermission[] } schema?: { queryEntities?: Record | BackendSchemaEntity[] mutationEntities?: Record | BackendSchemaEntity[] specialEntities?: BackendSpecialEntity[] [key: string]: any } [key: string]: any } ================================================ FILE: assets/studio/js/src/modules/graphql/components/graphql-detail-view.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React, { useEffect } from 'react' import { IconTextButton } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' import { type DataHubAdapterDetailViewProps } from '../../config/dynamic-types/dynamic-type-data-hub-adapter-abstract' import { BaseDetailView, type TabItem, ConfigToolbar, useDetailView } from '../../../components/base-detail-view' import { GeneralTab } from './tabs/general-tab' import { SchemaDefinitionTab } from './tabs/schema-definition-tab' import { SecurityDefinitionTab } from './tabs/security-definition-tab' import { PermissionsTab } from './tabs/permissions-tab' import { useBundleDataHubGraphqlExplorerUrlQuery } from '../graphql-api-slice-enhanced' import { useBundleDataHubConfigGetQuery, useBundleDataHubConfigUpdateMutation } from '../../config/config-api-slice-enhanced' import { isEmpty, isNil } from 'lodash' import { type GraphQLFormValues } from './types' import { transformFormToBackend, transformBackendToForm } from '../utils/transformers' import { type BackendConfiguration } from './backend-types' import { ApiError, trackError } from '@pimcore/studio-ui-bundle/modules/app' export const GraphQLDetailView = ({ configName, onChange, onDelete }: DataHubAdapterDetailViewProps): React.JSX.Element => { const { t } = useTranslation() // API hooks const { data: configData, error: fetchError, isLoading, isFetching, refetch, requestId } = useBundleDataHubConfigGetQuery( { name: configName }, { refetchOnMountOrArgChange: true } ) const { data: explorerUrlData } = useBundleDataHubGraphqlExplorerUrlQuery({ name: configName }) const [updateConfig, { error: updateError, isLoading: isSaving }] = useBundleDataHubConfigUpdateMutation() // Error tracking useEffect(() => { if (!isNil(fetchError)) { trackError(new ApiError(fetchError)) } }, [fetchError]) useEffect(() => { if (!isNil(updateError)) { trackError(new ApiError(updateError)) } }, [updateError]) const loading = isLoading || isFetching const backendConfig = (configData?.configuration ?? {}) as BackendConfiguration const isWriteable = backendConfig?.general?.writeable ?? true const handleSaveToApi = async (updatedConfig: BackendConfiguration, modificationDate: number): Promise<{ modificationDate?: number }> => { const response = await updateConfig({ name: configName, bundleDataHubUpdateConfiguration: { data: JSON.stringify(updatedConfig), modificationDate } }).unwrap() return { modificationDate: response?.modificationDate } } // Shared form state management const { form, isDirty, initialValues, handleSave, handleValuesChange } = useDetailView({ configName, configData: backendConfig, modificationDate: configData?.modificationDate, isLoading: loading, requestId, transformToForm: transformBackendToForm, transformToBackend: transformFormToBackend, onSave: handleSaveToApi, onChange }) const handleOpenInTab = (): void => { if (explorerUrlData !== undefined && !isEmpty(explorerUrlData.explorerUrl)) { let explorerUrl = explorerUrlData.explorerUrl const securityMethod = form.getFieldValue(['security', 'method']) as string | undefined if (securityMethod === 'datahub_apikey') { const apikey = form.getFieldValue(['security', 'apikey']) as string | undefined if (!isNil(apikey) && !isEmpty(apikey)) { const firstKey = apikey.split('\n')[0] if (!isEmpty(firstKey)) { explorerUrl = `${explorerUrl}?apikey=${firstKey}` } } } window.open(explorerUrl, '_blank') } } const tabs: TabItem[] = [ { key: 'general', label: t('data-hub.tabs.general'), children: }, { key: 'schema', label: t('data-hub.tabs.schema-definition'), children: }, { key: 'security', label: t('data-hub.tabs.security-definition'), children: }, { key: 'permissions', label: t('data-hub.tabs.permissions'), children: } ] const toolbar = ( {t('data-hub.open-in-tab')} ] } configName={ configName } isDirty={ isDirty } isLoading={ loading } isSaving={ isSaving } isWriteable={ isWriteable } onDelete={ onDelete } onRefresh={ refetch } onSave={ handleSave } /> ) return ( ) } ================================================ FILE: assets/studio/js/src/modules/graphql/components/inline-dropdown-panel/inline-dropdown-panel.styles.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import { createStyles } from 'antd-style' export const useStyles = createStyles(({ token, css }) => { return { panel: css` position: absolute; z-index: ${token.zIndexPopupBase}; min-width: 400px; background-color: ${token.colorBgContainer}; padding: ${token.padding}px; box-shadow: ${token.boxShadowSecondary}; border-radius: ${token.borderRadius}px; ` } }) ================================================ FILE: assets/studio/js/src/modules/graphql/components/inline-dropdown-panel/inline-dropdown-panel.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { useStyles } from './inline-dropdown-panel.styles' interface InlineDropdownPanelProps { children: React.ReactNode } export const InlineDropdownPanel = ({ children }: InlineDropdownPanelProps): React.JSX.Element => { const { styles } = useStyles() return (
{children}
) } ================================================ FILE: assets/studio/js/src/modules/graphql/components/tabs/general-tab.tsx ================================================ /** * This source file is available under the terms of the * Pimcore Open Core License (POCL) * Full copyright and license information is available in * LICENSE.md which is distributed with this source code. * * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com) * @license Pimcore Open Core License (POCL) */ import React from 'react' import { Form, Input, Switch, TextArea, FormKit } from '@pimcore/studio-ui-bundle/components' import { useTranslation } from '@pimcore/studio-ui-bundle/app' export interface GeneralTabProps { adapterTypeLabel?: string } export const GeneralTab = ({ adapterTypeLabel }: GeneralTabProps = {}): React.JSX.Element => { const { t } = useTranslation() const typeLabel = adapterTypeLabel ?? t('data-hub.adapter.graphql') return (