Resources

name path methods description
AdminResource
  • /admin/actionlog
  • /admin/errorlog
  • /admin/maintenance
  • /admin/publicKey
  • /admin/publishInfo
  • /admin/tools
  • /admin/updates
  • /admin/version
  • /admin/actionlog/actions
  • /admin/actionlog/types
  • /admin/config/reload
  • /admin/content/dirtqueue
  • /admin/content/publishqueue
  • /admin/features/{name}
  • /admin/content/dirtqueue/summary
  • /admin/content/dirtqueue/{id}
  • /admin/content/dirtqueue/{id}/redo
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • DELETE GET
  • GET POST
  • GET
  • GET
  • DELETE
  • PUT
Resource for various tasks used by the administrator (like retrieving version numbers)
AuthenticationResource
  • /auth/globalprefix
  • /auth/hashpassword
  • /auth/login
  • /auth/matchpassword
  • /auth/ssologin
  • /auth/logout/{sid}
  • /auth/validate/{sid}
  • GET
  • POST
  • GET POST
  • POST
  • GET
  • POST
  • GET
Authentication Resource. This can be used to authenticate an existing SID.
ConstructResource
  • /construct
  • /construct/category
  • /construct/list
  • /construct/{id}
  • /construct/category/sortorder
  • /construct/category/{id}
  • /construct/link/nodes
  • /construct/load/{constructId}
  • /construct/unlink/nodes
  • /construct/{id}/nodes
  • /construct/delete/{constructId}/{idOrKeyname}
  • GET POST
  • GET POST
  • GET
  • DELETE GET PUT
  • POST
  • DELETE GET PUT
  • POST
  • GET
  • POST
  • 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
ContentRepositoryProxyResource
  • /contentrepositories/{id}/proxy
  • /contentrepositories/{id}/proxylogin
  • /contentrepositories/{id}/proxy/{path}
  • DELETE GET HEAD OPTIONS POST PUT
  • POST
  • DELETE GET HEAD OPTIONS POST PUT
Resource for proxying requests to the Mesh instance of a Mesh Content.Repository.
ContentRepositoryResource
  • /contentrepositories
  • /contentrepositories/{id}
  • /contentrepositories/{id}/availableroles
  • /contentrepositories/{id}/copy
  • /contentrepositories/{id}/cr_fragments
  • /contentrepositories/{id}/entries
  • /contentrepositories/{id}/roles
  • /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
  • GET
  • PUT
  • GET
  • GET POST
  • GET POST
  • DELETE GET PUT
  • PUT
  • PUT
  • GET
  • DELETE GET PUT
  • PUT
  • PUT
Resource for handling ContentRepositories
DatasourceResource
  • /datasource
  • /datasource/{id}
  • /datasource/{id}/constructs
  • /datasource/{id}/entries
  • /datasource/{id}/entries/{entryId}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET POST PUT
  • DELETE GET PUT
Resource for management of datasources
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
FUMResource
  • /fum/{filename}
  • GET POST
Resource for handling of postponed FUM requests
FileResource
  • /file
  • /file/copy
  • /file/create
  • /file/createSimple
  • /file/load
  • /file/move
  • /file/delete/{id}
  • /file/load/{id}
  • /file/move/{id}
  • /file/save/{id}
  • /file/usage/file
  • /file/usage/folder
  • /file/usage/image
  • /file/usage/page
  • /file/usage/template
  • /file/usage/total
  • /file/wastebin/delete
  • /file/wastebin/restore
  • /file/content/load/{id}
  • /file/wastebin/delete/{id}
  • /file/wastebin/restore/{id}
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • POST
  • POST
