Resources

name path methods description
ActivitiResource
  • /activiti/processqueue
  • /activiti/status
  • /activiti/task/{id}
  • GET
  • GET
  • DELETE GET POST
Resource for integration of Activiti with the CMS. Usage of this resource requires the feature activiti_integration to be activated.
AdminResource
  • /admin/tools
  • /admin/version
  • /admin/features/{name}
  • GET
  • GET
  • GET
Resource for various tasks used by the administrator (like retrieving version numbers)
AuthenticationResource
  • /auth/globalprefix
  • /auth/hashpassword
  • /auth/login
  • /auth/loginwithrsa
  • /auth/matchpassword
  • /auth/ssologin
  • /auth/logout/{sid}
  • /auth/validate/{sid}
  • GET
  • POST
  • GET POST
  • POST
  • POST
  • GET
  • POST
  • GET
Authentication Resource. This can be used to authenticate an existing SID.
ClusterResource
  • /cluster/info
  • /cluster/master
  • GET
  • PUT
Resource for clustering support
ConstructResource
  • /construct/list
  • /construct/load/{constructId}
  • /construct/delete/{constructId}/{idOrKeyname}
  • GET
  • GET
  • POST
Resource for handling constructs
ContentRepositoryFragmentResource
  • /cr_fragments
  • /cr_fragments/{id}
  • /cr_fragments/{id}/entries
  • /cr_fragments/{id}/entries/{entryId}
  • GET POST
  • DELETE GET PUT
  • GET POST
  • DELETE GET PUT
Resource for handling ContentRepository Fragments
ContentRepositoryResource
  • /contentrepositories
  • /contentrepositories/{id}
  • /contentrepositories/{id}/copy
  • /contentrepositories/{id}/cr_fragments
  • /contentrepositories/{id}/entries
  • /contentrepositories/{id}/cr_fragments/{crFragmentId}
  • /contentrepositories/{id}/data/check
  • /contentrepositories/{id}/data/repair
  • /contentrepositories/{id}/entries/check
  • /contentrepositories/{id}/entries/{entryId}
  • /contentrepositories/{id}/structure/check
  • /contentrepositories/{id}/structure/repair
  • GET POST
  • DELETE GET PUT
  • PUT
  • GET
  • GET POST
  • DELETE GET PUT
  • PUT
  • PUT
  • GET
  • DELETE GET PUT
  • PUT
  • PUT
Resource for handling ContentRepositories
DiffResource
  • /diff/daisyDiff
  • /diff/html
  • /diff/source
  • POST
  • POST
  • POST
This resource implements the diff tool in the REST API, which can be used to calculate the diff between html contents.
ExportResource
  • /export/selection
  • POST
Export helper resource
FileResource
  • /file/copy
  • /file/create
  • /file/createSimple
  • /file/disinherit
  • /file/load
  • /file/localizationinfo
  • /file/move
  • /file/push2master
  • /file/unlocalize
  • /file/delete/{id}
  • /file/disinherit/{id}
  • /file/load/{id}
  • /file/localizationinfo/{id}
  • /file/localizations/{id}
  • /file/localize/{id}
  • /file/move/{id}
  • /file/push2master/{id}
  • /file/save/{id}
  • /file/unlocalize/{id}
  • /file/usage/file
  • /file/usage/folder
  • /file/usage/image
  • /file/usage/page
  • /file/usage/syncableObjects
  • /file/usage/template
  • /file/usage/total
  • /file/wastebin/delete
  • /file/wastebin/restore
  • /file/content/load/{id}
  • /file/wastebin/delete/{id}
  • /file/wastebin/restore/{id}
  • POST
  • POST
  • POST
  • GET POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • POST
  • POST
Resource for loading and manipulating Files in GCN
FolderResource
  • /folder/create
  • /folder/disinherit
  • /folder/findFiles
  • /folder/findPages
  • /folder/getFolders
  • /folder/load
  • /folder/move
  • /folder/push2master
  • /folder/unlocalize
  • /folder/breadcrumb/{id}
  • /folder/count/{id}
  • /folder/delete/{id}
  • /folder/disinherit/{id}
  • /folder/getExternalLinks/{folderId}
  • /folder/getFiles/{folderId}
  • /folder/getFolders/{id}
  • /folder/getImages/{folderId}
  • /folder/getItems/{folderId}
  • /folder/getPages/{id}
  • /folder/getTemplates/{folderId}
  • /folder/load/{id}
  • /folder/localizationinfo/{id}
  • /folder/localizations/{id}
  • /folder/localize/{id}
  • /folder/move/{id}
  • /folder/privileges/{id}
  • /folder/push2master/{id}
  • /folder/save/{id}
  • /folder/startpage/{id}
  • /folder/unlocalize/{id}
  • /folder/usage/syncableObjects
  • /folder/wastebin/delete
  • /folder/wastebin/restore
  • /folder/wastebin/delete/{id}
  • /folder/wastebin/restore/{id}
  • POST
  • GET POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
