All APIs (Generated)

GET

/api/v1/categories/children

getChildren()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
inode	string

Response

application/json
application/javascript

GET

/api/v1/categories/_export

export()

Request

Param	Type
contextInode	string
filter	string

Response

application/json
application/javascript

POST

/api/v1/categories/_import

importCategories()

Request

Param	Type
contextInode	string
filter	string

Response

application/json
application/javascript

PUT

/api/v1/categories/_sort

save()

Request

Param	Type
contextInode	string
filter	string

Response

application/json
application/javascript

GET

/api/v1/content/versions/{inode}

findByInode()

Request

Param	Type
contextInode	string
filter	string

Response

application/json;charset=UTF-8

GET

/api/v1/content/versions/

findVersions()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json;charset=UTF-8

POST

/api/v1/languages/i18n

getMessages()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/_archive

archive()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/_publish

publish()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/_unarchive

unarchive()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/_unpublish

unpublish()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/draft

saveDraft()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/_savepublish

saveAndPublish()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

GET

/api/v1/templates/{templateId}/live

getLiveById()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

GET

/api/v1/templates/{templateId}/working

getWorkingById()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

PUT

/api/v1/templates/{templateId}/_copy

copy()

Request

Param	Type
inodes	string
identifier	string
groupByLang	string
limit	int

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes

findSchemes()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

POST

/api/v1/workflow/schemes

saveScheme()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/actions/{actionId}

findAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

DELETE

/api/v1/workflow/actions/{actionId}

deleteAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/{actionId}

updateAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

POST

/api/v1/workflow/actions

saveAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

DELETE

/api/v1/workflow/steps/{stepId}/actions/{actionId}

deleteAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/steps/{stepId}/actions/{actionId}

findActionByStep()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

DELETE

/api/v1/workflow/steps/{stepId}

deleteStep()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

PUT

/api/v1/workflow/steps/{stepId}

updateStep()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/steps/{stepId}

findStepById()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

DELETE

/api/v1/workflow/schemes/{schemeId}

deleteScheme()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

PUT

/api/v1/workflow/schemes/{schemeId}

updateScheme()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/contenttypes/{contentTypeVarOrId}/system/actions

findSystemActionsByContentType()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes/{schemeId}/system/actions

findSystemActionsByScheme()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

PUT

/api/v1/workflow/reorder/step/{stepId}/order/{order}

reorderStep()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

PUT

/api/v1/workflow/reorder/steps/{stepId}/actions/{actionId}

reorderAction()

Request

Param	Type
contentTypeId	string
showArchive	boolean

Response

application/json
application/javascript

GET

/api/v1/workflow/contentlet/{inode}/actions

findAvailableActions()

Request

Param	Type
renderMode	string

Response

application/json
application/javascript

GET

/api/v1/workflow/actionlets

findActionlets()

Request

Param	Type
renderMode	string

Response

application/json
application/javascript

GET

/api/v1/workflow/defaultactions/contenttype/{contentTypeId}

findAvailableDefaultActionsByContentType()

Request

Param	Type
renderMode	string

Response

application/json
application/javascript

GET

/api/v1/workflow/defaultactions/schemes

findAvailableDefaultActionsBySchemes()

Request

Param	Type
ids	string

Response

application/json
application/javascript

GET

/api/v1/workflow/initialactions/contenttype/{contentTypeId}

findInitialAvailableActionsByContentType()

Request

Param	Type
ids	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/contentlet/actions/bulk/fire

fireBulkActions()

Request

Param	Type
ids	string

Response

application/json
application/javascript

POST

/api/v1/workflow/contentlet/actions/_bulkfire

fireBulkActions()

Request

Param	Type
ids	string

Response

text/event-stream

POST

/api/v1/workflow/actions/default/fire/{systemAction}

fireMultipleActionDefault()

Request

Param	Type
ids	string

Response

application/octet-stream

PATCH

/api/v1/workflow/actions/default/fire/{systemAction}

fireMergeActionDefault()

Request

Param	Type
inode	string
identifier	string
language	string
offset	int

Response

application/octet-stream

PUT

/api/v1/workflow/actions/default/fire/{systemAction}

fireActionDefaultMultipart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/default/fire/{systemAction}

fireActionDefaultSinglePart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

DELETE

/api/v1/workflow/actionlets/{actionletId}

deleteActionlet()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

POST

/api/v1/workflow/steps

addStep()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/fire

fireActionByNameMultipart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/fire

fireActionByNameSinglePart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/{actionId}/firemultipart

fireActionMultipartNewPath()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/{actionId}/fire

fireActionMultipart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/{actionId}/fire

fireActionSinglePart()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/actions/default/firemultipart/{systemAction}

fireActionDefaultMultipartNewPath()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

POST

/api/v1/workflow/schemes/import

importScheme()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes/{schemeId}/export

exportScheme()

Request

Param	Type
inode	string
identifier	string
indexPolicy	string
language	string

Response

application/json
application/javascript

POST

/api/v1/workflow/schemes/{schemeId}/copy

copyScheme()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/system/actions/{workflowActionId}

getSystemActionsReferredByWorkflowAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

PUT

/api/v1/workflow/system/actions

saveSystemAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/workflow/system/actions/{identifier}

deletesSystemAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

POST

/api/v1/workflow/steps/{stepId}/actions

saveActionToStep()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/steps/{stepId}/actions

findActionsByStep()

Request

Param	Type
name	string

Response

application/json
application/javascript

POST

/api/v1/workflow/actions/{actionId}/actionlets

saveActionletToAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/actions/{actionId}/actionlets

findActionletsByAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes/schemescontenttypes/{contentTypeId}

findAllSchemesAndSchemesByContentType()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes/{schemeId}/steps

