NodeResource Resource

Resource for handling Nodes in GCN

GET /node

List nodes.
The result can be filtered by

  • id
  • name
and sorted by
  • id
  • name

Request Parameters
name type description default constraints
package query if given, check the node status against the staging package    
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
perms query Flag to add permission information for the returned items. false boolean
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 Codes
code condition
200 The node list was returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeList (JSON) node list

Example

Request
GET /node
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deletefolder", "updateinheritance" ],
    "property2" : [ "channelsync", "deletetemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node

Create a new node. See NodeResourceImpl#checkCreateRequest for a detailed list of constraints on the given request. In short:

  • the node and hostname must be provided
  • no other node with the same hostname and (binary) publish directory may exist
  • if the Aloha editor is to be used, utf8 must be enabled

Request Body
media type data type description
application/json NodeSaveRequest (JSON) The request containing a REST model of the node to be created.
Response Codes
code condition
200 The node was created.
400 The node could not be created due to insufficient data provided.
409 The node could not be created due to a conflict with other nodes.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeLoadResponse (JSON) A node load response containing the values of the newly created node on success, or a response code indicating any errors on failure.

Example

Request
PUT /node
Content-Type: application/json
Accept: application/json

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "NONE",
    "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" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "description" : "..."
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "NONE",
    "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" : "node",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/create

This method has been deprecated.

Create a new node. See NodeResourceImpl#checkCreateRequest for a detailed list of constraints on the given request. In short:

  • the node and hostname must be provided
  • no other node with the same hostname and (binary) publish directory may exist
  • if the Aloha editor is to be used, utf8 must be enabled

Request Body
media type data type description
application/json NodeSaveRequest (JSON) The request containing a REST model of the node to be created.
Response Codes
code condition
200 The node was created.
400 The node could not be created due to insufficient data provided.
409 The node could not be created due to a conflict with other nodes.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeLoadResponse (JSON) A node load response containing the values of the newly created node on success, or a response code indicating any errors on failure.

Example

Request
POST /node/create
Content-Type: application/json
Accept: application/json

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "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" : { }
    }
  },
  "description" : "..."
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "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" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/features

Get list of available node features.
The result can be filtered by

  • id
  • name
  • description
and sorted by
  • id
  • name
  • description

Request Parameters
name type description default constraints
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 Codes
code condition
200 Available features were returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json FeatureModelList (JSON) list response

Example

Request
GET /node/features
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "inheritance", "linktemplates" ],
    "property2" : [ "updatefolder", "importitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{id}

Delete the given node

Request Parameters
name type description default constraints
id path id of the node    
wait query wait timeout in milliseconds 0 long
Response Codes
code condition
200 The node was deleted.
404 The node was not found.
409 The node could not be deleted due to a conflict with other nodes.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
DELETE /node/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{id}

Load a single node

Request Parameters
name type description default constraints
id path id of the node to load. This can be either the localid or a globalid    
update query true when the folder is fetched for updating. Currently, nodes cannot be locked in the backend, but it is still recommended to set this parameter to true when the node shall be modified. false boolean
Response Codes
code condition
200 The node was returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeLoadResponse (JSON) response containing the node to load

Example

Request
GET /node/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "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" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/{id}

Saves the values specified in the request to the node. See NodeResourceImpl#checkRequestConsistency for a detailed list of constraints on the request. In short:

  • any folder id that is given must be valid
  • no other node with the same hostname and (binary) publish directory may exist
  • if the Aloha editor is to be used, utf8 must be enabled

Request Parameters
name type description
id path
Request Body
media type data type description
application/json NodeSaveRequest (JSON) The request containing the fields to be updated in the node.
Response Codes
code condition
200 The node was updated.
400 The node could not be updated due to insufficient data provided.
404 The node was not found.
409 The node could not be updated due to a conflict with other nodes.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) A generic response indicating the success or failure of the operation.

Example

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

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "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" : { }
    }
  },
  "description" : "..."
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/features/{id}

This method has been deprecated.

Load the activated features

