Gentics CMS - REST API Library

Contains Model classes for the Gentics Content.Node REST API

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/version
  • 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.
ConstructResource
  • /construct/list
  • /construct/load/{constructId}
  • /construct/delete/{constructId}/{idOrKeyname}
  • GET
  • GET
  • POST
Resource for handling constructs
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/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
  • 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/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
  • 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/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
  • 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}/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
  • POST
  • POST
  • POST
  • DELETE PUT
  • DELETE PUT
Resource for handling Nodes in GCN
PackageResource
  • /devtools/packages
  • /devtools/sync
  • /devtools/autocomplete/constructs
  • /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}/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}/datasources/{datasource}
  • /devtools/packages/{name}/objectproperties/{objectproperty}
  • /devtools/packages/{name}/templates/{template}
  • GET
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • GET PUT
  • PUT
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • DELETE 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/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/page
  • /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
  • 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
  • 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.
TemplateResource
  • /template/link
  • /template/localizationinfo
  • /template/push2master
  • /template/unlink
  • /template/unlocalize
  • /template/getTags/{id}
  • /template/link/{id}
  • /template/load/{id}
  • /template/localizationinfo/{id}
  • /template/push2master/{id}
  • /template/unlink/{id}
  • /template/unlocalize/{id}
  • POST
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
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.

Data Types

JSON