findStepsByScheme()

Request

Param	Type
name	string

Response

application/json
application/javascript

POST

/api/v1/workflow/contentlet/actions/bulk

getBulkActions()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/actions/{actionId}/condition

evaluateActionCondition()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/workflow/schemes/{schemeId}/actions

findActionsByScheme()

Request

Param	Type
name	string

Response

application/json
application/javascript

POST

/api/v1/workflow/schemes/actions/{systemAction}

findActionsBySchemesAndSystemAction()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/pushpublish/filters/{filterKey}

getFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/pushpublish/filters/{filterKey}

deleteFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/fieldTypes/{filterKey}

getFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/fieldTypes/{filterKey}

deleteFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/loginform/{filterKey}

getFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/loginform/{filterKey}

deleteFilter()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/contentrelationships/{params: .*}

getContent()

Request

Param	Type
name	string

Response

*/*

POST

/api/bundlePublisher/publish

publish()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}

getContentTypeFieldById()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

PUT

/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}

updateContentTypeFieldById()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

DELETE

/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}

deleteContentTypeFieldById()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}

getContentTypeFieldByVar()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

PUT

/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}

updateContentTypeFieldByVar()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

DELETE

/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}

deleteContentTypeFieldByVar()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/personas/sites/{id}

list()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/personas/layout/{params:.*}

getLayout()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

text/html

GET

/api/openapi/sites/{id}

list()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/openapi/layout/{params:.*}

getLayout()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

text/html

GET

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}

self()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

DELETE

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}

remove()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

*/*

PUT

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}

update()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

POST

/api/v1/sites/{siteId}/ruleengine/rules

add()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/v1/sites/{siteId}/ruleengine/rules

list()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

GET

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{groupId}

self()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

PUT

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{groupId}

update()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

POST

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups

add()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups

list()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

DELETE

/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{conditionGroupId}

remove()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

*/*

GET

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}

self()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

DELETE

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}

remove()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

*/*

PUT

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}

update()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

POST

/api/v1/sites/{siteId}/ruleengine/conditions

add()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}

self()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

DELETE

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}

remove()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

