Data Types

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