type description
AbstractListResponse Abstract list response
AuthenticationResponse Authentication Result
AutocompleteItem Item that is returned to autocomplete calls
ChannelLocalizationInfo REST Model class for localization info of a channel
CompletePageTask Page action values
Construct Construct
ConstructInPackage Construct in a package
ConstructListResponse Response containing a list of constructs
ConstructLoadResponse Class representing the construct load response.
ContentLanguage
ContentNodeItem ContentNodeItem which can be a Page, File, Image or Folder
ContentTagCreateRequest Request to create a content tag in a page
CreatedTag Created tag
DaisyDiffRequest Class representing a daisyDiff request sent to DiffResource. Encapsulates request data.
Datasource REST Model of a datasource
DatasourceInPackage Datasource in a package
DatasourceLoadResponse Response for a datasource load request.
DatasourceType Datasource types
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.
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 Editor of a node
ExportSelectionRequest Request containing the objects selected for export
ExportSelectionResponse Response containing the list of subselected folders
File File object, represents a File in GCN
FileCopyRequest Request to copy a file
FileCreateRequest Request to create a file from a URL
FileListResponse Response for a page list request
FileLoadResponse Response object for responses containing a File
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
FolderLoadResponse
FolderMoveRequest Request object for a request to move a folder
FolderObjectCountResponse Response containing object counts in folders
FolderSaveRequest Request object for a request to save a folder
FolderUsageListResponse Response for a folder usage request.
FoundFilesListResponse Response for a file list request
GenericResponse Generic response containing the response code and response messages (no additional objects)
Group Group information in REST calls
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
Image Image object, represents an Image in GCN
ImageLoadResponse Response object for responses containing an Image
ImageResizeRequest
ImageSaveRequest Request to save an image
ItemListResponse Response for a item list request
ItemType Types of items to be fetched with method
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
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 Generic response containing the response code and response messages (no additional objects)
LocalizeRequest Request to localize an object
LoginRequest Login Request containing the user credentials
LoginResponse Response to a login request
LoginWithRsaRequest Login Request containing the user credentials
MaintenanceResponse Response containing maintenance information
MarkupLanguage Markup language object
MatchPasswordRequest Match password request
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 A migration job entry contains information about an executed migration job. Infomation like the job status and the count of objects that have been handled are stored in MigrationJobEntry objects.
MigrationJobItemsResponse Response to requests for fetching jobitems. A MigrationJobItemsResponse object contains a list of objects that have been handled by the migration job.
MigrationJobLogEntryItem Class that represents a migration job item within the database log
MigrationPartMapping The tagtype migration part mapping model
MigrationPartsResponse Response to request to load parts for a given tag
MigrationPostProcessor Model for a TagTypeMigrationPostProcessor
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
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
NodeFeature Features that can be activated per node
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
NodeLoadResponse Response to a request to load a single node
NodeSaveRequest Request for creating a new node.
ObjectMoveRequest Request object for moving a single object
ObjectProperty REST Model of an object property definition
ObjectPropertyInPackage Object property definition in a package
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
Package Package
PackageListResponse Response containing a list of packages
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.
PageIdSetRequest Request containing a list of page IDs and a flag for whether all language variants of the specified pages shall be affected
PageListResponse Response for a page list request
PageLoadResponse Response for a page load request.
PagePreviewRequest Request for preview of a page
PagePreviewResponse Response for a page preview request
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.
PageStatus Stati of a page
PageTask Page assigned to a task
PageTaskListResponse Response containing a list of pages assigned to a task
PageUsageListResponse Response for a page usage request.
PageVersion REST Model of a Page Version
PagedConstructInPackageListResponse Paged list of constructs in packages
PagedConstructListResponse Paged list of constructs
PagedDatasourceInPackageListResponse Paged list of datasources in packages
PagedObjectPropertyInPackageListResponse Paged list of object property definitions in packages
PagedTemplateInPackageListResponse Paged list of templates in packages
PagedTemplateListResponse Paged list of templates
Part Rest Model for parts
PermBitsResponse Response containing permission and role bits
PermResponse Response containing the permission flag for a specific permission request
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 Enumeration for privileges (permissions)
PrivilegeMap Privilege Map containing privilege information (in general and language specific)
PrivilegesResponse Privileges response
ProcessQueueEntry Represents an entry in the process queue.
ProcessQueueResponse Generic response containing the response code and response messages (no additional objects)
Property Property object, representing a property of a Tag (a part of a tag in GCN)
PushToMasterRequest Request to push a specified object from a channel into a master
ResponseCode Response codes that are returned to the client as answers for requests.
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.
SelectOption SelectOption object representing a datasource value in GCN
SelectType Enumeration of the selection type
SetLanguageRequest Request to set the session language
SetPermsRequest Request to set permission bits
StartpageRequest Request to set a folder startpage
SyncInfo Synchronization information for devtools sync
Tag Class for instances of tags
Tag Tag object representing a contenttag in the GCN
TagCreateRequest Tag create request
TagCreateResponse Resonse for a tag create request
TagListResponse Response with a list of tags
TagTypeMigrationMapping Tag Type Migration mapping object
TagTypeMigrationRequest Tag Type Migration Request
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.
Template Template object representing a template in GCN
TemplateInPackage Template in a package
TemplateListResponse Response for a template list request
TemplateLoadResponse Response for a template load request.
TemplateMigrationEditableTagMapping
TemplateMigrationMapping This class is a model for a template migration mapping.
TemplateMigrationNonEditableTagMapping Class that represents a mapping for a non editable template tag. This mapping is used for the template migration
TemplateMigrationRequest
TemplateMigrationTagMapping
TemplateTag Tag object representing a templaetag in the GCN
TemplateUsageListResponse Response for a page usage response (templates).
TimeManagement TimeManagement object for time management of pages in GCN
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 Severity for a message
Type Enumeration for unlocalized subtypes
Type Enumeration of property types
Type Enumeration for pushed subtypes
Type Possible tag types
UnlocalizeRequest Request to unlocalize an object
User User object, representing a SystemUser in GCN
UserDataResponse Response for the request to fetch user data
UserListResponse Response containing a list of users
UserLoadResponse Response containing a single user
UserSaveRequest Request used for saving users.
VersionResponse Response for a request asking for the version of the REST API on the server.
WastebinSearch Type for getting objects from wastebin
Workflow Workflow information about the page
WorkflowRequest Request for modifying a page in the workflow