*/*

PUT

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}

update()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

POST

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues

add()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues

list()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v1/sites/{siteId}/ruleengine/actions/{actionId}

self()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json
application/javascript

DELETE

/api/v1/sites/{siteId}/ruleengine/actions/{actionId}

remove()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

PUT

/api/v1/sites/{siteId}/ruleengine/actions/{actionId}

update()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

POST

/api/v1/sites/{siteId}/ruleengine/actions/

add()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/json

GET

/api/v1/form/{idOrVar}/successCallback

getSuccessCallbackFunction()

Request

Param	Type
type	string
callback	string
FORCE_PUSH	boolean

Response

application/javascript

GET

/api/v1/nav/{uri: .*}

loadJson()

Request

Param	Type
depth	string
languageId	string

Response

application/json
application/javascript

PUT

/api/v1/containers/_archive

archive()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

PUT

/api/v1/containers/_publish

publish()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

PUT

/api/v1/containers/_unarchive

unarchive()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

PUT

/api/v1/containers/_unpublish

unpublish()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

GET

/api/v1/containers/{containerId}/content/{contentletId}

containerContent()

Request

Param	Type
pageInode	string

Response

application/json
application/javascript

GET

/api/v1/containers/content/{contentletId}

containerContentByQueryParam()

Request

Param	Type
containerId	string
pageInode	string

Response

application/json
application/javascript

GET

/api/v1/containers/form/{formId}

containerFormByQueryParam()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

GET

/api/v1/containers/{containerId}/form/{formId}

containerForm()

Request

Param	Type
containerId	string

Response

application/json
application/javascript

DELETE

/api/v1/containersdelete/{containerId}/content/{contentletId}/uid/{uid}

removeContentletFromContainer()

Request

Param	Type
order	long

Response

application/json
application/javascript

GET

/api/v1/containers/live

getLiveById()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

GET

/api/v1/containers/working

getWorkingById()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

DELETE

/api/v1/containers_bulkdelete

bulkDelete()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

PUT

/api/v1/containers/_bulkpublish

bulkPublish()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

PUT

/api/v1/containers/_bulkunpublish

bulkUnpublish()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

PUT

/api/v1/containers/_bulkarchive

bulkArchive()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

PUT

/api/v1/containers/_bulkunarchive

bulkUnarchive()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

POST

/api/v1/containers/{id}/_copy

copy()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json
application/javascript

GET

/api/v1/jvm/

getJvmInfo()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/octet-stream
application/json

GET

/api/v1/notification/getNotifications/{params:.*}

getNotifications()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json

GET

/api/v1/notification/getNewNotificationsCount

getNewNotificationsCount()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json

PUT

/api/v1/notification/markAsRead

markAsRead()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json

DELETE

/api/v1/notification/id/{id}

delete()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json

PUT

/api/v1/notification/delete

delete()

Request

Param	Type
containerId	string
includeContentType	boolean

Response

application/json

GET

/api/v1/permissions/_bypermissiontype

getPermissionsByPermissionType()

Request

Param	Type
userid	string
permission	string
permissiontype	string

Response

application/json
application/javascript

GET

/api/v1/permissions/_bycontent

getByContentlet()

Request

Param	Type
contentletId	string
type	string

Response

application/json
application/javascript

GET

/api/v1/relationshipscardinalities

getCardinality()

Request

Param	Type
contentletId	string
type	string

Response

application/json
application/javascript

GET

/api/portlet/{params:.*}

layoutGet()

Request

Param	Type
contentletId	string
type	string

Response

text/html

POST

/api/portlet/{params:.*}

layoutPost()

Request

Param	Type
contentletId	string
type	string

Response

text/html

GET

/api/portlet/layout/{params:.*}

getLayout()

Request

Param	Type
contentletId	string
type	string

Response

text/html

POST

/api/essearch

searchPost()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json

GET

/api/essearch

search()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json

GET

/api/esraw

searchRawGet()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json

POST

/api/esraw

searchRaw()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json

GET

/api/es/layout/{params:.*}

getLayout()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

text/html

DELETE

/api/v1/contenttype/id/{idOrVar}

deleteType()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json
application/javascript

PUT

/api/v1/contenttype/id/{idOrVar}

updateType()

Request

Param	Type
depth	string
live	boolean
allCategoriesInfo	boolean

Response

application/json
application/javascript

GET

/api/v1/contenttype/id/{idOrVar}

getType()

Request

Param	Type
languageId	long
live	boolean

Response

application/json
application/javascript

POST

/api/v1/contenttype/_filter

filteredContentTypes()

Request

Param	Type
languageId	long
live	boolean

Response

application/json
application/javascript

GET

/api/v1/contenttype/basetypes

getRecentBaseTypes()

Request

Param	Type
languageId	long
live	boolean

Response

application/json
application/javascript

POST

/api/v1/contenttype/{baseVariableName}/_copy

copyType()

Request

Param	Type
languageId	long
live	boolean

Response

application/json
application/javascript

GET

/api/ws/v1/system/events

getEvents()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/ws/v1/system/syncevents

getSyncEvents()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/appconfiguration/events

getEvents()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/appconfiguration/syncevents

getSyncEvents()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/dotexp/stats

getData()

Request

Param	Type
lastcallback	long

Response

application/octet-stream
application/json

GET

/api/v1/dotexp/visit

getJvmInfo()

Request

Param	Type
lastcallback	long

Response

application/octet-stream
application/json

POST

/api/integrity/_generateintegritydata

generateIntegrityData()

Request

Param	Type
lastcallback	long

Response

text/plain

GET

/api/integrity/{requestId}/integrityData

getIntegrityData()

Request

Param	Type
lastcallback	long

Response

application/zip

GET

/api/integrity/checkintegrity/{params:.*}

checkIntegrity()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/integrity/checkIntegrityProcessStatus/{params:.*}

checkIntegrityProcessStatus()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/integrity/getIntegrityResult/{params:.*}

getIntegrityResult()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/integrity/discardconflicts/{params:.*}

discardConflicts()

Request

Param	Type
lastcallback	long

Response

application/json

POST

/api/integrity/_fixconflictsfromremote

fixConflictsFromRemote()

Request

Param	Type
lastcallback	long

Response

text/plain

GET

/api/integrity/fixconflicts/{params:.*}

fixConflicts()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/v1/system/ruleengine/conditionlets

list()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/v1/system/ruleengine/actionlets

list()

Request

Param	Type
lastcallback	long

Response

application/json

GET

/api/v1/logger/{loggerName}

getLogger()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

POST

/api/v1/dotsaml/login/{idpConfigId}

processLogin()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/dotsaml/login/{idpConfigId}

doLogin()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

POST

/api/v1/dotsaml/logout/{idpConfigId}

logoutPost()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/dotsaml/logout/{idpConfigId}

logoutGet()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/dotsaml/metadata/{idpConfigId}

metadata()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/id/{fieldId}

getContentTypeFieldById()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

PUT

/api/v1/contenttype/{typeId}/fields/id/{fieldId}

updateContentTypeFieldById()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

DELETE

/api/v1/contenttype/{typeId}/fields/id/{fieldId}

deleteContentTypeFieldById()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}

getContentTypeFieldByVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

PUT

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}

updateContentTypeFieldByVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

DELETE

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}

deleteContentTypeFieldByVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

POST

/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables

createFieldVariableByFieldId()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables

getFieldVariablesByFieldId()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

POST

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables

createFieldVariableByFieldVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables

getFieldVariablesByFieldVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}

getFieldVariableByFieldId()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

PUT

/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}

updateFieldVariableByFieldId()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

DELETE

/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}

deleteFieldVariableByFieldId()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}

getFieldVariableByFieldVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

PUT

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}

updateFieldVariableByFieldVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

DELETE

/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}

deleteFieldVariableByFieldVar()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/auditPublishing/get/{bundleId:.*}

get()

Request

Param	Type
lastcallback	long

Response

text/xml

POST

/api/v1/contentrelated

pullRelated()

Request

Param	Type
lastcallback	long

Response

application/json
application/javascript

GET

/api/v1/content/_canlock/{inodeOrIdentifier}

canLockContent()

Request

Param	Type
language	string

Response

application/json

GET

/api/v1/content/{inodeOrIdentifier}

getContent()

Request

Param	Type
language	string

Response

application/json

PUT

/api/v1/site/{siteId}/_makedefault

makeDefault()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/currentSite

currentSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/defaultSite

defaultSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/switch/{id}

switchSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/switch

switchSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/thumbnails

findAllSiteThumbnails()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/{siteId}/_publish

publishSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/{siteId}/_unpublish

unpublishSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/{siteId}/_archive

archiveSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/{siteId}/_unarchive

unarchiveSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/site/{siteId}

deleteSite()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/{siteId}

findHostByIdentifier()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/{siteId}/setup_progress

getSiteSetupProgress()

Request

Param	Type
language	string

Response

application/json
application/javascript

POST

/api/v1/site/_byname

findHostByName()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/variable

saveSiteVariable()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/site/variable/{siteId}

getSiteVariables()

Request

Param	Type
language	string

Response

application/json
application/javascript

PUT

/api/v1/site/_copy

copySite()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/caches/provider/{provider: .*}/keys/{group: .*}

getKeys()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/caches/provider/{provider: .*}/flush

flushAll()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/caches/provider/{provider: .*}/flush/{group: .*}

flushGroup()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/caches/provider/{provider: .*}/{group: .*}

showProviders()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/caches/providers/{group: .*}

showProviders()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/caches/provider/{provider: .*}/object/{group: .*}/{id: .*}

showObject()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/caches/provider/{provider: .*}/objects/{group: .*}

showObjects()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/caches/provider/{provider: .*}/flush/{group: .*}/{id: .*}

flushObject()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/upgradetask/provider/{provider: .*}/keys/{group: .*}

getKeys()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/upgradetask/provider/{provider: .*}/flush

flushAll()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/upgradetask/provider/{provider: .*}/flush/{group: .*}

flushGroup()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/upgradetask/provider/{provider: .*}/{group: .*}

showProviders()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/upgradetask/providers/{group: .*}

showProviders()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/upgradetask/provider/{provider: .*}/object/{group: .*}/{id: .*}

showObject()

Request

Param	Type
language	string

Response

application/json
application/javascript

GET

/api/v1/upgradetask/provider/{provider: .*}/objects/{group: .*}

showObjects()

Request

Param	Type
language	string

Response

application/json
application/javascript

DELETE

/api/v1/upgradetask/provider/{provider: .*}/flush/{group: .*}/{id: .*}

flushObject()

Request

Param	Type
language	string

Response

application/json
application/javascript

POST

/api/v1/apps/export

exportSecrets()

Request

Param	Type
language	string

Response

application/octet-stream
application/json

GET

/api/v1/apps/

listAvailableApps()

Request

Param	Type
filter	string

Response

application/json
application/javascript

POST

/api/v1/apps/

createApp()

Request

Param	Type
filter	string

Response

application/json
application/javascript

DELETE

/api/v1/apps/

deleteIndividualAppSecret()

Request

Param	Type
filter	string

Response

application/json
application/javascript

GET

/api/v1/apps/{key}

getAppByKey()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string

Response

application/json
application/javascript

DELETE

/api/v1/apps/{key}

deleteApp()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/apps/{key}/{siteId}

getAppDetail()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

PUT

/api/v1/apps/{key}/{siteId}

updateAppIndividualSecret()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

POST

/api/v1/apps/{key}/{siteId}

createAppSecrets()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

DELETE

/api/v1/apps/{key}/{siteId}

deleteAllAppSecrets()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

POST

/api/v1/apps/import

importSecrets()

Request

Param	Type
removeDescriptor	boolean

Response

application/json

GET

/api/v1/browsertree/sitename/{sitename}/uri/

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/browsertree/sitename/{sitename}/uri/{uri : .+}

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/logout/sitename/{sitename}/uri/

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/logout/sitename/{sitename}/uri/{uri : .+}

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/publishqueue/sitename/{sitename}/uri/

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

GET

/api/v1/publishqueue/sitename/{sitename}/uri/{uri : .+}

loadAssetsUnder()

Request

Param	Type
removeDescriptor	boolean

Response

application/json
application/javascript

POST

/api/config/regenerateKey

regenerateKey()

Request

Param	Type
removeDescriptor	boolean

Response

application/json

POST

/api/config/deleteEnvironment

deleteEnvironment()

Request

Param	Type
user	string
password	string
environment	string
type	string
callback	string

Response

application/json

POST

/api/config/saveCompanyBasicInfo

saveCompanyBasicInfo()

Request

Param	Type
user	string
password	string
portalURL	string
mx	string
emailAddress	string
size	string
type	string
street	string
homeURL	string
city	string
state	string

Response

application/json

POST

/api/config/saveCompanyLocaleInfo

saveCompanyLocaleInfo()

Request

Param	Type
user	string
password	string
languageId	string
timeZoneId	string

Response

application/json

POST

/api/config/saveCompanyAuthTypeInfo

saveCompanyAuthTypeInfo()

Request

Param	Type
user	string
password	string
authType	string

Response

application/json

POST

/api/config/saveCompanyLogo

saveCompanyLogo()

Request

Param	Type
user	string
password	string
authType	string

Response

text/html

POST

/api/config/deleteEndpoint

deleteEndpoint()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

GET

/api/user/getloggedinuser/{params:.*}

getLoggedInUser()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

GET

/api/cluster/test

testCluster()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

*/*