Resource for loading and manipulating folders in GCN
GroupResource
  • /group/list
  • /group/load
  • GET
  • GET
Resource to get groups
I18nResource
  • /i18n/get
  • /i18n/set
  • /i18n/t
  • /i18n/t/{key}
  • GET
  • POST
  • GET
  • GET
Resource to translate given keys (optionally including parameters)
ImageResource
  • /image/disinherit
  • /image/load
  • /image/localizationinfo
  • /image/move
  • /image/push2master
  • /image/resize
  • /image/unlocalize
  • /image/delete/{id}
  • /image/disinherit/{id}
  • /image/load/{id}
  • /image/localizationinfo/{id}
  • /image/localizations/{id}
  • /image/localize/{id}
  • /image/move/{id}
  • /image/push2master/{id}
  • /image/save/{id}
  • /image/unlocalize/{id}
  • /image/usage/file
  • /image/usage/folder
  • /image/usage/image
  • /image/usage/page
  • /image/usage/syncableObjects
  • /image/usage/template
  • /image/usage/total
  • /image/wastebin/delete
  • /image/wastebin/restore
  • /image/wastebin/delete/{id}
  • /image/wastebin/restore/{id}
  • GET POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
Resource for loading and manipulating Images in GCN
InfoResource
  • /info/maintenance
  • GET
Resource for access to general info about the system, which are available without a valid session.
LanguageResource
  • /language/list
  • GET
Resource to manage cms languages
MessagingResource
  • /msg/list
  • /msg/read
  • /msg/send
  • GET
  • POST
  • POST
Messaging resource to access the inbox (list, view, mark read, delete) and send messages
MigrationResource
  • /migration/cancelMigration
  • /migration/getMigrationConstructs
  • /migration/getMigrationLogs
  • /migration/getMigrationStatus
  • /migration/getMigrationTagTypes
  • /migration/getPossiblePartMappings
  • /migration/performMigration
  • /migration/performTemplateMigration
  • /migration/reinvokeMigration
  • /migration/getMigrationJobItems/{jobId}
  • /migration/getMigrationLog/{jobId}
  • /migration/getPartsForTagType/{id}
  • GET
  • POST
  • GET
  • GET
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
Resource used for performing Tag Type Migrations and Template Migrations
NodeResource
  • /node/create
  • /node/features/{id}
  • /node/getLanguages/{id}
  • /node/load/{id}
  • /node/save/{id}
  • /node/{nodeId}/constructs
  • /node/{nodeId}/settings
  • /node/{nodeId}/templates
  • /node/features/activate/{id}
  • /node/features/deactivate/{id}
  • /node/features/set/{id}
  • /node/{nodeId}/constructs/{constructId}
  • /node/{nodeId}/templates/{templateId}
  • POST
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • DELETE PUT
  • DELETE PUT
Resource for handling Nodes in GCN
PackageResource
  • /devtools/packages
  • /devtools/sync
  • /devtools/autocomplete/constructs
  • /devtools/autocomplete/cr_fragments
  • /devtools/autocomplete/datasources
  • /devtools/autocomplete/objectproperties
  • /devtools/autocomplete/templates
  • /devtools/listen/{uuid}
  • /devtools/packages/{name}
  • /devtools/preview/{uuid}
  • /devtools/nodes/{nodeId}/packages
  • /devtools/packages/{name}/cms2fs
  • /devtools/packages/{name}/constructs
  • /devtools/packages/{name}/cr_fragments
  • /devtools/packages/{name}/datasources
  • /devtools/packages/{name}/fs2cms
  • /devtools/packages/{name}/objectproperties
  • /devtools/packages/{name}/templates
  • /devtools/preview/page/{id}
  • /devtools/nodes/{nodeId}/packages/{packageName}
  • /devtools/packages/{name}/constructs/{construct}
  • /devtools/packages/{name}/cr_fragments/{cr_fragment}
  • /devtools/packages/{name}/datasources/{datasource}
  • /devtools/packages/{name}/objectproperties/{objectproperty}
  • /devtools/packages/{name}/templates/{template}
  • GET
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • GET PUT
  • PUT
  • GET
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • DELETE PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
PageResource
  • /page/assign
  • /page/autocomplete
  • /page/copy
  • /page/create
  • /page/disinherit
  • /page/load
  • /page/localizationinfo
  • /page/move
  • /page/preview
  • /page/publish
  • /page/pubqueue
  • /page/push2master
  • /page/search
  • /page/unlocalize
  • /page/cancel/{id}
  • /page/delete/{id}
  • /page/disinherit/{id}
  • /page/getTags/{id}
  • /page/load/{id}
  • /page/localizationinfo/{id}
  • /page/localizations/{id}
  • /page/localize/{id}
  • /page/move/{id}
  • /page/newtag/{id}
  • /page/newtags/{id}
  • /page/publish/{id}
  • /page/push2master/{id}
  • /page/render/{id}
  • /page/restore/{id}
  • /page/save/{id}
  • /page/takeOffline/{id}
  • /page/translate/{id}
  • /page/unlocalize/{id}
  • /page/usage/linkedFile
  • /page/usage/linkedImage
  • /page/usage/linkedPage
  • /page/usage/page
  • /page/usage/syncableObjects
  • /page/usage/tag
  • /page/usage/template
  • /page/usage/total
  • /page/usage/variant
  • /page/wastebin/delete
  • /page/wastebin/restore
  • /page/restore/{pageid}/{tag}
  • /page/wastebin/delete/{id}
  • /page/wastebin/restore/{id}
  • /page/workflow/decline/{id}
  • /page/workflow/revoke/{id}
  • POST
  • GET
  • POST
  • POST
  • GET POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
