TemplateResource Resource

Resource used for loading, saving and manipulating GCN templates.

GET /template/load/{id}

Load the template with the given id and return it.

Request Parameters
name type description constraints
id path The template id  
nodeId query channel id int
Response Body
media type data type
application/json TemplateLoadResponse (JSON)

Example

Request
GET /template/load/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "template" : {
    "inheritedFrom" : "...",
    "masterNode" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "description" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "locked" : true,
    "markupLanguage" : {
      "id" : 12345,
      "name" : "...",
      "extension" : "...",
      "contentType" : "..."
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  },
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/getTags/{id}

Get the list of templatetags for this template

Request Parameters
name type description default constraints
id path id of the template. The local or global id    
maxItems query -1 int
search query    
skipCount query 0 int
sortby query name "name"
sortorder query asc "ASC" or "DESC" or "NONE" or "asc" or "desc" or "none"
Response Body
media type data type description
application/json TagListResponse (JSON) response object

Example

Request
GET /template/getTags/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tags" : [ {
    "id" : 12345,
    "name" : "...",
    "constructId" : 12345,
    "active" : true,
    "properties" : {
      "property1" : {
        "type" : "PAGE",
        "stringValue" : "...",
        "booleanValue" : true,
        "fileId" : 12345,
        "imageId" : 12345,
        "folderId" : 12345,
        "pageId" : 12345,
        "stringValues" : [ "...", "..." ],
        "options" : [ { }, { } ],
        "selectedOptions" : [ { }, { } ],
        "datasourceId" : 12345,
        "overview" : { },
        "templateId" : 12345,
        "contentTagId" : 12345,
        "templateTagId" : 12345,
        "nodeId" : 12345,
        "partId" : 12345,
        "id" : 12345,
        "globalId" : "..."
      },
      "property2" : {
        "type" : "IMAGE",
        "stringValue" : "...",
        "booleanValue" : true,
        "fileId" : 12345,
        "imageId" : 12345,
        "folderId" : 12345,
        "pageId" : 12345,
        "stringValues" : [ "...", "..." ],
        "options" : [ { }, { } ],
        "selectedOptions" : [ { }, { } ],
        "datasourceId" : 12345,
        "overview" : { },
        "templateId" : 12345,
        "contentTagId" : 12345,
        "templateTagId" : 12345,
        "nodeId" : 12345,
        "partId" : 12345,
        "id" : 12345,
        "globalId" : "..."
      }
    },
    "type" : "OBJECTTAG"
  }, {
    "id" : 12345,
    "name" : "...",
    "constructId" : 12345,
    "active" : true,
    "properties" : {
      "property1" : {
        "type" : "LIST",
        "stringValue" : "...",
        "booleanValue" : true,
        "fileId" : 12345,
        "imageId" : 12345,
        "folderId" : 12345,
        "pageId" : 12345,
        "stringValues" : [ "...", "..." ],
        "options" : [ { }, { } ],
        "selectedOptions" : [ { }, { } ],
        "datasourceId" : 12345,
        "overview" : { },
        "templateId" : 12345,
        "contentTagId" : 12345,
        "templateTagId" : 12345,
        "nodeId" : 12345,
        "partId" : 12345,
        "id" : 12345,
        "globalId" : "..."
      },
      "property2" : {
        "type" : "SELECT",
        "stringValue" : "...",
        "booleanValue" : true,
        "fileId" : 12345,
        "imageId" : 12345,
        "folderId" : 12345,
        "pageId" : 12345,
        "stringValues" : [ "...", "..." ],
        "options" : [ { }, { } ],
        "selectedOptions" : [ { }, { } ],
        "datasourceId" : 12345,
        "overview" : { },
        "templateId" : 12345,
        "contentTagId" : 12345,
        "templateTagId" : 12345,
        "nodeId" : 12345,
        "partId" : 12345,
        "id" : 12345,
        "globalId" : "..."
      }
    },
    "type" : "OBJECTTAG"
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/usage/syncableObjects

Get objects which are directly or indirectly linked by the specified templates, which can be synchronised to a master channel along with the templates themselves. Linked objects are pages, files and images specified in UrlPartTypes of content or object tags. Direct dependencies are in the pages, files and images files of the response. Indirect dependencies are mapped in dependencies.

Request Parameters
name type description constraints multivalued
dstNodeId query The channel ID of the target channel int no
ids query The IDs of the templates to get linked objects for int yes
srcNodeId query The channel ID of the source channel int no
Response Body
media type data type
application/json ReferencedSyncableObjectsListResponse (JSON)

Example

Request
GET /template/usage/syncableObjects
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "haveDependencies" : true,
  "dependencies" : {
    "property1" : {
      "property1" : { },
      "property2" : { }
    },
    "property2" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "pages" : [ {
    "niceUrl" : "...",
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "start" : 12345,
      "end" : 12345,
      "monday" : true,
      "tuesday" : true,
      "wednesday" : true,
      "thursday" : true,
      "friday" : true,
      "saturday" : true,
      "sunday" : true,
      "at" : 12345
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "status" : 12345,
    "online" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "translatepage", "inheritance" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "pageStatus" : "offline",
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "folder",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "niceUrl" : "...",
    "fileName" : "...",
    "description" : "...",
    "templateId" : 12345,
    "folderId" : 12345,
    "priority" : 12345,
    "publisher" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "pdate" : 12345,
    "language" : "...",
    "languageName" : "...",
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "start" : 12345,
      "end" : 12345,
      "monday" : true,
      "tuesday" : true,
      "wednesday" : true,
      "thursday" : true,
      "friday" : true,
      "saturday" : true,
      "sunday" : true,
      "at" : 12345
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "status" : 12345,
    "online" : true,
    "template" : {
      "inheritedFrom" : "...",
      "masterNode" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "description" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "locked" : true,
      "markupLanguage" : { },
      "inherited" : true,
      "folderId" : 12345,
      "masterId" : 12345,
      "path" : "...",
      "templateTags" : {
        "property1" : { },
        "property2" : { }
      },
      "objectTags" : {
        "property1" : { },
        "property2" : { }
      },
      "source" : "...",
      "channelSetId" : 12345,
      "channelId" : 12345,
      "master" : true
    },
    "folder" : {
      "inheritedFrom" : "...",
      "inheritedFromId" : 12345,
      "masterNode" : "...",
      "masterNodeId" : 12345,
      "motherId" : 12345,
      "publishDir" : "...",
      "description" : "...",
      "nodeId" : 12345,
      "inherited" : true,
      "atposidx" : "...",
      "startPageId" : { },
      "tags" : {
        "property1" : { },
        "property2" : { }
      },
      "subfolders" : [ { }, { } ],
      "hasSubfolders" : true,
      "privileges" : [ "publishpage", "updatefolder" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    },
    "contentSetId" : 12345,
    "contentGroupId" : 12345,
    "languageVariants" : {
      "property1" : { },
      "property2" : { }
    },
    "inherited" : true,
    "locked" : true,
    "lockedSince" : 12345,
    "lockedBy" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "workflow" : {
      "groups" : [ { }, { } ],
      "message" : "...",
      "user" : { },
      "modified" : true,
      "timestamp" : 12345
    },
    "translationStatus" : {
      "pageId" : 12345,
      "name" : "...",
      "versionTimestamp" : 12345,
      "language" : "...",
      "inSync" : true,
      "version" : "...",
      "latestVersion" : { }
    },
    "currentVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "publishedVersion" : {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    },
    "versions" : [ {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    }, {
      "number" : "...",
      "timestamp" : 12345,
      "editor" : { }
    } ],
    "pageStatus" : "queue",
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "pagesTotal" : 12345,
  "pagesWithoutPermission" : 12345,
  "files" : [ {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "image",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "filesTotal" : 12345,
  "filesWithoutPermission" : 12345,
  "images" : [ {
    "sizeX" : 12345,
    "sizeY" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "folder",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "sizeX" : 12345,
    "sizeY" : 12345,
    "dpiX" : 12345,
    "dpiY" : 12345,
    "gisResizable" : true,
    "fpX" : 12345.0,
    "fpY" : 12345.0,
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "imagesTotal" : 12345,
  "imagesWithoutPermission" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/push2master/{id}

Push a template from a channel into a master

Request Parameters
name type description constraints
id path id of the template int
Request Body
media type data type description
application/json PushToMasterRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/push2master/{id}
Content-Type: application/json
Accept: application/json

                
{
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "template", "file" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/push2master

Push a list of templates from a channel into a master

Request Body
media type data type description
application/json MultiPushToMasterRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/push2master
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "template", "folder" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/unlocalize/{id}

Unlocalize the given template

Request Parameters
name type description constraints
id path id of the template to unlocalize int
Request Body
media type data type description
application/json UnlocalizeRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/unlocalize/{id}
Content-Type: application/json
Accept: application/json

                
{
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "file", "template" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/unlocalize

Unlocalize templates in a channel

Request Body
media type data type description
application/json MultiUnlocalizeRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/unlocalize
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "folder", "file" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/localizationinfo

Get localization info for a list of templates for a given channel and all master channels

Request Parameters
name type description constraints multivalued
id query list of template ids int yes
nodeId query id of the node to start with int no
Response Body
media type data type description
application/json LocalizationInfo (JSON) localization info

Example

Request
GET /template/localizationinfo
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "channels" : [ {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  }, {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  } ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "FAILURE",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/localizationinfo/{id}

Get localization info for a template for a given channel and all master channels

Request Parameters
name type description constraints
id path id of the template. This can either be the local or global id of the template.  
nodeId query id of the node to start with int
Response Body
media type data type description
application/json LocalizationInfo (JSON) localization info

Example

Request
GET /template/localizationinfo/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "channels" : [ {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  }, {
    "channelId" : 12345,
    "folder" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "page" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "image" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "file" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "template" : {
      "inherited" : 12345,
      "localized" : 12345,
      "local" : 12345
    },
    "inherited" : 12345,
    "localized" : 12345,
    "local" : 12345
  } ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/localizations/{id}

Get the IDs an their respective node IDs of localized copies of the specified template.

Request Parameters
name type description constraints
id path The ID of the master template. int
Response Body
media type data type description
application/json LocalizationsResponse (JSON) A map of template IDs to node IDs of localized copies.

Example

Request
GET /template/localizations/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "masterId" : 12345,
  "masterNodeId" : 12345,
  "nodeIds" : {
    "property1" : 12345,
    "property2" : 12345
  },
  "status" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "total" : 12345,
  "hidden" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/link/{id}

Link the given template to the given folders. For linking templates to folders, the user must have the following permissions:

  • edit the template (which includes viewing the template)
  • link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.

Request Parameters
name type description
id path id of the template
Request Body
media type data type description
application/json LinkRequest (JSON) request containing the list of folders and other data
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/link/{id}
Content-Type: application/json
Accept: application/json

                
{
  "recursive" : true,
  "folderIds" : [ "...", "..." ],
  "nodeId" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/link

Link the given templates to the given folders. For linking templates to folders, the user must have the following permissions:

  • edit the template (which includes viewing the template)
  • link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.

Request Body
media type data type description
application/json MultiLinkRequest (JSON) request containing the list of folders and other data
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/link
Content-Type: application/json
Accept: application/json

                
{
  "templateIds" : [ "...", "..." ],
  "recursive" : true,
  "folderIds" : [ "...", "..." ],
  "nodeId" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/unlink/{id}

Unlink the given template from the given folders. For unlinking templates from folders, the user must have the following permissions:

  • edit the template (which includes viewing the template)
  • link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.

Request Parameters
name type description
id path id of the template
Request Body
media type data type description
application/json LinkRequest (JSON) request containing the list of folders and other data
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/unlink/{id}
Content-Type: application/json
Accept: application/json

                
{
  "recursive" : true,
  "folderIds" : [ "...", "..." ],
  "nodeId" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /template/unlink

Unlink the given templates from the given folders. For unlinking templates from folders, the user must have the following permissions:

  • edit the template (which includes viewing the template)
  • link templates to all target folders (which includes viewing folder and viewing templates in the folder)
If at least on of these permissions is not granted to the user, the method will fail.

Request Body
media type data type description
application/json MultiLinkRequest (JSON) request containing the list of folders and other data
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /template/unlink
Content-Type: application/json
Accept: application/json

                
{
  "templateIds" : [ "...", "..." ],
  "recursive" : true,
  "folderIds" : [ "...", "..." ],
  "nodeId" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /template/{id}/tagstatus

Get the tag status for a template. The tag status will contain a list of all template tags, which are editable in pages together with the count of pages in sync, out of sync, incompatible or missing

Request Parameters
name type description default constraints
id path template ID    
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name  
Response Body
media type data type description
application/json TagStatusResponse (JSON) response

Example

Request
GET /template/{id}/tagstatus
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "responseMessage" : "...",
    "property" : "..."
  }
}