GET

/api/cluster/getESConfigProperties/{params:.*}

getESConfigProperties()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

GET

/api/cluster/licenseRepoStatus

getLicenseRepoStatus()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

POST

/api/cluster/remove/{params:.*}

removeFromCluster()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

*/*

GET

/api/cluster/getNodesStatus/{params:.*}

getNodesInfo()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

GET

/api/v1/menu/test

testCluster()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

*/*

GET

/api/v1/menu/getESConfigProperties/{params:.*}

getESConfigProperties()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

GET

/api/v1/menu/licenseRepoStatus

getLicenseRepoStatus()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

POST

/api/v1/menu/remove/{params:.*}

removeFromCluster()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

*/*

GET

/api/v1/menu/getNodesStatus/{params:.*}

getNodesInfo()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json

POST

/api/v1/personalization/pagepersonas

personalizePageContainers()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json
application/javascript

DELETE

/api/v1/personalization/pagepersonas/page/{pageId}/personalization/{personalization}

personalizePageContainers()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json
application/javascript

POST

/api/v1/temp/byUrl

copyTempFromUrl()

Request

Param	Type
user	string
password	string
endPoint	string
type	string
callback	string

Response

application/json
application/javascript

GET

/api/structure/{path:.*}

getStructuresWithWYSIWYGFields()

Request

Param	Type
name	string

Response

application/json

PUT

/api/v3/contenttype/{typeIdOrVarName}/fields/{id}

updateField()

Request

Param	Type
name	string

Response

application/json
application/javascript

PUT

/api/v3/contenttype/{typeIdOrVarName}/fields/move

moveFields()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/portlet/{portletId}

findPortlet()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/portlet/{portletId}/_doesuserhaveaccess

doesUserHaveAccessToPortlet()

Request

Param	Type
name	string

Response

application/json
application/javascript

POST

/api/v1/portlet/custom

createContentPortlet()

Request

Param	Type
name	string

Response

application/json
application/javascript

PUT

/api/v1/portlet/custom/{portletId}/_addtolayout/{layoutId}

addContentPortletToLayout()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/portlet/custom/{portletId}

deleteCustomPortlet()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/portlet/portletId/{portletId}

deletePersonalPortlet()

Request

Param	Type
name	string

Response

application/json
application/javascript

DELETE

/api/v1/portlet/portletId/{portletId}/roleId/{roleId}

deletePortletForRole()

Request

Param	Type
name	string

Response

application/json
application/javascript

GET

/api/v1/portlet/_actionurl/{contentTypeVariable}

getCreateContentURL()

Request

Param	Type
name	string

Response

application/json
application/javascript

PUT

/api/v1/toolgroups/{layoutId}/_addtouser

addToolGroupToUser()

Request

Param	Type
userid	string

Response

application/json
application/javascript

PUT

/api/v1/toolgroups/{layoutId}/_removefromuser

deleteToolGroupFromUser()

Request

Param	Type
userid	string

Response

application/json
application/javascript

GET

/api/v1/toolgroups/{layoutId}/_userHasLayout

userHasLayout()

Request

Param	Type
userid	string

Response

application/json
application/javascript

GET

/api/osgi/_processExports/{bundle:.*}

processBundle()

Request

Param	Type
userid	string

Response

application/json

GET

/api/osgi/getInstalledBundles/{params:.*}

getInstalledBundles()

Request

Param	Type
userid	string

Response

application/json

GET

/api/v1/content/resourcelinksfield/{field}

findResourceLink()

Request

Param	Type
inode	string
identifier	string
language	string

Response

application/json;charset=UTF-8

GET

/api/v1/roles_search

searchRoles()

Request

Param	Type
searchName	string
searchKey	string
roleId	string
start	int
count	int
includeUserRoles	boolean
includeWorkflowRoles	boolean

Response

application/json

GET

/api/v1/roles/{roleid}/rolehierarchyanduserroles

loadUsersAndRolesByRoleId()

Request

Param	Type
roleHierarchyForAssign	boolean
name	string

Response

application/json

GET

/api/v1/roles/checkuserroles/userid/{userId}/roleids/{roleIds}

checkRoles()

Request

Param	Type
roleHierarchyForAssign	boolean
name	string

Response

application/json

DELETE

/api/v1/roles/layouts

deleteRoleLayouts()

Request

Param	Type
roleHierarchyForAssign	boolean
name	string

Response

application/json

POST

/api/v1/roles/layouts

saveRoleLayouts()

Request

Param	Type
roleHierarchyForAssign	boolean
name	string

Response

application/json

GET

/api/v1/roles/{roleId}/layouts

findRoleLayouts()

Request

Param	Type
roleHierarchyForAssign	boolean
name	string

Response

application/json

GET

/api/v1/roles/{roleid}

loadRoleByRoleId()

Request

Param	Type
loadChildrenRoles	boolean

Response

application/json

PUT

/api/v1/browser/selectedfolder

selectFolder()

Request

Param	Type
loadChildrenRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/browser/selectedfolder

getSelectFolder()

Request

Param	Type
loadChildrenRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/configuration/config

getConfigVariables()

Request

Param	Type
keys	string

Response

application/json
application/javascript

POST

/api/v1/configuration/_validateCompanyEmail

validateEmail()

Request

Param	Type
keys	string

Response

application/json
application/javascript

PATCH

/api/vtl/{folder}/{pathParam: .*}

patch()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/{folder}/{pathParam: .*}

post()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/{folder}/{pathParam: .*}

postMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/{folder}/{pathParam: .*}

putMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PATCH

/api/vtl/{folder}/{pathParam: .*}

patchMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/{folder}/{pathParam: .*}

put()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

DELETE

/api/vtl/{folder}/{pathParam: .*}

delete()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PATCH

/api/vtl/{folder}

patch()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/{folder}

post()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/{folder}

postMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/{folder}

putMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PATCH

/api/vtl/{folder}

patchMultipart()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

GET

/api/vtl/{folder}

get()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/{folder}

put()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

DELETE

/api/vtl/{folder}

delete()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

GET

/api/vtl/dynamic

dynamicGet()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/dynamic

dynamicPost()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/dynamic

dynamicPut()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

GET

/api/vtl/dynamic/{pathParam:.*}

dynamicGet()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

POST

/api/vtl/dynamic/{pathParam:.*}

dynamicPost()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PUT

/api/vtl/dynamic/{pathParam:.*}

dynamicPut()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

PATCH

/api/vtl/dynamic/{pathParam:.*}

dynamicPatch()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

DELETE

/api/vtl/dynamic/{pathParam:.*}

dynamicDelete()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

GET

/api/vtl/{folder}/{pathParam:.*}

get()

Request

Param	Type
keys	string

Response

application/json
application/xml
text/plain

GET

/api/v1/page/render/{uri: .*}

render()

Request

Param	Type
mode	string
com.dotmarketing.persona.id	string
language_id	string
device_inode	string

Response

application/json
application/javascript

POST

/api/v1/page/{pageId}/layout

saveLayout()

Request

Param	Type
mode	string
com.dotmarketing.persona.id	string
language_id	string
device_inode	string

Response

application/json
application/javascript

POST

/api/v1/page/layout

saveLayout()

Request

Param	Type
mode	string
com.dotmarketing.persona.id	string
language_id	string
device_inode	string

Response

application/json
application/javascript

GET

/api/v1/page/json/{uri: .*}

loadJson()

Request

Param	Type
mode	string
com.dotmarketing.persona.id	string
language_id	string
device_inode	string

Response

application/json
application/javascript

POST

/api/v1/page{pageId}/content

addContent()

Request

Param	Type
variantName	string

Response

application/json

GET

/api/v1/page/renderHTML/{uri: .*}

renderHTMLOnly()

Request

Param	Type
mode	string

Response

application/html
application/javascript

GET

/api/v1/pagesearch

searchPage()

Request

Param	Type
path	string
live	boolean
onlyLiveSites	boolean

Response

application/html
application/javascript

GET

/api/v1/page/{pageId}/render/versions

getHtmlVersionsPage()

Request

Param	Type
langId	string

Response

application/json
application/javascript

GET

/api/v1/page/{pageId}/content/tree

getContentTree()

Request

Param	Type
langId	string

Response

application/json
application/javascript

GET

/api/v1/page/{pageId}/personas

getPersonalizedPersonasOnPage()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

PUT

/api/v1/page/copyContent

copyContent()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json

PUT

/api/v1/page/{pageId}/_deepcopy

deepCopyPage()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json

GET

/api/v1/system-status/

statusCheck()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json

GET

/api/v1/system-status/alive

aliveCheck()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

*/*