Resource used for loading, saving and manipulating GCN pages.
PermResource
  • /perm/list/{type}
  • /perm/{type}/{id}
  • /perm/list/{type}/{id}
  • /perm/{perm}/{type}/{id}
  • GET
  • GET POST
  • GET
  • GET
Resource for reading and writing permissions.

The following table can be used to look up the bit positions (starting at 0) of the folder permissions:

TypeShortDescriptionBit
FoldersShow0
rAssign user permissions1
cCreate8
eEdit9
dDelete10
Pages/Images/FilessShow11
cCreate12
eEdit13
dDelete14
iImport23
PagespPublish19
TemplatessShow15
cCreate16
lLink21
eEdit17
dDelete18
WorkflowvLink22

The following table can be used to look up the bit positions (starting at 0) of the role permissions:

TypeDescriptionBit
Role permissionsShow10
Create11
Modify12
Delete13
Publishing14
Translate15
PolicyMapResource
  • /policyMap/policy
  • /policyMap/partType/{typeId}/policyGroup
  • GET
  • GET
API for reading from the policy map.
SchedulerResource
  • /scheduler/resume
  • /scheduler/status
  • /scheduler/suspend
  • PUT
  • GET
  • PUT
Resource for managing the scheduler
SearchResource
  • /elastic/{path}
  • POST
Resource for endpoints that are forwarded to elasticsearch for performing searches
TemplateResource
  • /template/link
  • /template/localizationinfo
  • /template/push2master
  • /template/unlink
  • /template/unlocalize
  • /template/getTags/{id}
  • /template/link/{id}
  • /template/load/{id}
  • /template/localizationinfo/{id}
  • /template/localizations/{id}
  • /template/push2master/{id}
  • /template/unlink/{id}
  • /template/unlocalize/{id}
  • /template/usage/syncableObjects
  • /template/{id}/tagstatus
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
Resource used for loading, saving and manipulating GCN templates.
UserResource
  • /user/list
  • /user/me
  • /user/me/data
  • /user/save/{id}
  • /user/me/data/{key}
  • GET
  • GET
  • GET
  • POST
  • DELETE GET POST
Resource to get Users. The list of users returned will always be filtered by user permission: A user may only see users that are members of the same groups or subgroups of the groups, the user is member of
ValidationResource
  • /validate/bundleDescription
  • /validate/bundleName
  • /validate/bundleSecret
  • /validate/fsPath
  • /validate/genericInput
  • /validate/groupDescription
  • /validate/groupName
  • /validate/hostName
  • /validate/nodeDescription
  • /validate/nodeName
  • /validate/roleDescription
  • /validate/roleName
  • /validate/userDescription
  • /validate/userEmail
  • /validate/userFirstName
  • /validate/userLastName
  • /validate/userMessage
  • /validate/userName
  • /validate/nodeInput/{nodeId}
  • /validate/tagPart/{partId}
  • /validate/nodeInput/{nodeId}/fileDescription
  • /validate/nodeInput/{nodeId}/fileName
  • /validate/nodeInput/{nodeId}/folderDescription
  • /validate/nodeInput/{nodeId}/folderName
  • /validate/nodeInput/{nodeId}/mimeType
  • /validate/nodeInput/{nodeId}/pageDescription
  • /validate/nodeInput/{nodeId}/pageName
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
REST API for validating user input.