Resource used for loading, saving and manipulating GCN templates.
Load the template with the given id and return it.
name | type | description | constraints |
---|---|---|---|
id | path | The template id | |
nodeId | query | channel id | int |
media type | data type |
---|---|
application/json | TemplateLoadResponse (JSON) |
GET /template/load/{id} Accept: application/json
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" : "CONTENTTAG"
},
"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" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Get the list of templatetags for this template
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" |
media type | data type | description |
---|---|---|
application/json | TagListResponse (JSON) | response object |
GET /template/getTags/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"tags" : [ {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"active" : true,
"properties" : {
"property1" : {
"type" : "FILE",
"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" : "NODE",
"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" : "VELOCITY",
"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" : "DATASOURCE",
"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" : "TEMPLATETAG"
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"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" : "FAILURE",
"responseMessage" : "...",
"property" : "..."
}
}
Push a template from a channel into a master
name | type | description | constraints |
---|---|---|---|
id | path | id of the template | int |
media type | data type | description |
---|---|---|
application/json | PushToMasterRequest (JSON) | request |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/push2master/{id}
Content-Type: application/json
Accept: application/json
{
"masterId" : 12345,
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "folder", "image" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"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" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Push a list of templates from a channel into a master
media type | data type | description |
---|---|---|
application/json | MultiPushToMasterRequest (JSON) | request |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/push2master
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"masterId" : 12345,
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "template", "page" ]
}
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" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Unlocalize the given template
name | type | description | constraints |
---|---|---|---|
id | path | id of the template to unlocalize | int |
media type | data type | description |
---|---|---|
application/json | UnlocalizeRequest (JSON) | request |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/unlocalize/{id}
Content-Type: application/json
Accept: application/json
{
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "image", "page" ]
}
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" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}
Unlocalize templates in a channel
media type | data type | description |
---|---|---|
application/json | MultiUnlocalizeRequest (JSON) | request |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/unlocalize
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "image", "file" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"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" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Get localization info for a list of templates for a given channel and all master channels
name | type | description | constraints | multivalued |
---|---|---|---|---|
id | query | list of template ids | int | yes |
nodeId | query | id of the node to start with | int | no |
media type | data type | description |
---|---|---|
application/json | LocalizationInfo (JSON) | localization info |
GET /template/localizationinfo Accept: application/json
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" : "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" : "NOTFOUND",
"responseMessage" : "...",
"property" : "..."
}
}
Get localization info for a template for a given channel and all master channels
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 |
media type | data type | description |
---|---|---|
application/json | LocalizationInfo (JSON) | localization info |
GET /template/localizationinfo/{id} Accept: application/json
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" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Link the given template to the given folders. For linking templates to folders, the user must have the following permissions:
name | type | description |
---|---|---|
id | path | id of the template |
media type | data type | description |
---|---|---|
application/json | LinkRequest (JSON) | request containing the list of folders and other data |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/link/{id}
Content-Type: application/json
Accept: application/json
{
"recursive" : true,
"folderIds" : [ "...", "..." ],
"nodeId" : 12345
}
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" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Link the given templates to the given folders. For linking templates to folders, the user must have the following permissions:
media type | data type | description |
---|---|---|
application/json | MultiLinkRequest (JSON) | request containing the list of folders and other data |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/link
Content-Type: application/json
Accept: application/json
{
"templateIds" : [ "...", "..." ],
"recursive" : true,
"folderIds" : [ "...", "..." ],
"nodeId" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"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" : "FAILURE",
"responseMessage" : "...",
"property" : "..."
}
}
Unlink the given template from the given folders. For unlinking templates from folders, the user must have the following permissions:
name | type | description |
---|---|---|
id | path | id of the template |
media type | data type | description |
---|---|---|
application/json | LinkRequest (JSON) | request containing the list of folders and other data |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/unlink/{id}
Content-Type: application/json
Accept: application/json
{
"recursive" : true,
"folderIds" : [ "...", "..." ],
"nodeId" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"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" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Unlink the given templates from the given folders. For unlinking templates from folders, the user must have the following permissions:
media type | data type | description |
---|---|---|
application/json | MultiLinkRequest (JSON) | request containing the list of folders and other data |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | generic response |
POST /template/unlink
Content-Type: application/json
Accept: application/json
{
"templateIds" : [ "...", "..." ],
"recursive" : true,
"folderIds" : [ "...", "..." ],
"nodeId" : 12345
}
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" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}