Gentics CMS - Documentation

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.

ClusterResource

/cluster/info
/cluster/master

GET
PUT

Resource for clustering support

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

ContentStagingResource

/content/package
/content/package/{name}
/content/package/{name}/export
/content/package/{name}/import
/content/package/{name}/status
/content/package/{name}/zip
/content/package/{name}/import/errors
/content/package/{name}/list/{pathSegments}
/content/package/{name}/{type}/{uuid}

GET PUT
DELETE GET POST
POST
POST
POST
GET POST
GET
GET
DELETE PUT

Content Staging REST API

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

FormResource

/form
/form/{id}
/form/usage/page
/form/usage/template
/form/usage/total
/form/wastebin/{id}
/form/{id}/binaries
/form/{id}/data
/form/{id}/export
/form/{id}/lock
/form/{id}/online
/form/{id}/version
/form/wastebin/{id}/restore
/form/{id}/binaries/status
/form/{id}/data/{dataId}
/form/{id}/download/{downloadUuid}
/form/{id}/export/status
/form/{id}/folder/{folderId}
/form/{id}/offline/at
/form/{id}/preview/{language}
/form/{id}/publish/at
/form/{id}/version/{version}
/form/{id}/version/{version}/restore
/form/{id}/data/{dataId}/binary/{field}

GET POST
DELETE GET PUT
GET
GET
GET
DELETE
GET POST
GET
GET POST
DELETE PUT
DELETE PUT
GET
POST
GET
DELETE GET
GET
GET
PUT
DELETE
GET POST
DELETE
GET
POST
GET

Resource for forms

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

LinkCheckerResource

/linkChecker/check
/linkChecker/pages
/linkChecker/stats
/linkChecker/pages/{id}
/linkChecker/pages/{pageId}/links/{id}

POST
GET
GET
GET POST
GET POST

Resource for the link checker

MCFileResource

/file/disinherit
/file/localizationinfo
/file/push2master
/file/unlocalize
/file/disinherit/{id}
/file/localizationinfo/{id}
/file/localizations/{id}
/file/localize/{id}
/file/push2master/{id}
/file/unlocalize/{id}
/file/usage/syncableObjects

GET POST
GET
POST
POST
GET POST
GET
GET
POST
POST
POST
GET

Resource for handling multichannelling aspects of files

MCFolderResource

/folder/disinherit
/folder/push2master
/folder/unlocalize
/folder/disinherit/{id}
/folder/localizationinfo/{id}
/folder/localizations/{id}
/folder/localize/{id}
/folder/push2master/{id}
/folder/unlocalize/{id}
/folder/usage/syncableObjects

GET POST
POST
POST
GET POST
GET
GET
POST
POST
POST
GET

Resource for handling multichannelling aspects of folders

MCImageResource

/image/disinherit
/image/localizationinfo
/image/push2master
/image/unlocalize
/image/disinherit/{id}
/image/localizationinfo/{id}
/image/localizations/{id}
/image/localize/{id}
/image/push2master/{id}
/image/unlocalize/{id}
/image/usage/syncableObjects

GET POST
GET
POST
POST
GET POST
GET
GET
POST
POST
POST
GET

Resource for handling multichannelling aspects of images.

MCPageResource

/page/disinherit
/page/localizationinfo
/page/push2master
/page/unlocalize
/page/disinherit/{id}
/page/localizationinfo/{id}
/page/localizations/{id}
/page/localize/{id}
/page/push2master/{id}
/page/unlocalize/{id}
/page/usage/syncableObjects

GET POST
GET
POST
POST
GET POST
GET
GET
POST
POST
POST
GET

Resource for handling multichannelling aspects of pages.

MCTemplateResource

/template/localizationinfo
/template/push2master
/template/unlocalize
/template/localizationinfo/{id}
/template/localizations/{id}
/template/localize/{id}
/template/push2master/{id}
/template/unlocalize/{id}
/template/usage/syncableObjects

GET
POST
POST
GET
GET
POST
POST
POST
GET