Request Parameters
name type description
id path id of the node
Response Codes
code condition
200 Features were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeFeatureResponse (JSON) response containing the activated features

Example

Request
GET /node/features/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "features" : [ "live_urls_per_node", "publish_folder_startpage" ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/getLanguages/{id}

This method has been deprecated.

Get the ordered list of languages of the node

Request Parameters
name type description
id path node id
Response Codes
code condition
200 Languages were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json LanguageListResponse (JSON) ordered list of languages

Example

Request
GET /node/getLanguages/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "languages" : [ {
    "id" : 12345,
    "globalId" : "...",
    "code" : "...",
    "name" : "..."
  }, {
    "id" : 12345,
    "globalId" : "...",
    "code" : "...",
    "name" : "..."
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/load/{id}

This method has been deprecated.

Load a single node

Request Parameters
name type description default constraints
id path id of the node to load. This can be either the localid or a globalid    
update query true when the folder is fetched for updating. Currently, nodes cannot be locked in the backend, but it is still recommended to set this parameter to true when the node shall be modified. false boolean
Response Codes
code condition
200 The node was returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeLoadResponse (JSON) response containing the node to load

Example

Request
GET /node/load/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "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" : "form",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/save/{id}

This method has been deprecated.

Saves the values specified in the request to the node. See NodeResourceImpl#checkRequestConsistency for a detailed list of constraints on the request. In short:

  • any folder id that is given must be valid
  • no other node with the same hostname and (binary) publish directory may exist
  • if the Aloha editor is to be used, utf8 must be enabled

Request Parameters
name type description
id path
Request Body
media type data type description
application/json NodeSaveRequest (JSON) The request containing the fields to be updated in the node.
Response Codes
code condition
200 The node was updated.
400 The node could not be updated due to insufficient data provided.
404 The node was not found.
409 The node could not be updated due to a conflict with other nodes.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) A generic response indicating the success or failure of the operation.

Example

Request
POST /node/save/{id}
Content-Type: application/json
Accept: application/json

                
{
  "node" : {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "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" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "FILENAME",
    "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" : { }
    }
  },
  "description" : "..."
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{id}/availableLanguages

Get list of languages, which can be assigned to the node.
The result can be filtered by

  • id
  • globalId
  • name
  • code
and sorted by
  • id
  • globalId
  • name
  • code

Request Parameters
name type description default constraints
id path node 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 Codes
code condition
200 Languages were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json LanguageList (JSON) list of available languages

Example

Request
GET /node/{id}/availableLanguages
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "update", "updatefolder" ],
    "property2" : [ "deleteform", "formreport" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{id}/features

Get list of features activated for the node.
The result can be filtered by

  • name
and sorted by
  • name

Request Parameters
name type description default constraints
id path node 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 Codes
code condition
200 Features were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json FeatureList (JSON) list of activated features

Example

Request
GET /node/{id}/features
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "viewform", "updateconstructs" ],
    "property2" : [ "publish", "deletetemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{id}/languages

Get list of languages in the node. The result can be filtered by

  • id
  • globalId
  • name
  • code

Request Parameters
name type description default constraints
id path node 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    
Response Codes
code condition
200 Languages were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json LanguageList (JSON) ordered list of languages

Example

Request
GET /node/{id}/languages
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "setperm", "deletefolder" ],
    "property2" : [ "updateinheritance", "deletefolder" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/{id}/languages

Set ordered list of languages

Request Parameters
name type description
id path node id
Request Body
media type data type description
application/json array of ContentLanguage (JSON) ordered list of languages
Response Codes
code condition
200 Language were set.
404 The node or a language was not found.
409 Language could not be removed due to a conflict with existing data.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json LanguageList (JSON) response

Example

Request
POST /node/{id}/languages
Content-Type: application/json
Accept: application/json

                
[ {
  "id" : 12345,
  "globalId" : "...",
  "code" : "...",
  "name" : "..."
} ]
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "updatetemplates", "userassignment" ],
    "property2" : [ "importitems", "readitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{nodeId}/constructs

Get the constructs assigned to this node.
The result can be filtered by

  • keyword
  • name
  • description
and sorted by
  • id
  • globalId
  • keyword
  • name
  • description

Request Parameters
name type description default constraints
nodeId path Node ID (local or global)    
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
perms query Flag to add permission information for the returned items. false boolean
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 Codes
code condition
200 Constructs were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json PagedConstructListResponse (JSON) Response containing the constructs assigned to this node

Example

Request
GET /node/{nodeId}/constructs
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "read", "formreport" ],
    "property2" : [ "view", "readitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/{nodeId}/copy

Copy the given node.

Request Parameters
name type description default constraints
nodeId path node ID    
wait query wait timeout in milliseconds 0 long
Request Body
media type data type description
application/json NodeCopyRequest (JSON) copy request
Response Codes
code condition
200 Node was copied.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
POST /node/{nodeId}/copy
Content-Type: application/json
Accept: application/json

                
{
  "pages" : true,
  "templates" : true,
  "files" : true,
  "workflows" : true,
  "copies" : 12345
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{nodeId}/objectproperties

Get the object properties assigned to this node.
The result can be filtered by

  • keyword
  • name
  • description
and sorted by
  • keyword
  • name
  • description

Request Parameters
name type description default constraints
nodeId path Node ID (local or global)    
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
perms query Flag to add permission information for the returned items. false boolean
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 Codes
code condition
200 Object properties were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json PagedObjectPropertyListResponse (JSON) Response containing the object properties assigned to this node

Example

Request
GET /node/{nodeId}/objectproperties
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "update", "readitems" ],
    "property2" : [ "deletefolder", "updateinheritance" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{nodeId}/settings

Load settings specific to the specified node. To get the settings in $NODE_SETTINGS_GLOBAL are loaded and then the values from $NODE_SETTINGS[nodeId] are added.

Request Parameters
name type description
nodeId path Node ID (local or global)
Response Codes
code condition
200 Node settings were returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeSettingsResponse (JSON) The conigured settings for this node in JSON format

Example

Request
GET /node/{nodeId}/settings
Content-Type: */*
Accept: application/json

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

                
{
  "data" : { },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{nodeId}/templates

Get the templates assigned to this node. The result can be filtered by

  • name
  • description
and sorted by
  • name
  • description

Request Parameters
name type description default constraints
nodeId path Node ID (local or global)    
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
perms query Flag to add permission information for the returned items. false boolean
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 Codes
code condition
200 Templates were returned.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json PagedTemplateListResponse (JSON) Response containing the templates assigned to this node

Example

Request
GET /node/{nodeId}/templates
Content-Type: */*
Accept: application/json

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

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deletetemplates", "publishform" ],
    "property2" : [ "createform", "linkoverview" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/features/activate/{id}

This method has been deprecated.

Activate the given list of features (features not listed will not be changed)

Request Parameters
name type description
id path id of the node. This can be either the localid or the globalid
Request Body
media type data type
application/json NodeFeatureRequest (JSON)
Response Codes
code condition
200 Features were activated.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /node/features/activate/{id}
Content-Type: application/json
Accept: application/json

                
{
  "features" : [ "contentfile_auto_offline", "link_checker" ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/features/deactivate/{id}

This method has been deprecated.

Deactivate the given list of features (features not listed will not be changed)

Request Parameters
name type description
id path id of the node. This can be either the localid or the globalid
Request Body
media type data type
application/json NodeFeatureRequest (JSON)
Response Codes
code condition
200 Features were deactivated.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /node/features/deactivate/{id}
Content-Type: application/json
Accept: application/json

                
{
  "features" : [ "disable_instant_delete", "disable_instant_delete" ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /node/features/set/{id}

This method has been deprecated.

Set the given list of features. Exactly the listed features will be activated, all other will be deactivated

Request Parameters
name type description
id path id of the node. This can be either the localid or the globalid
Request Body
media type data type
application/json NodeFeatureRequest (JSON)
Response Codes
code condition
200 Features were set.
404 The node was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /node/features/set/{id}
Content-Type: application/json
Accept: application/json

                
{
  "features" : [ "new_tageditor", "forms" ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{id}/features/{feature}

Deactivate the feature for the node

Request Parameters
name type description constraints
feature path feature to activate "always_localize" or "asset_management" or "contentfile_auto_offline" or "disable_instant_delete" or "forms" or "link_checker" or "live_urls_per_node" or "new_tageditor" or "publish_folder_startpage"
id path node ID  
Response Codes
code condition
200 Features was deactivated.
404 The node was not found.
405 Requested feature is not generally activated.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
DELETE /node/{id}/features/{feature}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node/{id}/features/{feature}

Activate the feature for the node

Request Parameters
name type description constraints
feature path feature to activate "always_localize" or "asset_management" or "contentfile_auto_offline" or "disable_instant_delete" or "forms" or "link_checker" or "live_urls_per_node" or "new_tageditor" or "publish_folder_startpage"
id path node ID  
Response Codes
code condition
200 Features was activated.
404 The node was not found.
405 Requested feature is not generally activated.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
PUT /node/{id}/features/{feature}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{id}/languages/{languageId}

Remove language from node

Request Parameters
name type description
id path node id
languageId path language id or language code
Response Codes
code condition
200 Language was removed from the node.
404 The node or language was not found.
409 Language could not be removed due to a conflict with existing data.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
DELETE /node/{id}/languages/{languageId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node/{id}/languages/{languageId}

Add language to node

Request Parameters
name type description
id path node id
languageId path language id or language code
Response Codes
code condition
200 Language was added to the node.
404 The node or language was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) response

Example

Request
PUT /node/{id}/languages/{languageId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{nodeId}/constructs/{constructId}

Remove a construct from a node.

Request Parameters
name type description
constructId path Construct ID (local or global)
nodeId path Node ID (local or global)
Response Codes
code condition
200 Construct was removed.
404 The node or construct was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
DELETE /node/{nodeId}/constructs/{constructId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node/{nodeId}/constructs/{constructId}

Add a construct to a node.

Request Parameters
name type description
constructId path Construct ID (local or global)
nodeId path Node ID (local or global)
Response Codes
code condition
200 Construct was added.
404 The node or construct was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
PUT /node/{nodeId}/constructs/{constructId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{nodeId}/objectproperties/{objectPropertyId}

Remove an object property from a node.

Request Parameters
name type description
nodeId path Node ID (local or global)
objectPropertyId path Construct ID (local or global)
Response Codes
code condition
200 Object property was removed.
404 The node or object property was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
DELETE /node/{nodeId}/objectproperties/{objectPropertyId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node/{nodeId}/objectproperties/{objectPropertyId}

Add an object property to a node.

Request Parameters
name type description
nodeId path Node ID (local or global)
objectPropertyId path
Response Codes
code condition
200 Object property was added.
404 The node or object property was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
PUT /node/{nodeId}/objectproperties/{objectPropertyId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /node/{nodeId}/templates/{templateId}

Remove a template from a node. This will also unlink the template from all folders of the node

Request Parameters
name type description
nodeId path Node ID (local or global)
templateId path Template ID (local or global)
Response Codes
code condition
200 Template was removed.
404 The node or template was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
DELETE /node/{nodeId}/templates/{templateId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /node/{nodeId}/templates/{templateId}

Get the template, if it is assigned to the node

Request Parameters
name type description
nodeId path Node ID (local or global)
templateId path Template ID (local or global)
Response Codes
code condition
200 Template was found in the node.
404 Either the node was not found, or the template is not assigned to the node.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json TemplateLoadResponse (JSON) template load response

Example

Request
GET /node/{nodeId}/templates/{templateId}
Content-Type: */*
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" : "...",
      "feature" : "...",
      "excludeFromPublishing" : true
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /node/{nodeId}/templates/{templateId}

Add a template to a node. This will just assign the template to the node, but not link it to any folders.

Request Parameters
name type description
nodeId path Node ID (local or global)
templateId path Template ID (local or global)
Response Codes
code condition
200 Template was added.
404 The node or template was not found.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
PUT /node/{nodeId}/templates/{templateId}
Content-Type: */*
Accept: application/json

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

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}