GET

/api/v1/authenticationlogInUser

getLoginUser()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

POST

/api/v1/authentication/api-token

getApiToken()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/maintenance/_downloadLog/{fileName}

downloadLogFile()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/octet-stream
application/json

GET

/api/v1/maintenance/_pgDumpAvailable

isPgDumpAvailable()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

text/plain

GET

/api/v1/maintenance/_downloadDb

downloadDb()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/octet-stream
application/json

GET

/api/v1/maintenance/_downloadAssets

downloadAssets()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/octet-stream
application/json

GET

/api/v1/maintenance/_downloadStarter

downloadStarter()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/octet-stream
application/json

GET

/api/v1/maintenance/_downloadStarterWithAssets

downloadStarterWithAssets()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/octet-stream
application/json

DELETE

/api/v1/maintenance/_shutdown

shutdown()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/themes/id/{id}

findThemeById()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

PUT

/api/v1/apitoken/remote

getRemoteToken()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/apitoken/{tokenId}/jwt

getJwtFromApiToken()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

PUT

/api/v1/apitoken/users/{userid}/revoke

revokeUserToken()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

PUT

/api/v1/apitoken/users/revoke

revokeUsersToken()

Request

Param	Type
filter	string
page	int
per_page	int
orderby	string
direction	string
hostId	string
respectFrontEndRoles	boolean