Resource for handling multichannelling aspects of templates.

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:

Type	Short	Description	Bit
Folder	s	Show	0
	r	Assign user permissions	1
	c	Create	8
	e	Edit	9
	d	Delete	10
Pages/Images/Files	s	Show	11
	c	Create	12
	e	Edit	13
	d	Delete	14
	i	Import	23
Pages	p	Publish	19
Templates	s	Show	15
	c	Create	16
	l	Link	21
	e	Edit	17
	d	Delete	18
Workflow	v	Link	22

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

Type	Description	Bit
Role permissions	Show	10
	Create	11
	Modify	12
	Delete	13
	Publishing	14
	Translate	15

PolicyMapResource

/policyMap/policy
/policyMap/partType/{typeId}/policyGroup

GET
GET

API for reading from the policy map.

PublishProtocolResource

/publish/state
/publish/state/{type}/{objId}

GET
GET

Interface for managing publish protocol resources.

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

SearchIndexResource

/index
/index/{name}/rebuild

GET
PUT

Resource for maintenance of search indices

SearchResource

/elastic/{path}
/elastic/{type}/_search

POST
POST

Resource for endpoints that are forwarded to elasticsearch for performing searches

StagedConstructResource

/construct/{id}/hash

GET

Resource for handling constructs

StagedDatasourceResource

/datasource/{id}/hash

GET

Resource for management of datasources

StagedObjectPropertyResource

/objectproperty/{id}/hash

GET

Resource for management of object property definitions

StagedTemplateResource

/template/{id}/hash

GET

Resource used for loading, saving and manipulating GCN templates.

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.

JSON