Resource for loading and manipulating Files in GCN
FolderResource
  • /folder
  • /folder/create
  • /folder/findFiles
  • /folder/findPages
  • /folder/getFolders
  • /folder/load
  • /folder/move
  • /folder/breadcrumb/{id}
  • /folder/count/{id}
  • /folder/delete/{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/move/{id}
  • /folder/privileges/{id}
  • /folder/sanitize/publishDir
  • /folder/save/{id}
  • /folder/startpage/{id}
  • /folder/wastebin/delete
  • /folder/wastebin/restore
  • /folder/wastebin/delete/{id}
  • /folder/wastebin/restore/{id}
  • GET
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
Resource for loading and manipulating folders in GCN
GroupResource
  • /group
  • /group/list
  • /group/load
  • /group/{id}
  • /group/{id}/groups
  • /group/{id}/perms
  • /group/{id}/users
  • /group/{id}/groups/{subgroupId}
  • /group/{id}/perms/{type}
  • /group/{id}/users/{userId}
  • /group/{id}/perms/{type}/{instanceId}
  • GET
  • GET
  • GET
  • DELETE GET POST
  • GET PUT
  • GET
  • GET PUT
  • PUT
  • GET POST
  • DELETE PUT
  • GET POST
Resource to get groups
I18nResource
  • /i18n/get
  • /i18n/list
  • /i18n/set
  • /i18n/t
  • /i18n/t/{key}
  • GET
  • GET
  • POST
  • GET
  • GET
Resource to translate given keys (optionally including parameters)
ImageResource
  • /image
  • /image/load
  • /image/move
  • /image/resize
  • /image/rotate
  • /image/delete/{id}
  • /image/load/{id}
  • /image/move/{id}
  • /image/save/{id}
  • /image/usage/file
  • /image/usage/folder
  • /image/usage/image
  • /image/usage/page
  • /image/usage/template
  • /image/usage/total
  • /image/wastebin/delete
  • /image/wastebin/restore
  • /image/wastebin/delete/{id}
  • /image/wastebin/restore/{id}
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • 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
  • /language/list
  • /language/{id}
  • GET POST
  • GET
  • DELETE GET PUT
Resource to manage cms languages
MarkupLanguageResource
  • /markupLanguage
  • GET
Resource for getting markup languages
MessagingResource
  • /msg/list
  • /msg/read
  • /msg/send
  • /msg/{id}
  • GET
  • POST
  • POST
  • DELETE
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
  • /node/create
  • /node/features
  • /node/{id}
  • /node/features/{id}
  • /node/getLanguages/{id}
  • /node/load/{id}
  • /node/save/{id}
  • /node/{id}/availableLanguages
  • /node/{id}/features
  • /node/{id}/languages
  • /node/{nodeId}/constructs
  • /node/{nodeId}/copy
  • /node/{nodeId}/objectproperties
  • /node/{nodeId}/settings
  • /node/{nodeId}/templates
  • /node/features/activate/{id}
  • /node/features/deactivate/{id}
  • /node/features/set/{id}
  • /node/{id}/features/{feature}
  • /node/{id}/languages/{languageId}
  • /node/{nodeId}/constructs/{constructId}
  • /node/{nodeId}/objectproperties/{objectPropertyId}
  • /node/{nodeId}/templates/{templateId}
  • GET PUT
  • POST
  • GET
  • DELETE GET POST
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET POST
  • GET
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • DELETE PUT
  • DELETE PUT
  • DELETE PUT
  • DELETE PUT
  • DELETE GET PUT
Resource for handling Nodes in GCN
ObjectPropertyResource
  • /objectproperty
  • /objectproperty/category
  • /objectproperty/{id}
  • /objectproperty/category/{id}
  • /objectproperty/link/nodes
  • /objectproperty/unlink/nodes
  • /objectproperty/{id}/constructs
  • /objectproperty/{id}/nodes
  • GET POST
  • GET POST
  • DELETE GET PUT
  • DELETE GET PUT
  • POST
  • POST
  • GET
  • GET
Resource for management of object property definitions
PackageResource
  • /devtools/packages
  • /devtools/sync
  • /devtools/autocomplete/constructs
  • /devtools/autocomplete/contentrepositories
  • /devtools/autocomplete/cr_fragments
  • /devtools/autocomplete/datasources
  • /devtools/autocomplete/objectproperties
  • /devtools/autocomplete/templates
  • /devtools/listen/{uuid}
  • /devtools/packages/{name}
  • /devtools/preview/{uuid}
  • /devtools/stoplisten/{uuid}
  • /devtools/nodes/{nodeId}/packages
  • /devtools/package/{name}/check
  • /devtools/packages/{name}/cms2fs
  • /devtools/packages/{name}/constructs
  • /devtools/packages/{name}/contentrepositories
  • /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/package/{name}/check/result
  • /devtools/packages/{name}/constructs/{construct}
  • /devtools/packages/{name}/contentrepositories/{contentrepository}
  • /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
  • GET
  • DELETE GET PUT
  • GET
  • POST
  • GET PUT
  • GET
  • PUT
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • DELETE PUT
  • GET
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
PageResource
  • /page
  • /page/assign
  • /page/autocomplete
  • /page/copy
  • /page/create
  • /page/load
  • /page/move
  • /page/preview
  • /page/publish
  • /page/pubqueue
  • /page/render
  • /page/search
  • /page/cancel/{id}
  • /page/delete/{id}
  • /page/diff/{id}
  • /page/getTags/{id}
  • /page/load/{id}
  • /page/move/{id}
  • /page/newtag/{id}
  • /page/newtags/{id}
  • /page/publish/{id}
  • /page/pubqueue/approve
  • /page/render/{id}
  • /page/renderTag/{tag}
  • /page/restore/{id}
  • /page/save/{id}
  • /page/suggest/filename
  • /page/takeOffline/{id}
  • /page/translate/{id}
  • /page/usage/linkedFile
  • /page/usage/linkedImage
  • /page/usage/linkedPage
  • /page/usage/page
  • /page/usage/tag
  • /page/usage/template
  • /page/usage/total
  • /page/usage/variant
  • /page/wastebin/delete
  • /page/wastebin/restore
  • /page/diff/versions/{id}
  • /page/render/content/{id}
  • /page/renderTag/{id}/{tag}
  • /page/restore/{pageid}/{tag}
  • /page/wastebin/delete/{id}
  • /page/wastebin/restore/{id}
  • /page/workflow/decline/{id}
  • /page/workflow/revoke/{id}
  • GET
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
Resource used for loading, saving and manipulating GCN pages.
PartTypeResource
  • /parttype
  • GET
Resource for part types
PermResource
  • /perm/{type}
  • /perm/list/{type}
  • /perm/{type}/{id}
  • /perm/list/{type}/{id}
  • /perm/{perm}/{type}/{id}
  • GET POST
  • 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.
RoleResource
  • /role
  • /role/{id}
  • /role/{id}/perm
  • GET PUT
  • DELETE GET POST
  • GET POST
Resource for management of roles
SchedulerResource
  • /scheduler/jobs
  • /scheduler/resume
  • /scheduler/schedule
  • /scheduler/status
  • /scheduler/suspend
  • /scheduler/task
  • /scheduler/execution/{id}
  • /scheduler/schedule/{id}
  • /scheduler/task/{id}
  • /scheduler/schedule/{id}/execute
  • /scheduler/schedule/{id}/execution
  • GET
  • PUT
  • GET POST
  • GET
  • PUT
  • GET POST
  • GET
  • DELETE GET PUT
  • DELETE GET PUT
  • POST
  • GET
Resource for managing the scheduler
TemplateResource
  • /template
  • /template/link
  • /template/unlink
  • /template/{id}
  • /template/getTags/{id}
  • /template/link/{id}
  • /template/load/{id}
  • /template/unlink/{id}
  • /template/{id}/copy
  • /template/{id}/folders
  • /template/{id}/nodes
  • /template/{id}/tag
  • /template/{id}/tagstatus
  • /template/{id}/unlock
  • GET POST
  • POST
  • POST
  • DELETE GET POST
  • GET
  • POST
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
Resource used for loading, saving and manipulating GCN templates.
UserResource
  • /user
  • /user/list
  • /user/me
  • /user/{id}
  • /user/me/data
  • /user/save/{id}
  • /user/{id}/groups
  • /user/me/data/{key}
  • /user/{id}/groups/{groupId}
  • /user/{id}/groups/{groupId}/nodes
  • /user/{id}/groups/{groupId}/nodes/{nodeId}
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • POST
  • GET
  • DELETE GET POST
  • DELETE PUT
  • GET
  • DELETE PUT
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
UsersnapResource
  • /usersnap
  • GET
Resource for Usersnap integration
ValidationResource
  • /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
REST API for validating user input.