Response

application/json
application/javascript

GET

/api/v1/apitoken/{userId}/tokens

getApiTokens()

Request

Param	Type
showRevoked	boolean

Response

application/json
application/javascript

PUT

/api/v1/apitoken/{tokenId}/revoke

revokeApiToken()

Request

Param	Type
showRevoked	boolean

Response

application/json
application/javascript

DELETE

/api/v1/apitoken/{tokenId}

deleteApiToken()

Request

Param	Type
showRevoked	boolean

Response

application/json
application/javascript

POST

/api/v1/apitoken/

issueApiToken()

Request

Param	Type
showRevoked	boolean

Response

application/json
application/javascript

GET

/api/v1/system/i18n/{lang:[\w]{2,3}(?:-?[\w]{2})?}/{rsrc:.*}

list()

Request

Param	Type
showRevoked	boolean

Response

application/json

DELETE

/api/bundle/all

deleteAll()

Request

Param	Type
showRevoked	boolean

Response

application/json

GET

/api/bundle/updatebundle/{params:.*}

updateBundle()

Request

Param	Type
showRevoked	boolean

Response

application/json

GET

/api/bundle/getunsendbundles/{params:.*}

getUnsendBundles()

Request

Param	Type
showRevoked	boolean

Response

application/json

GET

/api/bundle/{bundleId}/assets

getPublishQueueElements()

Request

Param	Type
limit	int

Response

application/json

GET

/api/bundle/deletepushhistory/{params:.*}

deletePushHistory()

Request

Param	Type
limit	int

Response

application/json

GET

/api/bundle/deleteenvironmentpushhistory/{params:.*}

deleteEnvironmentPushHistory()

Request

Param	Type
limit	int

Response

application/json

DELETE

/api/bundle/ids

deleteBundlesByIdentifiers()

Request

Param	Type
limit	int

Response

application/json

DELETE

/api/bundle/olderthan/{olderThan}

deleteBundlesOlderThan()

Request

Param	Type
limit	int

Response

application/json

DELETE

/api/bundle/all/fail

deleteAllFail()

Request

Param	Type
limit	int

Response

application/json

DELETE

/api/bundle/all/success

deleteAllSuccess()

Request

Param	Type
limit	int

Response

application/json

GET

/api/bundle/_download/{bundleId}

downloadBundle()

Request

Param	Type
limit	int

Response

application/octet-stream

POST

/api/bundle/_generate

generateBundle()

Request

Param	Type
limit	int

Response

application/octet-stream

POST

/api/bundle/sync

uploadBundleSync()

Request

Param	Type
limit	int

Response

application/json
application/xml
text/plain

GET

/api/bundle/{bundleId}/manifest

downloadManifest()

Request

Param	Type
limit	int

Response

application/json
application/octet-stream

GET

/api/rulesengine/layout/{params:.*}

getLayout()

