Contains Model classes for the Gentics Content.Node REST API
name | path | methods | description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActivitiResource |
|
|
Resource for integration of Activiti with the CMS. Usage of this resource requires the feature activiti_integration to be activated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdminResource |
|
|
Resource for various tasks used by the administrator (like retrieving version numbers) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthenticationResource |
|
|
Authentication Resource. This can be used to authenticate an existing SID. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClusterResource |
|
|
Resource for clustering support | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConstructResource |
|
|
Resource for handling constructs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContentRepositoryResource |
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DiffResource |
|
|
This resource implements the diff tool in the REST API, which can be used to calculate the diff between html contents. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExportResource |
|
|
Export helper resource | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FileResource |
|
|
Resource for loading and manipulating Files in GCN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FolderResource |
|
|
Resource for loading and manipulating folders in GCN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GroupResource |
|
|
Resource to get groups | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
I18nResource |
|
|
Resource to translate given keys (optionally including parameters) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImageResource |
|
|
Resource for loading and manipulating Images in GCN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InfoResource |
|
|
Resource for access to general info about the system, which are available without a valid session. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LanguageResource |
|
|
Resource to manage cms languages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MessagingResource |
|
|
Messaging resource to access the inbox (list, view, mark read, delete) and send messages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MigrationResource |
|
|
Resource used for performing Tag Type Migrations and Template Migrations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NodeResource |
|
|
Resource for handling Nodes in GCN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageResource |
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageResource |
|
|
Resource used for loading, saving and manipulating GCN pages. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PermResource |
|
|
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:
The following table can be used to look up the bit positions (starting at 0) of the role permissions:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PolicyMapResource |
|
|
API for reading from the policy map. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SchedulerResource |
|
|
Resource for managing the scheduler | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SearchResource |
|
|
Resource for endpoints that are forwarded to elasticsearch for performing searches | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TemplateResource |
|
|
Resource used for loading, saving and manipulating GCN templates. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserResource |
|
|
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 |
|
|
REST API for validating user input. |
type | description |
---|---|
AbstractListResponse | Abstract list response |
AuthenticationResponse | Authentication Result |
AutocompleteItem | Item that is returned to autocomplete calls |
CRElasticsearchModel | Model of the Elasticsearch specific configuration for Mesh CRs |
ChannelLocalizationInfo | REST Model class for localization info of a channel |
ClusterInfo | Response containing clustering information |
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 |
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 | Model of a custom tool |
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 |
FeatureResponse | Response containing information about a feature |
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 |
MemberInfo | Info about the local member |
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 |
MigrationPreProcessor | Model for a TagTypeMigrationPreProcessor |
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. |
NodeSettingsResponse | Response to a request for loading node specific settings. |
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 |
ReferencedFilesListResponse | Response for a list of referenced files or images |
ReferencedPagesListResponse | Response for a list of referenced pages |
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. |
SchedulerStatus | Possible status values of the scheduler |
SchedulerStatusResponse | Scheduler status |
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 |
Status | Possible Check Status values |
SuspendRequest | Request to suspend the scheduler |
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 |
TagmapEntryListResponse | Response containing a list of ContentRepositories |
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. |
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 |
ToolsResponse | Response containing the custom tools to display in the UI |
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 | Possible ContentRepository 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 |