type	description
AbstractItemResponse	Abstract item response
AbstractListResponse	Abstract list response
AbstractModel	Abstract base class for REST Model implementations that have a global Id
ActionLogEntry	Model of an entry in the action log
ActionLogEntryList	Response containing a list of action log entries
ActionLogType	Model of the type of logged objects
ActionLogTypeList	Response containing a list of logged object types
ActionModel	Model of a logged action
ActionModelList	Response containing a list of logged actions
AuthenticationResponse	Authentication Result
AutocompleteItem	Item that is returned to autocomplete calls
BreadcrumbItem
BulkLinkUpdateRequest
CRElasticsearchModel
ChannelLocalizationInfo	REST Model class for localization info of a channel
CheckExternalLinkRequest
CheckResponse	Generic response containing the response code and response messages (no additional objects)
ClusterInfo	Response containing clustering information
CmpCompatibility
CmpVersionInfo
Construct	Construct
ConstructCategory	Construct Category
ConstructCategoryListResponse	Response containing a list of construct categoriess
ConstructCategoryLoadResponse	Class representing the construct category load response.
ConstructInPackage	Construct in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
ConstructList	Response containing a list of constructs
ConstructListResponse	Response containing a list of constructs
ConstructLoadResponse	Class representing the construct load response.
ContentLanguage	Rest Model of a content language
ContentLanguageResponse	Response containing a single content language
ContentMaintenanceAction
ContentMaintenanceActionRequest	REST Model of a content maintenance action request
ContentMaintenanceType
ContentNodeItem	ContentNodeItem which can be a Page, File, Image or Folder
ContentPackageBase	Base model for content package
ContentPackageChannel	REST entity for channel info for the Content Staging package object.
ContentPackageFile	REST entity for the file, contained in the Content Staging package.
ContentPackageFolder	REST API folder entity for Content Staging.
ContentPackageFolderResponse	Generic response containing the response code and response messages (no additional objects)
ContentPackageForm	REST entity for the form, contained in the Content Staging package.
ContentPackageImage	REST entity for the image, contained in the Content Staging package.
ContentPackageListResponse	Abstract list response
ContentPackageLoadResponse	Response of Content Staging package.
ContentPackageNode	REST entity for the node, contained in the Content Staging package.
ContentPackagePage	REST entity for the page, contained in the Content Staging package.
ContentRepositoryFragmentEntryListResponse	Response containing a list of ContentRepository Fragment Entries
ContentRepositoryFragmentEntryModel	Model of an entry in a ContentRepository Fragment
ContentRepositoryFragmentEntryResponse	Response containing a ContentRepository Fragment Entry
ContentRepositoryFragmentInPackage	ContentRepository Fragment in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
ContentRepositoryFragmentListResponse	Response containing a list of ContentRepository Fragments
ContentRepositoryFragmentModel	Model of a ContentRepository Fragment
ContentRepositoryFragmentResponse	Response containing a ContentRepository Fragment
ContentRepositoryInPackage	Content Repository in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
ContentRepositoryListResponse	Response containing a list of ContentRepositories
ContentRepositoryModel	ContentRepository
ContentRepositoryResponse	Response containing a ContentRepository
ContentTagCreateRequest	Request to create a content tag in a page
CreatedTag	Created tag
CustomTool
DaisyDiffRequest	Class representing a daisyDiff request sent to DiffResource. Encapsulates request data.
Datasource	REST Model of a datasource
DatasourceEntryListResponse	Response containing a list of datasource entries
DatasourceEntryModel	REST Model of a datasource entry
DatasourceEntryResponse	Response containing a datasource entry
DatasourceInPackage	Datasource in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
DatasourceLoadResponse	Response for a datasource load request.
DatasourceType
DeleteInfo
DiffRequest	Class representing a diff request sent to DiffResource. Encapsulates request data.
DiffResponse	Class representing the response to a diff request sent to DiffResource.
DirtQueueEntry
DirtQueueEntryList	REST Model containing a list of dirt queue entries
DirtQueueSummaryEntry
DirtQueueSummaryResponse	REST Model containing a list of dirt queue summary entries
DisinheritRequest	Request to set the multichannelling exclusion and disinheriting status of an object
DisinheritResponse	Response containing disinherit information
Editable	Class for instances of editables
Editor
EditorControlStyle
ErrorLogEntry	Model of a logged error
ErrorLogEntryList	Response containing a list of logged errors
ExecutionListResponse	Abstract list response
ExecutionModel	Model for a scheduler exection.
ExecutionResponse	Response containing information about a scheduler execution.
ExportSelectionRequest	Request containing the objects selected for export
ExportSelectionResponse	Response containing the list of subselected folders
ExternalLink
ExternalLinkCheckHistoryEntry
ExternalLinkList	Abstract list response
ExternalLinkResponse	Response containing information about an external link
ExternalLinkStatistics	Generic response containing the response code and response messages (no additional objects)
ExternalLinkStatus
FUMResponseStatus
FUMResult	FUM Result Model
FUMStatus
FUMStatusResponse	Response model for request to finish postponed FUM action
FeatureList	Abstract list response
FeatureModelList	Abstract list response
FeatureResponse	Generic response containing the response code and response messages (no additional objects)
File	File object, represents a File in GCN
FileCopyRequest	Request to copy a file
FileCreateRequest	Request to create a file from a URL
FileListResponse	Abstract list response
FileLoadResponse	Response object for responses containing a File
FilePrivileges
FileSaveRequest	Request to save a file
FileUploadResponse	Generic response containing the response code and response messages (no additional objects)
FileUsageListResponse	Response for a file/image usage request.
Folder	Folder object, representing a Folder in GCN
FolderCreateRequest	Request object for a request to create a folder
FolderExternalLinksResponse	REST Model external links response. It contains the pages with external links.
FolderListRequest	Request object for a request to list folders
FolderListResponse	Abstract list response
FolderLoadResponse	Generic response containing the response code and response messages (no additional objects)
FolderMoveRequest	Request object for a request to move a folder
FolderObjectCountResponse	Response containing object counts in folders
FolderPublishDirSanitizeRequest	Request to sanitize a folder publish directory
FolderPublishDirSanitizeResponse	Response containing a sanitized folder publish directory
FolderSaveRequest	Request object for a request to save a folder
FolderUsageListResponse	Response for a folder usage request.
FormListResponse	Response containing a list of forms
FormModel	REST Model of a form
FormResponse	Response containing an item
FormTimeManagement	Time Management of forms
FoundFilesListResponse	Response for a file list request
GenericItemListOfPublishLogDto
GenericJobStatusResponse	Generic response containing the response code and response messages (no additional objects)
GenericResponse	Generic response containing the response code and response messages (no additional objects)
Group	Group information in REST calls
GroupList	Abstract list response
GroupLoadResponse	Generic response containing the response code and response messages (no additional objects)
GroupPolicyResponse
GroupsPermBitsResponse	Response containing permission and role bits
GroupsResponse	Response for the request to get the groups
HashPasswordRequest	Hash password request
HashPasswordResponse	Response to a login request
IdSetRequest	Request containing a list of IDs
IdTypeMapRequest	Request containing a map of objecttype-IDs.
Image	Image object, represents an Image in GCN
ImageListResponse	Abstract list response
ImageLoadResponse	Response object for responses containing an Image
ImageResizeRequest
ImageRotate
ImageRotateRequest	Request to rotate an image
ImageSaveRequest	Request to save an image
ImplementationHashResponse	Response containing the implementation hash (and string representation on which the hash is based) for an entity
IndexList	Abstract list response
IndexModel	REST Model of a search index
IntervalUnit
ItemListResponse	Response for a item list request
ItemType	Types of items to be fetched with method
ItemVersion	REST Model of an Item Version
ItemVersionListResponse	Response containing a list of versions
JobProgress
JobStatus	Response containing the job status for a background job
JobStatus
JobsResponse	Abstract list response
LanguageList	Model of language list
LanguageListResponse	Response for a language list request
LanguagePrivileges	Privileges set on a specific language
LanguageResponse	Response containing the current session language
Latest	Inner class to encapsulate the information about the latest version of the language variant
LegacyFileListResponse	Response for a page list request
LegacyFolderListResponse	Base for responses containing staging status of elements
LegacyPageListResponse	Response for a page list request
LinkRequest	Request object for linking a template to folders or unlinking a template from folders
ListType	Enumeration of the type of objects in the overview
LocalizationInfo	REST Model for localization info
LocalizationInfoItem	REST Model for the localization information of a specific type.
LocalizationsResponse	Response containing localization info
LocalizeRequest	Request to localize an object
LoginRequest	Login Request containing the user credentials
LoginResponse	Response to a login request
MaintenanceModeRequest	Rest Model of the request to set/unset the maintenance mode
MaintenanceResponse	Generic response containing the response code and response messages (no additional objects)
MarkupLanguage	Markup language object
MarkupLanguageListResponse	Response containing a list of markup languages
MatchPasswordRequest	Match password request
MemberInfo	Info about the local member
MeshRolesRequest	Request to set Mesh roles for a Mesh CR
MeshRolesResponse	Response containing a list of Mesh role names
Message	Represents a message that can be displayed in the MessageLine.
MessageSendRequest	Request to send messages to users/groups
MessagesReadRequest	Request to set messages to be read
MetaEditable	Class for instances of meta editables
MigrationGetLogResponse	Response to request to retrieve log for a tag type migration
MigrationGetLogsResponse	Response to request to retrieve all logs for tag type migration
MigrationJobEntry
MigrationJobItemsResponse	Response to requests for fetching jobitems. A MigrationJobItemsResponse object contains a list of objects that have been handled by the migration job.
MigrationJobLogEntryItem
MigrationPartMapping	The tagtype migration part mapping model
MigrationPartsResponse	Response to request to load parts for a given tag
MigrationPostProcessor
MigrationPreProcessor
MigrationReinvokeRequest	Tag Type Migration Reinvoke Request. This request can be used to reinvoke a migration job.
MigrationResponse	The MigrationResponse is returned when a migration job is invoked or reinvoked. It contains the jobId and message information.
MigrationStatusResponse	Response to request to check status of tag type migration
MigrationTagsRequest	Request object for a request to retrieve tag types for tag migration
MigrationTagsResponse	Response to request to load tags for a list of objects
MultiDisinheritResponse	Response containing disinherit information for multiple objects
MultiFileLoadResponse	Response containing information about multiple files.
MultiFolderLoadRequest	Request to load multiple folders.
MultiFolderLoadResponse	Response containing information about multiple folders.
MultiFolderMoveRequest	Request to move multiple folders
MultiImageLoadResponse	Response containing information about multiple images.
MultiLinkRequest	Request object for linking multiple templates to or unlink multiple templates from folders
MultiObjectLoadRequest	Request to load multiple objects. This request can be used to load files and images and acts as a base for MultiFolderLoadRequest and MultiPageLoadRequest.
MultiObjectMoveRequest	Request object for moving multiple objects
MultiPageAssignRequest
MultiPageLoadRequest	Request to load multiple pages.
MultiPageLoadResponse	Response containing information about multiple pages.
MultiPagePublishRequest	Request for publishing many pages
MultiPubqueueApproveRequest	Request to approve multiple pages in queue
MultiPushToMasterRequest	Request to push multiple objects (of same type) to the master
MultiTagCreateRequest	Request to create tags
MultiTagCreateResponse	Response containing data about the created tags
MultiUnlocalizeRequest	Request to unlocalize multiple objects of same type
Node	REST Model for a Node
NodeCopyRequest	Request to copy a node
NodeFeature
NodeFeatureModel
NodeFeatureRequest	Request for activating, deactivating or setting node features
NodeFeatureResponse	Response containing the activated features
NodeIdObjectId	Object containing nodeId and objectId of an object selected for an overview
NodeList	Abstract list response
NodeLoadResponse	Response to a request to load a single node
NodeRestrictionResponse	Response containing node restrictions of user-group assignments
NodeSaveRequest	Request for creating a new node.
NodeSettingsResponse	Response to a request for loading node specific settings.
ObjectCount
ObjectMoveRequest	Request object for moving a single object
ObjectProperty	REST Model of an object property definition
ObjectPropertyCategory	Rest Model for object property categories
ObjectPropertyCategoryListResponse	Response containing a list of object property categories
ObjectPropertyCategoryLoadResponse	Response for an object property category load request.
ObjectPropertyInPackage	Object property definition in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
ObjectPropertyListResponse	Response containing a list of object properties
ObjectPropertyLoadResponse	Response for an object property load request.
OrderBy	Enumeration for the 'order by' setting
OrderDirection	Enumeration for the order directions
Overview	Overview object, representing an overview in GCN
OverviewSetting	Model for overview settings
Package	Package
PackageListResponse	Abstract list response
Page	Page object representing a page in GCN
PageCopyRequest	Request for a batch copy call
PageCopyResponse	Response for a page copy request
PageCopyResultInfo	The page copy result info contains information about each copy action that has taken place during a page copy call. When a page is copied to multiple folders multiple objects of this class will be added to the page copy response.
PageCreateRequest	Page create request
PageExternalLink	This class contains the external links of a page.
PageFilenameSuggestRequest	Request object for suggesting a filename
PageFilenameSuggestResponse	Response containing the suggested fileName
PageIdSetRequest	Request containing a list of page IDs and a flag for whether all language variants of the specified pages shall be affected
PageLanguageCode
PageList	Abstract list response
PageListResponse	Abstract list response
PageLoadResponse	Response for a page load request.
PageOfflineRequest	Request for taking a page offline
PagePreviewRequest	Request for preview of a page
PagePreviewResponse	Response for a page preview request
PagePrivileges
PagePublishRequest	Request for publishing a page
PageRenderResponse	Response for request to render a page
PageSaveRequest	Request used for saving a page. If not set otherwise, a new version will be created (if necessary) and the page will remain locked for the user.
PageUsageListResponse	Response for a page usage request.
PageVersion	REST Model of a Page Version
PageWithExternalLinks
PagedConstructInPackageListResponse	Paged list of constructs in packages
PagedConstructListResponse	Paged list of constructs
PagedContentRepositoryFragmentInPackageListResponse	Paged list of ContentRepository Fragments in packages
PagedContentRepositoryInPackageListResponse	Paged list of ContentRepositories in packages
PagedDatasourceInPackageListResponse	Paged list of datasources in packages
PagedDatasourceListResponse	Paged list of datasources
PagedFolderListResponse	Response containing a list of folders
PagedObjectPropertyInPackageListResponse	Paged list of object property definitions in packages
PagedObjectPropertyListResponse	Paged list of object properties
PagedTemplateInPackageListResponse	Paged list of templates in packages
PagedTemplateListResponse	Paged list of templates
Part	Rest Model for parts
PartType
PasswordType	Possible values for how the password is set
PermBitsResponse	Response containing permission and role bits
PermResponse	Response containing the permission flag for a specific permission request
PermType
Permission
PermissionsMap	Permissions map
PolicyGroupResponse	The policies in the group can be assumed to be in the same order defined in the policy map.
PolicyResponse
PossiblePartMappingsResponse	Response for possible part type mapping requests
Privilege
~~PrivilegeMap~~	~~Privilege Map containing privilege information (in general and language specific)~~
PrivilegesResponse	Privileges response
Property	Property object, representing a property of a Tag (a part of a tag in GCN)
PublishInfoResponse	Generic response containing the response code and response messages (no additional objects)
PublishLogDto
PublishQueueCounts
PublishQueueResponse	Response containing the publish queue counts for nodes
PublishableContentItem	ContentNodeItem which can be a Page, File, Image or Folder
PushToMasterRequest	Request to push a specified object from a channel into a master
QueuedTimeManagement	Queued TimeManagement
Record
ReferencedFilesListResponse	Response for a list of referenced files or images
ReferencedPagesListResponse	Response for a list of referenced pages
ReferencedSyncableObjectsListResponse	Response containing directly linked objects and indirect dependencies for an object that should be synchronised to a master channel.
RegexModel	Model for Regex definition
ReplaceExternalLinkRequest	Request to replace an external Link with another URL
ReplaceScope
ResponseCode
ResponseInfo	Response information that contains a response code and a response message. The response message should not be internationalized. If you want to provide a user friendly message use the message object instead.
RoleItem
RoleListResponse	Abstract list response
RoleModel	Model for a role
RolePermResponse	Response containing role permissions
RolePermissions
RolePermissionsModel	Model for role permissions
RoleResponse	Generic response containing the response code and response messages (no additional objects)
ScheduleData
ScheduleFollow
ScheduleInterval
ScheduleListResponse	Response containing a list of schedules
ScheduleModel	Model for a scheduler schedule.
ScheduleResponse	Response containing a scheduler schedule
ScheduleStatus
ScheduleType
SchedulerExecutorStatus
SchedulerStatus
SchedulerStatusResponse	Scheduler status
SelectOption	SelectOption object representing a datasource value in GCN
SelectSetting	Model for select settings
SelectType	Enumeration of the selection type
SetLanguageRequest	Request to set the session language
SetPermsRequest	Request to set permission bits
StagedChannel	REST entity for channel info for the Content Staging package object.
StagedContentPackage	Content staging package entity.
StagedError	Content staging error DTO.
StagedFile	REST entity for the file, contained in the Content Staging package.
StagedFolder	REST API folder entity for Content Staging.
StagedForm	REST entity for the form, contained in the Content Staging package.
StagedImage	REST entity for the image, contained in the Content Staging package.
StagedLocalizableObject
StagedNode	REST entity for the node, contained in the Content Staging package.
StagedNodeIdObjectId	Node / Object ID pair for the Content Staging package.
StagedObjectTag	REST entity for the tag, contained in the Content Staging package.
StagedObjectVersion	A version for the version-enabled entity, for the Content Staging package.
StagedObjectVersionType
StagedOverview	REST entity for the overview, contained in the Content Staging package.
StagedPage	REST entity for the page, contained in the Content Staging package.
StagedProperty	REST entity for the object property, contained in the Content Staging package.
StagedReference	A Global ID + Hash pair
StagedTag	REST entity for the tag, contained in the Content Staging package.
StagingBase
StagingErrorKind
StagingResponse	Base for responses containing staging status of elements
StagingStatus	Content staging package status for an entity.
StagingStatusResponse	Base for responses containing staging status of elements
StartpageRequest	Request to set a folder startpage
Status	Possible Check Status values
SuspendRequest	Request to suspend the scheduler
SyncInfo	Synchronization information for devtools sync
Tag	Tag object representing a contenttag in the GCN
Tag	Class for instances of tags
TagCreateRequest	Tag create request
TagCreateResponse	Resonse for a tag create request
TagList	Abstract list response
TagListResponse	Response with a list of tags
TagStatus
TagStatusResponse	Response containing the tag status for a template
TagTypeMigrationMapping	Tag Type Migration mapping object
TagTypeMigrationRequest	Tag Type Migration Request
TagmapEntryConsistencyResponse	Response containing a list of inconsistencies
TagmapEntryInconsistencyModel	Model of a tagmap inconsistency
TagmapEntryListResponse	Response containing a list of ContentRepository Entries
TagmapEntryModel
TagmapEntryResponse	Response containing a tagmap entry
TargetFolder	Target folder object for a page copy call. A folder is identified by its id and the channelId. You can omit the channelId when you want to copy to master folders.
TaskListResponse	Response containing a list of tasks
TaskModel	REST Model of a Scheduler Task
TaskResponse	Response containing an item
Template	Template object representing a template in GCN
TemplateCopyRequest	Request to create a copy of a template
TemplateCreateRequest	Request to create a new template
TemplateInNode	Template in a node
TemplateInNodeResponse	Response containing a list of templates assigned to nodes
TemplateInPackage	Template in a package. If the object does not have a (local) ID, this means that the object was not synchronized to the CMS. It is also possible, that the global ID of the object is null, if it is not set in the `gentics_structure.json` file. Objects without global ID in the filesystem can be imported into the CMS, but will never be "in sync", because they cannot be identified without global ID.
TemplateListResponse	Response for a template list request
TemplateLoadResponse	Response for a template load request.
TemplateMigrationEditableTagMapping
TemplateMigrationMapping
TemplateMigrationNonEditableTagMapping
TemplateMigrationRequest
TemplateMigrationTagMapping
TemplateSaveRequest	Request for saving a template
TemplateTag	Tag object representing a templaetag in the GCN
TemplateUsageListResponse	Response for a page usage response (templates).
TimeManagement	Time Management of pages
ToolsResponse	Generic response containing the response code and response messages (no additional objects)
TotalUsageInfo
TotalUsageResponse	Usage response which contains the total count info for the queried element/s.
TranslationStatus	Class encapsulating the synchronization information of page translations
Type	Enumeration for unlocalized subtypes
Type	Enumeration of property types
Type	Possible ContentRepository types
Type	Enumeration for pushed subtypes
Type	Severity for a message
Type	Possible tag types
TypePermissionItem
TypePermissionList	List of permissions
TypePermissionRequest	Request to change permissions on a type
TypePermissionResponse	Response containing permissions and role assignments
TypePermissions
UILanguage	REST Model for UI languages
UILanguagesResponse	Abstract list response
UnlocalizeRequest	Request to unlocalize an object
Update
UpdateExternalLinkStatusRequest
UpdatesInfoResponse	Generic response containing the response code and response messages (no additional objects)
User	User object, representing a SystemUser in GCN
UserDataResponse	Response for the request to fetch user data
UserList	Abstract list response
UserListResponse	Response containing a list of users
UserLoadResponse	Response containing a single user
UserSaveRequest	Request used for saving users.
UsersnapResponse	Response containing the Usersnap settings
VersionResponse	Response for a request asking for the version of the REST API on the server.
WastebinSearch
Workflow	Workflow information about the page
WorkflowRequest	Request for modifying a page in the workflow

Gentics CMS - Documentation

Resources

Data Types

JSON