Request

Param	Type
limit	int

Response

text/html

GET

/api/v1/personas{id}

self()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/restexample/test/{params:.*}

loadJson()

Request

Param	Type
limit	int

Response

application/json

GET

/api/restexample/layout/{params:.*}

getLayout()

Request

Param	Type
limit	int

Response

text/html

DELETE

/api/v2/languages/{languageId}

deleteLanguage()

Request

Param	Type
limit	int

Response

application/json
application/javascript

PUT

/api/v2/languages/{languageId}

updateLanguage()

Request

Param	Type
limit	int

Response

application/json
application/javascript

PUT

/api/v2/languages/{language}/_makedefault

makeDefault()

Request

Param	Type
limit	int

Response

application/json
application/javascript

POST

/api/v2/languages/{languageTag}

saveFromLanguageTag()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/v2/languages/{languageTag}

getFromLanguageTag()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/v2/languages{language}/keys

getAllMessages()

Request

Param	Type
limit	int

Response

application/json
application/javascript

POST

/api/v2/languages/i18n

getMessages()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/v2/languages/id/{languageid}

get()

Request

Param	Type
limit	int

Response

application/json
application/javascript

DELETE

/api/v1/versionables/{versionableInode}

deleteVersion()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/v1/versionables/{versionableInodeOrIdentifier}

findVersionable()

Request

Param	Type
limit	int

Response

application/json
application/javascript

PUT

/api/v1/versionables/{versionableInode}/_bringback

bringBack()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/content/indexsearch/{query}/sortby/{sortby}/limit/{limit}/offset/{offset}

indexSearch()

Request

Param	Type
limit	int

Response

application/json

GET

/api/content/indexcount/{query}

indexCount()

Request

Param	Type
limit	int

Response

text/plain

PUT

/api/content/lock/{params:.*}

lockContent()

Request

Param	Type
limit	int

Response

application/json

PUT

/api/content/canLock/{params:.*}

canLockContent()

Request

Param	Type
limit	int

Response

application/json

PUT

/api/content/unlock/{params:.*}

unlockContent()

Request

Param	Type
limit	int

Response

application/json

PUT

/api/content/{params:.*}

multipartPUT()

Request

Param	Type
limit	int

Response

application/json
application/javascript
text/plain

POST

/api/content/{params:.*}

multipartPOST()

Request

Param	Type
limit	int

Response

text/plain

PUT

/api/content/{params:.*}

singlePUT()

Request

Param	Type
limit	int

Response

application/json
text/plain

POST

/api/content/{params:.*}

singlePOST()

Request

Param	Type
limit	int

Response

application/json
text/plain

GET

/api/content/{params:.*}

getContent()

Request

Param	Type
limit	int

Response

application/json

POST

/api/content/_search

search()

Request

Param	Type
limit	int

Response

application/json

GET

/api/v1/content/fileassets/{inode}/resourcelink

findResourceLink()

Request

Param	Type
limit	int

Response

application/json;charset=UTF-8

GET

/api/v1/users/current

self()

Request

Param	Type
limit	int

Response

application/json
application/javascript

PUT

/api/v1/users/current

update()

Request

Param	Type
limit	int

Response

application/json
application/javascript

POST

/api/v1/users/loginas

loginAs()

Request

Param	Type
limit	int

Response

application/json
application/javascript

PUT

/api/v1/users/logoutas

logoutAs()

Request

Param	Type
limit	int

Response

application/json
application/javascript

GET

/api/v1/users/loginAsData

loginAsData()

Request

Param	Type
filter	string
page	int
per_page	int

Response

application/json
application/javascript

GET

/api/v1/users/filter/{params:.*}

filter()

Request

Param	Type
filter	string
page	int
per_page	int

Response

application/json
application/javascript

GET

/api/v1/logs/{fileName}/_tail

getLogs()

Request

Param	Type
linesBack	int

Response

text/event-stream

DELETE

/api/v1/esindex/failed

deleteFailedRecords()

Request

Param	Type
linesBack	int

Response

application/json

GET

/api/v1/esindex/failed

downloadRemainingRecordsAsCsv()

Request

Param	Type
linesBack	int

Response

application/json

POST

/api/v1/esindex/optimize

optimizeIndices()

Request

Param	Type
linesBack	int

Response

application/json

DELETE

/api/v1/esindex/cache

flushIndiciesCache()

Request

Param	Type
linesBack	int

Response

application/json

DELETE

/api/v1/esindex/{indexName: .*}

deleteIndex()

Request

Param	Type
linesBack	int

Response

application/json

PUT

/api/v1/esindex/{indexName: .*}

modIndex()

Request

Param	Type
action	string

Response

application/json

GET

/api/v1/esindex/indexlist/{params:.*}

indexList()

Request

Param	Type
action	string

Response

application/json

GET

/api/v1/esindex/active/{params:.*}

getActive()

Request

Param	Type
action	string

Response

text/plain

PUT

/api/v1/esindex/activate/{params:.*}

activateIndex()

Request

Param	Type
action	string

Response

*/*

PUT

/api/v1/esindex/deactivate/{params:.*}

deactivateIndex()

Request

Param	Type
action	string

Response

*/*

PUT

/api/v1/esindex/create/{params:.*}

createIndex()

Request

Param	Type
action	string

Response

text/plain

PUT

/api/v1/esindex/clear/{params:.*}

clearIndex()

Request

Param	Type
action	string

Response

*/*

PUT

/api/v1/esindex/close/{params:.*}

closeIndex()

Request

Param	Type
action	string

Response

*/*

PUT

/api/v1/esindex/open/{params:.*}

openIndex()

Request

Param	Type
action	string

Response

