{"openapi":"3.0.1","info":{"title":"dotCMS REST API","version":"3"},"servers":[{"url":"/","description":"dotCMS Server","variables":{}}],"tags":[{"name":"Accessibility Checker","description":"Endpoints that perform operations related to validating accessibility in content."},{"name":"Content Analytics","description":"This REST Endpoint exposes information related to how dotCMS content is accessed and interacted with by users."},{"name":"API Token","description":"Endpoints that handle operations related to API tokens","externalDocs":{"description":"Additional API token information","url":"https://www.dotcms.com/docs/latest/rest-api-authentication#APIToken"}},{"name":"Authentication","description":"Endpoints that perform operations related to user authentication","externalDocs":{"description":"Additional Authentication API information","url":"https://www.dotcms.com/docs/latest/rest-api-authentication"}},{"name":"Content Type","description":"Endpoints that perform operations related to content types.","externalDocs":{"description":"Additional Content Type API information","url":"https://www.dotcms.com/docs/latest/content-type-api"}},{"name":"Page","description":"Endpoints that operate on pages","externalDocs":{"description":"Additional Page API information","url":"https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas"}},{"name":"Workflow","description":"Endpoints that perform operations related to workflows.","externalDocs":{"description":"Additional Workflow API information","url":"https://www.dotcms.com/docs/latest/workflow-rest-api"}},{"name":"Content Type Field"},{"name":"Content Delivery"},{"name":"Bundle"},{"name":"Navigation"},{"name":"Experiment"},{"name":"Content Report"}],"paths":{"/api/v1/ai/completions/config":{"get":{"operationId":"getConfig","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/ai/completions/rawPrompt":{"post":{"operationId":"rawPrompt","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompletionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/ai/completions":{"post":{"operationId":"summarizeFromContent","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompletionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/ai/embeddings/count":{"get":{"operationId":"count_1","parameters":[{"name":"site","in":"query","schema":{"type":"string"}},{"name":"contentType","in":"query","schema":{"type":"string"}},{"name":"indexName","in":"query","schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"fieldVar","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"count","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompletionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/embeddings":{"post":{"operationId":"embed","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EmbeddingsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"delete","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"asMap":{"type":"object","additionalProperties":{"type":"object"}},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/embeddings/db":{"delete":{"operationId":"dropAndRecreateTables","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"asMap":{"type":"object","additionalProperties":{"type":"object"}},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/embeddings/indexCount":{"get":{"operationId":"indexCount","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/embeddings/test":{"get":{"operationId":"textResource","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/image/generate":{"get":{"operationId":"indexByInode_1","parameters":[{"name":"prompt","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"handleImageRequest","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AIImageRequestDTO"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/image/test":{"get":{"operationId":"indexByInode","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/search/related":{"get":{"operationId":"relatedByGet","parameters":[{"name":"language","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"indexName","in":"query","schema":{"type":"string"}},{"name":"fieldVar","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"relatedByPost","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"asMap":{"type":"object","additionalProperties":{"type":"object"}},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/search":{"get":{"operationId":"searchByGet","parameters":[{"name":"query","in":"query","schema":{"type":"string"}},{"name":"searchLimit","in":"query","schema":{"type":"integer","format":"int32","default":1000}},{"name":"searchOffset","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"contentType","in":"query","schema":{"type":"string"}},{"name":"indexName","in":"query","schema":{"type":"string","default":"default"}},{"name":"threshold","in":"query","schema":{"type":"number","format":"float","default":0.5}},{"name":"stream","in":"query","schema":{"type":"boolean","default":false}},{"name":"responseLength","in":"query","schema":{"type":"integer","format":"int32","default":1024}},{"name":"operator","in":"query","schema":{"type":"string","default":"<=>"}},{"name":"language","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}},"post":{"operationId":"searchByPost","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompletionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/search/test":{"get":{"operationId":"testResponse","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/ai/text/generate":{"get":{"operationId":"doGet","parameters":[{"name":"prompt","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"doPost","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompletionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/dotsaml/login/{idpConfigId}":{"get":{"operationId":"doLogin","parameters":[{"name":"idpConfigId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"processLogin","parameters":[{"name":"idpConfigId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/xml":{},"text/html":{}}}}}},"/api/v1/dotsaml/logout/{idpConfigId}":{"get":{"operationId":"logoutGet","parameters":[{"name":"idpConfigId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{},"application/xhtml+xml":{}}}}},"post":{"operationId":"logoutPost","parameters":[{"name":"idpConfigId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{},"application/xhtml+xml":{}}}}}},"/api/v1/dotsaml/metadata/{idpConfigId}":{"get":{"operationId":"metadata","parameters":[{"name":"idpConfigId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/xml":{}}}}}},"/api/v1/fieldTypes":{"get":{"operationId":"getFieldTypes","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/js/{folder}":{"get":{"operationId":"get","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"putMultipart","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"postMultipart","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"delete_1","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"patchMultipart","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/js/{folder}/{pathParam}":{"get":{"operationId":"get_1","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"putMultipart_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"postMultipart_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"delete_2","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"patchMultipart_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/js/dynamic/{pathParam}":{"get":{"operationId":"dynamicGet_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"dynamicPut_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"dynamicPost_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"dynamicDelete","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"dynamicPatch","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/js/dynamic":{"get":{"operationId":"dynamicGet","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"dynamicPut","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"dynamicPost","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/auditPublishing/get/{bundleId}":{"get":{"operationId":"get_2","parameters":[{"name":"bundleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/xml":{}}}}}},"/api/layout/{params}":{"get":{"operationId":"getLayout","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/bundlePublisher/publish":{"post":{"operationId":"publish","parameters":[{"name":"type","in":"query","schema":{"type":"string"}},{"name":"callback","in":"query","schema":{"type":"string"}},{"name":"FORCE_PUSH","in":"query","schema":{"type":"boolean"}},{"name":"filterkey","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/all":{"delete":{"tags":["Bundle"],"operationId":"deleteAll","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/all/fail":{"delete":{"tags":["Bundle"],"operationId":"deleteAllFail","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/all/success":{"delete":{"tags":["Bundle"],"operationId":"deleteAllSuccess","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/ids":{"delete":{"tags":["Bundle"],"operationId":"deleteBundlesByIdentifiers","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteBundlesByIdentifierForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/olderthan/{olderThan}":{"delete":{"tags":["Bundle"],"operationId":"deleteBundlesOlderThan","parameters":[{"name":"olderThan","in":"path","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/deleteenvironmentpushhistory/{params}":{"get":{"tags":["Bundle"],"operationId":"deleteEnvironmentPushHistory","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/deletepushhistory/{params}":{"get":{"tags":["Bundle"],"operationId":"deletePushHistory","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/_download/{bundleId}":{"get":{"tags":["Bundle"],"operationId":"downloadBundle","parameters":[{"name":"bundleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}}}},"/api/bundle/{bundleId}/manifest":{"get":{"tags":["Bundle"],"operationId":"downloadManifest","parameters":[{"name":"bundleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/octet-stream":{}}}}}},"/api/bundle/_generate":{"post":{"tags":["Bundle"],"operationId":"generateBundle","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBundleForm"}}}},"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}}}},"/api/bundle/{bundleId}/assets":{"get":{"tags":["Bundle"],"operationId":"getPublishQueueElements","parameters":[{"name":"bundleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/getunsendbundles/{params}":{"get":{"tags":["Bundle"],"operationId":"getUnsendBundles","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle/updatebundle/{params}":{"get":{"tags":["Bundle"],"operationId":"updateBundle","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/bundle":{"post":{"tags":["Bundle"],"operationId":"uploadBundleAsync","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/bundle/sync":{"post":{"tags":["Bundle"],"operationId":"uploadBundleSync","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/config/deleteEndpoint":{"post":{"operationId":"deleteEndpoint","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"endPoint":{"type":"string"},"type":{"type":"string"},"callback":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/deleteEnvironment":{"post":{"operationId":"deleteEnvironment","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"environment":{"type":"string"},"type":{"type":"string"},"callback":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/regenerateKey":{"post":{"operationId":"regenerateKey","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/saveCompanyAuthTypeInfo":{"post":{"operationId":"saveCompanyAuthTypeInfo","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"authType":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/saveCompanyBasicInfo":{"post":{"operationId":"saveCompanyBasicInfo","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"portalURL":{"type":"string"},"mx":{"type":"string"},"emailAddress":{"type":"string"},"size":{"type":"string"},"type":{"type":"string"},"street":{"type":"string"},"homeURL":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/saveCompanyLocaleInfo":{"post":{"operationId":"saveCompanyLocaleInfo","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"languageId":{"type":"string"},"timeZoneId":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/config/saveCompanyLogo":{"post":{"operationId":"saveCompanyLogo","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"logoFile":{"$ref":"#/components/schemas/FormDataContentDisposition"}}}}}},"responses":{"default":{"description":"default response","content":{"text/html":{}}}},"deprecated":true}},"/api/cluster/getESConfigProperties/{params}":{"get":{"operationId":"getESConfigProperties","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/cluster/licenseRepoStatus":{"get":{"operationId":"getLicenseRepoStatus","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/cluster/getNodesStatus/{params}":{"get":{"operationId":"getNodesInfo","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/cluster/remove/{params}":{"post":{"operationId":"removeFromCluster","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/cluster/test":{"get":{"operationId":"testCluster","responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/content/canLock/{params}":{"put":{"tags":["Content Delivery"],"operationId":"canLockContent","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/content/{params}":{"get":{"tags":["Content Delivery"],"operationId":"getContent","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"put":{"tags":["Content Delivery"],"operationId":"singlePUT","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"text/plain":{}}}},"deprecated":true},"post":{"tags":["Content Delivery"],"operationId":"singlePOST","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"text/plain":{}}}},"deprecated":true}},"/api/content/indexcount/{query}":{"get":{"tags":["Content Delivery"],"operationId":"indexCount_1","parameters":[{"name":"query","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"callback","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{}}}}}},"/api/content/indexsearch/{query}/sortby/{sortby}/limit/{limit}/offset/{offset}":{"get":{"tags":["Content Delivery"],"operationId":"indexSearch","parameters":[{"name":"query","in":"path","required":true,"schema":{"type":"string"}},{"name":"sortby","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"callback","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/content/lock/{params}":{"put":{"tags":["Content Delivery"],"operationId":"lockContent","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/content/_search":{"post":{"tags":["Content Delivery"],"operationId":"search","parameters":[{"name":"rememberQuery","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/content/unlock/{params}":{"put":{"tags":["Content Delivery"],"operationId":"unlockContent","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/environment":{"get":{"summary":"Returns the environments","operationId":"loadAllEnvironments","responses":{"200":{"description":"Collection of environments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityEnvironmentsView"}}}}}},"post":{"summary":"Creates an environment","operationId":"create","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentForm"}}}},"responses":{"200":{"description":"If creation is successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityEnvironmentView"}}}},"403":{"description":"If the user is not an admin or access to the configuration layout or does have permission, it will return a 403.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"400":{"description":"If the environment already exits","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/environment/{id}":{"put":{"summary":"Updates an environment","operationId":"update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentForm"}}}},"responses":{"200":{"description":"If update is success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityEnvironmentView"}}}},"403":{"description":"If the user is not an admin or access to the configuration layout or does have permission, it will return a 403.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"400":{"description":"If the environment already exits","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes an environment","operationId":"delete_3","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"If deletion is successfully environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}},"403":{"description":"If the user is not an admin or access to the configuration layout or does have permission, it will return a 403.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"404":{"description":"If the environment does not exits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DoesNotExistException"}}}}}}},"/api/environment/loadenvironments/{params}":{"get":{"operationId":"loadEnvironments","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/integrity/checkintegrity/{params}":{"get":{"operationId":"checkIntegrity","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/integrity/checkIntegrityProcessStatus/{params}":{"get":{"operationId":"checkIntegrityProcessStatus","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/integrity/discardconflicts/{params}":{"get":{"operationId":"discardConflicts","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/integrity/fixconflicts/{params}":{"get":{"operationId":"fixConflicts","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/integrity/_fixconflictsfromremote":{"post":{"operationId":"fixConflictsFromRemote","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"DATA_TO_FIX":{"type":"object"},"TYPE":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"text/plain":{}}}}}},"/api/integrity/_generateintegritydata":{"post":{"operationId":"generateIntegrityData","responses":{"default":{"description":"default response","content":{"text/plain":{}}}}}},"/api/integrity/{requestId}/integrityData":{"get":{"operationId":"getIntegrityData","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/zip":{}}}}}},"/api/integrity/getIntegrityResult/{params}":{"get":{"operationId":"getIntegrityResult","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/portlet/layout/{params}":{"get":{"operationId":"getLayout_1","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/portlet/{params}":{"get":{"operationId":"layoutGet","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}},"post":{"operationId":"layoutPost","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/license/applyLicense":{"post":{"operationId":"applyLicense","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}},{"name":"licenseText","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/delete/{params}":{"delete":{"operationId":"delete_4","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/free/{params}":{"post":{"operationId":"freeLicense","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/all/{params}":{"get":{"operationId":"getAll","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/license/pick/{params}":{"post":{"operationId":"pickLicense","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/upload/{params}":{"post":{"operationId":"putZipFile","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataContentDisposition"},"return":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/requestCode/{params}":{"post":{"operationId":"requestLicense","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/license/resetLicense/{params}":{"post":{"operationId":"resetLicense","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/osgi/getInstalledBundles/{params}":{"get":{"operationId":"getInstalledBundles","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true}},"/api/osgi/_processExports/{bundle}":{"get":{"operationId":"processBundle","parameters":[{"name":"bundle","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true}},"/api/osgi":{"post":{"operationId":"updateBundles","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/publishqueue":{"delete":{"operationId":"deleteAssetsByIdentifiers","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeletePPQueueElementsByIdentifierForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/restexample/layout/{params}":{"get":{"operationId":"getLayout_2","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/restexample/test/{params}":{"get":{"operationId":"loadJson","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/role/loadbyid/{params}":{"get":{"operationId":"loadById","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/role/loadbyname/{params}":{"get":{"operationId":"loadByName","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/role/loadchildren/{params}":{"get":{"operationId":"loadChildren","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/rulesengine/layout/{params}":{"get":{"operationId":"getLayout_3","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/structure/{path}":{"get":{"operationId":"getStructuresWithWYSIWYGFields","parameters":[{"name":"path","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"callback","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/tags":{"get":{"operationId":"list","parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"siteId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestTag"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestTag"}}}}}},"deprecated":true},"put":{"operationId":"updateTag","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateTagForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"post":{"operationId":"addTag","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/tags/{tagId}":{"delete":{"operationId":"delete_5","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/tags/inode/{inode}":{"get":{"operationId":"findTagsByInode","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"delete":{"operationId":"deleteTagInodesByInode","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/tags/{nameOrId}":{"get":{"operationId":"getTagsByNameOrId","parameters":[{"name":"nameOrId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/tags/user/{userId}":{"get":{"operationId":"getTagsByUserId","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/tags/import":{"post":{"operationId":"importTags","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true}},"/api/v1/tags/tag/{nameOrId}/inode/{inode}":{"put":{"operationId":"linkTagsAndInode","parameters":[{"name":"nameOrId","in":"path","required":true,"schema":{"type":"string"}},{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/testResource/testGet/{params}":{"get":{"operationId":"getDocumentCount","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/testResource/testPost":{"post":{"operationId":"saveTest","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user":{"type":"string"},"password":{"type":"string"},"param1":{"type":"string"},"param2":{"type":"string"},"type":{"type":"string"},"callback":{"type":"string"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/user/getloggedinuser/{params}":{"get":{"operationId":"getLoggedInUser","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true}},"/api/util/encodeQueryParamValue/{params}":{"get":{"operationId":"getLoggedInUser_1","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/widget/{params}":{"get":{"operationId":"getWidget","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain; charset=UTF-8":{}}}}}},"/api/v1/achecker/guidelines":{"get":{"tags":["Accessibility Checker"],"summary":"Retrieves Accessibility Guidelines","description":"Returns the list of available Accessibility Guidelines that are used to validate content.","operationId":"getAccessibilityGuidelines","responses":{"200":{"description":"Guideline list retrieved successfully","content":{"application/json":{}}},"500":{"description":"Internal Server Error"}}}},"/api/v1/achecker/_validate":{"post":{"tags":["Accessibility Checker"],"summary":"Validates content","description":"Validates the given content against the one or more Accessibility Guidelines.","operationId":"postValidateContent","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Content validated successfully","content":{"application/json":{"example":"{\n \"entity\": {\n \"errors\": [\n {\n \"check\": {\n \"check_id\": 98,\n \"confidence\": 2,\n \"confidenceEnum\": \"POTENTIAL\",\n \"decision_fail\": \"Not all abbreviations are marked with the abbr element.\",\n \"decision_pass\": \"All abbreviations are marked with the abbr element.\",\n \"description\": \"If body element content is greater than 10 characters (English) this error will be generated.\",\n \"err\": \"Abbreviations may not be marked with abbr element.\",\n \"func\": \"return (BasicFunctions::getPlainTextLength() <= 10);\",\n \"how_to_repair\": \"\",\n \"html_tag\": \"body\",\n \"lang\": \"en\",\n \"long_description\": null,\n \"name\": \"Abbreviations must be marked with abbr element.\",\n \"note\": \"\",\n \"open_to_public\": 1,\n \"question\": \"Are there any abbreviations in the document that are not marked with the abbr element?\",\n \"rationale\": \"_RATIONALE_98\",\n \"repair_example\": \"\",\n \"search_str\": null,\n \"test_expected_result\": \"1. All abbreviations are expected to be marked with a valid abbr element.\",\n \"test_failed_result\": \"1. Mark all abbreviations with a valid abbr element.\",\n \"test_procedure\": \"1. Check the document for any text abbreviations.\\\\n2. If an abbreviation is found, check if it is properly marked with the abbr element.\",\n \"user_id\": 0\n },\n \"col_number\": 110,\n \"cssCode\": null,\n \"htmlCode\": \" Adventure travel done right Wherever you want to go, whatever you want to get into, we’ve go...\",\n \"image\": null,\n \"imageAlt\": null,\n \"line_number\": 0,\n \"success\": false\n },\n ...\n ...\n ],\n \"lang\": \"en\",\n \"results\": [\n {\n \"check\": {\n \"check_id\": 29,\n \"confidence\": 0,\n \"confidenceEnum\": \"KNOWN\",\n \"decision_fail\": \"\",\n \"decision_pass\": \"\",\n \"description\": \"Each document must contain a valid doctype declaration.\",\n \"err\": \"doctype declaration missing.\",\n \"func\": \"return (BasicFunctions::getNumOfTagInWholeContent(\\\\\\\"doctype\\\\\\\") > 0);\",\n \"how_to_repair\": \"Add a valid doctype declaration to the document.\",\n \"html_tag\": \"html\",\n \"lang\": \"en\",\n \"long_description\": null,\n \"name\": \"HTML content has a valid doctype declaration.\",\n \"note\": \"\",\n \"open_to_public\": 1,\n \"question\": \"\",\n \"rationale\": \"\",\n \"repair_example\": \"\",\n \"search_str\": null,\n \"test_expected_result\": \"1. HTML content has a valid doctype declaration.\",\n \"test_failed_result\": \"1. Add a valid doctype declaration to the document.\",\n \"test_procedure\": \"1. Check for the presence of a doctype declaration at the start of the document.\\\\n2. Check the content of the doctype declaration.\",\n \"user_id\": 0\n },\n \"col_number\": 110,\n \"cssCode\": null,\n \"htmlCode\": \" Adventure travel done right Wherever you want to go, what...\",\n \"image\": null,\n \"imageAlt\": null,\n \"line_number\": 0,\n \"success\": true\n },\n ...\n ...\n ]\n },\n \"errors\": [],\n \"i18nMessagesMap\": {},\n \"messages\": [],\n \"pagination\": null,\n \"permissions\": []\n}"}}},"400":{"description":"Bad Request"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/analytics/content/event":{"post":{"tags":["Content Analytics"],"summary":"Fire an user custom event.","description":"receives a custom event payload and fires the event to the collectors","operationId":"fireUserCustomEvent","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"200":{"description":"If the event was created successfully","content":{"application/json":{"example":"TBD"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/analytics/content/_query":{"post":{"tags":["Content Analytics"],"summary":"Retrieve Content Analytics data","description":"Returns information of specific dotCMS objects whose health and engagement data is tracked. This method takes a specific less verbose JSON format to query the data.","operationId":"postContentAnalyticsQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryForm"}}}},"responses":{"200":{"description":"Content Analytics data being queried","content":{"application/json":{"example":{"query":{"measures":["request.count"],"order":"request.count DESC","dimensions":["request.url","request.pageId","request.pageTitle"],"filters":"request.whatAmI = ['PAGE']","limit":100,"offset":1}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/analytics/content":{"post":{"tags":["Content Analytics"],"summary":"Returns Content Analytics data","description":"Returns information of specific dotCMS objects whose health and engagement data is tracked, using Path Parameters instead of a CubeJS JSON query. This helps abstract the complexity of the underlying JSON format for users that need an easier way to query for specific data.","operationId":"postContentAnalyticsSimpleQuery","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"200":{"description":"Content Analytics data being queried","content":{"application/json":{"example":{"measures":"request.count request.totalSessions","dimensions":"request.host request.whatAmI request.url","timeDimensions":"request.createdAt:day:Last month","filters":"request.totalRequest gt 0:request.whatAmI contains PAGE,FILE","order":"request.count asc:request.createdAt asc","limit":15,"offset":0}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/analytics/content/_query/cube":{"post":{"tags":["Content Analytics"],"summary":"Retrieve Content Analytics data","description":"Returns information of specific dotCMS objects whose health and engagement data is tracked, using a CubeJS JSON query.","operationId":"postContentAnalyticsQuery_1","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Content Analytics data being queried","content":{"application/json":{"example":{"dimensions":["Events.experiment","Events.variant"]}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/announcements":{"get":{"operationId":"announcements","parameters":[{"name":"refreshCache","in":"query","schema":{"type":"boolean"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListAnnouncement"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListAnnouncement"}}}}}}},"/api/v1/apps":{"get":{"operationId":"listAvailableApps","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"createApp","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteIndividualAppSecret","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteSecretForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/apps/{key}/{siteId}":{"get":{"operationId":"getAppDetail","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateAppIndividualSecret","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecretForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"createAppSecrets","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecretForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteAllAppSecrets","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/apps/{key}":{"get":{"operationId":"getAppByKey","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteApp","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"removeDescriptor","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/apps/export":{"post":{"operationId":"exportSecrets","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExportSecretForm"}}}},"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/apps/import":{"post":{"operationId":"importSecrets","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/assets/_archive":{"post":{"tags":["Web Assets"],"operationId":"archiveAsset","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AssetInfoRequestForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/assets/_delete":{"post":{"tags":["Web Assets"],"operationId":"deleteAsset","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AssetInfoRequestForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/assets/folders/_delete":{"post":{"tags":["Web Assets"],"operationId":"deleteFolder","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AssetInfoRequestForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/assets/_download":{"post":{"tags":["Web Assets"],"operationId":"download","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AssetsRequestForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/assets":{"put":{"tags":["Web Assets"],"operationId":"saveUpdateAsset","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FormDataContentDisposition"},"assetPath":{"type":"string"},"detail":{"$ref":"#/components/schemas/FileUploadDetail"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"tags":["Web Assets"],"operationId":"getAssetsInfo","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AssetInfoRequestForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/apitoken/{tokenId}":{"delete":{"tags":["API Token"],"summary":"Deletes an API token","description":"Deletes an API token by identifier. May be performed on either active, expired, or revoked.\n\nReturned entity contains the property `deleted`, the value of which is the deleted token object.","operationId":"deleteApiTokenById","parameters":[{"name":"tokenId","in":"path","description":"Identifier of API token to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token successfully deleted","content":{"application/json":{"example":{"entity":{"deleted":{"allowNetwork":null,"claims":{"label":"string"},"expired":false,"expiresDate":1822623941000,"id":"string","issueDate":1728061510000,"issuer":"string","modificationDate":1728069870000,"notBeforeDate":false,"requestingIp":"string","requestingUserId":"string","revoked":true,"revokedDate":1728069870000,"subject":"string","tokenType":"string","userId":"string","valid":false}},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"404":{"description":"Token not found"},"500":{"description":"Unexpected server error"}}}},"/api/v1/apitoken/{userId}/tokens":{"get":{"tags":["API Token"],"summary":"Retrieves API tokens based on a user ID","description":"Accepts a user identifier and returns a list of API tokens associated with that user.\n\nThe returned list may optionally include or exclude tokens that have been revoked.\n\n","operationId":"getApiTokensByUserId","parameters":[{"name":"userId","in":"path","description":"Identifier of user to check for tokens.","required":true,"schema":{"type":"string"}},{"name":"showRevoked","in":"query","description":"Determines whether revoked tokens are shown. Defaults to `false` if omitted.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"User's API tokens successfully retrieved","content":{"application/json":{"example":{"entity":{"tokens":[{"allowNetwork":null,"claims":{"label":"string"},"expired":false,"expiresDate":1822623941000,"id":"string","issueDate":1728061510000,"issuer":"string","modificationDate":1728061510000,"notBeforeDate":false,"requestingIp":"string","requestingUserId":"string","revoked":false,"revokedDate":null,"subject":"string","tokenType":"string","userId":"string","valid":true}]},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"403":{"description":"Forbidden"},"404":{"description":"Invalid user"},"500":{"description":"Unexpected server error"}}}},"/api/v1/apitoken/{tokenId}/jwt":{"get":{"tags":["API Token"],"summary":"Generates a new JWT for an existing token","description":"Returns a JSON web token. This overwrites the JWT value associated with the specified token object.","operationId":"getGetJwtFromApiToken","parameters":[{"name":"tokenId","in":"path","description":"Identifier of API token to receive a new JWT.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"JSON web token successfully created","content":{"application/json":{"example":{"entity":{"jwt":"string"},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"403":{"description":"Forbidden"},"404":{"description":"Token not found"},"500":{"description":"Unexpected server error"}}}},"/api/v1/apitoken/remote":{"put":{"tags":["API Token"],"summary":"Generates a remote API token","description":"This endpoint takes as part of its payload authentication credentials for a user account on a remote dotCMS instance. It returns a token object that can be used to permit remote operation according to the role and permissions of the authenticated account.\n\nThis is used, for example, in configuring a [push publishing](https://www.dotcms.com/docs/latest/push-publishing) endpoint.\n\nUsable only by administrators.","operationId":"putGetRemoteToken","requestBody":{"description":"PUT body consists of a JSON object containing three properties: `token`, concerning the token's direct properties; `remote`, defining the remote host, and `auth`, specifying remote user authentication.\n\nEach of these three top-level properties is itself an object containing further properties, listed fully below:\n\n| Properties | Value | Description |\n|----------------------------|---------|------------------------------------------------------------------------|\n| `token.network` | String | Network mask in which the token is active. |\n| `token.expirationSeconds` | String | Seconds until the token expires. |\n| `token.claims` | Object | Object containing the property `label`, defined below. |\n| `token.claims.label` | String | The name of the token generated. |\n| | | |\n| `remote.host` | String | Remote host for which to generate a token. |\n| `remote.port` | String | Port number for the remote host. |\n| `remote.protocol` | String | Web protocol used to connect to the remote host. |\n| | | |\n| `auth.login` | String | Email of account from which the remote token will derive permissions. |\n| `auth.password` | String | A string representing a base64-encoded password. |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteAPITokenForm"},"example":{"token":{"network":"0.0.0.0/0","expirationSeconds":"1000","claims":{"label":"Example"}},"remote":{"host":"dotcms-receiver.local","port":"8082","protocol":"http"},"auth":{"login":"admin@dotcms.com","password":"YWRtaW4="}}}},"required":true},"responses":{"200":{"description":"Remote token generated successfully","content":{"application/json":{"example":{"entity":{"jwt":"string","token":{"allowNetwork":"0.0.0.0/0","claims":{"label":"string"},"expired":false,"expiresDate":0,"id":"string","issueDate":0,"issuer":"string","modificationDate":0,"notBeforeDate":false,"requestingIp":"string","requestingUserId":"string","revoked":false,"revokedDate":0,"subject":"string","tokenType":"string","userId":"string","valid":true}},"errors":[],"i18nMessagesMap":{},"messages":[],"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Unexpected server error"}}}},"/api/v1/apitoken":{"post":{"tags":["API Token"],"summary":"Issues an API token","description":"Issues an API token to an authorized user account.\n\nReturns an object representing the issued token.","operationId":"postIssueApiToken","requestBody":{"description":"This method requires a POST body of a JSON object containing the following properties.\n\n| Property | Value | Description |\n|-----------------|-----------|-----------------------------------------------|\n| `userId` | String | **Required.** ID of user attempting receiving |\n| `expirationSeconds` | Integer | **Required.** TTL of token in seconds. |\n| `network` | String | Network mask in which token is valid. Defaults to `0.0.0.0/0`, or any local network. |\n| `claims` | Object | Contains `label` property. |\n| `claims.label` | String | Sets a user-defined name for token. |\n| `shouldBeAdmin` | Boolean | If `true`, the call only succeeds if the token is being issued to an admin account. Defaults to `false` if omitted. |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTokenForm"},"example":{"userId":"string","expirationSeconds":0,"network":"string","claims":{"label":"string"},"shouldBeAdmin":false}}},"required":true},"responses":{"200":{"description":"Token successfully issued to user","content":{"application/json":{"example":{"entity":{"jwt":"string","token":{"allowNetwork":"0.0.0.0/0","claims":{"label":"string"},"expired":false,"expiresDate":0,"id":"string","issueDate":0,"issuer":"string","modificationDate":0,"notBeforeDate":false,"requestingIp":"string","requestingUserId":"string","revoked":false,"revokedDate":0,"subject":"string","tokenType":"string","userId":"string","valid":true}},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Unexpected server error"}}}},"/api/v1/apitoken/{tokenId}/revoke":{"put":{"tags":["API Token"],"summary":"Revokes an API token","description":"Revokes a token by its identifier.\n\n Returned entity contains the property `revoked`, whose value is an object representing the revoked token.","operationId":"putRevokeTokenById","parameters":[{"name":"tokenId","in":"path","description":"Identifier of API token to be revoked","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token revoked successfully","content":{"application/json":{"example":{"entity":{"revoked":{"allowNetwork":null,"claims":{"label":"string"},"expired":false,"expiresDate":1822623941000,"id":"string","issueDate":1728061510000,"issuer":"string","modificationDate":1728069870000,"notBeforeDate":false,"requestingIp":"string","requestingUserId":"string","revoked":true,"revokedDate":1728069870000,"subject":"string","tokenType":"string","userId":"string","valid":false}},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"401":{"description":"Invalid user"},"403":{"description":"Forbidden"},"404":{"description":"Token not found"},"500":{"description":"Unexpected server error"}}}},"/api/v1/authentication":{"post":{"tags":["Authentication"],"summary":"Verifies user or application authentication","description":"Takes a user's login ID and password and checks them against the user rolls.\n\nIf the user is found and authenticated, a session is created.\n\nOtherwise the system will return an 'authentication failed' message.\n\n","operationId":"postAuthentication","requestBody":{"description":"This method takes a user's credentials and language preferences to authenticate them.\n\nRequires a POST body consisting of a JSON object containing the following properties:\n\n| **Property** | **Value** | **Description** |\n|--------------|-----------|-----------------------------------------------|\n| `userId` | String | **Required.** ID of user attempting to log in |\n| `password` | String | User password |\n| `language` | String | Preferred language for user |\n| `country` | String | Country where user is located |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationForm"}}},"required":true},"responses":{"200":{"description":"User authentication successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityUserMapView"}}}},"401":{"description":"User not authenticated"},"403":{"description":"Forbidden request"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Unexpected error"}}}},"/api/v1/authentication/logInUser":{"get":{"tags":["Authentication"],"summary":"Retrieves user data","description":"Provides information about any users that are currently in a session.\n\nThis retrieved data will be formatted into a JSON response body.\n\n","operationId":"getLogInUser","responses":{"200":{"description":"User data successfully collected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityUserView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityUserView"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized request"},"404":{"description":"User not found"}}}},"/api/v1/forgotpassword":{"post":{"operationId":"forgotPassword","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ForgotPasswordForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/loginform":{"post":{"operationId":"loginForm","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18NForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/logout":{"get":{"operationId":"logout","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/changePassword":{"post":{"operationId":"resetPassword","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResetPasswordForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/browser":{"post":{"operationId":"getFolderContent","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/BrowserQueryForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/browser/selectedfolder":{"get":{"operationId":"getSelectFolder","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"selectFolder","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/OpenFolderForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/browsertree/sitename/{sitename}/uri":{"get":{"operationId":"loadAssetsUnder","parameters":[{"name":"sitename","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/browsertree/sitename/{sitename}/uri/{uri}":{"get":{"operationId":"loadAssetsUnder_1","parameters":[{"name":"sitename","in":"path","required":true,"schema":{"type":"string"}},{"name":"uri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/categories":{"get":{"operationId":"getCategories","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"category_name"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"showChildrenCount","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"save_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveNew","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"delete_6","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/categories/_export":{"get":{"operationId":"export","parameters":[{"name":"contextInode","in":"query","schema":{"type":"string"}},{"name":"filter","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/csv":{}}}}}},"/api/v1/categories/{idOrKey}":{"get":{"operationId":"getCategoryByIdOrKey","parameters":[{"name":"idOrKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"showChildrenCount","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/categories/children":{"get":{"operationId":"getChildren","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"category_name"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"showChildrenCount","in":"query","schema":{"type":"boolean"}},{"name":"allLevels","in":"query","schema":{"type":"boolean"}},{"name":"parentList","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/categories/hierarchy":{"post":{"summary":"Get the List of Parents from set of categories","description":"Response with the list of parents for a specific set of categories. If any of the categoriesdoes not exists then it is just ignored","operationId":"getSchemes","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryKeysForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HierarchyShortCategoriesResponseView"}}}}}}},"/api/v1/categories/_import":{"post":{"operationId":"importCategories","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/categories/_sort":{"put":{"operationId":"save","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryEditForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_archive":{"put":{"operationId":"archive","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_bulkarchive":{"put":{"operationId":"bulkArchive","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_bulkdelete":{"delete":{"operationId":"bulkDelete","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_bulkpublish":{"put":{"operationId":"bulkPublish","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_bulkunarchive":{"put":{"operationId":"bulkUnarchive","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_bulkunpublish":{"put":{"operationId":"bulkUnpublish","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/{containerId}/content/{contentletId}":{"get":{"operationId":"containerContent","parameters":[{"name":"containerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contentletId","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageInode","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/content/{contentletId}":{"get":{"operationId":"containerContentByQueryParam","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}},{"name":"pageInode","in":"query","schema":{"type":"string"}},{"name":"contentletId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/{containerId}/form/{formId}":{"get":{"operationId":"containerForm","parameters":[{"name":"containerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"formId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/form/{formId}":{"get":{"operationId":"containerFormByQueryParam","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}},{"name":"formId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/{id}/_copy":{"post":{"operationId":"copy","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityContainerView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityContainerView"}}}}}}},"/api/v1/containers":{"get":{"operationId":"getContainers","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"title"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"host","in":"query","schema":{"type":"string"}},{"name":"system","in":"query","schema":{"type":"boolean"}},{"name":"archive","in":"query","schema":{"type":"boolean"}},{"name":"content_type","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"update_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ContainerForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveNew_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ContainerForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"delete_7","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/live":{"get":{"operationId":"getLiveById","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}},{"name":"includeContentType","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/working":{"get":{"operationId":"getWorkingById","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}},{"name":"includeContentType","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_publish":{"put":{"operationId":"publish_1","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/delete/{containerId}/content/{contentletId}/uid/{uid}":{"delete":{"operationId":"removeContentletFromContainer","parameters":[{"name":"containerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contentletId","in":"path","required":true,"schema":{"type":"string"}},{"name":"order","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"uid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_unarchive":{"put":{"operationId":"unarchive","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/containers/_unpublish":{"put":{"operationId":"unpublish","parameters":[{"name":"containerId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/contentrelationships/{params}":{"get":{"operationId":"getContent_1","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/contentreport/folder/{folder}":{"get":{"tags":["Content Report"],"summary":"Generates a report of the different Content Types living under a Folder, and the number of content items for each type","operationId":"getFolderContentReport","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"upper(name)"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}}],"responses":{"200":{"description":"Content Report for the specified Folder ID/path, or an empty list if either the Folder doesn't exist, or no content is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentReportView"}}}}}}},"/api/v1/contentreport/site/{site}":{"get":{"tags":["Content Report"],"summary":"Generates a report of the different Content Types living under a Site, and the number of content items for each type","operationId":"getSiteContentReport","parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"upper(name)"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}}],"responses":{"200":{"description":"Content Report for the specified Site ID/Key, or an empty list if either the Site doesn't exist, or no content is found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}}}}},"/api/v1/content/_canlock/{inodeOrIdentifier}":{"get":{"operationId":"canLockContent_1","parameters":[{"name":"inodeOrIdentifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":"-1"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/content/{identifier}/languages":{"get":{"operationId":"checkContentLanguageVersions","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListExistingLanguagesForContentletView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListExistingLanguagesForContentletView"}}}}}}},"/api/v1/content/{identifier}/references/count":{"get":{"operationId":"getAllContentletReferencesCount","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityCountView"}}}}}}},"/api/v1/content/{inodeOrIdentifier}":{"get":{"operationId":"getContent_2","parameters":[{"name":"inodeOrIdentifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":""}},{"name":"depth","in":"query","schema":{"type":"integer","format":"int32","default":-1}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/content/{inodeOrIdentifier}/references":{"get":{"operationId":"getContentletReferences","parameters":[{"name":"inodeOrIdentifier","in":"path","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":""}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListContentReferenceView"}}}}}}},"/api/v1/content/related":{"post":{"summary":"Pull Related Content","operationId":"pullRelated","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PullRelatedForm"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"404":{"description":"Contentlet not found"},"400":{"description":"Contentlet does not have a relationship field"}}}},"/api/v1/content/_draft":{"put":{"operationId":"saveDraft","parameters":[{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":"-1"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityContentletView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityContentletView"}}}}}}},"/api/v1/content/versions/{inode}":{"get":{"operationId":"findByInode","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/content/versions":{"get":{"operationId":"findVersions","parameters":[{"name":"inodes","in":"query","schema":{"type":"string"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"groupByLang","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/content/resourcelinks/field/{field}":{"get":{"operationId":"findResourceLink","parameters":[{"name":"field","in":"path","required":true,"schema":{"type":"string"}},{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":"-1"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/content/resourcelinks":{"get":{"operationId":"findResourceLinks","parameters":[{"name":"inode","in":"query","schema":{"type":"string"}},{"name":"identifier","in":"query","schema":{"type":"string"}},{"name":"language","in":"query","schema":{"type":"string","default":"-1"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/content/_import/abandoned":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of abandoned content import jobs","description":"Fetches the current status of abandoned content import jobs.","operationId":"getAbandonedContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved abandoned content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/active":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of active content import jobs","description":"Fetches the current status of active content import jobs.","operationId":"getActiveContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved active content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/{jobId}/cancel":{"post":{"tags":["Content Import"],"summary":"Cancel a content import job","description":"Cancel a content import job based on the provided job ID.","operationId":"cancelContentImportJob","parameters":[{"name":"jobId","in":"path","description":"The ID of the job whose status is to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully cancelled content import job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"404":{"description":"Job not found"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/canceled":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of canceled content import jobs","description":"Fetches the current status of canceled content import jobs.","operationId":"getCanceledContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved canceled content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/completed":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of completed content import jobs","description":"Fetches the current status of completed content import jobs.","operationId":"getCompletedContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved completed content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/failed":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of failed content import jobs","description":"Fetches the current status of failed content import jobs.","operationId":"getFailedContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved failed content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/{jobId}":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of a content import job","description":"Fetches the current status of a content import job based on the provided job ID.","operationId":"getJobStatus","parameters":[{"name":"jobId","in":"path","description":"The ID of the job whose status is to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved job status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"404":{"description":"Job not found"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of a content import jobs","description":"Fetches the current status of all content import jobs.","operationId":"getContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}},"post":{"tags":["Content Import"],"summary":"Imports content from a CSV file","description":"Creates and enqueues a new content import job. Requires a CSV file and a JSON string representing import parameters.","operationId":"importContent","requestBody":{"description":"Import parameters including the file to import and a JSON string for import settings.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ContentImportParamsSchema"}}},"required":true},"responses":{"200":{"description":"Content import job created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"},"example":{"entity":"3930f815-7aa4-4649-94c2-3f37fd21136d","errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request due to validation errors"},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"404":{"description":"Content type or language not found"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/{jobId}/monitor":{"get":{"tags":["Content Import"],"summary":"Monitor a specific content import job progress","description":"Allows clients to monitor the progress of a specific content import job identified by its jobId. The response uses Server-Sent Events (SSE) to provide real-time updates.","operationId":"monitorContentImportJobs","parameters":[{"name":"jobId","in":"path","description":"The ID of the job whose status is to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Real-time job progress updates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"404":{"description":"Job not found"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/successful":{"get":{"tags":["Content Import"],"summary":"Retrieves the status of successful content import jobs","description":"Fetches the current status of successful content import jobs.","operationId":"getSuccessfulContentImportJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved successful content import jobs status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/content/_import/_validate":{"post":{"tags":["Content Import"],"summary":"Validates content import from a CSV file","description":"Creates and enqueues a new content import job in preview mode based on the provided parameters. The job processes a CSV file and validates the content based on the specified content type, language, and workflow action.","operationId":"validateContentImport","requestBody":{"description":"Import parameters including the file to import and a JSON string for import settings.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ContentImportParamsSchema"}}},"required":true},"responses":{"200":{"description":"Content import job in preview mode created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"},"example":{"entity":"3930f815-7aa4-4649-94c2-3f37fd21136d","errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request due to validation errors"},"401":{"description":"Invalid user authentication"},"403":{"description":"Forbidden due to insufficient permissions"},"404":{"description":"Content type or language not found"},"500":{"description":"Internal server error"}}}},"/api/v1/contenttype/{baseVariableName}/_copy":{"post":{"tags":["Content Type"],"summary":"Copies a content type","description":"Creates a new content type by copying an existing one.\n\nReturns resulting content type.","operationId":"postContentTypeCopy","parameters":[{"name":"baseVariableName","in":"path","description":"The variable name of the content type to copy.\n\nExample value: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Requires POST body consisting of a JSON object with the following properties:\n\n| Property | Type | Description |\n|----------|--------|-------------|\n| `name` | String | **Required.** Name of new content type |\n| `variable` | String | System variable of new content type |\n| `folder` | String | Folder in which new content type will live |\n| `host` | String | Site or host to which the new content type will belong |\n| `icon` | String | System icon to represent content type |\n\nValues not specified default to values of the original content type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyContentTypeForm"},"example":{"name":"Copied Content Type Name","variable":"copiedContentTypeVar","folder":"SYSTEM_FOLDER","host":"8a7d5e23-da1e-420a-b4f0-471e7da8ea2d","icon":"event_note"}}},"required":true},"responses":{"200":{"description":"Content type copied successfully","content":{"application/json":{"example":{"errors":[{"errorCode":"string","message":"string","fieldName":"string"}],"entity":{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fields":[],"fixed":true,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"name":"string1","siteName":"string","sortOrder":0,"system":true,"systemActionMappings":{},"variable":"string","versionable":true,"workflows":[]},"messages":[{"message":"string"}],"i18nMessagesMap":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"permissions":["string"],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype":{"get":{"tags":["Content Type"],"summary":"Retrieves a list of content types","description":"Returns a list of content type objects based on the filtering criteria.","operationId":"getContentType","parameters":[{"name":"filter","in":"query","description":"String to filter/search for specific content types; leave blank to return all.","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number in response pagination.\n\nDefault: `1`","schema":{"type":"integer","format":"int64"}},{"name":"per_page","in":"query","description":"Number of results per page for pagination.\n\nDefault: `10`","schema":{"type":"integer","format":"int64"}},{"name":"orderby","in":"query","description":"Column(s) to sort the results. Multiple columns can be combined in a comma-separated list. Column names can also be set within a SQL string function, such as `upper()`.\n\nSome possible values:\n\n`name`, `velocity_var_name`, `mod_date`, `sort_order`\n\n`description`, `structuretype`, `category`, `inode`","schema":{"type":"string","default":"upper(name)"}},{"name":"direction","in":"query","description":"Sort direction: choose between ascending or descending.","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"type","in":"query","description":"Variable name of [base content type](https://www.dotcms.com/docs/latest/base-content-types).","schema":{"type":"string","enum":["ANY","CONTENT","WIDGET","FORM","FILEASSET","HTMLPAGE","PERSONA","VANITY_URL","KEY_VALUE","DOTASSET"]}},{"name":"host","in":"query","description":"Filter by site identifier.","schema":{"type":"string"}},{"name":"sites","in":"query","description":"Multi-site filter: Takes comma-separated list of site identifiers or keys.","schema":{"type":"string"}}],"responses":{"200":{"description":"Content types retrieved successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fixed":true,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"nEntries":0,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Content Type"],"summary":"Creates one or more content types","description":"Creates one or more content types specified in the JSON payload.\n\n Returns a list entity containing the created content type objects.","operationId":"postContentTypeCreate","requestBody":{"description":"Payload may consist of a single content type JSON object, or a list containing multiple content type objects.\n\nObjects require `clazz` and `name` properties at minimum.\n\nMay optionally include the following special properties:\n\n| Property | Value | Description |\n|-|-|-|\n| `systemActionMappings` | JSON Object | Maps [Default Workflow Actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) (as keys) to workflow action identifiers (as values) for this content type.|\n| `workflow` | List of Strings | A list of identifiers of workflow schemes to be associated with the content type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTypeForm"},"example":[{"clazz":"com.dotcms.contenttype.model.type.ImmutableSimpleContentType","defaultType":false,"name":"The Content Type 1","description":"THE DESCRIPTION","host":"48190c8c-42c4-46af-8d1a-0cd5db894797","owner":"dotcms.org.1","variable":"TheContentType1","fixed":false,"system":false,"folder":"SYSTEM_FOLDER","systemActionMappings":{"NEW":"ceca71a0-deee-4999-bd47-b01baa1bcfc8","PUBLISH":"ceca71a0-deee-4999-bd47-b01baa1bcfc8"},"workflow":["d61a59e1-a49c-46f2-a929-db2b4bfa88b2"]},{"clazz":"com.dotcms.contenttype.model.type.ImmutableSimpleContentType","defaultType":false,"name":"The Content Type 2","description":"THE DESCRIPTION","host":"48190c8c-42c4-46af-8d1a-0cd5db894797","owner":"dotcms.org.1","variable":"TheContentType2","fixed":false,"system":false,"folder":"SYSTEM_FOLDER","workflow":["d61a59e1-a49c-46f2-a929-db2b4bfa88b2"]}]}},"required":true},"responses":{"200":{"description":"Content type(s) created successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fields":[],"fixed":true,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"name":"string","owner":"string","siteName":"string","sortOrder":0,"system":true,"systemActionMappings":{},"variable":"string","versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/id/{idOrVar}":{"get":{"tags":["Content Type"],"summary":"Retrieves a single content type","description":"Returns one content type based on the provided ID or Velocity variable name.","operationId":"getContentTypeIdVar","parameters":[{"name":"idOrVar","in":"path","description":"The ID or Velocity variable name of the content type to retrieve.\n\nExample: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}},{"name":"languageId","in":"query","description":"The language ID for localization.","schema":{"type":"integer","format":"int64"}},{"name":"live","in":"query","description":"Determines whether live versions of language variables are used in the returned object.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Content type retrieved successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fields":[],"fixed":false,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","systemActionMappings":{},"versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Content Type"],"summary":"Updates a content type","description":"Updates the content type based on the given ID or Velocity variable name.\n\nReturns a copy of the updated content type object.\n\n> **Caution:** When updating a content type, any editable fields omitted from the request body will be removed from the content type. To update selected properties without deleting others,submit the full JSON entity with the desired items edited.","operationId":"putContentTypeUpdate","parameters":[{"name":"idOrVar","in":"path","description":"The ID or Velocity variable name of the content type to update.\n\nExample value: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The minimum required properties for a successful update are `clazz`, `id`, and `name`.\n\nMay also optionally include the following special properties:\n\n| Property | Value | Description |\n|-|-|-|\n| `systemActionMappings` | JSON Object | Maps [Default Workflow Actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) (as keys) to workflow action identifiers (as values) for this content type.|\n| `workflow` | List of Strings | A list of identifiers of workflow schemes to be associated with the content type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTypeForm"},"example":{"clazz":"com.dotcms.contenttype.model.type.ImmutableSimpleContentType","defaultType":false,"id":"39fecdb0-46cc-40a9-a056-f2e1a80ea78c","name":"The Content Type 2","description":"THE DESCRIPTION 2","host":"48190c8c-42c4-46af-8d1a-0cd5db894797","owner":"dotcms.org.1","variable":"TheContentType1","fixed":false,"system":false,"folder":"SYSTEM_FOLDER","workflow":["d61a59e1-a49c-46f2-a929-db2b4bfa88b2"]}}},"required":true},"responses":{"200":{"description":"Content type updated successfully","content":{"application/json":{"example":{"entity":{"baseType":"string","clazz":"string","defaultType":true,"fields":[],"fixed":true,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"name":"string","siteName":"string","sortOrder":0,"system":true,"systemActionMappings":{},"variable":"string","versionable":true,"workflows":[]},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Content Type"],"summary":"Deletes a content type","description":"Deletes the content type based on the provided ID or Velocity variable name.\n\nReturns JSON string containing the identifier of the deleted content type.","operationId":"deleteContentType","parameters":[{"name":"idOrVar","in":"path","description":"The ID or Velocity variable name of the content type to delete.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Content type deleted successfully","content":{"application/json":{"example":{"entity":"{\"deleted\":\"string\"}","errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"403":{"description":"Forbidden"},"404":{"description":"Content type not found"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/_filter":{"post":{"tags":["Content Type"],"summary":"Filters content types","description":"Returns the list of content type objects that match the specified filter, with optional pagination criteria.","operationId":"postContentTypeFilter","requestBody":{"description":"Requires POST body consisting of a JSON object with the following properties:\n\n| Property | Type | Description |\n|----------|--------|-------------|\n| `filter` | JSON Object | Contains three properties:
`query`A simple query returning full or partial matches.
`types`A comma-separated list of specific content type variables.
`sites`A comma-separated list of site identifiers or keys.
|\n| `page` | Integer | Which page of results to show. Defaults to `1`. |\n| `perPage` | Integer | Number of results to display per page. Defaults to `10`. |\n| `orderBy` | String | Sorting parameter: `name` (default), `velocity_var_name`, `mod_date`, or `sort_order`. |\n| `direction` | String | `ASC` (default) or `DESC` for ascending or descending. |","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredContentTypesForm"},"example":{"filter":{"query":"","types":"Blog,Activity","sites":"demo.dotcms.com,SYSTEM_HOST"},"page":1,"perPage":10,"orderBy":"name","direction":"ASC"}}},"required":true},"responses":{"200":{"description":"Content types filtered successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fixed":false,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"nEntries":0,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/basetypes":{"get":{"tags":["Content Type"],"summary":"Retrieves base content types","description":"Returns a list of base content types.","operationId":"getContentTypeBaseTypes","responses":{"200":{"description":"Base content types retrieved successfully","content":{"application/json":{"example":{"entity":[{"label":"string","name":"string","types":null}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/{typeId}/fields":{"get":{"operationId":"getContentTypeFields","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"put":{"operationId":"updateFields","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"post":{"operationId":"createContentTypeField","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"delete":{"operationId":"deleteFields","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}":{"get":{"operationId":"getContentTypeFieldById","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"put":{"operationId":"updateContentTypeFieldById","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"delete":{"operationId":"deleteContentTypeFieldById","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}":{"get":{"operationId":"getContentTypeFieldByVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"put":{"operationId":"updateContentTypeFieldByVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"delete":{"operationId":"deleteContentTypeFieldByVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables":{"get":{"operationId":"getFieldVariablesByFieldId","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"createFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables":{"get":{"operationId":"getFieldVariablesByFieldVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"createFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}":{"get":{"operationId":"getFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}":{"get":{"operationId":"getFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/ema":{"get":{"operationId":"getDetails","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/ws/v1/system/events":{"get":{"operationId":"getEvents","parameters":[{"name":"lastcallback","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/ws/v1/system/syncevents":{"get":{"operationId":"getSyncEvents","parameters":[{"name":"lastcallback","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/experiments/{experimentId}/variants":{"post":{"tags":["Experiment"],"operationId":"addVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_archive":{"put":{"tags":["Experiment"],"operationId":"archive_1","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}}}}}}},"/api/v1/experiments/scheduled/{experimentId}/_cancel":{"post":{"tags":["Experiment"],"operationId":"cancel","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments":{"get":{"tags":["Experiment"],"operationId":"list_1","parameters":[{"name":"pageId","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["RUNNING","SCHEDULED","ENDED","DRAFT","ARCHIVED"]}}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}}}}}},"post":{"tags":["Experiment"],"operationId":"create_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExperimentForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}":{"delete":{"tags":["Experiment"],"operationId":"delete_8","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewString"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewString"}}}}}},"patch":{"tags":["Experiment"],"operationId":"update_2","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExperimentForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/goals/primary":{"delete":{"tags":["Experiment"],"operationId":"deleteGoal","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/targetingConditions/{id}":{"delete":{"tags":["Experiment"],"operationId":"deleteTargetingCondition","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/variants/{name}":{"put":{"tags":["Experiment"],"operationId":"updateVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}},"delete":{"tags":["Experiment"],"operationId":"deleteVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_end":{"post":{"tags":["Experiment"],"operationId":"end","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{id}":{"get":{"tags":["Experiment"],"operationId":"get_3","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{id}/results":{"get":{"tags":["Experiment"],"operationId":"getResult","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentResults"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentResults"}}}}}}},"/api/v1/experiments/health":{"get":{"tags":["Experiment"],"operationId":"healthcheck","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}}}}},"/api/v1/experiments/isUserIncluded":{"post":{"tags":["Experiment"],"operationId":"isUserIncluded","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExcludedExperimentListForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentSelectedView"}}}}}}},"/api/v1/experiments/{experimentId}/variants/{name}/_promote":{"put":{"tags":["Experiment"],"operationId":"promoteVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_start":{"post":{"tags":["Experiment"],"operationId":"start","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/content/fileassets/{inode}/resourcelink":{"get":{"operationId":"findResourceLink_1","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/folder/createfolders/{siteName}":{"post":{"operationId":"createFolders","parameters":[{"name":"siteName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/folder/{siteName}":{"delete":{"operationId":"deleteFolders","parameters":[{"name":"siteName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/folder/{folderId}":{"get":{"operationId":"findFolderById","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/folder/byPath":{"post":{"operationId":"findSubFoldersByPath","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchByPathForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/folder/siteId/{siteId}/path/{path}":{"get":{"operationId":"loadFolderAndSubFoldersByPath","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/folder/sitename/{siteName}/uri/{uri}":{"get":{"operationId":"loadFolderByURI","parameters":[{"name":"siteName","in":"path","required":true,"schema":{"type":"string"}},{"name":"uri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/folder/{id}/file-browser-selected":{"put":{"operationId":"selectFolder_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/form/{idOrVar}/successCallback":{"get":{"operationId":"getSuccessCallbackFunction","parameters":[{"name":"idOrVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/javascript":{}}}}}},"/api/v1/esindex/activate/{params}":{"put":{"operationId":"activateIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/clear/{params}":{"put":{"operationId":"clearIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/close/{params}":{"put":{"operationId":"closeIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/create/{params}":{"put":{"operationId":"createIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{}}}},"deprecated":true}},"/api/v1/esindex/deactivate/{params}":{"put":{"operationId":"deactivateIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/failed":{"get":{"operationId":"downloadRemainingRecordsAsCsv","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"deleteFailedRecords","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/{indexName}":{"put":{"operationId":"modIndex","parameters":[{"name":"indexName","in":"path","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"deleteIndex","parameters":[{"name":"indexName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/cache":{"delete":{"operationId":"flushIndiciesCache","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/active/{params}":{"get":{"operationId":"getActive","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{}}}},"deprecated":true}},"/api/v1/esindex/cluster":{"get":{"operationId":"getClusterStats","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex":{"get":{"operationId":"getIndexStatus","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/reindex":{"get":{"operationId":"getReindexationProgress","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"startReindex","parameters":[{"name":"shards","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"contentType","in":"query","schema":{"type":"string","default":"DOTALL"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"stopReindexation","parameters":[{"name":"switch","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/indexlist/{params}":{"get":{"operationId":"indexList","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/open/{params}":{"put":{"operationId":"openIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/optimize":{"post":{"operationId":"optimizeIndices","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/jobs/abandoned":{"get":{"operationId":"abandonedJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/active":{"get":{"operationId":"activeJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/{queueName}/active":{"get":{"operationId":"activeJobs_1","parameters":[{"name":"queueName","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/{jobId}/cancel":{"post":{"operationId":"cancelJob","parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewString"}}}}}}},"/api/v1/jobs/canceled":{"get":{"operationId":"canceledJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/completed":{"get":{"operationId":"completedJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/{queueName}":{"post":{"operationId":"createJob_1","parameters":[{"name":"queueName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/jobs/failed":{"get":{"operationId":"failedJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/{jobId}/status":{"get":{"operationId":"getJobStatus_1","parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJob"}}}}}}},"/api/v1/jobs/queues":{"get":{"operationId":"getQueues","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewSetString"}}}}}}},"/api/v1/jobs":{"get":{"operationId":"listJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/jobs/{jobId}/monitor":{"get":{"operationId":"monitorJob","parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/EventOutput"}}}}}}},"/api/v1/jobs/successful":{"get":{"operationId":"successfulJobs","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewJobPaginatedResult"}}}}}}},"/api/v1/languages/i18n":{"post":{"operationId":"getMessages","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18NForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/languages":{"get":{"operationId":"list_2","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestLanguage"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestLanguage"}}}}}}}},"/api/v1/jvm":{"get":{"operationId":"getJvmInfo","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadAssets":{"get":{"operationId":"downloadAssets","parameters":[{"name":"oldAssets","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadDb":{"get":{"operationId":"downloadDb","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadLog/{fileName}":{"get":{"operationId":"downloadLogFile","parameters":[{"name":"fileName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadStarter":{"get":{"operationId":"downloadStarter","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadStarterWithAssets":{"get":{"operationId":"downloadStarterWithAssets","parameters":[{"name":"oldAssets","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_pgDumpAvailable":{"get":{"operationId":"isPgDumpAvailable","responses":{"default":{"description":"default response","content":{"text/plain":{}}}}}},"/api/v1/maintenance/_shutdown":{"delete":{"operationId":"shutdown","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/maintenance/_shutdownCluster":{"delete":{"operationId":"shutdownCluster","parameters":[{"name":"rollingDelay","in":"query","schema":{"type":"integer","format":"int32","default":60}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/menu":{"get":{"operationId":"getMenus","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/notification/delete":{"put":{"operationId":"delete_9","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/id/{id}":{"delete":{"operationId":"delete_10","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/getNewNotificationsCount":{"get":{"operationId":"getNewNotificationsCount","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/getNotifications/{params}":{"get":{"operationId":"getNotifications","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}},{"name":"Range","in":"header","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/markAsRead":{"put":{"operationId":"markAsRead","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/osgi/jar/{jar}/_deploy":{"put":{"summary":"deploys bundle","operationId":"deploy","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Error loading OSGI Bundle"}}}},"/api/v1/osgi/available-plugins":{"get":{"summary":"get available plugins","operationId":"getAvailablePlugis","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListView"}}}}}}},"/api/v1/osgi/extra-packages":{"get":{"summary":"get extra packages","operationId":"getExtraPackages","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}},"put":{"summary":"modify extra packages","operationId":"modifyExtraPackages","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExtraPackagesForm"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi":{"get":{"summary":"Returns a list of all bundles installed","operationId":"getInstalledBundles_1","parameters":[{"name":"ignoresystembundles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBundleListView"}}}}}},"post":{"summary":"Upload bundles to the OSGI framework","operationId":"uploadBundles","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"403":{"description":"Can not access the upload folder or invalid OSGI Upload request"}}}},"/api/v1/osgi/dotsystem":{"get":{"summary":"Returns the dot system list of all bundles installed","operationId":"getSystemInstalledBundles","parameters":[{"name":"ignoresystembundles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBundleListView"}}}}}}},"/api/v1/osgi/_processExports/{bundle}":{"get":{"summary":"Process exports","operationId":"processBundle_1","parameters":[{"name":"bundle","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi/_restart":{"put":{"summary":"restarts the OSGI framework","operationId":"restart","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi/jar/{jar}/_start":{"put":{"summary":"starts bundle","operationId":"start_1","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/osgi/jar/{jar}/_stop":{"put":{"summary":"stops bundle","operationId":"stop","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/osgi/jar/{jar}":{"delete":{"summary":"Undeploys bundle","operationId":"undeploy","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/nav/{uri}":{"get":{"tags":["Navigation"],"operationId":"loadJson_1","parameters":[{"name":"uri","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string"}},{"name":"languageId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/{pageId}/content":{"post":{"tags":["Page"],"operationId":"addContent","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"variantName","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageContainerForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/page/{pageId}/languages":{"get":{"tags":["Page"],"operationId":"checkPageLanguageVersions","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v1/page/_check-permission":{"post":{"tags":["Page"],"operationId":"checkPagePermission","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageCheckPermissionForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}}}}},"/api/v1/page/copyContent":{"put":{"tags":["Page"],"operationId":"copyContent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyContentletForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewMapStringObject"}}}}}}},"/api/v1/page/{pageId}/_deepcopy":{"put":{"tags":["Page"],"operationId":"deepCopyPage","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewMapStringObject"}}}}}}},"/api/v1/page/actions":{"post":{"tags":["Page"],"operationId":"findAvailableActions","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FindAvailableActionsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPageWorkflowActionsView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityPageWorkflowActionsView"}}}}}}},"/api/v1/page/{pageId}/content/tree":{"get":{"tags":["Page"],"operationId":"getContentTree","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListMulitreeView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewListMulitreeView"}}}}}}},"/api/v1/page/{pageId}/render/versions":{"get":{"tags":["Page"],"operationId":"getHtmlVersionsPage","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"langId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/types":{"get":{"tags":["Page"],"operationId":"getPageTypes","parameters":[{"name":"filter","in":"query","schema":{"type":"string","default":""}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"UPPER(name)"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/{pageId}/personas":{"get":{"tags":["Page"],"operationId":"getPersonalizedPersonasOnPage","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","schema":{"type":"string","default":"title"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"hostId","in":"query","schema":{"type":"string"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"respectFrontEndRoles","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/json/{uri}":{"get":{"tags":["Page"],"operationId":"loadJson_2","parameters":[{"name":"uri","in":"path","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","schema":{"type":"string"}},{"name":"com.dotmarketing.persona.id","in":"query","schema":{"type":"string"}},{"name":"language_id","in":"query","schema":{"type":"string"}},{"name":"device_inode","in":"query","schema":{"type":"string"}},{"name":"publishDate","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/render/{uri}":{"get":{"tags":["Page"],"operationId":"render","parameters":[{"name":"uri","in":"path","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","schema":{"type":"string"}},{"name":"com.dotmarketing.persona.id","in":"query","schema":{"type":"string"}},{"name":"language_id","in":"query","schema":{"type":"string"}},{"name":"device_inode","in":"query","schema":{"type":"string"}},{"name":"publishDate","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/page/renderHTML/{uri}":{"get":{"tags":["Page"],"operationId":"renderHTMLOnly","parameters":[{"name":"uri","in":"path","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","schema":{"type":"string","default":"LIVE_ADMIN"}}],"responses":{"default":{"description":"default response","content":{"application/html":{},"application/javascript":{}}}}}},"/api/v1/page/layout":{"post":{"tags":["Page"],"summary":"Saves a page template","description":"Handles saving of a page template using provided data. Method processes the request and returns HTTP response indicating a complete save operation.","operationId":"postPageLayout","requestBody":{"description":"POST body consists of a JSON object containing one property called 'PageForm', which contains a template layout for the page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageForm"}}},"required":true},"responses":{"200":{"description":"Page template saved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request or data exception"},"404":{"description":"Page not found"}}}},"/api/v1/page/{pageId}/layout":{"post":{"tags":["Page"],"summary":"Links template and page","description":"Takes a saved template and links it to an HTML page.\n\nAny pages with a template already linked will update with the new link.\n\nOtherwise a new template will be created without making any changes to previous templates.\n\nReturns the rendered page.\n\n","operationId":"postPageLayoutHTMLLink","parameters":[{"name":"pageId","in":"path","description":"ID for the page will link to","required":true,"schema":{"type":"string"}},{"name":"variantName","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"POST body consists of a JSON object containing one property called 'PageForm', which contains information about the layout of a page's template ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageForm"}}},"required":true},"responses":{"200":{"description":"Page template linked to HTML and saved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request or data exception"},"404":{"description":"Page not found"}}}},"/api/v1/page/search":{"get":{"tags":["Page"],"operationId":"searchPage","parameters":[{"name":"path","in":"query","schema":{"type":"string"}},{"name":"live","in":"query","schema":{"type":"boolean"}},{"name":"onlyLiveSites","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/html":{},"application/javascript":{}}}}}},"/api/v1/personalization/pagepersonas":{"post":{"operationId":"personalizePageContainers","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonalizationPersonaPageForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/personalization/pagepersonas/page/{pageId}/personalization/{personalization}":{"delete":{"operationId":"personalizePageContainers_1","parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"personalization","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/personas":{"get":{"operationId":"list_3","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestPersona"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestPersona"}}}}}}}},"/api/v1/personas/{id}":{"get":{"operationId":"self","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestPersona"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/RestPersona"}}}}}}},"/api/v1/portlet/custom/{portletId}/_addtolayout/{layoutId}":{"put":{"operationId":"addContentPortletToLayout","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}},{"name":"layoutId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/custom/{portletId}":{"delete":{"operationId":"deleteCustomPortlet","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/portletId/{portletId}":{"delete":{"operationId":"deletePersonalPortlet","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/portletId/{portletId}/roleId/{roleId}":{"delete":{"operationId":"deletePortletForRole","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/{portletId}/_doesuserhaveaccess":{"get":{"operationId":"doesUserHaveAccessToPortlet","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/{portletId}":{"get":{"operationId":"findPortlet","parameters":[{"name":"portletId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/_actionurl/{contentTypeVariable}":{"get":{"operationId":"getCreateContentURL","parameters":[{"name":"contentTypeVariable","in":"path","required":true,"schema":{"type":"string"}},{"name":"language_id","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/portlet/custom":{"put":{"operationId":"updatePortlet","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPortletForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveNew_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPortletForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/toolgroups/{layoutId}/_addtouser":{"put":{"operationId":"addToolGroupToUser","parameters":[{"name":"layoutId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userid","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/toolgroups/{layoutId}/_removefromuser":{"put":{"operationId":"deleteToolGroupFromUser","parameters":[{"name":"layoutId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userid","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/toolgroups/{layoutId}/_userHasLayout":{"get":{"operationId":"userHasLayout","parameters":[{"name":"layoutId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userid","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/pushpublish/filters/{filterKey}":{"get":{"operationId":"getFilter","parameters":[{"name":"filterKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteFilter","parameters":[{"name":"filterKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/pushpublish/filters":{"get":{"operationId":"getFilters","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateFromForm","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FilterDescriptorForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveFromForm","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FilterDescriptorForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/relationships/cardinalities":{"get":{"operationId":"getCardinality","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/relationships":{"get":{"operationId":"getOneSidedRelationships","parameters":[{"name":"contentTypeId","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}/_archive":{"put":{"operationId":"archiveSite","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/_copy":{"put":{"operationId":"copySite","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CopySiteForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site":{"get":{"operationId":"sites","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"archive","in":"query","schema":{"type":"boolean"}},{"name":"live","in":"query","schema":{"type":"boolean"}},{"name":"system","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateSite","parameters":[{"name":"id","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"createNewSite","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/currentSite":{"get":{"operationId":"currentSite","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/defaultSite":{"get":{"operationId":"defaultSite","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}":{"get":{"operationId":"findHostByIdentifier","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteSite","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/thumbnails":{"get":{"operationId":"findAllSiteThumbnails","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/_byname":{"post":{"operationId":"findHostByName","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchSiteByNameForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}/setup_progress":{"get":{"operationId":"getSiteSetupProgress","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/variable/{siteId}":{"get":{"summary":"Retrieve the Site Variables for a site","operationId":"getSiteVariables","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}},"404":{"description":"When the site id does not exists"}}}},"/api/v1/site/{siteId}/_makedefault":{"put":{"operationId":"makeDefault","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}/_publish":{"put":{"operationId":"publishSite","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/variable":{"put":{"summary":"Save a Site Variable","operationId":"saveSiteVariable","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteVariableForm"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseHostVariableEntityView"}}}},"400":{"description":"When a required value is not sent"}}}},"/api/v1/site/switch":{"put":{"operationId":"switchSite","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/switch/{id}":{"put":{"operationId":"switchSite_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}/_unarchive":{"put":{"operationId":"unarchiveSite","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/site/{siteId}/_unpublish":{"put":{"operationId":"unpublishSite","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/rules":{"get":{"operationId":"list_4","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestRule"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestRule"}}}}}}},"post":{"operationId":"add","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRule"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}":{"get":{"operationId":"self_1","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRule"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/RestRule"}}}}}},"put":{"operationId":"update_3","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRule"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRule"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/RestRule"}}}}}},"delete":{"operationId":"remove","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/actions":{"post":{"operationId":"add_1","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRuleAction"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/actions/{actionId}":{"get":{"operationId":"self_2","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRuleAction"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/RestRuleAction"}}}}}},"put":{"operationId":"update_4","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRuleAction"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRuleAction"}}}}}},"delete":{"operationId":"remove_1","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups":{"get":{"operationId":"list_5","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"add_2","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionGroup"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{conditionGroupId}":{"delete":{"operationId":"remove_2","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{groupId}":{"get":{"operationId":"self_3","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionGroup"}}}}}},"put":{"operationId":"update_5","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionGroup"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionGroup"}}}}}}},"/api/v1/sites/{siteId}/ruleengine/conditions":{"post":{"operationId":"add_3","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCondition"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}":{"get":{"operationId":"self_4","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"put":{"operationId":"update_6","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCondition"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCondition"}}}}}},"delete":{"operationId":"remove_3","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues":{"get":{"operationId":"list_6","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"add_4","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionValue"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}":{"get":{"operationId":"self_5","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"valueId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"put":{"operationId":"update_7","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"valueId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionValue"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestConditionValue"}}}}}},"delete":{"operationId":"remove_4","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"conditionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"valueId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/v1/appconfiguration":{"get":{"operationId":"list_7","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/configuration/config":{"get":{"operationId":"getConfigVariables","parameters":[{"name":"keys","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/configuration":{"get":{"operationId":"list_8","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"set","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/api/v1/configuration/_validateCompanyEmail":{"post":{"operationId":"validateEmail","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyEmailForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/system-table/{key}":{"get":{"operationId":"get_4","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}},"delete":{"operationId":"delete_11","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/system-table/_delete":{"delete":{"operationId":"deleteWithKey","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/system-table":{"get":{"operationId":"getAll_1","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewMapStringString"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewMapStringString"}}}}}},"put":{"operationId":"update_8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValueForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}},"post":{"operationId":"save_2","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/KeyValueForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/upgradetask":{"post":{"operationId":"upgrade","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpgradeTaskForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/flush":{"delete":{"operationId":"flushAll","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/flush/{group}":{"delete":{"operationId":"flushGroup","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/flush/{group}/{id}":{"delete":{"operationId":"flushObject","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/keys/{group}":{"get":{"operationId":"getKeys","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/object/{group}/{id}":{"get":{"operationId":"showObject","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/objects/{group}":{"get":{"operationId":"showObjects","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/providers/{group}":{"get":{"operationId":"showProviders","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/caches/provider/{provider}/{group}":{"get":{"operationId":"showProviders_1","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"}},{"name":"group","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/system/i18n/{lang}/{rsrc}":{"get":{"operationId":"list_9","parameters":[{"name":"lang","in":"path","required":true,"schema":{"type":"string"}},{"name":"rsrc","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/logger":{"get":{"operationId":"getLoggers","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"changeLoggerLevel","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChangeLoggerForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/logger/{loggerName}":{"get":{"operationId":"getLogger","parameters":[{"name":"loggerName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/{a}":{"get":{"operationId":"heavyCheck","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/{a}/{a}":{"get":{"operationId":"ready","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/permissions/_bycontent":{"get":{"summary":"Get permission for a Contentlet","operationId":"getByContentlet","parameters":[{"name":"contentletId","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","default":"READ"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPermissionView"}}}},"403":{"description":"If not admin user"}}}},"/api/v1/permissions/_bycontent/_groupbytype":{"get":{"summary":"Get permissions roles group by type for a Contentlet","operationId":"getByContentletGroupByType","parameters":[{"name":"contentletId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPermissionView"}}}},"403":{"description":"If not admin user"}}}},"/api/v1/permissions/_bypermissiontype":{"get":{"operationId":"getPermissionsByPermissionType","parameters":[{"name":"userid","in":"query","schema":{"type":"string"}},{"name":"permission","in":"query","schema":{"type":"string"}},{"name":"permissiontype","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/{key}":{"get":{"operationId":"get_5","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"delete_12","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/hash/{key}":{"get":{"operationId":"getHash","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteHash","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/echo/{message}":{"get":{"operationId":"echo","parameters":[{"name":"message","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/incr/{key}":{"get":{"operationId":"getIncrement","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"incrementAsync","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/ping":{"get":{"operationId":"ping","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis":{"put":{"operationId":"set_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SetForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/redis/hash":{"put":{"operationId":"setHash","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SetHashForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/roles":{"get":{"operationId":"loadRootRoles","parameters":[{"name":"loadChildrenRoles","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"addNewRole","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RoleForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/checkuserroles/userid/{userId}/roleids/{roleIds}":{"get":{"operationId":"checkRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleIds","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/layouts":{"get":{"operationId":"getAllLayouts","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"saveRoleLayouts","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RoleLayoutForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"deleteRoleLayouts","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RoleLayoutForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/{roleId}/layouts":{"get":{"operationId":"findRoleLayouts","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/{roleid}":{"get":{"operationId":"loadRoleByRoleId","parameters":[{"name":"roleid","in":"path","required":true,"schema":{"type":"string"}},{"name":"loadChildrenRoles","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/{roleid}/rolehierarchyanduserroles":{"get":{"operationId":"loadUsersAndRolesByRoleId","parameters":[{"name":"roleid","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleHierarchyForAssign","in":"query","schema":{"type":"boolean","default":false}},{"name":"name","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/roles/_search":{"get":{"summary":"Search Roles","operationId":"searchRoles","parameters":[{"name":"searchName","in":"query","description":"Value to filter by role name","schema":{"type":"string","default":""}},{"name":"searchKey","in":"query","description":"Value to filter by role key","schema":{"type":"string","default":""}},{"name":"roleId","in":"query","description":"Value for specific role id","schema":{"type":"string","default":""}},{"name":"start","in":"query","description":"Offset on pagination","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Size on pagination","schema":{"type":"integer","format":"int32","default":20}},{"name":"includeUserRoles","in":"query","description":"Set false if do not want to include user rules","schema":{"type":"boolean","default":true}},{"name":"includeWorkflowRoles","in":"query","description":"Set to true if want to include the workflow roles","schema":{"type":"boolean","default":false}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySmallRoleView"}}}}}}},"/api/v1/system/ruleengine/actionlets":{"get":{"operationId":"list_10","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/system/ruleengine/conditionlets":{"get":{"operationId":"list_11","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/storages/hello":{"get":{"operationId":"hello","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/storages/chain/_replicate/{from}/to/{to}":{"get":{"operationId":"replicateStorages","parameters":[{"name":"from","in":"path","required":true,"schema":{"type":"string","enum":["FILE_SYSTEM","DB","S3","MEMORY","DEFAULT_CHAIN","CHAIN1","CHAIN2","CHAIN3"]}},{"name":"to","in":"path","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"matrixParameters":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"path":{"type":"string"}}}}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/logs/{fileName}/_tail":{"get":{"tags":["TailLog"],"operationId":"getLogs","parameters":[{"name":"fileName","in":"path","required":true,"schema":{"type":"string"}},{"name":"linesBack","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/EventOutput"}}}}}}},"/api/v1/temp/byUrl":{"post":{"operationId":"copyTempFromUrl","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteUrlForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/temp":{"post":{"operationId":"uploadTempResourceMulti","parameters":[{"name":"maxFileLength","in":"query","schema":{"type":"string","default":"-1"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}}}},"/api/v1/templates/_archive":{"put":{"operationId":"archive_2","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/{templateId}/_copy":{"put":{"operationId":"copy_1","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates":{"get":{"operationId":"list_12","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":40}},{"name":"orderby","in":"query","schema":{"type":"string","default":"mod_date"}},{"name":"direction","in":"query","schema":{"type":"string","default":"DESC"}},{"name":"host","in":"query","schema":{"type":"string"}},{"name":"archive","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"save_3","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TemplateForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveNew_3","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TemplateForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"delete_13","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/image":{"post":{"operationId":"fetchTemplateImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateImageForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}}},"/api/v1/templates/{templateId}/live":{"get":{"operationId":"getLiveById_1","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/{templateId}/working":{"get":{"operationId":"getWorkingById_1","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/_publish":{"put":{"operationId":"publish_2","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/_savepublish":{"put":{"operationId":"saveAndPublish","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TemplateForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/draft":{"put":{"operationId":"saveDraft_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TemplateForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/_unarchive":{"put":{"operationId":"unarchive_1","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/templates/_unpublish":{"put":{"operationId":"unpublish_1","requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/themes/id/{id}":{"get":{"operationId":"findThemeById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/themes":{"get":{"operationId":"findThemes","parameters":[{"name":"hostId","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":-1}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"searchParam","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users":{"put":{"summary":"Update an existing user.","operationId":"udpate","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserForm"}}}},"responses":{"200":{"description":"If success returns a map with the user + user id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}},"403":{"description":"If the user is not an admin or access to the role + user layouts or does have permission, it will return a 403.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}},"404":{"description":"If the user to update does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}},"400":{"description":"If the user information is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseSiteVariablesEntityView"}}}}}},"post":{"operationId":"create_2","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users/filter":{"get":{"operationId":"filter","parameters":[{"name":"query","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":40}},{"name":"orderby","in":"query","schema":{"type":"string"}},{"name":"direction","in":"query","schema":{"type":"string","default":"ASC"}},{"name":"includeanonymous","in":"query","schema":{"type":"boolean"}},{"name":"includedefault","in":"query","schema":{"type":"boolean"}},{"name":"assetinode","in":"query","schema":{"type":"string"}},{"name":"permission","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users/loginas":{"post":{"operationId":"loginAs","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LoginAsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users/loginAsData":{"get":{"operationId":"loginAsData","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users/logoutas":{"put":{"operationId":"logoutAs","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/users/current":{"get":{"operationId":"self_6","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestUser"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/RestUser"}}}}}},"put":{"operationId":"updateCurrent","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateCurrentUserForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/variants/{variantName}/_promote":{"put":{"tags":["Variant"],"operationId":"promote","parameters":[{"name":"variantName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/versionables/{versionableInode}/_bringback":{"put":{"operationId":"bringBack","parameters":[{"name":"versionableInode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/versionables/{versionableInode}":{"delete":{"operationId":"deleteVersion","parameters":[{"name":"versionableInode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/versionables/{versionableInodeOrIdentifier}":{"get":{"operationId":"findVersionable","parameters":[{"name":"versionableInodeOrIdentifier","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/vtl/{folder}":{"get":{"operationId":"get_6","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"putMultipart_2","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"postMultipart_2","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"delete_14","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"patchMultipart_2","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/vtl/{folder}/{pathParam}":{"get":{"operationId":"get_7","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"putMultipart_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"postMultipart_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"delete_15","parameters":[{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"patchMultipart_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/vtl/dynamic/{pathParam}":{"get":{"operationId":"dynamicGet_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"dynamicPut_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"dynamicPost_3","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"delete":{"operationId":"dynamicDelete_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"patch":{"operationId":"dynamicPatch_1","parameters":[{"name":"pathParam","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/vtl/dynamic":{"get":{"operationId":"dynamicGet_2","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"put":{"operationId":"dynamicPut_2","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}},"post":{"operationId":"dynamicPost_2","requestBody":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"text/plain":{}}}}}},"/api/v1/workflow/steps":{"post":{"tags":["Workflow"],"summary":"Add a new workflow step","description":"Creates a [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps).\n\nReturns an object representing the step.","operationId":"postAddWorkflowStep","requestBody":{"description":"Body consists of a JSON object containing a workflow step update form. This includes the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `schemeId` | String | The identifier of the [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) to which the step will be added. |\n| `stepName` | String | The name of the workflow step. |\n| `enableEscalation` | Boolean | Determines whether a step is capable of automatic escalation to the next step. (Read more about [schedule-enabled workflows](https://www.dotcms.com/docs/latest/schedule-enabled-workflow).) |\n| `escalationAction` | String | The identifier of the workflow action to execute on automatic escalation. |\n| `escalationTime` | String | The time, in seconds, before the workflow automatically escalates. |\n| `stepResolved` | Boolean | If true, any content which enters this workflow step will be considered resolved.\nContent in a resolved step will not appear in the workflow queues of any users.\n |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowStepAddForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Created workflow step successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowStepView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/schemes/{schemeId}/copy":{"post":{"tags":["Workflow"],"summary":"Copy a workflow scheme","description":"Copy a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\n A name for the new scheme may be provided either by parameter or by POST body property; if no name is supplied, the name will be that of the copied workflow scheme with the current Unix epoch timestamp integer appended.\n\nReturns copied workflow scheme on success.","operationId":"postCopyScheme","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme.\n\nExample value: `d61a59e1-a49c-46f2-a929-db2b4bfa88b2` (Default system workflow)","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name of new scheme from copy.\n\nNote: A name with a length less than 2 characters or greater than 100 may require renaming before certain actions, such as archiving, can be taken on it.","schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a `name` property; an alternate way to supply the name of the new scheme, instead of parameter.\n\n Name supplied this way must be at minimum 2 and at maximum 100 characters in length.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCopyForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Copied workflow scheme successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowSchemeView"}}}},"400":{"description":"Bad request"},"404":{"description":"Workflow scheme not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/{actionId}":{"get":{"tags":["Workflow"],"summary":"Find action by ID","description":"Returns a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) object.","operationId":"getWorkflowActionByActionId","parameters":[{"name":"actionId","in":"path","description":"Identifier of the workflow action to return.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionView"}}}},"404":{"description":"Workflow action not found"}}},"put":{"tags":["Workflow"],"summary":"Update an existing workflow action","description":"Updates a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) based on the payload properties.\n\nReturns updated workflow action.\n\n","operationId":"putSaveActionsByWorkflowActionForm","parameters":[{"name":"actionId","in":"path","description":"Identifier of workflow action to update.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a JSON object containing the same form data as used above in `POST /v1/workflow/actions`. However, this endpoint uses the form's properties differently, as noted below:\n\n| Property | Type | Description |\n|-|-|-|\n| `schemeId` | String | The [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) under which the action will be created. |\n| `actionName` | String | The name of the workflow action. Multiple actions of the same name can coexist with different identifiers. |\n| `whoCanUse` | List of Strings | A list of identifiers representing [users](https://www.dotcms.com/docs/latest/user-management), [role keys](https://www.dotcms.com/docs/latest/adding-roles), or [other user categories](https://www.dotcms.com/docs/latest/managing-workflows#ActionWho) allowed to use this action. This list can be empty. |\n| `actionIcon` | String | The icon to associate with the action. Example: `workflowIcon`. |\n| `actionCommentable` | Boolean | Whether this action supports comments. |\n| `showOn` | List of Strings | List defining under which of the eight valid [workflow states](https://www.dotcms.com/docs/latest/managing-workflows#ActionShow) the action is visible. States must be specified uppercase, such as `NEW` or `LOCKED`. There is no single state for ALL; each state must be listed. |\n| `actionNextStep` | String | The identifier of the step to enter after performing the action; `currentstep` is also a valid value. |\n| `actionNextAssign` | String | A user identifier or role key (such as `CMS Anonymous`) to serve as the default entry in the assignment dropdown. |\n| `actionCondition` | String | [Custom Velocity code](https://www.dotcms.com/docs/latest/managing-workflows#ActionAssign) to be executed along with the action. |\n| `actionAssignable` | Boolean | Whether this action can be assigned. |\n| `actionRoleHierarchyForAssign` | Boolean | If true, non-administrators cannot assign tasks to administrators. |\n| `metadata` | Object | Optional. Additional metadata to include in the action definition. |\n| `actionId` | String | Omit; not used in this endpoint. |\n| `stepId` | String | Omit; not used in this endpoint. |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowActionForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Updated workflow action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}},"delete":{"tags":["Workflow"],"summary":"Delete a workflow action","description":"Deletes a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) from all [steps](https://www.dotcms.com/docs/latest/managing-workflows#Steps) in which it appears.\n\nReturns \"Ok\" on success.\n\n","operationId":"deleteWorkflowActionByActionId","parameters":[{"name":"actionId","in":"path","description":"Identifier of the workflow action to delete.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow action deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/steps/{stepId}/actions/{actionId}":{"get":{"tags":["Workflow"],"summary":"Find a workflow action within a step","description":"Returns a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) if it exists within a specific [step](https://www.dotcms.com/docs/latest/managing-workflows#Steps).","operationId":"getWorkflowActionByStepActionId","parameters":[{"name":"stepId","in":"path","description":"Identifier of a workflow step.\n\nExample value: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow \"Draft\" step)","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","description":"Identifier of a workflow action.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action returned successfully from step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionView"}}}},"404":{"description":"Workflow action not found within specified step"}}},"delete":{"tags":["Workflow"],"summary":"Remove a workflow action from a step","description":"Deletes an [action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) from a single [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps).\n\nReturns \"Ok\" on success.\n\nIf the action exists on other steps, removing it from one step will not delete the action outright.","operationId":"deleteWorkflowActionFromStepByActionId","parameters":[{"name":"actionId","in":"path","description":"Identifier of the workflow action to remove.","required":true,"schema":{"type":"string"}},{"name":"stepId","in":"path","description":"Identifier of the step containing the action.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow action removed from step successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/actionlets/{actionletId}":{"delete":{"tags":["Workflow"],"summary":"Remove an actionlet from a workflow action","description":"Removes an [actionlet](https://www.dotcms.com/docs/latest/workflow-sub-actions), or sub-action, from a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions). This deletes only the actionlet's binding to the action utilizing it, and leaves the actionlet category intact.\n\nTo find the identifier, you can call `GET /workflow/actions/{actionId}/actionlets`.\n\nReturns \"Ok\" on success.\n\n","operationId":"deleteWorkflowActionletFromAction","parameters":[{"name":"actionletId","in":"path","description":"Identifier of the actionlet to delete.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow actionlet deleted from action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/schemes/{schemeId}":{"put":{"tags":["Workflow"],"summary":"Update a workflow scheme","description":"Updates a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\nReturns updated scheme on success.","operationId":"putUpdateWorkflowScheme","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme.\n\nExample value: `d61a59e1-a49c-46f2-a929-db2b4bfa88b2` (Default system workflow)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request body consists of the following three properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `schemeName` | String | The workflow scheme's name. |\n| `schemeDescription` | String | A description of the scheme. |\n| `schemeArchived` | Boolean | If `true`, the scheme will be be placed in an archived state. |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSchemeForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Updated workflow scheme successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"400":{"description":"Bad request"},"404":{"description":"Workflow scheme not found."},"415":{"description":"Unsupported Media Type"}}},"delete":{"tags":["Workflow"],"summary":"Delete a workflow scheme","description":"Deletes a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes)\n\nScheme must already be in an archived state.\n\nReturns deleted workflow scheme on success.","operationId":"deleteWorkflowSchemeById","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme to delete.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow scheme deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowSchemeView"}}}},"404":{"description":"Workflow scheme not found"}}}},"/api/v1/workflow/steps/{stepId}":{"get":{"tags":["Workflow"],"summary":"Retrieves a workflow step","description":"Returns a [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps) by identifier.","operationId":"getFindWorkflowStepById","parameters":[{"name":"stepId","in":"path","description":"Identifier of the step to retrieve.\n\nExample: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow Draft step)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Found workflow step successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowStepView"}}}},"400":{"description":"Bad request"},"404":{"description":"Workflow step not found."}}},"put":{"tags":["Workflow"],"summary":"Update an existing workflow step","description":"Updates a [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps).\n\nReturns an object representing the updated step.","operationId":"putUpdateWorkflowStepById","parameters":[{"name":"stepId","in":"path","description":"Identifier of the step to update.\n\nExample: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow Draft step)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a JSON object containing a workflow step update form. This includes the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `stepOrder` | Integer | The position of the step within the [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes), with `0` being the first. |\n| `stepName` | String | The name of the workflow step. |\n| `enableEscalation` | Boolean | Determines whether a step is capable of automatic escalation to the next step. (Read more about [schedule-enabled workflows](https://www.dotcms.com/docs/latest/schedule-enabled-workflow).) |\n| `escalationAction` | String | The identifier of the workflow action to execute on automatic escalation. |\n| `escalationTime` | String | The time, in seconds, before the workflow automatically escalates. |\n| `stepResolved` | Boolean | If true, any content which enters this workflow step will be considered resolved.\nContent in a resolved step will not appear in the workflow queues of any users.\n |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowStepUpdateForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Updated workflow step successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowStepView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}},"delete":{"tags":["Workflow"],"summary":"Delete a workflow step","description":"Deletes a [step](https://www.dotcms.com/docs/latest/managing-workflows#Steps) from a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\nReturns the deleted workflow step object.","operationId":"deleteWorkflowStepById","parameters":[{"name":"stepId","in":"path","description":"Identifier of a workflow step to delete.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow step deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowStepView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/system/actions/{identifier}":{"delete":{"tags":["Workflow"],"summary":"Delete default system action binding by action id","description":"Deletes a [default system action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) binding.\n\nReturns the deleted system action object.\n\nThis method is minimally destructive, as it neither deletes a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions), nor removes any system action category. Instead, it dissolves the association between the two, which can be re-established any time.\n\nTo find a suitable identifier, you can use `GET /system/actions/{workflowActionId}` and find it in the immediate `identifier` property of any of the objects returned in the entity.","operationId":"deleteSystemActionByActionId","parameters":[{"name":"identifier","in":"path","description":"Identifier of the system action mapping to delete.\n\nExample value: `59995336-187e-442a-b398-04b9f137eabd` (Demo starter binding that maps `DELETE` system action to the \"Destroy\" workflow action for the Blog content type)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"System action binding deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemActionWorkflowActionMapping"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/actions/{actionId}/condition":{"get":{"tags":["Workflow"],"summary":"Find condition by action ID","description":"Returns a string representing the \"condition\" on the selected action.\n\nMore specifically: if the workflow action has anything in its [Custom Code](https://www.dotcms.com/docs/latest/custom-workflow-actions) field, the result is evaluated as Velocity, and the output is returned.","operationId":"getWorkflowConditionByActionId","parameters":[{"name":"actionId","in":"path","description":"Identifier of a workflow action to check for condition.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Condition returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/schemes/{schemeIdOrVariable}/export":{"get":{"tags":["Workflow"],"summary":"Export a workflow scheme","description":"Export a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\nReturns the full workflow scheme, along with steps, actions, permissions, etc., on success.","operationId":"getExportScheme","parameters":[{"name":"schemeIdOrVariable","in":"path","description":"Identifier or variable name of the workflow scheme to export.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Exported workflow scheme successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"},"example":{"entity":{"permissions":[{"bitPermission":false,"id":0,"individualPermission":true,"inode":"string","permission":0,"roleId":"string","type":"string"}],"workflowObject":{"actionClassParams":[{"actionClassId":"string","id":null,"key":"string","value":null}],"actionClasses":[{"actionId":"string","actionlet":{"actionClass":"string","howTo":"string","localizedHowto":"string","localizedName":"string","name":"string","nextStep":null,"parameters":[{"defaultValue":"","displayName":"string","key":"string","required":false}]},"clazz":"string","id":"string","name":"string","order":0}],"actionSteps":[{"actionId":"string","actionOrder":"0","stepId":"string"}],"actions":[{"assignable":false,"commentable":false,"condition":"","icon":"string","id":"string","metadata":null,"name":"string","nextAssign":"string","nextStep":"string","nextStepCurrentStep":true,"order":0,"owner":null,"roleHierarchyForAssign":false,"schemeId":"string","showOn":[]}],"schemeSystemActionWorkflowActionMappings":[{"identifier":"string","owner":{"archived":false,"creationDate":1723806880187,"defaultScheme":false,"description":"string","entryActionId":null,"id":"string","mandatory":false,"modDate":1723796816309,"name":"string","system":false,"variableName":"string"},"systemAction":"string","workflowAction":{"assignable":false,"commentable":false,"condition":"","icon":"string","id":"string","metadata":null,"name":"string","nextAssign":"string","nextStep":"string","nextStepCurrentStep":true,"order":0,"owner":null,"roleHierarchyForAssign":false,"schemeId":"string","showOn":[]},"ownerContentType":false,"ownerScheme":true}],"schemes":[{"archived":false,"creationDate":1723806880187,"defaultScheme":false,"description":"string","entryActionId":null,"id":"string","mandatory":false,"modDate":1723796816309,"name":"string","system":false,"variableName":"string"}],"steps":[{"creationDate":1723806894533,"enableEscalation":false,"escalationAction":null,"escalationTime":0,"id":"string","myOrder":0,"name":"string","resolved":false,"schemeId":"string"}],"version":"string"}},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request"},"404":{"description":"Workflow scheme not found"}}}},"/api/v1/workflow/actionlets":{"get":{"tags":["Workflow"],"summary":"Find all workflow actionlets","description":"Returns a list of all workflow actionlets — a.k.a. [workflow sub-actions](https://www.dotcms.com/docs/latest/workflow-sub-actions). The returned list is complete and does not use pagination.","operationId":"getWorkflowActionlets","responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow actionlets returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionletsView"}}}}}}},"/api/v1/workflow/actions/{actionId}/actionlets":{"get":{"tags":["Workflow"],"summary":"Find workflow actionlets by workflow action","description":"Returns a list of the workflow actionlets — a.k.a. [workflow sub-actions](https://www.dotcms.com/docs/latest/workflow-sub-actions) — associated with a specified workflow action.","operationId":"getWorkflowActionletsByActionId","parameters":[{"name":"actionId","in":"path","description":"Identifier of workflow action to examine for actionlets.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow actionlets returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionClassesView"},"example":{"entity":[{"actionId":"string","actionlet":{"actionClass":"string","howTo":"string","localizedHowto":"string","localizedName":"string","name":"string","nextStep":null,"parameters":[{"displayName":"string","key":"string","defaultValue":"string","required":true}]},"clazz":"string","id":"string","name":"string","order":0}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"404":{"description":"Workflow action not found"}}},"post":{"tags":["Workflow"],"summary":"Adds an actionlet to a workflow action","description":"Adds an actionlet — a.k.a. a [workflow sub-action](https://www.dotcms.com/docs/latest/workflow-sub-actions) — to a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions).\n\nReturns \"Ok\" on success.","operationId":"postAddActionletToActionById","parameters":[{"name":"actionId","in":"path","description":"Identifier of workflow action to receive actionlet.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a JSON object containing a workflow action form. This includes the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `actionletClass` | String | The class of the actionlet to be assigned.

Example: `com.dotcms.rendering.js.JsScriptActionlet` |\n| `order` | Integer | The position of the actionlet within the action's sequence. |\n| `parameters` | Object | Further parameters and properties are conveyed here, depending on the particulars of the selected actionlet.

For a complete list of possible parameters, refer to the various keys listed in `GET /workflow/actionlets`. |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowActionletActionForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow actionlet assigned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"},"example":{"errors":[{"errorCode":"string","message":"string","fieldName":"string"}],"entity":"Ok","messages":[{"message":"string"}],"i18nMessagesMap":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"permissions":["string"],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0}}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/schemes/{schemeId}/actions":{"get":{"tags":["Workflow"],"summary":"Find all actions in a workflow scheme","description":"Returns a list of [workflow actions](https://www.dotcms.com/docs/latest/managing-workflows#Actions) associated with a specified [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).","operationId":"getWorkflowActionsBySchemeId","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme.\n\nExample value: `d61a59e1-a49c-46f2-a929-db2b4bfa88b2` (Default system workflow)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Actions returned successfully from workflow scheme","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionsView"}}}},"404":{"description":"Workflow scheme not found"}}}},"/api/v1/workflow/schemes/actions/{systemAction}":{"post":{"tags":["Workflow"],"summary":"Finds workflow actions by schemes and system action","description":"Returns a list of [workflow actions](https://www.dotcms.com/docs/latest/managing-workflows#Actions) associated with [workflow schemes](https://www.dotcms.com/docs/latest/managing-workflows#Schemes), further filtered by [default system actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions).","operationId":"postFindActionsBySchemesAndSystemAction","parameters":[{"name":"systemAction","in":"path","description":"Default system action.","required":true,"schema":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}],"requestBody":{"description":"Body consists of a JSON object containing a single property called `schemes`, which contains a list of workflow scheme identifier strings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSchemesForm"},"example":{"schemes":["d61a59e1-a49c-46f2-a929-db2b4bfa88b2"]}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionsView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/steps/{stepId}/actions":{"get":{"tags":["Workflow"],"summary":"Find all actions in a workflow step","description":"Returns a list of [workflow actions](https://www.dotcms.com/docs/latest/managing-workflows#Actions) associated with a specified [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps).","operationId":"getWorkflowActionsByStepId","parameters":[{"name":"stepId","in":"path","description":"Identifier of a workflow step.\n\nExample value: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow \"Draft\" step)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Actions returned successfully from step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionsView"}}}},"404":{"description":"Workflow step not found"}}},"post":{"tags":["Workflow"],"summary":"Adds a workflow action to a workflow step","description":"Assigns a single [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) to a [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps). Returns \"Ok\" on success.","operationId":"postActionToStepById","parameters":[{"name":"stepId","in":"path","description":"Identifier of a workflow step to receive a new action.\n\nExample value: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow \"Draft\" step)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a JSON object with a single property:\n\n| Property | Type | Description |\n|-|-|-|\n| `actionId` | String | The identifier of the workflow action to assign to the step specified in the parameter. |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowActionStepForm"},"example":{"actionId":"b9d89c80-3d88-4311-8365-187323c96436"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow action added to step successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"},"example":{"errors":[{"errorCode":"string","message":"string","fieldName":"string"}],"entity":"Ok","messages":[{"message":"string"}],"i18nMessagesMap":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"permissions":["string"],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0}}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/schemes/schemescontenttypes/{contentTypeId}":{"get":{"tags":["Workflow"],"summary":"Find workflow schemes by content type id","description":"Fetches [workflow schemes](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) associated with a content type by its identifier. Returns an entity containing two properties:\n\n| Property | Description |\n|----------|-------------|\n| `contentTypeSchemes` | A list of schemes associated with the specified content type. |\n| `schemes` | A list of non-archived schemes, irrespective of relation to the content type. |","operationId":"getWorkflowSchemesByContentTypeId","parameters":[{"name":"contentTypeId","in":"path","description":"Identifier of content type to examine for workflow schemes.\n\nExample value: `c541abb1-69b3-4bc5-8430-5e09e5239cc8` (Default page content type)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Scheme(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAndSchemesContentTypeView"}}}},"404":{"description":"Content type ID not found"}}}},"/api/v1/workflow/contentlet/{inode}/actions":{"get":{"tags":["Workflow"],"summary":"Finds workflow actions by content inode","description":"Returns a list of [workflow actions](https://www.dotcms.com/docs/latest/managing-workflows#Actions) associated with a [contentlet](https://www.dotcms.com/docs/latest/content#Contentlets) specified by inode.","operationId":"getWorkflowActionsByContentletInode","parameters":[{"name":"inode","in":"path","description":"Inode of contentlet to examine for workflow actions.\n\n","required":true,"schema":{"type":"string"}},{"name":"renderMode","in":"query","description":"*Optional.* Case-insensitive parameter indicating how results are to be displayed.\n\nIn listing mode, all associated actions are returned; in editing mode (the default), it returns only the actions accessible to the contentlet's current workflow step.","schema":{"type":"string","enum":["EDITING","LISTING"],"default":"EDITING"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Scheme(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionsView"}}}},"404":{"description":"Contentlet not found"}}}},"/api/v1/workflow/defaultactions/contenttype/{contentTypeId}":{"get":{"tags":["Workflow"],"summary":"Find possible default actions by content type","description":"Returns a list of actions that may be used as a [default action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) for a specified [content type](https://www.dotcms.com/docs/latest/content-types), along with their associated [workflow schemes](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).","operationId":"getDefaultActionsByContentTypeId","parameters":[{"name":"contentTypeId","in":"path","description":"Identifier or variable of content type to examine for actions.\n\nExample ID: `c541abb1-69b3-4bc5-8430-5e09e5239cc8` (Default page content type)\n\nExample Variable: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Default action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDefaultWorkflowActionsView"}}}},"404":{"description":"Content type not found"}}}},"/api/v1/workflow/defaultactions/schemes":{"get":{"tags":["Workflow"],"summary":"Find possible default actions by scheme(s)","description":"Returns a list of actions that are eligible to be used as a [default action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) for one or more [workflow schemes](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).","operationId":"getDefaultActionsBySchemeIds","parameters":[{"name":"ids","in":"query","description":"Comma-separated list of workflow scheme identifiers.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDefaultWorkflowActionsView"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/initialactions/contenttype/{contentTypeId}":{"get":{"tags":["Workflow"],"summary":"Find initial actions by content type","description":"Returns a list of available actions of the initial/first step(s) of the workflow scheme(s) associated with a [content type](https://www.dotcms.com/docs/latest/content-types).","operationId":"getInitialActionsByContentTypeId","parameters":[{"name":"contentTypeId","in":"path","description":"Identifier or variable of content type to examine for initial actions.\n\nExample ID: `c541abb1-69b3-4bc5-8430-5e09e5239cc8` (Default page content type)\n\nExample Variable: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Initial action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDefaultWorkflowActionsView"}}}},"404":{"description":"Content type not found"}}}},"/api/v1/workflow/schemes":{"get":{"tags":["Workflow"],"summary":"Find workflow schemes","description":"Returns workflow schemes. Can be filtered by content type and/or live status through optional query parameters.","operationId":"getWorkflowSchemes","parameters":[{"name":"contentTypeId","in":"query","description":"Optional filter parameter that takes a content type identifier and returns all [workflow schemes](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) associated with that type.\n\nLeave blank to return all workflow schemes.\n\nExample value: `c541abb1-69b3-4bc5-8430-5e09e5239cc8` (Default page content type)","schema":{"type":"string"}},{"name":"showArchived","in":"query","description":"If `true`, includes archived schemes in response.","schema":{"type":"boolean","default":true}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Scheme(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowSchemesView"}}}},"404":{"description":"Workflow scheme not found"}}},"post":{"tags":["Workflow"],"summary":"Create a workflow scheme","description":"Create a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\n Returns created workflow scheme on success.","operationId":"postSaveScheme_1","requestBody":{"description":"The request body consists of the following three properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `schemeName` | String | The workflow scheme's name. |\n| `schemeDescription` | String | A description of the scheme. |\n| `schemeArchived` | Boolean | If `true`, the scheme will be created in an archived state. |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSchemeForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Copied workflow scheme successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowSchemeView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/schemes/{schemeId}/steps":{"get":{"tags":["Workflow"],"summary":"Find steps by workflow scheme ID","description":"Returns a list of [steps](https://www.dotcms.com/docs/latest/managing-workflows#Steps) associated with a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).","operationId":"getWorkflowStepsBySchemeId","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme.\n\nExample value: `d61a59e1-a49c-46f2-a929-db2b4bfa88b2` (Default system workflow)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Scheme(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowStepsView"}}}},"404":{"description":"Workflow scheme not found"}}}},"/api/v1/workflow/contenttypes/{contentTypeVarOrId}/system/actions":{"get":{"tags":["Workflow"],"summary":"Find default system actions mapped to a content type","description":"Returns a list of [default system actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) associated with a specified [content type](https://www.dotcms.com/docs/latest/content-types).","operationId":"getSystemActionMappingsByContentType","parameters":[{"name":"contentTypeVarOrId","in":"path","description":"The ID or Velocity variable of the content type to inspectfor default system action bindings.\n\nExample value: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action(s) returned successfully from content type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemActionWorkflowActionMappings"}}}},"404":{"description":"Content Type not found"}}}},"/api/v1/workflow/schemes/{schemeId}/system/actions":{"get":{"tags":["Workflow"],"summary":"Find default system actions mapped to a workflow scheme","description":"Returns a list of [default system actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) associated with a specified [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).","operationId":"getSystemActionMappingsBySchemeId","parameters":[{"name":"schemeId","in":"path","description":"Identifier of workflow scheme.\n\nExample value: `d61a59e1-a49c-46f2-a929-db2b4bfa88b2` (Default system workflow)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Actions returned successfully from workflow scheme","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemActionWorkflowActionMappings"}}}},"404":{"description":"Workflow scheme not found"}}}},"/api/v1/workflow/actions/firemultipart":{"put":{"tags":["Workflow"],"summary":"Fire action by name (multipart form) 🚧","description":"(**Construction notice:** Still needs request body documentation. Coming soon!)\n\nFires a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions), specified by name, on a target contentlet. Uses a multipart form to transmit its data.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireActionByNameMultipart","parameters":[{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"requestBody":{"description":"Multipart form. More details to follow.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/fire":{"put":{"tags":["Workflow"],"summary":"Fire workflow action by name","description":"Fires a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions), specified by name, on a target contentlet.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireActionByName","parameters":[{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"requestBody":{"description":"Body consists of a JSON object containing at minimum the `actionName` property, specifying a workflow action to fire.\n\nThe full list of properties that may be used with this form is as follows:\n\n| Property | Type | Description |\n|-|-|-|\n| `actionName` | String | The name of the workflow action to perform. |\n| `contentlet` | Object | An alternate way of specifying the target contentlet. If no identifier or inode is included via parameter, either one could instead be included in the body as a property of this object. |\n| `comments` | String | Comments that will appear in the [workflow tasks](https://www.dotcms.com/docs/latest/workflow-tasks) tool with the execution of this workflow action. |\n| `individualPermissions` | Object | Allows setting granular permissions associated with the target. The object properties are the [system names of permissions](https://www.dotcms.com/docs/latest/user-permissions#Permissions), such as READ, PUBLISH, EDIT, etc. Their respective values are a list of user or role identifiers that should be granted the permission in question. Example: `\"READ\": [\"9ad24203-ae6a-4e5e-aa10-a8c38fd11f17\",\"MyRole\"]` |\n| `assign` | String | The identifier of a user or role to next receive the workflow task assignment. |\n| `pathToMove` | String | If the workflow action includes the Move actionlet, this property will specify the target path. This path must include a host, such as `//default/testfolder`, `//demo.dotcms.com/application`, etc. |\n| `query` | String | Not used in this method. |\n| `whereToSend` | String | For the [push publishing](push-publishing) actionlet; sets the push-publishing environment to receive the target content. Must be specified as an environment identifier. [Learn how to find environment IDs here.](https://www.dotcms.com/docs/latest/push-publishing-endpoints#EnvironmentIds) |\n| `iWantTo` | String | For the push publishing actionlet; this can be set to one of three values: These are further configurable with the properties below that specify publishing and expiration dates, times, etc. |\n| `publishDate` | String | For the push publishing actionlet; specifies a date to push the content. Format: `yyyy-MM-dd`. |\n| `publishTime` | String | For the push publishing actionlet; specifies a time to push the content. Format: `hh-mm`. |\n| `expireDate` | String | For the push publishing actionlet; specifies a date to remove the content. Format: `yyyy-MM-dd`. |\n| `expireTime` | String | For the push publishing actionlet; specifies a time to remove the content. Format: `hh-mm`. |\n| `neverExpire` | Boolean | For the push publishing actionlet; a value of `true` invalidates the expiration time/date. |\n| `filterKey` | String | For the push publishing actionlet; specifies a [push publishing filter](https://www.dotcms.com/docs/latest/push-publishing-filters) key, should the workflow action call for such. To retrieve a full list of push publishing filters and their keys, use `GET /v1/pushpublish/filters`. |\n| `timezoneId` | String | For the push publishing actionlet; specifies the time zone to which the indicated times belong. Uses the [tz database](https://www.iana.org/time-zones). For a list of values, see [the database directly](https://data.iana.org/time-zones/tz-link.html) or refer to [the Wikipedia entry listing tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireActionByNameForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/default/firemultipart/{systemAction}":{"put":{"tags":["Workflow"],"summary":"Fire action by ID (multipart form) 🚧","description":"(**Construction notice:** Still needs request body documentation. Coming soon!)\n\nFires a default [system action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) on target contentlet. Uses a multipart form to transmit its data.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireActionByIdMultipart","parameters":[{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}},{"name":"systemAction","in":"path","description":"Default system action.","required":true,"schema":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/default/fire/{systemAction}":{"put":{"tags":["Workflow"],"summary":"Fire system action by name","description":"Fire a [default system action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) by name on a target contentlet.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireDefaultSystemAction","parameters":[{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}},{"name":"systemAction","in":"path","description":"Default system action.","required":true,"schema":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}],"requestBody":{"description":"Optional body consists of a JSON object containing a FireActionByNameForm object — a form that appears in similar functions, as well, but implemented with minor differences across methods. As such, some properties are unused.\n\nThe full list of properties that may be used with this form is as follows:\n\n| Property | Type | Description |\n|-|-|-|\n| `actionName` | String | Not used in this method. |\n| `contentlet` | Object | An alternate way of specifying the target contentlet. If no identifier or inode is included via parameter, either one could instead be included in the body as a property of this object. |\n| `comments` | String | Comments that will appear in the [workflow tasks](https://www.dotcms.com/docs/latest/workflow-tasks) tool with the execution of this workflow action. |\n| `individualPermissions` | Object | Allows setting granular permissions associated with the target. The object properties are the [system names of permissions](https://www.dotcms.com/docs/latest/user-permissions#Permissions), such as READ, PUBLISH, EDIT, etc. Their respective values are a list of user or role identifiers that should be granted the permission in question. Example: `\"READ\": [\"9ad24203-ae6a-4e5e-aa10-a8c38fd11f17\",\"MyRole\"]` |\n| `assign` | String | The identifier of a user or role to next receive the workflow task assignment. |\n| `pathToMove` | String | If the workflow action includes the Move actionlet, this property will specify the target path. This path must include a host, such as `//default/testfolder`, `//demo.dotcms.com/application`, etc. |\n| `query` | String | Not used in this method. |\n| `whereToSend` | String | For the [push publishing](push-publishing) actionlet; sets the push-publishing environment to receive the target content. Must be specified as an environment identifier. [Learn how to find environment IDs here.](https://www.dotcms.com/docs/latest/push-publishing-endpoints#EnvironmentIds) |\n| `iWantTo` | String | For the push publishing actionlet; this can be set to one of three values: These are further configurable with the properties below that specify publishing and expiration dates, times, etc. |\n| `publishDate` | String | For the push publishing actionlet; specifies a date to push the content. Format: `yyyy-MM-dd`. |\n| `publishTime` | String | For the push publishing actionlet; specifies a time to push the content. Format: `hh-mm`. |\n| `expireDate` | String | For the push publishing actionlet; specifies a date to remove the content. Format: `yyyy-MM-dd`. |\n| `expireTime` | String | For the push publishing actionlet; specifies a time to remove the content. Format: `hh-mm`. |\n| `neverExpire` | Boolean | For the push publishing actionlet; a value of `true` invalidates the expiration time/date. |\n| `filterKey` | String | For the push publishing actionlet; specifies a [push publishing filter](https://www.dotcms.com/docs/latest/push-publishing-filters) key, should the workflow action call for such. To retrieve a full list of push publishing filters and their keys, use `GET /v1/pushpublish/filters`. |\n| `timezoneId` | String | For the push publishing actionlet; specifies the time zone to which the indicated times belong. Uses the [tz database](https://www.iana.org/time-zones). For a list of values, see [the database directly](https://data.iana.org/time-zones/tz-link.html) or refer to [the Wikipedia entry listing tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireActionByNameForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}},"post":{"tags":["Workflow"],"summary":"Fire system action by name over multiple contentlets","description":"Fire a [default system action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) by name on multiple target contentlets.\n\nReturns a list of resultant contentlet maps, each with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"postFireSystemActionByNameMulti","parameters":[{"name":"systemAction","in":"path","description":"Default system action.","required":true,"schema":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}],"requestBody":{"description":"Optional body consists of a JSON object containing various properties, some of which are specific to certain actionlets.\n\nThe full list of properties that may be used with this form is as follows:\n\n| Property | Type | Description |\n|-|-|-|\n| `contentlet` | List of Objects | Multiple contentlet objects to serve as the target of the selected default system action; requires, at minimum, an identifier in each. |\n| `comments` | String | Comments that will appear in the [workflow tasks](https://www.dotcms.com/docs/latest/workflow-tasks) tool with the execution of this workflow action. |\n| `assign` | String | The identifier of a user or role to next receive the workflow task assignment. |\n| `whereToSend` | String | For the [push publishing](push-publishing) actionlet; sets the push-publishing environment to receive the target content. Must be specified as an environment identifier. [Learn how to find environment IDs here.](https://www.dotcms.com/docs/latest/push-publishing-endpoints#EnvironmentIds) |\n| `iWantTo` | String | For the push publishing actionlet; this can be set to one of three values: These are further configurable with the properties below that specify publishing and expiration dates, times, etc. |\n| `publishDate` | String | For the push publishing actionlet; specifies a date to push the content. Format: `yyyy-MM-dd`. |\n| `publishTime` | String | For the push publishing actionlet; specifies a time to push the content. Format: `hh-mm`. |\n| `expireDate` | String | For the push publishing actionlet; specifies a date to remove the content. Format: `yyyy-MM-dd`. |\n| `expireTime` | String | For the push publishing actionlet; specifies a time to remove the content. Format: `hh-mm`. |\n| `neverExpire` | Boolean | For the push publishing actionlet; a value of `true` invalidates the expiration time/date. |\n| `filterKey` | String | For the push publishing actionlet; specifies a [push publishing filter](https://www.dotcms.com/docs/latest/push-publishing-filters) key, should the workflow action call for such. To retrieve a full list of push publishing filters and their keys, use `GET /v1/pushpublish/filters`. |\n| `timezoneId` | String | For the push publishing actionlet; specifies the time zone to which the indicated times belong. Uses the [tz database](https://www.iana.org/time-zones). For a list of values, see [the database directly](https://data.iana.org/time-zones/tz-link.html) or refer to [the Wikipedia entry listing tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireMultipleActionForm"},"example":{"contentlet":[{"identifier":"d684c0a9abeeeceea8b9a7e32fc272ae"},{"identifier":"c2701eced2b59f0bbd55b3d9667878ce"}],"comments":"test comment"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"},"example":{"entity":{"results":[{"c2701eced2b59f0bbd55b3d9667878ce":{"AUTO_ASSIGN_WORKFLOW":false,"archived":false,"baseType":"string","body":"string","body_raw":"string","contentType":"string","creationDate":1725051866540,"folder":"string","hasLiveVersion":false,"hasTitleImage":false,"host":"string","hostName":"string","identifier":"c2701eced2b59f0bbd55b3d9667878ce","inode":"string","languageId":1,"live":false,"locked":false,"modDate":1727438483022,"modUser":"string","modUserName":"string","owner":"string","ownerName":"string","publishDate":1727438483051,"publishUser":"string","publishUserName":"string","sortOrder":0,"stInode":"string","title":"string","titleImage":"string","url":"string","working":false}}],"summary":{"affected":1,"failCount":0,"successCount":1,"time":45}},"errors":[],"i18nMessagesMap":{},"messages":[],"permissions":[]}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}},"patch":{"tags":["Workflow"],"summary":"Modify specific fields on multiple contentlets","description":"Assigns values to the specified fields across multiple [contentlets](https://www.dotcms.com/docs/latest/content#Contentlets) simultaneously.\n\nCan use a [Lucene query](https://www.dotcms.com/docs/latest/content-search-syntax#Lucene) in its body to select all resulting content items.\n\nReturns a list of resultant contentlet maps, each with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"patchFireMergeSystemAction","parameters":[{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}},{"name":"offset","in":"query","description":"Numeric offset for query results; useful for paginating.","schema":{"type":"integer","format":"int64"}},{"name":"systemAction","in":"path","description":"Default system action.","required":true,"schema":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}],"requestBody":{"description":"Optional body consists of a JSON object containing various properties, some of which are specific to certain actionlets.\n\nThe full list of properties that may be used with this form is as follows:\n\n| Property | Type | Description |\n|-|-|-|\n| `query` | String | A Lucene query that can target multiple contentlets for editing. Example: `+contentType:htmlpageasset` for all dotCMS pages. |\n| `contentlet` | Object | An alternate way of specifying the target contentlet. If no identifier or inode is included via parameter, either one could instead be included in the body as a property of this object. |\n| `comments` | String | Comments that will appear in the [workflow tasks](https://www.dotcms.com/docs/latest/workflow-tasks) tool with the execution of this workflow action. |\n| `individualPermissions` | Object | Allows setting granular permissions associated with the target. The object properties are the [system names of permissions](https://www.dotcms.com/docs/latest/user-permissions#Permissions), such as READ, PUBLISH, EDIT, etc. Their respective values are a list of user or role identifiers that should be granted the permission in question. Example: `\"READ\": [\"9ad24203-ae6a-4e5e-aa10-a8c38fd11f17\",\"MyRole\"]` |\n| `assign` | String | The identifier of a user or role to next receive the workflow task assignment. |\n| `pathToMove` | String | If the workflow action includes the Move actionlet, this property will specify the target path. This path must include a host, such as `//default/testfolder`, `//demo.dotcms.com/application`, etc. |\n| `whereToSend` | String | For the [push publishing](push-publishing) actionlet; sets the push-publishing environment to receive the target content. Must be specified as an environment identifier. [Learn how to find environment IDs here.](https://www.dotcms.com/docs/latest/push-publishing-endpoints#EnvironmentIds) |\n| `iWantTo` | String | For the push publishing actionlet; this can be set to one of three values: These are further configurable with the properties below that specify publishing and expiration dates, times, etc. |\n| `publishDate` | String | For the push publishing actionlet; specifies a date to push the content. Format: `yyyy-MM-dd`. |\n| `publishTime` | String | For the push publishing actionlet; specifies a time to push the content. Format: `hh-mm`. |\n| `expireDate` | String | For the push publishing actionlet; specifies a date to remove the content. Format: `yyyy-MM-dd`. |\n| `expireTime` | String | For the push publishing actionlet; specifies a time to remove the content. Format: `hh-mm`. |\n| `neverExpire` | Boolean | For the push publishing actionlet; a value of `true` invalidates the expiration time/date. |\n| `filterKey` | String | For the push publishing actionlet; specifies a [push publishing filter](https://www.dotcms.com/docs/latest/push-publishing-filters) key, should the workflow action call for such. To retrieve a full list of push publishing filters and their keys, use `GET /v1/pushpublish/filters`. |\n| `timezoneId` | String | For the push publishing actionlet; specifies the time zone to which the indicated times belong. Uses the [tz database](https://www.iana.org/time-zones). For a list of values, see [the database directly](https://data.iana.org/time-zones/tz-link.html) or refer to [the Wikipedia entry listing tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireActionForm"},"example":{"comments":"Publish an existing Generic content","query":"+contentType:webPageContent AND title:testcontent","contentlet":{"title":"TestContentNowWithCaps"}}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Contentlet(s) modified successfully","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"},"example":{"entity":{"results":[{"c2701eced2b59f0bbd55b3d9667878ce":{"AUTO_ASSIGN_WORKFLOW":false,"archived":false,"baseType":"string","body":"string","body_raw":"string","contentType":"string","creationDate":1725051866540,"folder":"string","hasLiveVersion":false,"hasTitleImage":false,"host":"string","hostName":"string","identifier":"c2701eced2b59f0bbd55b3d9667878ce","inode":"string","languageId":1,"live":false,"locked":false,"modDate":1727438483022,"modUser":"string","modUserName":"string","owner":"string","ownerName":"string","publishDate":1727438483051,"publishUser":"string","publishUserName":"string","sortOrder":0,"stInode":"string","title":"string","titleImage":"string","url":"string","working":false}}],"summary":{"affected":1,"failCount":0,"successCount":1,"time":45}},"errors":[],"i18nMessagesMap":{},"messages":[],"permissions":[]}}}},"404":{"description":"Content Type not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/{actionId}/firemultipart":{"put":{"tags":["Workflow"],"summary":"Fire action by ID (multipart form) 🚧","description":"(**Construction notice:** Still needs request body documentation. Coming soon!)\n\nFires a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions), specified by identifier, on a target contentlet. Uses a multipart form to transmit its data.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireActionByIdMultipart_1","parameters":[{"name":"actionId","in":"path","description":"Identifier of a workflow action.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}},{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"requestBody":{"description":"Multipart form. More details to follow.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions/{actionId}/fire":{"put":{"tags":["Workflow"],"summary":"Fire action by ID","description":"Fires a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions), specified by identifier, on a target contentlet.\n\nReturns a map of the resultant contentlet, with an additional `AUTO_ASSIGN_WORKFLOW` property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.","operationId":"putFireActionById","parameters":[{"name":"actionId","in":"path","description":"Identifier of a workflow action.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}},{"name":"inode","in":"query","description":"Inode of the target content.","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Identifier of target content.","schema":{"type":"string"}},{"name":"indexPolicy","in":"query","description":"Determines how target content is indexed.\n\n| Value | Description |\n|-------|-------------|\n| `DEFER` | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |\n| `WAIT_FOR` | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |\n| `FORCE` | Forces Elasticsearch to index the content **immediately**.
**Caution:** Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |\n\n","schema":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"requestBody":{"description":"Optional body consists of a JSON object containing various properties, some of which are specific to certain actionlets.\n\nThe full list of properties that may be used with this form is as follows:\n\n| Property | Type | Description |\n|-|-|-|\n| `contentlet` | Object | An alternate way of specifying the target contentlet. If no identifier or inode is included via parameter, either one could instead be included in the body as a property of this object. |\n| `comments` | String | Comments that will appear in the [workflow tasks](https://www.dotcms.com/docs/latest/workflow-tasks) tool with the execution of this workflow action. |\n| `individualPermissions` | Object | Allows setting granular permissions associated with the target. The object properties are the [system names of permissions](https://www.dotcms.com/docs/latest/user-permissions#Permissions), such as READ, PUBLISH, EDIT, etc. Their respective values are a list of user or role identifiers that should be granted the permission in question. Example: `\"READ\": [\"9ad24203-ae6a-4e5e-aa10-a8c38fd11f17\",\"MyRole\"]` |\n| `assign` | String | The identifier of a user or role to next receive the workflow task assignment. |\n| `pathToMove` | String | If the workflow action includes the Move actionlet, this property will specify the target path. This path must include a host, such as `//default/testfolder`, `//demo.dotcms.com/application`, etc. |\n| `query` | String | Not used in this method. |\n| `whereToSend` | String | For the [push publishing](push-publishing) actionlet; sets the push-publishing environment to receive the target content. Must be specified as an environment identifier. [Learn how to find environment IDs here.](https://www.dotcms.com/docs/latest/push-publishing-endpoints#EnvironmentIds) |\n| `iWantTo` | String | For the push publishing actionlet; this can be set to one of three values: These are further configurable with the properties below that specify publishing and expiration dates, times, etc. |\n| `publishDate` | String | For the push publishing actionlet; specifies a date to push the content. Format: `yyyy-MM-dd`. |\n| `publishTime` | String | For the push publishing actionlet; specifies a time to push the content. Format: `hh-mm`. |\n| `expireDate` | String | For the push publishing actionlet; specifies a date to remove the content. Format: `yyyy-MM-dd`. |\n| `expireTime` | String | For the push publishing actionlet; specifies a time to remove the content. Format: `hh-mm`. |\n| `neverExpire` | Boolean | For the push publishing actionlet; a value of `true` invalidates the expiration time/date. |\n| `filterKey` | String | For the push publishing actionlet; specifies a [push publishing filter](https://www.dotcms.com/docs/latest/push-publishing-filters) key, should the workflow action call for such. To retrieve a full list of push publishing filters and their keys, use `GET /v1/pushpublish/filters`. |\n| `timezoneId` | String | For the push publishing actionlet; specifies the time zone to which the indicated times belong. Uses the [tz database](https://www.iana.org/time-zones). For a list of values, see [the database directly](https://data.iana.org/time-zones/tz-link.html) or refer to [the Wikipedia entry listing tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireActionForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Fired action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request"},"404":{"description":"Content not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/contentlet/actions/_bulkfire":{"post":{"tags":["Workflow"],"summary":"Perform workflow actions on bulk content","description":"This operation allows you to specify a multiple content items (either by query or a list of identifiers), a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) to perform on them, and additional parameters as needed by the selected action.","operationId":"postBulkActionsFire","requestBody":{"description":"Body consists of a JSON object with the following possible properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `contentletIds` | List of Strings | A list of individual contentlet identifiers. |\n| `query` | String | [Lucene query](https://www.dotcms.com/docs/latest/content-search-syntax#Lucene); uses all matching contentlets. |\n| `workflowActionId` | String | The identifier of the workflow action to be performed on the selected content. |\n| `additionalParams` | Object | Further parameters and properties are conveyed here, depending on the particulars of the selected action.

For a complete list of possible parameters, refer to the various keys listed in `GET /workflow/actionlets`. |\n\nIf both `contentletIds` and `query` properties are present, the operation will perform the selected action on all contentlets indicated in both. Note that this will lead to the workflow action being performed on the same contentlet twice, if it appears in both.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireBulkActionsForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOutput"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/contentlet/actions/bulk/fire":{"put":{"tags":["Workflow"],"summary":"Perform workflow actions on bulk content","description":"This operation allows you to specify a multiple content items (either by query or a list of identifiers), a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) to perform on them, and additional parameters as needed by the selected action.","operationId":"putBulkActionsFire","requestBody":{"description":"Body consists of a JSON object with the following possible properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `contentletIds` | List of Strings | A list of individual contentlet identifiers. |\n| `query` | String | [Lucene query](https://www.dotcms.com/docs/latest/content-search-syntax#Lucene); uses all matching contentlets. |\n| `workflowActionId` | String | The identifier of the workflow action to be performed on the selected content. |\n| `additionalParams` | Object | Further parameters and properties are conveyed here, depending on the particulars of the selected action.

For a complete list of possible parameters, refer to the various keys listed in `GET /workflow/actionlets`. |\n\nIf both `contentletIds` and `query` properties are present, the operation will use the query and disregard the identifier list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireBulkActionsForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBulkActionsResultView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/contentlet/actions/bulk":{"post":{"tags":["Workflow"],"summary":"Finds available bulk workflow actions for content","description":"Returns a list of bulk actions available for [contentlets](https://www.dotcms.com/docs/latest/content#Contentlets) either by identifiers or by query, as specified in the body.","operationId":"postBulkActions","requestBody":{"description":"Body consists of a JSON object with either of the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `contentletIds` | List of Strings | A list of individual contentlet identifiers. |\n| `query` | String | [Lucene query](https://www.dotcms.com/docs/latest/content-search-syntax#Lucene); uses all matching contentlets. |\n\nIf both properties are present, the operation will use the list of identifiers and disregard the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionForm"},"example":{"contentletIds":["651a4dc8-2124-45d8-8bd2-d8e68ad358a8","f8d60f79-e006-42e0-894f-5d3488b796f6"],"query":"+contentType:*"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Zero or more bulk actions returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBulkActionView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/status/{contentletInode}":{"get":{"tags":["Workflow"],"summary":"Find workflow status of content","description":"Checks the current workflow status of a contentlet by its [inode](https://www.dotcms.com/docs/latest/content-versions#IdentifiersInodes).\n\nReturns an object containing the associated [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes), [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps), and [workflow task](https://www.dotcms.com/docs/latest/workflow-tasks) associated with the contentlet.","operationId":"getContentWorkflowStatusByInode","parameters":[{"name":"contentletInode","in":"path","description":"Inode of content version to inspect for workflow status.\n\n","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContentletWorkflowStatusView"}}}},"400":{"description":"Bad Request"}}}},"/api/v1/workflow/system/actions/{workflowActionId}":{"get":{"tags":["Workflow"],"summary":"Find default system actions by workflow action id","description":"Returns a list of [default system actions](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) associated with a specified [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions).","operationId":"getSystemActionsByActionId","parameters":[{"name":"workflowActionId","in":"path","description":"Identifier of the workflow action to return.\n\nExample value: `b9d89c80-3d88-4311-8365-187323c96436` (Default system workflow \"Publish\" action)","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemActionWorkflowActionMappings"}}}},"404":{"description":"Workflow action not found"}}}},"/api/v1/workflow/tasks/history/comments/{contentletIdentifier}":{"get":{"tags":["Workflow"],"summary":"Find workflow tasks history and comments of content","description":"Retrieve the workflow tasks comments of a contentlet by its [id](https://www.dotcms.com/docs/latest/content-versions#IdentifiersInodes).\n\nReturns an object containing the associated [workflow history or comments]https://www2.dotcms.com/docs/latest/workflow-tasks, [workflow task]","operationId":"getWorkflowTasksHistoryComments","parameters":[{"name":"contentletIdentifier","in":"path","description":"Id of content to inspect for workflow tasks.\n\n","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Action(s) returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowHistoryCommentsView"}}}},"400":{"description":"Bad Request"}}}},"/api/v1/workflow/schemes/import":{"post":{"tags":["Workflow"],"summary":"Import a workflow scheme","description":"Import a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes).\n\nReturns \"OK\" on success.","operationId":"postImportScheme","requestBody":{"description":"Body consists of a JSON object containing two properties: \n\n| Property | Type | Description |\n|-|-|-|\n| `workflowObject` | Object | An entire scheme along with steps and actions, such as received from the corresponding export method. |\n| `permissions` | List of Objects | A list of permission objects, such as received from the corresponding export method. |\n\nThe simplest way to perform an import is to pass the full value of the `entity` property returned by the corresponding Workflow Scheme Export endpoint as the data payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSchemeImportObjectForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Imported workflow scheme successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/reorder/steps/{stepId}/actions/{actionId}":{"put":{"tags":["Workflow"],"summary":"Change the order of actions within a workflow step","description":"Updates a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions)'s order within a [step](https://www.dotcms.com/docs/latest/managing-workflows#Steps) by assigning it a numeric order.\n\nReturns \"Ok\" on success.\n\n","operationId":"putReorderWorkflowActionsInStep","parameters":[{"name":"stepId","in":"path","description":"Identifier of the step containing the action.","required":true,"schema":{"type":"string"}},{"name":"actionId","in":"path","description":"Identifier of the action to reorder.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Body consists of a JSON object containing the single property `order`, which is assigned an integer value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowReorderWorkflowActionStepForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Updated workflow action successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"400":{"description":"Bad request"},"404":{"description":"Workflow step or action not found"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/reorder/step/{stepId}/order/{order}":{"put":{"tags":["Workflow"],"summary":"Change the order of steps within a scheme","description":"Updates a [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps)'s order within a [scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) by assigning it a numeric order.\n\nReturns \"Ok\" on success.\n\n","operationId":"putReorderWorkflowStepsInScheme","parameters":[{"name":"stepId","in":"path","description":"Identifier of the step to reorder.\n\nExample: `ee24a4cb-2d15-4c98-b1bd-6327126451f3` (Default system workflow Draft step)","required":true,"schema":{"type":"string"}},{"name":"order","in":"path","description":"Integer indicating the step's position in the order, with `0` as the first. All other steps numbers are adjusted accordingly, leaving no gaps.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow step reordered successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/actions":{"post":{"tags":["Workflow"],"summary":"Creates/saves a workflow action","description":"Creates or updates a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) from the properties specified in the payload. Returns the created workflow action.","operationId":"postActionsByWorkflowActionForm","requestBody":{"description":"Body consists of a JSON object containing a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) form. This includes the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `actionId` | String | The identifier of the workflow action to be updated. If left blank, a new workflow action will be created. |\n| `schemeId` | String | The [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) under which the action will be created. |\n| `stepId` | String | The [workflow step](https://www.dotcms.com/docs/latest/managing-workflows#Steps) with which to associate the action. |\n| `actionName` | String | The name of the workflow action. Multiple actions of the same name can coexist with different identifiers. |\n| `whoCanUse` | List of Strings | A list of identifiers representing [users](https://www.dotcms.com/docs/latest/user-management), [role keys](https://www.dotcms.com/docs/latest/adding-roles), or [other user categories](https://www.dotcms.com/docs/latest/managing-workflows#ActionWho) allowed to use this action. This list can be empty. |\n| `actionIcon` | String | The icon to associate with the action. Example: `workflowIcon`. |\n| `actionCommentable` | Boolean | Whether this action supports comments. |\n| `showOn` | List of Strings | List defining under which of the eight valid [workflow states](https://www.dotcms.com/docs/latest/managing-workflows#ActionShow) the action is visible. States must be specified uppercase, such as `NEW` or `LOCKED`. There is no single state for ALL; each state must be listed. |\n| `actionNextStep` | String | The identifier of the step to enter after performing the action; `currentstep` is also a valid value. |\n| `actionNextAssign` | String | A user identifier or role key (such as `CMS Anonymous`) to serve as the default entry in the assignment dropdown. |\n| `actionCondition` | String | [Custom Velocity code](https://www.dotcms.com/docs/latest/managing-workflows#ActionAssign) to be executed along with the action. |\n| `actionAssignable` | Boolean | Whether this action can be assigned. |\n| `actionRoleHierarchyForAssign` | Boolean | If true, non-administrators cannot assign tasks to administrators. |\n| `metadata` | Object | Additional metadata to include in the action definition. |\n\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowActionForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Workflow action created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowActionView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/{contentletId}/comments":{"post":{"tags":["Workflow"],"summary":"Create a workflow comment","description":"Create a [workflow comment].\n\n Returns created workflow comment on success.","operationId":"postSaveScheme","parameters":[{"name":"contentletId","in":"path","description":"Identifier of contentlet to add comment.","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language version of target content.","schema":{"type":"string","default":"-1"}}],"requestBody":{"description":"The request body consists of the following three properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `comment` | String | The workflow comment. |\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCommentForm"}}}},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Copied workflow comment successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityWorkflowCommentView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v1/workflow/system/actions":{"put":{"tags":["Workflow"],"summary":"Save a default system action mapping","description":"This operation allows you to save a [default system action](https://www.dotcms.com/docs/latest/managing-workflows#DefaultActions) mapping. This requires:\n\n1. Selecting a default system action to be mapped;\n2. Specifying a [workflow action](https://www.dotcms.com/docs/latest/managing-workflows#Actions) to be performed when that system action is called;\n3. Associating this mapping with either a [workflow scheme](https://www.dotcms.com/docs/latest/managing-workflows#Schemes) or a [content type](https://www.dotcms.com/docs/latest/content-types).\n\nSee the request body below for further details.","operationId":"putSaveSystemActions","requestBody":{"description":"Body consists of a JSON object with the following properties:\n\n| Property | Type | Description |\n|-|-|-|\n| `systemAction` | String | A default system action, such as `NEW` or `PUBLISH`. |\n| `actionId` | String | The identifier of an action that will be performed by the specified system action. |\n| `schemeId` | String | The identifier of a workflow scheme to be associated with the system action. |\n| `contentTypeVariable` | String | The variable of a content type to be associated with the system action. Note that the content type must already have the schema assigned as one of its valid workflows in order to bind a system action from said schema. |\n\nIf both the `schemeId` and `contentTypeVariable` are specified, the scheme identifier takes precedence, and the content type variable is disregarded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSystemActionForm"}}},"required":true},"responses":{"401":{"description":"Invalid User"},"403":{"description":"Forbidden"},"406":{"description":"Not Acceptable"},"500":{"description":"Internal Server Error"},"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBulkActionsResultView"}}}},"400":{"description":"Bad request"},"415":{"description":"Unsupported Media Type"}}}},"/api/v2/contenttype/{typeIdOrVarName}/fields":{"get":{"operationId":"getContentTypeFields_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"put":{"operationId":"updateFields_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true},"post":{"operationId":"createContentTypeField_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteFields_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}},"deprecated":true}},"/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}":{"get":{"operationId":"getContentTypeFieldById_1","parameters":[{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateContentTypeFieldById_1","parameters":[{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteContentTypeFieldById_1","parameters":[{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}":{"get":{"operationId":"getContentTypeFieldByVar_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"put":{"operationId":"updateContentTypeFieldByVar_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteContentTypeFieldByVar_1","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/{languageId}":{"put":{"operationId":"updateLanguage","parameters":[{"name":"languageId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LanguageForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteLanguage","parameters":[{"name":"languageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/id/{languageid}":{"get":{"operationId":"get_8","parameters":[{"name":"languageid","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/{language}/keys":{"get":{"operationId":"getAllMessages","parameters":[{"name":"language","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/_getdefault":{"get":{"operationId":"getDefaultLanguage","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewLanguage"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewLanguage"}}}}}}},"/api/v2/languages/{languageTag}":{"get":{"operationId":"getFromLanguageTag","parameters":[{"name":"languageTag","in":"path","required":true,"schema":{"type":"string"}},{"name":"strict","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"post":{"operationId":"saveFromLanguageTag","parameters":[{"name":"languageTag","in":"path","required":true,"schema":{"type":"string"}},{"name":"strict","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/iso":{"get":{"operationId":"getIsoLanguagesAndCountries","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/i18n":{"post":{"operationId":"getMessages_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18NForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/variables":{"get":{"operationId":"getVariables","parameters":[{"name":"renderNulls","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages":{"get":{"operationId":"list_13","parameters":[{"name":"contentInode","in":"query","schema":{"type":"string"}},{"name":"countLangVars","in":"query","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"saveLanguage","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LanguageForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/languages/{language}/_makedefault":{"put":{"operationId":"makeDefault_1","parameters":[{"name":"language","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MakeDefaultLangForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v2/tags":{"get":{"operationId":"list_14","parameters":[{"name":"name","in":"query","schema":{"type":"string"}},{"name":"siteId","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}}}}}},"put":{"operationId":"updateTag_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateTagForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}}}}}},"post":{"operationId":"addTag_1","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}}}}}}},"/api/v2/tags/{tagId}":{"delete":{"operationId":"delete_16","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}}}}},"/api/v2/tags/inode/{inode}":{"get":{"operationId":"findTagsByInode_1","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagInodesMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagInodesMapView"}}}}}},"delete":{"operationId":"deleteTagInodesByInode_1","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}}}}},"/api/v2/tags/{nameOrId}":{"get":{"operationId":"getTagsByNameOrId_1","parameters":[{"name":"nameOrId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}}}}}}},"/api/v2/tags/user/{userId}":{"get":{"operationId":"getTagsByUserId_1","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagMapView"}}}}}}},"/api/v2/tags/import":{"post":{"operationId":"importTags_1","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}}}}},"/api/v2/tags/tag/{nameOrId}/inode/{inode}":{"put":{"operationId":"linkTagsAndInode_1","parameters":[{"name":"nameOrId","in":"path","required":true,"schema":{"type":"string"}},{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagInodesMapView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityTagInodesMapView"}}}}}}},"/api/v3/contenttype/{typeIdOrVarName}/fields/allfields":{"get":{"tags":["Content Type Field"],"summary":"Returns filtered Content Type fields","description":"Returns the list of fields in a Content Type that meet the specified criteria.","operationId":"allfields","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["REQUIRED","USER_SEARCHABLE","SYSTEM_INDEXED","SHOW_IN_LIST","UNIQUE"]}}}],"requestBody":{"content":{"application/json":{"examples":{"filter":{"summary":"Filter fields by one or more of the specified criteria","description":"filter","value":"REQUIRED,SYSTEM_INDEXED,UNIQUE,SHOW_IN_LIST,USER_SEARCHABLE"}}}}},"responses":{"200":{"description":"Content type retrieved successfully","content":{"application/json":{"example":{"entity":[{"clazz":"com.dotcms.contenttype.model.field.ImmutableTextField","contentTypeId":"3b70f386cf65117a675f284eea928415","dataType":"TEXT","dbColumn":"text2","defaultValue":null,"fixed":false,"forceIncludeInApi":false,"hint":null,"iDate":1732992811000,"id":"e39533a92ee05d8c083f7e6a1a5ee5e5","indexed":true,"listed":false,"modDate":1732992838000,"name":"Description","owner":null,"readOnly":false,"regexCheck":null,"relationType":null,"required":true,"searchable":false,"sortOrder":3,"unique":true,"values":null,"variable":"description"}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad Request, when using invalid filter names"},"401":{"description":"Invalid User"},"404":{"description":"Content Type was not found"},"500":{"description":"Internal Server Error"}}}},"/api/v3/contenttype/{typeIdOrVarName}/fields":{"get":{"operationId":"getContentTypeFields_2","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}},"delete":{"operationId":"deleteFields_2","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteFieldsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v3/contenttype/{typeIdOrVarName}/fields/move":{"put":{"operationId":"moveFields","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveFieldsForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v3/contenttype/{typeIdOrVarName}/fields/{id}":{"put":{"operationId":"updateField","parameters":[{"name":"typeIdOrVarName","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/es/layout/{params}":{"get":{"operationId":"getLayout_4","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/es/search":{"get":{"operationId":"search_1","parameters":[{"name":"depth","in":"query","schema":{"type":"string"}},{"name":"live","in":"query","schema":{"type":"boolean"}},{"name":"allCategoriesInfo","in":"query","schema":{"type":"boolean"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"searchPost","parameters":[{"name":"depth","in":"query","schema":{"type":"string"}},{"name":"live","in":"query","schema":{"type":"boolean"}},{"name":"allCategoriesInfo","in":"query","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/es/raw":{"get":{"operationId":"searchRawGet","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"searchRaw","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/personas/layout/{params}":{"get":{"operationId":"getLayout_5","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/html":{}}}}}},"/api/personas/sites/{id}":{"get":{"operationId":"list_15","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Persona"}}},"application/javascript":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Persona"}}}}}}}},"/api/v1/telemetry/stats":{"get":{"summary":"Retrieves dotCMS usage data","operationId":"getData","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMetricsSnapshotView"}}}}}}},"/api/releasenotes/component/{componentId}":{"get":{"operationId":"getComponentsById","parameters":[{"name":"componentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"componentIndex","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"numberOfComponents","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentList"}}}}}}},"/api/releasenotes/main":{"get":{"operationId":"getReleaseNotesMain","parameters":[{"name":"componentIndex","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"numberOfComponents","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentList"}}}}}}},"/api/releasenotes/publish/{releaseName}":{"post":{"operationId":"publish_3","parameters":[{"name":"releaseName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}},"/api/releasenotes/unpublish/{releaseName}":{"post":{"operationId":"unpublish_2","parameters":[{"name":"releaseName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}}},"components":{"schemas":{"CompletionsForm":{"type":"object","properties":{"prompt":{"maxLength":4096,"minLength":1,"type":"string"},"searchLimit":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"searchOffset":{"minimum":0,"type":"integer","format":"int32"},"responseLengthTokens":{"minimum":128,"type":"integer","format":"int32"},"language":{"type":"integer","format":"int64"},"stream":{"type":"boolean"},"fieldVar":{"type":"string"},"indexName":{"type":"string"},"contentType":{"type":"array","items":{"type":"string"}},"threshold":{"type":"number","format":"float"},"temperature":{"maximum":2,"minimum":0,"type":"number","format":"float"},"model":{"type":"string"},"operator":{"type":"string"},"site":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}}},"Role":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"roleKey":{"type":"string"},"parent":{"type":"string"},"editPermissions":{"type":"boolean"},"editUsers":{"type":"boolean"},"editLayouts":{"type":"boolean"},"locked":{"type":"boolean"},"system":{"type":"boolean"},"roleChildren":{"type":"array","items":{"type":"string"}},"dbfqn":{"type":"string"},"fqn":{"type":"string"},"user":{"type":"boolean"}}},"User":{"type":"object","properties":{"modificationDate":{"type":"string","format":"date-time"},"recipientName":{"type":"string"},"actualCompanyId":{"type":"string"},"passwordExpired":{"type":"boolean"},"recipientAddress":{"type":"string"},"multipleRecipients":{"type":"boolean"},"recipientInternetAddress":{"type":"string"},"anonymousUser":{"type":"boolean"},"userRole":{"$ref":"#/components/schemas/Role"},"languageId":{"type":"string"},"timeZoneId":{"type":"string"},"companyId":{"type":"string"},"resolution":{"type":"string"},"refreshRate":{"type":"string"},"defaultUser":{"type":"boolean"},"female":{"type":"boolean"},"recipientId":{"type":"string"},"timeZone":{"type":"object","properties":{"dstsavings":{"type":"integer","format":"int32"},"rawOffset":{"type":"integer","format":"int32"},"id":{"type":"string"},"displayName":{"type":"string"}}},"locale":{"type":"object","properties":{"script":{"type":"string"},"country":{"type":"string"},"variant":{"type":"string"},"unicodeLocaleAttributes":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"unicodeLocaleKeys":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"displayLanguage":{"type":"string"},"displayScript":{"type":"string"},"displayCountry":{"type":"string"},"displayVariant":{"type":"string"},"displayName":{"type":"string"},"extensionKeys":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"iso3Language":{"type":"string"},"iso3Country":{"type":"string"},"language":{"type":"string"}}},"fullName":{"type":"string"},"lastLoginDate":{"type":"string","format":"date-time"},"failedLoginAttempts":{"type":"integer","format":"int32"},"agreedToTermsOfUse":{"type":"boolean"},"deleteInProgress":{"type":"boolean"},"passwordReset":{"type":"boolean"},"passwordEncrypted":{"type":"boolean"},"favoriteActivity":{"type":"string"},"favoriteBibleVerse":{"type":"string"},"favoriteFood":{"type":"string"},"favoriteMovie":{"type":"string"},"favoriteMusic":{"type":"string"},"roundedSkins":{"type":"boolean"},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}},"passwordExpirationDate":{"type":"string","format":"date-time"},"emailAddress":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"skinId":{"type":"string"},"active":{"type":"boolean"},"layoutIds":{"type":"string"},"middleName":{"type":"string"},"nickName":{"type":"string"},"birthday":{"type":"string","format":"date-time"},"male":{"type":"boolean"},"createDate":{"type":"string","format":"date-time"},"comments":{"type":"string"},"userId":{"type":"string"},"loginDate":{"type":"string","format":"date-time"},"loginIP":{"type":"string"},"lastLoginIP":{"type":"string"},"deleteDate":{"type":"string","format":"date-time"},"smsId":{"type":"string"},"aimId":{"type":"string"},"icqId":{"type":"string"},"msnId":{"type":"string"},"ymId":{"type":"string"},"dottedSkins":{"type":"boolean"},"greeting":{"type":"string"},"password":{"type":"string"},"modified":{"type":"boolean"},"new":{"type":"boolean"}}},"JSONObject":{"type":"object","properties":{"asMap":{"type":"object","additionalProperties":{"type":"object"}},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"EmbeddingsForm":{"type":"object","properties":{"query":{"maxLength":4096,"minLength":1,"type":"string"},"limit":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"offset":{"minimum":0,"type":"integer","format":"int32"},"indexName":{"type":"string"},"model":{"type":"string"},"velocityTemplate":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"userId":{"type":"string"}}},"AIImageRequestDTO":{"type":"object","properties":{"prompt":{"type":"string"},"numberOfImages":{"type":"integer","format":"int32"},"size":{"type":"string"},"model":{"type":"string"}}},"BodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"ContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"FormDataBodyPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"formDataContentDisposition":{"$ref":"#/components/schemas/FormDataContentDisposition"},"simple":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"FormDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"FormDataMultiPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"fields":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/FormDataBodyPart"}}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"MessageBodyWorkers":{"type":"object"},"MultiPart":{"type":"object","properties":{"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"$ref":"#/components/schemas/MessageBodyWorkers"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ParameterizedHeader"}}}}},"ParameterizedHeader":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"DeleteBundlesByIdentifierForm":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"string"}}}},"GenerateBundleForm":{"type":"object","properties":{"bundleId":{"type":"string"},"operation":{"type":"string","enum":["PUBLISH","UNPUBLISH"]},"filterKey":{"type":"string"}}},"SearchForm":{"type":"object","properties":{"query":{"type":"string"},"sort":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"userId":{"type":"string"},"render":{"type":"string"},"depth":{"type":"integer","format":"int32"},"languageId":{"type":"integer","format":"int64"},"allCategoriesInfo":{"type":"boolean"}}},"Environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"pushToAll":{"type":"boolean"},"permissionId":{"type":"string"},"owner":{"type":"string"}}},"ErrorEntity":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}}},"MessageEntity":{"type":"object","properties":{"message":{"type":"string"}}},"Pagination":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalEntries":{"type":"integer","format":"int64"}}},"ResponseEntityEnvironmentView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/Environment"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ForbiddenException":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"response":{"type":"object","properties":{"entityTag":{"type":"object","properties":{"value":{"type":"string"},"weak":{"type":"boolean"}}},"allowedMethods":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"links":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"uriBuilder":{"type":"object"},"rels":{"type":"array","items":{"type":"string"}},"rel":{"type":"string"},"params":{"type":"object","additionalProperties":{"type":"string"}},"uri":{"type":"string","format":"uri"},"type":{"type":"string"},"title":{"type":"string"}}}},"stringHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"statusInfo":{"type":"object","properties":{"reasonPhrase":{"type":"string"},"statusCode":{"type":"integer","format":"int32"},"family":{"type":"string","enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"]}}},"cookies":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"version":{"type":"integer","format":"int32"},"path":{"type":"string"},"domain":{"type":"string"},"comment":{"type":"string"},"maxAge":{"type":"integer","format":"int32"},"expiry":{"type":"string","format":"date-time"},"secure":{"type":"boolean"},"httpOnly":{"type":"boolean"}}}},"lastModified":{"type":"string","format":"date-time"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"metadata":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"entity":{"type":"object"},"date":{"type":"string","format":"date-time"},"length":{"type":"integer","format":"int32"},"location":{"type":"string","format":"uri"},"language":{"type":"object","properties":{"script":{"type":"string"},"country":{"type":"string"},"variant":{"type":"string"},"unicodeLocaleAttributes":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"unicodeLocaleKeys":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"displayLanguage":{"type":"string"},"displayScript":{"type":"string"},"displayCountry":{"type":"string"},"displayVariant":{"type":"string"},"displayName":{"type":"string"},"extensionKeys":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"iso3Language":{"type":"string"},"iso3Country":{"type":"string"},"language":{"type":"string"}}},"status":{"type":"integer","format":"int32"}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"EnvironmentForm":{"required":["name","pushMode"],"type":"object","properties":{"name":{"type":"string"},"pushMode":{"type":"string","enum":["PUSH_TO_ONE","PUSH_TO_ALL"]},"whoCanSend":{"type":"array","items":{"type":"string"}}}},"ResponseEntityBooleanView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"boolean"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"DoesNotExistException":{"type":"object","properties":{"cause":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"suppressed":{"type":"array","items":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"className":{"type":"string"},"nativeMethod":{"type":"boolean"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}}},"localizedMessage":{"type":"string"}}},"ResponseEntityEnvironmentsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/Environment"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"DeletePPQueueElementsByIdentifierForm":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"string"}}}},"RestTag":{"type":"object","properties":{"label":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"persona":{"type":"boolean"},"id":{"type":"string"}}},"TagForm":{"required":["tags"],"type":"object","properties":{"tags":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestTag"}},"ownerId":{"type":"string"}}},"UpdateTagForm":{"required":["siteId","tagId","tagName"],"type":"object","properties":{"siteId":{"type":"string"},"tagName":{"type":"string"},"tagId":{"type":"string"}}},"AccessibilityForm":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"ResponseEntityStringView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"string"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ReportResponseEntityView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"AnalyticsQuery":{"type":"object","properties":{"dimensions":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"measures":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"filters":{"type":"string"},"limit":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"timeDimensions":{"type":"string"},"order":{"type":"string"}}},"QueryForm":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/AnalyticsQuery"}}},"Announcement":{"type":"object","properties":{"identifier":{"type":"string"},"inode":{"type":"string"},"languageId":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"announcementDate":{"type":"string","format":"date-time"},"announcementDateAsISO8601":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"modDateAsISO8601":{"type":"string"}}},"ResponseEntityViewListAnnouncement":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/Announcement"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SecretForm":{"type":"object"},"DeleteSecretForm":{"required":["key","params","siteId"],"type":"object","properties":{"key":{"type":"string"},"siteId":{"type":"string"},"params":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"ExportSecretForm":{"required":["appKeysBySite","exportAll","password"],"type":"object","properties":{"password":{"type":"string"},"exportAll":{"type":"boolean"},"appKeys":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"writeOnly":true},"appKeysBySite":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}},"AssetInfoRequestForm":{"type":"object","properties":{"assetPath":{"type":"string"}}},"AssetsRequestForm":{"type":"object","properties":{"assetPath":{"type":"string"},"language":{"type":"string"},"live":{"type":"boolean"}}},"FileUploadDetail":{"type":"object","properties":{"assetPath":{"type":"string"},"language":{"type":"string"},"status":{"type":"boolean","writeOnly":true},"live":{"type":"boolean"}}},"RemoteAPITokenForm":{"type":"object","properties":{"tokenInfo":{"type":"object","additionalProperties":{"type":"object"}}}},"ApiTokenForm":{"type":"object","properties":{"userId":{"type":"string"},"expirationSeconds":{"type":"integer","format":"int32"},"network":{"type":"string"},"claims":{"type":"object","additionalProperties":{"type":"object"}},"shouldBeAdmin":{"type":"boolean"}}},"AuthenticationForm":{"required":["password","userId"],"type":"object","properties":{"userId":{"type":"string"},"password":{"type":"string"},"rememberMe":{"type":"boolean"},"backEndLogin":{"type":"boolean"},"language":{"type":"string"},"country":{"type":"string"}}},"ResponseEntityUserMapView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/AuthenticationForm"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityUserView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/AuthenticationForm"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ForgotPasswordForm":{"required":["userId"],"type":"object","properties":{"userId":{"type":"string"}}},"I18NForm":{"type":"object","properties":{"language":{"type":"string"},"country":{"type":"string"},"messagesKey":{"type":"array","items":{"type":"string"}}}},"ResetPasswordForm":{"required":["password","token"],"type":"object","properties":{"token":{"type":"string"},"password":{"type":"string"}}},"BrowserQueryForm":{"type":"object","properties":{"hostFolderId":{"type":"string"},"filter":{"type":"string"},"sortBy":{"type":"string"},"offset":{"type":"integer","format":"int32"},"maxResults":{"type":"integer","format":"int32"},"showWorking":{"type":"boolean"},"showArchived":{"type":"boolean"},"showFolders":{"type":"boolean"},"showFiles":{"type":"boolean"},"showPages":{"type":"boolean"},"sortByDesc":{"type":"boolean"},"showLinks":{"type":"boolean"},"showDotAssets":{"type":"boolean"},"languageId":{"type":"integer","format":"int64"},"extensions":{"type":"array","items":{"type":"string"}},"mimeTypes":{"type":"array","items":{"type":"string"}}}},"OpenFolderForm":{"type":"object","properties":{"path":{"type":"string"}}},"HierarchyShortCategoriesResponseView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyShortCategory"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"HierarchyShortCategory":{"type":"object","properties":{"inode":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"parentList":{"type":"array","items":{"$ref":"#/components/schemas/ShortCategory"}}}},"ShortCategory":{"type":"object","properties":{"name":{"type":"string"},"inode":{"type":"string"},"key":{"type":"string"}}},"CategoryKeysForm":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}}}},"CategoryEditForm":{"type":"object","properties":{"filter":{"type":"string"},"page":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"direction":{"type":"string"},"orderBy":{"type":"string"},"siteId":{"type":"string"},"parentInode":{"type":"string"},"categoryData":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"CategoryForm":{"required":["categoryName"],"type":"object","properties":{"siteId":{"type":"string"},"inode":{"type":"string"},"parent":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"string"},"key":{"type":"string"},"categoryName":{"type":"string"},"active":{"type":"boolean"},"sortOrder":{"type":"integer","format":"int32"},"categoryVelocityVarName":{"type":"string"}}},"Container":{"type":"object","properties":{"getiDate":{"type":"string","format":"date-time"},"type":{"type":"string"},"owner":{"type":"string"},"inode":{"type":"string"},"identifier":{"type":"string"},"source":{"type":"string","enum":["UNKNOWN","DB","FILE"]},"title":{"type":"string"},"friendlyName":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"modUser":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"showOnMenu":{"type":"boolean"},"code":{"type":"string"},"maxContentlets":{"type":"integer","format":"int32"},"useDiv":{"type":"boolean"},"preLoop":{"type":"string"},"postLoop":{"type":"string"},"notes":{"type":"string"},"parentPermissionable":{"$ref":"#/components/schemas/Permissionable"},"permissionId":{"type":"string"},"archived":{"type":"boolean"},"versionType":{"type":"string"},"versionId":{"type":"string"},"working":{"type":"boolean"},"deleted":{"type":"boolean"},"live":{"type":"boolean"},"name":{"type":"string"},"locked":{"type":"boolean"},"permissionType":{"type":"string"},"idate":{"type":"string","format":"date-time"},"categoryId":{"type":"string"},"new":{"type":"boolean"},"parents":{"type":"array","writeOnly":true,"items":{"type":"object"}}}},"Permissionable":{"type":"object","properties":{"permissionId":{"type":"string"},"permissionType":{"type":"string"},"parentPermissionable":{"$ref":"#/components/schemas/Permissionable"},"owner":{"type":"string"}}},"ResponseEntityContainerView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/Container"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ContainerForm":{"type":"object","properties":{"identifier":{"type":"string"},"title":{"type":"string"},"friendlyName":{"type":"string"},"maxContentlets":{"type":"integer","format":"int32"},"code":{"type":"string"},"notes":{"type":"string"},"preLoop":{"type":"string"},"postLoop":{"type":"string"},"showOnMenu":{"type":"boolean"},"sortOrder":{"type":"integer","format":"int32"},"sortContentletsBy":{"type":"string"},"structureInode":{"type":"string"},"containerStructures":{"type":"array","items":{"$ref":"#/components/schemas/ContainerStructure"}},"owner":{"type":"string"},"hostId":{"type":"string"},"staticify":{"type":"boolean"},"useDiv":{"type":"boolean"},"dynamic":{"type":"boolean"}}},"ContainerStructure":{"type":"object","properties":{"id":{"type":"string"},"structureId":{"type":"string"},"containerInode":{"type":"string"},"containerId":{"type":"string"},"code":{"type":"string"},"contentTypeVar":{"type":"string"}}},"ContentReportView":{"type":"object","properties":{"contentTypeName":{"type":"string"},"entries":{"type":"integer","format":"int64"}}},"ResponseSiteVariablesEntityView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/SiteVariableView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SiteVariableView":{"type":"object","properties":{"id":{"type":"string"},"hostId":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"lastModifierId":{"type":"string"},"lastModDate":{"type":"string","format":"date-time"},"lastModifierFullName":{"type":"string"}}},"ExistingLanguagesForContentletView":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"ResponseEntityViewListExistingLanguagesForContentletView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/ExistingLanguagesForContentletView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"CountView":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}}},"ResponseEntityCountView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/CountView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ContainerView":{"type":"object","properties":{"container":{"$ref":"#/components/schemas/Container"},"path":{"type":"string"}}},"ContentReferenceView":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/IHTMLPage"},"container":{"$ref":"#/components/schemas/ContainerView"},"personaName":{"type":"string"}}},"IHTMLPage":{"type":"object","properties":{"redirect":{"type":"string"},"seoKeywords":{"type":"string"},"pageUrl":{"type":"string"},"templateId":{"type":"string"},"menuOrder":{"type":"integer","format":"int32"},"httpsRequired":{"type":"boolean"},"seoDescription":{"type":"string"},"cacheTTL":{"type":"integer","format":"int64"},"friendlyName":{"type":"string"},"languageId":{"type":"integer","format":"int64"},"showOnMenu":{"type":"boolean"},"title":{"type":"string"},"identifier":{"type":"string"},"inode":{"type":"string"},"metadata":{"type":"string"},"map":{"type":"object","additionalProperties":{"type":"object"}},"content":{"type":"boolean"},"uri":{"type":"string"},"host":{"type":"string"},"archived":{"type":"boolean"},"versionType":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"working":{"type":"boolean"},"modUser":{"type":"string"},"live":{"type":"boolean"},"locked":{"type":"boolean"},"permissionId":{"type":"string"},"permissionType":{"type":"string"},"parentPermissionable":{"$ref":"#/components/schemas/Permissionable"},"owner":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"ResponseEntityViewListContentReferenceView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/ContentReferenceView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"object"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"PullRelatedForm":{"required":["fieldVariable","identifier","limit","offset","orderBy"],"type":"object","properties":{"fieldVariable":{"type":"string"},"identifier":{"type":"string"},"condition":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"orderBy":{"type":"string"}}},"ResponseEntityContentletView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"object","additionalProperties":{"type":"object"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ContentForm":{"type":"object","properties":{"contentlet":{"type":"object","additionalProperties":{"type":"object"}}}},"ErrorDetail":{"type":"object","properties":{"message":{"type":"string"},"exceptionClass":{"type":"string"},"stackTrace":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"processingStage":{"type":"string"}}},"ImmutableListJob":{"type":"array","properties":{"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/Job"},"last":{"$ref":"#/components/schemas/Job"}},"items":{"$ref":"#/components/schemas/Job"}},"ImmutableMapStringObject":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"Job":{"type":"object","properties":{"id":{"type":"string"},"queueName":{"type":"string"},"state":{"type":"string","enum":["PENDING","RUNNING","SUCCESS","FAILED","FAILED_PERMANENTLY","ABANDONED","ABANDONED_PERMANENTLY","CANCEL_REQUESTED","CANCELLING","CANCELED"]},"executionNode":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"result":{"$ref":"#/components/schemas/JobResult"},"parameters":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"object"}},"retryCount":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"}}},"JobPaginatedResult":{"type":"object","properties":{"jobs":{"type":"array","properties":{"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/Job"},"last":{"$ref":"#/components/schemas/Job"}},"items":{"$ref":"#/components/schemas/Job"}},"total":{"type":"integer","format":"int64"},"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"JobResult":{"type":"object","properties":{"errorDetail":{"$ref":"#/components/schemas/ErrorDetail"},"metadata":{"type":"object","additionalProperties":{"type":"object"}}}},"ResponseEntityJobPaginatedResultView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/JobPaginatedResult"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityViewJobPaginatedResult":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/JobPaginatedResult"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityViewString":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"string"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityJobView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/Job"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityViewJob":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/Job"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ContentImportParamsSchema":{"required":["file","form"],"type":"object","properties":{"file":{"type":"string","description":"The CSV file to import.","format":"binary"},"form":{"type":"string","description":"JSON string representing import settings.","example":"{\"contentType\":\"activity\",\"language\":\"en-US\",\"workflowActionId\":\"b9d89c80-3d88-4311-8365-187323c96436\",\"fields\":[\"e1f99107-fd0e-49d4-a099-1cc10aa284d8\"]}"}},"description":"Schema for content import parameters."},"ContentImportForm":{"required":["contentType","workflowActionId"],"type":"object","properties":{"contentType":{"type":"string"},"language":{"type":"string"},"workflowActionId":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}}}},"EventOutput":{"type":"object","properties":{"type":{"type":"object","properties":{"typeName":{"type":"string"}}},"closed":{"type":"boolean"}}},"CopyContentTypeForm":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"variable":{"type":"string"},"folder":{"type":"string"},"host":{"type":"string"},"icon":{"type":"string"}}},"ContentType":{"required":["clazz"],"type":"object","properties":{"owner":{"type":"string"},"clazz":{"type":"string"}},"discriminator":{"propertyName":"clazz"}},"ContentTypeForm":{"type":"object","properties":{"requestJson":{"type":"object"},"systemActions":{"type":"array","items":{"$ref":"#/components/schemas/Tuple2SystemActionString"}},"iterable":{"type":"object"},"workflows":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowFormEntry"}},"contentType":{"$ref":"#/components/schemas/ContentType"}}},"DotAssetContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"FileAssetContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"FormContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"},"multilingualable":{"type":"boolean"}}}]},"KeyValueContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"},"multilingualable":{"type":"boolean"}}}]},"PageContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"PersonaContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"SimpleContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"Tuple2SystemActionString":{"type":"object","properties":{"_1":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]},"_2":{"type":"string"}}},"VanityUrlContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"multilingualable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"}}}]},"WidgetContentType":{"type":"object","allOf":[{"$ref":"#/components/schemas/ContentType"},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"defaultType":{"type":"boolean"},"detailPage":{"type":"string"},"fixed":{"type":"boolean"},"iDate":{"type":"string","format":"date-time"},"system":{"type":"boolean"},"versionable":{"type":"boolean"},"variable":{"type":"string"},"urlMapPattern":{"type":"string"},"publishDateVar":{"type":"string"},"expireDateVar":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"host":{"type":"string"},"siteName":{"type":"string"},"icon":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"folder":{"type":"string"},"folderPath":{"type":"string"},"multilingualable":{"type":"boolean"}}}]},"WorkflowFormEntry":{"type":"object","properties":{"id":{"type":"string"},"variableName":{"type":"string"}}},"FilteredContentTypesForm":{"type":"object","properties":{"filter":{"type":"object","additionalProperties":{"type":"object"}},"page":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"orderBy":{"type":"string"},"direction":{"type":"string"}}},"Condition":{"type":"object","properties":{"parameter":{"type":"string"},"operator":{"type":"string","enum":["EQUALS","CONTAINS","EXISTS"]},"value":{"type":"object"}}},"Experiment":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"status":{"type":"string","enum":["RUNNING","SCHEDULED","ENDED","DRAFT","ARCHIVED"]},"trafficProportion":{"$ref":"#/components/schemas/TrafficProportion"},"scheduling":{"$ref":"#/components/schemas/Scheduling"},"trafficAllocation":{"type":"number","format":"float"},"creationDate":{"type":"string","format":"date-time"},"modDate":{"type":"string","format":"date-time"},"pageId":{"type":"string"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"goals":{"$ref":"#/components/schemas/Goals"},"targetingConditions":{"type":"array","items":{"$ref":"#/components/schemas/TargetingCondition"}},"lookBackWindowExpireTime":{"type":"integer","format":"int64"},"runningIds":{"$ref":"#/components/schemas/RunningIds"}}},"ExperimentVariant":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"weight":{"type":"number","format":"float"},"url":{"type":"string"},"promoted":{"type":"boolean"}}},"Goal":{"type":"object","properties":{"metric":{"$ref":"#/components/schemas/Metric"},"type":{"type":"string","writeOnly":true,"enum":["MINIMIZE","MAXIMIZE"]}}},"Goals":{"type":"object","properties":{"primary":{"$ref":"#/components/schemas/Goal"}}},"ImmutableListCondition":{"type":"array","properties":{"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/Condition"},"last":{"$ref":"#/components/schemas/Condition"}},"items":{"$ref":"#/components/schemas/Condition"}},"ImmutableMapStringString":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"Metric":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string","enum":["DIFFERENTIATING_FEATURES","PAID_FEATURES","PLATFORM_SPECIFIC_CUSTOMIZATION","SOPHISTICATED_CONTENT_ARCHITECTURE","POSITIVE_USER_EXPERIENCE","PLATFORM_SPECIFIC_DEVELOPMENT","RECENT_ACTIVITY","HISTORY_LEGACY_DEPRECATED_FEATURES"]},"feature":{"type":"string","enum":["CONTENTLETS","LANGUAGES","CONTENT_TYPES","SITES","URL_MAPS","WORKFLOW","USERS","SITE_SEARCH","IMAGE_API","LAYOUT","CONTENT_TYPE_FIELDS"]}}},"ResponseEntitySingleExperimentView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/Experiment"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"RunningId":{"type":"object","properties":{"id":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"RunningIds":{"type":"object","properties":{"ids":{"type":"array","items":{"$ref":"#/components/schemas/RunningId"}}}},"Scheduling":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"TargetingCondition":{"type":"object","properties":{"id":{"type":"string"},"conditionKey":{"type":"string"},"values":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"operator":{"type":"string","enum":["AND","OR"]}}},"TrafficProportion":{"type":"object","properties":{"type":{"type":"string","enum":["SPLIT_EVENLY","CUSTOM_PERCENTAGES"]},"variants":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ExperimentVariant"}}}},"AddVariantForm":{"type":"object","properties":{"description":{"type":"string"}}},"ResponseEntityExperimentView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/Experiment"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ExperimentForm":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"pageId":{"type":"string"},"trafficAllocation":{"type":"number","format":"float"},"trafficProportion":{"$ref":"#/components/schemas/TrafficProportion"},"scheduling":{"$ref":"#/components/schemas/Scheduling"},"goals":{"$ref":"#/components/schemas/Goals"},"targetingConditions":{"type":"array","items":{"$ref":"#/components/schemas/TargetingCondition"}},"lookbackWindow":{"type":"integer","format":"int32"}}},"BayesianResult":{"type":"object","properties":{"value":{"type":"number","format":"double"},"results":{"type":"array","properties":{"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/VariantResult"},"last":{"$ref":"#/components/schemas/VariantResult"}},"items":{"$ref":"#/components/schemas/VariantResult"}},"distributionPdfs":{"$ref":"#/components/schemas/SampleGroup"},"differenceData":{"$ref":"#/components/schemas/DifferenceData"},"quantiles":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/QuantilePair"}},"suggestedWinner":{"type":"string"}}},"CredibilityInterval":{"type":"object","properties":{"lower":{"type":"number","format":"double"},"upper":{"type":"number","format":"double"}}},"DifferenceData":{"type":"object","properties":{"controlData":{"type":"array","items":{"type":"number","format":"double"}},"testData":{"type":"array","items":{"type":"number","format":"double"}},"differences":{"type":"array","items":{"type":"number","format":"double"}},"relativeDifference":{"type":"number","format":"double"}}},"ExperimentResults":{"type":"object","properties":{"sessions":{"$ref":"#/components/schemas/TotalSession"},"goals":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GoalResults"}},"bayesianResult":{"$ref":"#/components/schemas/BayesianResult"}}},"GoalResults":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/Goal"},"variants":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/VariantResults"}}}},"ImmutableListVariantResult":{"type":"array","properties":{"empty":{"type":"boolean"},"first":{"$ref":"#/components/schemas/VariantResult"},"last":{"$ref":"#/components/schemas/VariantResult"}},"items":{"$ref":"#/components/schemas/VariantResult"}},"ImmutableMapDoubleQuantilePair":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/QuantilePair"}},"ImmutableMapStringListSampleData":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/SampleData"}}},"QuantilePair":{"type":"object","properties":{"quantile":{"type":"number","format":"double"},"formatted":{"type":"number","format":"double"}}},"ResponseEntityExperimentResults":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/ExperimentResults"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResultResumeItem":{"type":"object","properties":{"uniqueBySession":{"type":"integer","format":"int64"},"totalSessions":{"type":"integer","format":"int64"},"conversionRate":{"type":"number","format":"float"}}},"SampleData":{"type":"object","properties":{"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"}}},"SampleGroup":{"type":"object","properties":{"samples":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/SampleData"}}}}},"TotalSession":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"variants":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}},"UniqueBySessionResume":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"conversionRate":{"type":"number","format":"float"}}},"VariantResult":{"type":"object","properties":{"variant":{"type":"string"},"conversionRate":{"type":"number","format":"double"},"probability":{"type":"number","format":"double"},"expectedLoss":{"type":"number","format":"double"},"risk":{"type":"number","format":"double"},"medianGrowth":{"type":"number","format":"double"},"credibilityInterval":{"$ref":"#/components/schemas/CredibilityInterval"},"isControl":{"type":"boolean"}}},"VariantResults":{"type":"object","properties":{"weight":{"type":"number","format":"float"},"variantName":{"type":"string"},"variantDescription":{"type":"string"},"uniqueBySession":{"$ref":"#/components/schemas/UniqueBySessionResume"},"details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResultResumeItem"}}}},"LookBackWindow":{"type":"object","properties":{"value":{"type":"string"},"expireMillis":{"type":"integer","format":"int64"}}},"ResponseEntityExperimentSelectedView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/SelectedExperiments"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SelectedExperiment":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"runningId":{"type":"string"},"pageUrl":{"type":"string"},"variant":{"$ref":"#/components/schemas/SelectedVariant"},"lookBackWindow":{"$ref":"#/components/schemas/LookBackWindow"},"regexs":{"type":"object","additionalProperties":{"type":"string"}}}},"SelectedExperiments":{"type":"object","properties":{"experiments":{"type":"array","items":{"$ref":"#/components/schemas/SelectedExperiment"}},"includedExperimentIds":{"type":"array","items":{"type":"string"}},"excludedExperimentIds":{"type":"array","items":{"type":"string"}},"excludedExperimentIdsEnded":{"type":"array","items":{"type":"string"}}}},"SelectedVariant":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}},"ExcludedExperimentListForm":{"type":"object","properties":{"exclude":{"type":"array","items":{"type":"string"}}}},"ExperimentVariantForm":{"type":"object","properties":{"description":{"type":"string"}}},"SearchByPathForm":{"type":"object","properties":{"path":{"type":"string"}}},"ResponseEntityViewSetString":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"RestLanguage":{"type":"object","properties":{"name":{"type":"string"}}},"DeleteForm":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}}}},"ResponseEntityListView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"type":"object"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityListViewString":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"type":"string"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"BundleMap":{"type":"object","properties":{"bundleId":{"type":"integer","format":"int64"},"symbolicName":{"type":"string"},"location":{"type":"string"},"jarFile":{"type":"string"},"state":{"type":"integer","format":"int32"},"version":{"type":"string"},"separator":{"type":"string"},"system":{"type":"boolean"}}},"ResponseEntityBundleListView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/BundleMap"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ExtraPackagesForm":{"required":["packages"],"type":"object","properties":{"packages":{"type":"string"}}},"ContainerEntry":{"type":"object","properties":{"personaTag":{"type":"string"},"contentIds":{"type":"array","items":{"type":"string"}},"containerUUID":{"type":"string"},"containerId":{"type":"string"}}},"PageContainerForm":{"type":"object","properties":{"requestJson":{"type":"string"},"containerEntries":{"type":"array","items":{"$ref":"#/components/schemas/ContainerEntry"}}}},"PageCheckPermissionForm":{"type":"object","properties":{"type":{"type":"string","enum":["NONE","READ","USE","EDIT","WRITE","PUBLISH","EDIT_PERMISSIONS","CAN_ADD_CHILDREN"]},"hostId":{"type":"string"},"languageId":{"type":"integer","format":"int64"},"path":{"type":"string"}}},"ResponseEntityViewMapStringObject":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"object","additionalProperties":{"type":"object"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"CopyContentletForm":{"type":"object","properties":{"contentId":{"type":"string"},"pageId":{"type":"string"},"containerId":{"type":"string"},"relationType":{"type":"string"},"personalization":{"type":"string"},"variantId":{"type":"string"},"treeOrder":{"type":"integer","format":"int32"}}},"ActionInputView":{"type":"object","properties":{"id":{"type":"string"},"body":{"type":"object","additionalProperties":{"type":"object"}}}},"PageWorkflowActionsView":{"type":"object","properties":{"page":{"type":"object","additionalProperties":{"type":"object"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionView"}}}},"ResponseEntityPageWorkflowActionsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/PageWorkflowActionsView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowActionView":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"schemeId":{"type":"string"},"condition":{"type":"string"},"nextStep":{"type":"string"},"nextAssign":{"type":"string"},"icon":{"type":"string"},"roleHierarchyForAssign":{"type":"boolean"},"assignable":{"type":"boolean"},"commentable":{"type":"boolean"},"order":{"type":"integer","format":"int32"},"saveActionlet":{"type":"boolean","writeOnly":true},"publishActionlet":{"type":"boolean","writeOnly":true},"unpublishActionlet":{"type":"boolean","writeOnly":true},"archiveActionlet":{"type":"boolean","writeOnly":true},"pushPublishActionlet":{"type":"boolean","writeOnly":true},"onlyBatchActionlet":{"type":"boolean","writeOnly":true},"unarchiveActionlet":{"type":"boolean","writeOnly":true},"deleteActionlet":{"type":"boolean","writeOnly":true},"destroyActionlet":{"type":"boolean","writeOnly":true},"moveActionlet":{"type":"boolean","writeOnly":true},"commentActionlet":{"type":"boolean","writeOnly":true},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"resetable":{"type":"boolean","writeOnly":true},"actionInputs":{"type":"array","items":{"$ref":"#/components/schemas/ActionInputView"}},"nextStepCurrentStep":{"type":"boolean"},"moveActionletHashPath":{"type":"boolean","writeOnly":true},"owner":{"type":"string"},"showOn":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["NEW","LOCKED","UNLOCKED","PUBLISHED","UNPUBLISHED","ARCHIVED","LISTING","EDITING"]}},"hasOnlyBatchActionlet":{"type":"boolean"},"hasPublishActionlet":{"type":"boolean"},"hasUnpublishActionlet":{"type":"boolean"},"hasArchiveActionlet":{"type":"boolean"},"hasUnarchiveActionlet":{"type":"boolean"},"hasDeleteActionlet":{"type":"boolean"},"hasDestroyActionlet":{"type":"boolean"},"hasCommentActionlet":{"type":"boolean"},"hasResetActionlet":{"type":"boolean"},"hasPushPublishActionlet":{"type":"boolean"},"hasMoveActionletActionlet":{"type":"boolean"},"hasSaveActionlet":{"type":"boolean"},"hasMoveActionletHasPathActionlet":{"type":"boolean"}}},"FindAvailableActionsForm":{"type":"object","properties":{"renderMode":{"type":"string","enum":["EDITING","LISTING"]},"hostId":{"type":"string"},"languageId":{"type":"integer","format":"int64"},"path":{"type":"string"}}},"MulitreeView":{"type":"object","properties":{"pageId":{"type":"string"},"containerId":{"type":"string"},"contentId":{"type":"string"},"relationType":{"type":"string"},"treeOrder":{"type":"integer","format":"int32"},"personalization":{"type":"string"},"variantId":{"type":"string"}}},"ResponseEntityViewListMulitreeView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/MulitreeView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"Body":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/TemplateLayoutRow"}}}},"ContainerUUID":{"type":"object","properties":{"identifier":{"type":"string"},"uuid":{"type":"string"},"historyUUIDs":{"type":"array","items":{"type":"string"}}}},"PageForm":{"type":"object","properties":{"themeId":{"type":"string"},"title":{"type":"string"},"siteId":{"type":"string"},"layout":{"$ref":"#/components/schemas/TemplateLayout"},"anonymousLayout":{"type":"boolean"}}},"Sidebar":{"type":"object","properties":{"containers":{"type":"array","items":{"$ref":"#/components/schemas/ContainerUUID"}},"location":{"type":"string"},"width":{"type":"string"},"widthPercent":{"type":"integer","format":"int32"},"preview":{"type":"boolean"}}},"TemplateLayout":{"type":"object","properties":{"width":{"type":"string"},"title":{"type":"string"},"header":{"type":"boolean"},"footer":{"type":"boolean"},"body":{"$ref":"#/components/schemas/Body"},"sidebar":{"$ref":"#/components/schemas/Sidebar"},"version":{"type":"integer","format":"int32"},"bodyRows":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/TemplateLayoutRow"}}}},"TemplateLayoutColumn":{"type":"object","properties":{"containers":{"type":"array","items":{"$ref":"#/components/schemas/ContainerUUID"}},"widthPercent":{"type":"integer","format":"int32"},"leftOffset":{"type":"integer","format":"int32"},"styleClass":{"type":"string"},"preview":{"type":"boolean"},"width":{"type":"integer","format":"int32"},"left":{"type":"integer","format":"int32"}}},"TemplateLayoutRow":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/TemplateLayoutColumn"}},"styleClass":{"type":"string"}}},"PersonalizationPersonaPageForm":{"required":["pageId","personaTag"],"type":"object","properties":{"pageId":{"type":"string"},"personaTag":{"type":"string"}}},"RestPersona":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}},"CustomPortletForm":{"type":"object","properties":{"portletId":{"type":"string"},"portletName":{"type":"string"},"baseTypes":{"type":"string"},"contentTypes":{"type":"string"},"dataViewMode":{"type":"string"}}},"FilterDescriptorForm":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"sort":{"type":"string"},"defaultFilter":{"type":"boolean"},"roles":{"type":"string"},"filters":{"type":"object","additionalProperties":{"type":"object"}}}},"CopySiteForm":{"type":"object","properties":{"copyFromSiteId":{"type":"string"},"copyAll":{"type":"boolean"},"copyTemplatesContainers":{"type":"boolean"},"copyContentOnPages":{"type":"boolean"},"copyFolders":{"type":"boolean"},"copyContentOnSite":{"type":"boolean"},"copyLinks":{"type":"boolean"},"copySiteVariables":{"type":"boolean"},"copyContentTypes":{"type":"boolean"},"site":{"$ref":"#/components/schemas/SiteForm"}}},"SimpleSiteVariableForm":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}}},"SiteForm":{"type":"object","properties":{"aliases":{"type":"string"},"siteName":{"type":"string"},"tagStorage":{"type":"string"},"siteThumbnail":{"type":"string"},"runDashboard":{"type":"boolean"},"keywords":{"type":"string"},"description":{"type":"string"},"googleMap":{"type":"string"},"googleAnalytics":{"type":"string"},"addThis":{"type":"string"},"proxyUrlForEditMode":{"type":"string"},"embeddedDashboard":{"type":"string"},"languageId":{"type":"integer","format":"int64"},"identifier":{"type":"string"},"inode":{"type":"string"},"default":{"type":"boolean"},"forceExecution":{"type":"boolean"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/SimpleSiteVariableForm"}}}},"SearchSiteByNameForm":{"type":"object","properties":{"siteName":{"type":"string"}}},"HostVariable":{"type":"object","properties":{"id":{"type":"string"},"hostId":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"lastModifierId":{"type":"string"},"lastModDate":{"type":"string","format":"date-time"}}},"ResponseHostVariableEntityView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/HostVariable"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SiteVariableForm":{"type":"object","properties":{"id":{"type":"string"},"siteId":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}}},"RestConditionGroup":{"required":["operator"],"type":"object","properties":{"operator":{"type":"string"},"priority":{"type":"integer","format":"int32"},"conditions":{"type":"object","additionalProperties":{"type":"boolean"}}}},"RestRule":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"fireOn":{"type":"string"},"shortCircuit":{"type":"boolean"},"priority":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"},"conditionGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestConditionGroup"}},"ruleActions":{"type":"object","additionalProperties":{"type":"boolean"}}}},"ParameterModel":{"type":"object","properties":{"id":{"type":"string"},"ownerId":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"RestRuleAction":{"required":["actionlet","owningRule"],"type":"object","properties":{"owningRule":{"type":"string"},"priority":{"type":"integer","format":"int32"},"actionlet":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ParameterModel"}}}},"RestCondition":{"required":["conditionlet","operator","owningGroup"],"type":"object","properties":{"owningGroup":{"type":"string"},"conditionlet":{"type":"string"},"values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestConditionValue"}},"operator":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"RestConditionValue":{"required":["key"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"CompanyEmailForm":{"type":"object","properties":{"senderAndEmail":{"type":"string"}}},"ResponseEntityViewMapStringString":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"object","additionalProperties":{"type":"string"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"KeyValueForm":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"UpgradeTaskForm":{"required":["upgradeTaskClass"],"type":"object","properties":{"upgradeTaskClass":{"type":"string"}}},"ChangeLoggerForm":{"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string"}}},"PermissionView":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"inode":{"type":"string"},"roleId":{"type":"string"},"permission":{"type":"string","enum":["READ","USE","EDIT","WRITE","PUBLISH","EDIT_PERMISSIONS","CAN_ADD_CHILDREN"]},"type":{"type":"string"},"bitPermission":{"type":"boolean"}}},"ResponseEntityPermissionView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/PermissionView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SetForm":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object"}}},"SetHashForm":{"required":["fields","key"],"type":"object","properties":{"key":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"object"}}}},"RoleForm":{"required":["roleName"],"type":"object","properties":{"roleName":{"type":"string"},"roleKey":{"type":"string"},"parentRoleId":{"type":"string"},"canEditUsers":{"type":"boolean"},"canEditPermissions":{"type":"boolean"},"canEditLayouts":{"type":"boolean"},"description":{"type":"string"}}},"RoleLayoutForm":{"type":"object","properties":{"roleId":{"type":"string"},"layoutIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"ResponseEntitySmallRoleView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/SmallRoleView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SmallRoleView":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"roleKey":{"type":"string"},"user":{"type":"boolean"}}},"RemoteUrlForm":{"type":"object","properties":{"remoteUrl":{"type":"string"},"fileName":{"type":"string"},"accessKey":{"type":"string"},"urlTimeoutSeconds":{"type":"integer","format":"int32"},"maxFileLength":{"type":"integer","format":"int64"}}},"TemplateImageForm":{"type":"object","properties":{"templateId":{"type":"string"}}},"BodyView":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/TemplateLayoutRowView"}}}},"SidebarView":{"type":"object","properties":{"containers":{"type":"array","items":{"$ref":"#/components/schemas/ContainerUUID"}},"location":{"type":"string"},"width":{"type":"string"}}},"TemplateForm":{"required":["title"],"type":"object","properties":{"siteId":{"type":"string"},"identifier":{"type":"string"},"inode":{"type":"string"},"body":{"type":"string"},"selectedimage":{"type":"string"},"image":{"type":"string"},"drawed":{"type":"boolean"},"showOnMenu":{"type":"boolean"},"drawedBody":{"type":"string"},"countAddContainer":{"type":"integer","format":"int32"},"countContainers":{"type":"integer","format":"int32"},"headCode":{"type":"string"},"theme":{"type":"string"},"themeName":{"type":"string"},"footer":{"type":"string"},"friendlyName":{"type":"string"},"header":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"headerCheck":{"type":"boolean"},"footerCheck":{"type":"boolean"},"layout":{"$ref":"#/components/schemas/TemplateLayoutView"}}},"TemplateLayoutColumnView":{"type":"object","properties":{"containers":{"type":"array","items":{"$ref":"#/components/schemas/ContainerUUID"}},"width":{"type":"integer","format":"int32"},"leftOffset":{"type":"integer","format":"int32"},"styleClass":{"type":"string"}}},"TemplateLayoutRowView":{"type":"object","properties":{"styleClass":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/TemplateLayoutColumnView"}}}},"TemplateLayoutView":{"type":"object","properties":{"width":{"type":"string"},"title":{"type":"string"},"header":{"type":"boolean"},"footer":{"type":"boolean"},"body":{"$ref":"#/components/schemas/BodyView"},"sidebar":{"$ref":"#/components/schemas/SidebarView"}}},"UserForm":{"required":["email","firstName","lastName"],"type":"object","properties":{"userId":{"type":"string"},"active":{"type":"boolean"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"nickName":{"type":"string"},"email":{"type":"string"},"male":{"type":"boolean"},"birthday":{"type":"string"},"languageId":{"type":"string"},"timeZoneId":{"type":"string"},"password":{"type":"array","items":{"type":"string"}},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}},"roles":{"type":"array","items":{"type":"string"}}}},"LoginAsForm":{"required":["password","userId"],"type":"object","properties":{"userId":{"type":"string"},"password":{"type":"string"}}},"RestUser":{"type":"object","properties":{"userId":{"type":"string"},"givenName":{"type":"string"},"email":{"type":"string"},"surname":{"type":"string"},"roleId":{"type":"string"},"loginAs":{"type":"boolean"},"admin":{"type":"boolean"}}},"UpdateCurrentUserForm":{"required":["givenName","surname","userId"],"type":"object","properties":{"userId":{"type":"string"},"givenName":{"type":"string"},"email":{"type":"string"},"surname":{"type":"string"},"currentPassword":{"type":"string"},"newPassword":{"type":"string"}}},"ResponseEntityWorkflowStepView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/WorkflowStep"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowStep":{"type":"object","properties":{"id":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"schemeId":{"type":"string"},"myOrder":{"type":"integer","format":"int32"},"resolved":{"type":"boolean"},"enableEscalation":{"type":"boolean"},"escalationAction":{"type":"string"},"escalationTime":{"type":"integer","format":"int32"}}},"WorkflowStepAddForm":{"required":["enableEscalation","escalationAction","escalationTime","schemeId","stepName","stepResolved"],"type":"object","properties":{"schemeId":{"type":"string"},"stepName":{"type":"string"},"enableEscalation":{"type":"boolean"},"escalationAction":{"type":"string"},"escalationTime":{"type":"string"},"stepResolved":{"type":"boolean"}}},"ResponseEntityWorkflowSchemeView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/WorkflowScheme"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowScheme":{"type":"object","properties":{"id":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"variableName":{"type":"string"},"description":{"type":"string"},"archived":{"type":"boolean"},"mandatory":{"type":"boolean"},"defaultScheme":{"type":"boolean"},"modDate":{"type":"string","format":"date-time"},"entryActionId":{"type":"string"},"system":{"type":"boolean"}}},"WorkflowCopyForm":{"type":"object","properties":{"name":{"type":"string"}}},"ResponseEntitySystemActionWorkflowActionMapping":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/SystemActionWorkflowActionMapping"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"SystemActionWorkflowActionMapping":{"type":"object","properties":{"identifier":{"type":"string"},"systemAction":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]},"workflowAction":{"$ref":"#/components/schemas/WorkflowAction"},"owner":{"type":"object"},"ownerScheme":{"type":"boolean"},"ownerContentType":{"type":"boolean"}}},"WorkflowAction":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"schemeId":{"type":"string"},"condition":{"type":"string"},"nextStep":{"type":"string"},"nextAssign":{"type":"string"},"icon":{"type":"string"},"roleHierarchyForAssign":{"type":"boolean"},"assignable":{"type":"boolean"},"commentable":{"type":"boolean"},"order":{"type":"integer","format":"int32"},"saveActionlet":{"type":"boolean","writeOnly":true},"publishActionlet":{"type":"boolean","writeOnly":true},"unpublishActionlet":{"type":"boolean","writeOnly":true},"archiveActionlet":{"type":"boolean","writeOnly":true},"pushPublishActionlet":{"type":"boolean","writeOnly":true},"onlyBatchActionlet":{"type":"boolean","writeOnly":true},"unarchiveActionlet":{"type":"boolean","writeOnly":true},"deleteActionlet":{"type":"boolean","writeOnly":true},"destroyActionlet":{"type":"boolean","writeOnly":true},"moveActionlet":{"type":"boolean","writeOnly":true},"commentActionlet":{"type":"boolean","writeOnly":true},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"resetable":{"type":"boolean","writeOnly":true},"nextStepCurrentStep":{"type":"boolean"},"moveActionletHashPath":{"type":"boolean","writeOnly":true},"owner":{"type":"string"},"showOn":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["NEW","LOCKED","UNLOCKED","PUBLISHED","UNPUBLISHED","ARCHIVED","LISTING","EDITING"]}},"hasOnlyBatchActionlet":{"type":"boolean"},"hasPublishActionlet":{"type":"boolean"},"hasUnpublishActionlet":{"type":"boolean"},"hasArchiveActionlet":{"type":"boolean"},"hasUnarchiveActionlet":{"type":"boolean"},"hasDeleteActionlet":{"type":"boolean"},"hasDestroyActionlet":{"type":"boolean"},"hasCommentActionlet":{"type":"boolean"},"hasResetActionlet":{"type":"boolean"},"hasPushPublishActionlet":{"type":"boolean"},"hasMoveActionletActionlet":{"type":"boolean"},"hasSaveActionlet":{"type":"boolean"},"hasMoveActionletHasPathActionlet":{"type":"boolean"}}},"ResponseEntityWorkflowActionView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/WorkflowAction"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityWorkflowActionletsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkFlowActionlet"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkFlowActionlet":{"type":"object","properties":{"howTo":{"type":"string"},"actionClass":{"type":"string"},"localizedHowto":{"type":"string"},"localizedName":{"type":"string"},"name":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionletParameter"}}}},"WorkflowActionletParameter":{"type":"object","properties":{"displayName":{"type":"string"},"key":{"type":"string"},"defaultValue":{"type":"string"},"required":{"type":"boolean"}}},"ResponseEntityWorkflowActionClassesView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionClass"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowActionClass":{"type":"object","properties":{"id":{"type":"string"},"actionId":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"clazz":{"type":"string"},"actionlet":{"$ref":"#/components/schemas/WorkFlowActionlet"}}},"ResponseEntityWorkflowActionsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowSchemesForm":{"required":["schemes"],"type":"object","properties":{"schemes":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"SchemesAndSchemesContentTypeView":{"type":"object","properties":{"schemes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowScheme"}},"contentTypeSchemes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowScheme"}}}},"ResponseEntityDefaultWorkflowActionsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowDefaultActionView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowDefaultActionView":{"type":"object","properties":{"scheme":{"$ref":"#/components/schemas/WorkflowScheme"},"action":{"$ref":"#/components/schemas/WorkflowAction"},"firstStep":{"$ref":"#/components/schemas/WorkflowStep"}}},"ResponseEntityWorkflowSchemesView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowScheme"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityWorkflowStepsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntitySystemActionWorkflowActionMappings":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/SystemActionWorkflowActionMapping"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"FireActionByNameForm":{"type":"object","properties":{"comments":{"type":"string"},"assign":{"type":"string"},"publishDate":{"type":"string"},"publishTime":{"type":"string"},"expireDate":{"type":"string"},"expireTime":{"type":"string"},"neverExpire":{"type":"string"},"whereToSend":{"type":"string"},"filterKey":{"type":"string"},"query":{"type":"string"},"pathToMove":{"type":"string"},"timezoneId":{"type":"string"},"individualPermissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"actionName":{"type":"string"},"iwantTo":{"type":"string"},"contentlet":{"type":"object","additionalProperties":{"type":"object"}}}},"FireActionForm":{"type":"object","properties":{"comments":{"type":"string"},"assign":{"type":"string"},"publishDate":{"type":"string"},"publishTime":{"type":"string"},"expireDate":{"type":"string"},"expireTime":{"type":"string"},"neverExpire":{"type":"string"},"whereToSend":{"type":"string"},"filterKey":{"type":"string"},"query":{"type":"string"},"pathToMove":{"type":"string"},"timezoneId":{"type":"string"},"individualPermissions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"iwantTo":{"type":"string"},"contentlet":{"type":"object","additionalProperties":{"type":"object"}}}},"AdditionalParamsBean":{"type":"object","properties":{"pushPublish":{"$ref":"#/components/schemas/PushPublishBean"},"assignComment":{"$ref":"#/components/schemas/AssignCommentBean"},"additionalParamsMap":{"type":"object","additionalProperties":{"type":"object"}},"pushPublishBean":{"$ref":"#/components/schemas/PushPublishBean"},"assignCommentBean":{"$ref":"#/components/schemas/AssignCommentBean"}}},"AssignCommentBean":{"type":"object","properties":{"assign":{"type":"string"},"comment":{"type":"string"}}},"FireBulkActionsForm":{"type":"object","properties":{"query":{"type":"string"},"contentletIds":{"type":"array","items":{"type":"string"}},"workflowActionId":{"type":"string"},"additionalParams":{"$ref":"#/components/schemas/AdditionalParamsBean"},"popupParamsBean":{"$ref":"#/components/schemas/AdditionalParamsBean"}}},"PushPublishBean":{"type":"object","properties":{"whereToSend":{"type":"string"},"publishDate":{"type":"string"},"publishTime":{"type":"string"},"expireDate":{"type":"string"},"expireTime":{"type":"string"},"neverExpire":{"type":"string"},"filterKey":{"type":"string"},"iWantTo":{"type":"string","writeOnly":true},"timezoneId":{"type":"string"},"iwantTo":{"type":"string"}}},"ActionFail":{"type":"object","properties":{"identifier":{"type":"string"},"inode":{"type":"string"},"errorMessage":{"type":"string"}}},"BulkActionsResultView":{"type":"object","properties":{"successCount":{"type":"integer","format":"int64"},"skippedCount":{"type":"integer","format":"int64"},"fails":{"type":"array","items":{"$ref":"#/components/schemas/ActionFail"}}}},"ResponseEntityBulkActionsResultView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/BulkActionsResultView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"FireMultipleActionForm":{"type":"object","properties":{"comments":{"type":"string"},"assign":{"type":"string"},"publishDate":{"type":"string"},"publishTime":{"type":"string"},"expireDate":{"type":"string"},"expireTime":{"type":"string"},"neverExpire":{"type":"string"},"whereToSend":{"type":"string"},"filterKey":{"type":"string"},"timezoneId":{"type":"string"},"iwantTo":{"type":"string"},"contentlet":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}}},"BulkActionView":{"type":"object","properties":{"schemes":{"type":"array","items":{"$ref":"#/components/schemas/BulkWorkflowSchemeView"}}}},"BulkWorkflowSchemeView":{"type":"object","properties":{"scheme":{"$ref":"#/components/schemas/WorkflowScheme"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/BulkWorkflowStepView"}}}},"BulkWorkflowStepView":{"type":"object","properties":{"step":{"$ref":"#/components/schemas/CountWorkflowStep"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/CountWorkflowAction"}}}},"CountWorkflowAction":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"workflowAction":{"$ref":"#/components/schemas/WorkflowAction"},"pushPublish":{"type":"boolean"},"moveable":{"type":"boolean"},"conditionPresent":{"type":"boolean"}}},"CountWorkflowStep":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"workflowStep":{"$ref":"#/components/schemas/WorkflowStep"}}},"ResponseEntityBulkActionView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/BulkActionView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"BulkActionForm":{"type":"object","properties":{"contentletIds":{"type":"array","items":{"type":"string"}},"query":{"type":"string"}}},"ContentletWorkflowStatusView":{"type":"object","properties":{"step":{"$ref":"#/components/schemas/WorkflowStep"},"scheme":{"$ref":"#/components/schemas/WorkflowScheme"},"task":{"$ref":"#/components/schemas/WorkflowTask"}}},"ResponseContentletWorkflowStatusView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/ContentletWorkflowStatusView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowTask":{"type":"object","properties":{"id":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"assignedTo":{"type":"string"},"belongsTo":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"webasset":{"type":"string"},"languageId":{"type":"integer","format":"int64"},"inode":{"type":"string"},"new":{"type":"boolean"}}},"ResponseEntityWorkflowHistoryCommentsView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTimelineItemView"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowTimelineItemView":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"roleId":{"type":"string"},"postedBy":{"type":"string"},"commentDescription":{"type":"string"},"taskId":{"type":"string"},"type":{"type":"string"},"step":{"type":"object","additionalProperties":{"type":"string"}},"action":{"type":"object","additionalProperties":{"type":"string"}}}},"Permission":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"inode":{"type":"string"},"permission":{"type":"integer","format":"int32"},"type":{"type":"string"},"bitPermission":{"type":"boolean"},"individualPermission":{"type":"boolean"},"roleId":{"type":"string"}}},"WorkflowActionClassParameter":{"type":"object","properties":{"id":{"type":"string"},"actionClassId":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}}},"WorkflowSchemeImportExportObjectView":{"type":"object","properties":{"version":{"type":"string"},"schemes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowScheme"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"}},"actionSteps":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"actionClasses":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionClass"}},"actionClassParams":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowActionClassParameter"}},"schemeSystemActionWorkflowActionMappings":{"type":"array","items":{"$ref":"#/components/schemas/SystemActionWorkflowActionMapping"}}}},"WorkflowSchemeImportObjectForm":{"type":"object","properties":{"workflowObject":{"$ref":"#/components/schemas/WorkflowSchemeImportExportObjectView"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}}}},"WorkflowReorderWorkflowActionStepForm":{"required":["order"],"type":"object","properties":{"order":{"type":"integer","format":"int32"}}},"WorkflowActionForm":{"required":["actionAssignable","actionCommentable","actionName","actionNextStep","actionRoleHierarchyForAssign","schemeId","showOn"],"type":"object","properties":{"actionId":{"type":"string"},"schemeId":{"type":"string"},"stepId":{"type":"string"},"actionName":{"type":"string"},"whoCanUse":{"type":"array","items":{"type":"string"}},"actionIcon":{"type":"string"},"actionAssignable":{"type":"boolean"},"actionCommentable":{"type":"boolean"},"showOn":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["NEW","LOCKED","UNLOCKED","PUBLISHED","UNPUBLISHED","ARCHIVED","LISTING","EDITING"]}},"actionRoleHierarchyForAssign":{"type":"boolean"},"actionNextStep":{"type":"string"},"actionNextAssign":{"type":"string"},"actionCondition":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"object"}}}},"WorkflowActionStepForm":{"required":["actionId"],"type":"object","properties":{"actionId":{"type":"string"}}},"WorkflowActionletActionForm":{"required":["actionletClass"],"type":"object","properties":{"actionletClass":{"type":"string"},"order":{"type":"integer","format":"int32"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"ResponseEntityWorkflowCommentView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/WorkflowTimelineItemView"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"WorkflowCommentForm":{"type":"object","properties":{"comment":{"type":"string"}}},"WorkflowSchemeForm":{"required":["schemeName"],"type":"object","properties":{"schemeName":{"type":"string"},"schemeDescription":{"type":"string"},"schemeArchived":{"type":"boolean"}}},"WorkflowSystemActionForm":{"required":["actionId","systemAction"],"type":"object","properties":{"actionId":{"type":"string"},"schemeId":{"type":"string"},"contentTypeVariable":{"type":"string"},"systemAction":{"type":"string","enum":["NEW","EDIT","PUBLISH","UNPUBLISH","ARCHIVE","UNARCHIVE","DELETE","DESTROY"]}}},"WorkflowStepUpdateForm":{"required":["enableEscalation","escalationTime","stepName","stepOrder","stepResolved"],"type":"object","properties":{"stepOrder":{"type":"integer","format":"int32"},"stepName":{"type":"string"},"enableEscalation":{"type":"boolean"},"escalationAction":{"type":"string"},"escalationTime":{"type":"string"},"stepResolved":{"type":"boolean"}}},"Language":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"languageCode":{"type":"string"},"countryCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"isoCode":{"type":"string"}}},"ResponseEntityViewLanguage":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/Language"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"MakeDefaultLangForm":{"type":"object","properties":{"fireTransferAssetsJob":{"type":"boolean"}}},"LanguageForm":{"type":"object","properties":{"languageCode":{"type":"string"},"countryCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"isoCode":{"type":"string"}}},"ResponseEntityTagMapView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RestTag"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ResponseEntityTagInodesMapView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/TagInode"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"TagInode":{"type":"object","properties":{"inode":{"type":"string"},"tagId":{"type":"string"},"fieldVarName":{"type":"string"},"modDate":{"type":"string","format":"date-time"}}},"BinaryField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"CategoryField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"indexed":{"type":"boolean"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"CheckboxField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"ColumnField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"ConstantField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"CustomField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"DateField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"DateTimeField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"EmptyField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"Field":{"required":["clazz"],"type":"object","properties":{"fieldContentTypeProperties":{"type":"array","items":{"type":"string","enum":["NAME","VALUES","CATEGORIES","RELATIONSHIPS","REGEX_CHECK","HINT","REQUIRED","SEARCHABLE","INDEXED","LISTED","UNIQUE","DEFAULT_VALUE","DATA_TYPE"]}},"clazz":{"type":"string"}},"discriminator":{"propertyName":"clazz"}},"FieldResponseView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"FileField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"HiddenField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"HostFolderField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"indexed":{"type":"boolean"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"ImageField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"KeyValueField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"indexed":{"type":"boolean"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"LineDividerField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"MultiSelectField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"PermissionTabField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"RadioField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"RelationshipField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"indexed":{"type":"boolean"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]},"skipRelationshipCreation":{"type":"boolean"}}}]},"RelationshipsTabField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"RowField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"SelectField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"StoryBlockField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"TabDividerField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"TagField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"indexed":{"type":"boolean"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"TextAreaField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"TextField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"TimeField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"WysiwygField":{"type":"object","allOf":[{"$ref":"#/components/schemas/Field"},{"type":"object","properties":{"searchable":{"type":"boolean"},"unique":{"type":"boolean"},"indexed":{"type":"boolean"},"listed":{"type":"boolean"},"readOnly":{"type":"boolean"},"forceIncludeInApi":{"type":"boolean"},"owner":{"type":"string"},"id":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"relationType":{"type":"string"},"required":{"type":"boolean"},"variable":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"values":{"type":"string"},"regexCheck":{"type":"string"},"hint":{"type":"string"},"defaultValue":{"type":"string"},"fixed":{"type":"boolean"},"contentTypeId":{"type":"string"},"dbColumn":{"type":"string"},"iDate":{"type":"string","format":"date-time"},"dataType":{"type":"string","enum":["none","bool","date","float","integer","text","text_area","system_field"]}}}]},"DeleteFieldsForm":{"type":"object","properties":{"fieldsID":{"type":"array","items":{"type":"string"}}}},"MoveFieldsForm":{"type":"object"},"UpdateFieldForm":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/Field"}}},"Persona":{"type":"object","properties":{"lowIndexPriority":{"type":"boolean"},"variantId":{"type":"string"},"keyTag":{"type":"string"},"tags":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"identifier":{"type":"string"},"inode":{"type":"string"},"archived":{"type":"boolean"},"versionType":{"type":"string"},"modDate":{"type":"string","format":"date-time"},"versionId":{"type":"string"},"working":{"type":"boolean"},"modUser":{"type":"string"},"live":{"type":"boolean"},"locked":{"type":"boolean"},"title":{"type":"string"},"permissionId":{"type":"string"},"permissionType":{"type":"string"},"owner":{"type":"string"},"host":{"type":"string"},"form":{"type":"boolean"},"structureInode":{"type":"string"},"contentTypeId":{"type":"string"},"languageVariable":{"type":"boolean"},"indexPolicyDependencies":{"type":"string","enum":["DEFER","WAIT_FOR","FORCE"]},"languageId":{"type":"integer","format":"int64"},"folder":{"type":"string"},"sortOrder":{"type":"integer","format":"int64"},"fileAsset":{"type":"boolean"},"systemHost":{"type":"boolean"},"userAPI":{"$ref":"#/components/schemas/UserAPI"},"htmlpage":{"type":"boolean"},"vanityUrl":{"type":"boolean"},"categoryId":{"type":"string"},"keyValue":{"type":"boolean"},"titleImage":{"$ref":"#/components/schemas/Field"},"dotAsset":{"type":"boolean"},"persona":{"type":"boolean"},"new":{"type":"boolean"},"type":{"type":"string"}}},"UserAPI":{"type":"object","properties":{"unDeletedUsers":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"anonymousUser":{"$ref":"#/components/schemas/User"},"anonymousUserNoThrow":{"$ref":"#/components/schemas/User"},"defaultUser":{"$ref":"#/components/schemas/User"},"systemUser":{"$ref":"#/components/schemas/User"}}},"MetricCalculationError":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string","enum":["DIFFERENTIATING_FEATURES","PAID_FEATURES","PLATFORM_SPECIFIC_CUSTOMIZATION","SOPHISTICATED_CONTENT_ARCHITECTURE","POSITIVE_USER_EXPERIENCE","PLATFORM_SPECIFIC_DEVELOPMENT","RECENT_ACTIVITY","HISTORY_LEGACY_DEPRECATED_FEATURES"]},"feature":{"type":"string","enum":["CONTENTLETS","LANGUAGES","CONTENT_TYPES","SITES","URL_MAPS","WORKFLOW","USERS","SITE_SEARCH","IMAGE_API","LAYOUT","CONTENT_TYPE_FIELDS"]},"error":{"type":"string"},"type":{"$ref":"#/components/schemas/Metric"}}},"MetricValue":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string","enum":["DIFFERENTIATING_FEATURES","PAID_FEATURES","PLATFORM_SPECIFIC_CUSTOMIZATION","SOPHISTICATED_CONTENT_ARCHITECTURE","POSITIVE_USER_EXPERIENCE","PLATFORM_SPECIFIC_DEVELOPMENT","RECENT_ACTIVITY","HISTORY_LEGACY_DEPRECATED_FEATURES"]},"feature":{"type":"string","enum":["CONTENTLETS","LANGUAGES","CONTENT_TYPES","SITES","URL_MAPS","WORKFLOW","USERS","SITE_SEARCH","IMAGE_API","LAYOUT","CONTENT_TYPE_FIELDS"]},"value":{"type":"object"}}},"MetricsSnapshot":{"type":"object","properties":{"stats":{"type":"array","items":{"$ref":"#/components/schemas/MetricValue"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/MetricCalculationError"}}}},"ResponseEntityMetricsSnapshotView":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorEntity"}},"entity":{"$ref":"#/components/schemas/MetricsSnapshot"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageEntity"}},"i18nMessagesMap":{"type":"object","additionalProperties":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"ComponentList":{"type":"object","properties":{"hasMore":{"type":"boolean"},"components":{"type":"array","items":{"type":"string"}}}},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}