*/*

GET

/api/v1/esindex/

getIndexStatus()

Request

Param	Type
action	string

Response

application/json

GET

/api/v1/esindex/cluster

getClusterStats()

Request

Param	Type
action	string

Response

application/json

GET

/api/v1/esindex/reindex

getReindexationProgress()

Request

Param	Type
action	string

Response

application/json

POST

/api/v1/esindex/reindex

startReindex()

Request

Param	Type
shards	int
contentType	string

Response

application/json

DELETE

/api/v1/esindex/reindex

stopReindexation()

Request

Param	Type
switch	boolean

Response

application/json

GET

/api/role/loadchildren/{params:.*}

loadChildren()

Request

Param	Type
switch	boolean

Response

application/json

GET

/api/role/loadbyid/{params:.*}

loadById()

Request

Param	Type
switch	boolean

Response

application/json

GET

/api/role/loadbyname/{params:.*}

loadByName()

Request

Param	Type
switch	boolean

Response

application/json

POST

/api/v1/folder/createfolders/{siteName}

createFolders()

Request

Param	Type
switch	boolean

Response

application/json
application/javascript

DELETE

/api/v1/folder/{siteName}

deleteFolders()

Request

Param	Type
switch	boolean

Response

application/json
application/javascript

PUT

/api/v1/folder/{id}/file-browser-selected

selectFolder()

Request

Param	Type
switch	boolean

Response

application/json
application/javascript

GET

/api/v1/folder/sitename/{siteName}/uri/{uri : .+}

loadFolderByURI()

Request

Param	Type
switch	boolean

Response

application/json
application/javascript

GET

/api/v1/folder/siteId/{siteId}/path/{path : .+}

loadFolderAndSubFoldersByPath()

Request

Param	Type
switch	boolean

Response

application/json

POST

/api/v1/folder/byPath

findSubFoldersByPath()

Request

Param	Type
switch	boolean

Response

application/json

GET

/api/v1/folder/{folderId}

findFolderById()

Request

Param	Type
switch	boolean

Response

application/json

GET

/api/license/all/{params:.*}

getAll()

Request

Param	Type
switch	boolean

Response

application/json

POST

/api/license/pick/{params:.*}

pickLicense()

Request

Param	Type
switch	boolean

Response

*/*

POST

/api/license/upload/{params:.*}

putZipFile()

Request

Param	Type
switch	boolean

Response

*/*

POST

/api/license/free/{params:.*}

freeLicense()

Request

Param	Type
switch	boolean

Response

*/*

POST

/api/license/requestCode/{params:.*}

requestLicense()

Request

Param	Type
switch	boolean

Response

*/*

POST

/api/license/applyLicense

applyLicense()

Request

Param	Type
licenseText	string

Response

*/*

POST

/api/license/resetLicense/{params:.*}

resetLicense()

Request

Param	Type
licenseText	string

Response

*/*

DELETE

/api/license/delete/{params:.*}

delete()

Request

Param	Type
licenseText	string

Response

*/*

PUT

/api/v1/experiments/{experimentId}/_archive

archive()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/experiments/{experimentId}/variants

addVariant()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/experiments/{experimentId}/variants/{name}

deleteVariant()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/experiments/{experimentId}/targetingConditions/{id}

deleteTargetingCondition()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/experiments/{experimentId}/goals/primary

deleteGoal()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/v1/experiments/{id}

get()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

PATCH

/api/v1/experiments/{experimentId}

update()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/experiments/{experimentId}

delete()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/experiments/{experimentId}/_end

end()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/experiments/{experimentId}/_start

start()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

PUT

/api/v1/forgotpassword/{experimentId}/_archive

archive()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/forgotpassword/{experimentId}/variants

addVariant()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/forgotpassword/{experimentId}/variants/{name}

deleteVariant()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/forgotpassword/{experimentId}/targetingConditions/{id}

deleteTargetingCondition()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/forgotpassword/{experimentId}/goals/primary

deleteGoal()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/v1/forgotpassword/{id}

get()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

PATCH

/api/v1/forgotpassword/{experimentId}

update()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

DELETE

/api/v1/forgotpassword/{experimentId}

delete()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/forgotpassword/{experimentId}/_end

end()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/forgotpassword/{experimentId}/_start

start()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/environment/loadenvironments/{params:.*}

loadEnvironments()

Request

Param	Type
licenseText	string

Response

application/json

GET

/api/openapi.{type:json|yaml}/loadenvironments/{params:.*}

loadEnvironments()

Request

Param	Type
licenseText	string

Response

application/json

GET

/api/v1/changePassword/loadenvironments/{params:.*}

loadEnvironments()

Request

Param	Type
licenseText	string

Response

application/json

DELETE

/api/v1/tags/inode/{inode}

deleteTagInodesByInode()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/v1/tags/inode/{inode}

findTagsByInode()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/v1/tags/user/{userId}

getTagsByUserId()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/v1/tags/{nameOrId}

getTagsByNameOrId()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

PUT

/api/v1/tags/tag/{nameOrId}/inode/{inode}

linkTagsAndInode()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

POST

/api/v1/tags/import

importTags()

Request

Param	Type
licenseText	string

Response

application/json

DELETE

/api/v1/tags/{tagId}

delete()

Request

Param	Type
licenseText	string

Response

application/json
application/javascript

GET

/api/widget/{params:.*}

getWidget()

Request

Param	Type
licenseText	string

Response

text/plain;charset=UTF-8

dotCMS Cloud

Performance Hub

Headless CMS

Intranets & Extranets

Integration Platform

Knowledge Base

Web Apps & Sites

Customer Portals

Agile E-Commerce

Digital Asset Management

Industries

Partners

Our global network of partners represents over 800 offices in 150 countries

Resources

Services

Developer

All APIs (Generated)

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request