Resource for loading and manipulating folders in GCN
Get the list of folders in this folder.
The result can be filtered by
idnamedescriptionidnamedescriptionpublishDir| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| addPrivileges | query | Whether the privileges shall be added to the folders. | false | boolean | no |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folderId | query | Folder ID | no | ||
| inherited | query | true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pages. | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| nodeId | query | Node ID of the channel when used in multichannelling. | int | no | |
| package | query | no | |||
| page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int | no |
| 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 | no |
| privilegeMap | query | Whether the privileges shall be added to the folders as map. | false | boolean | no |
| q | query | Query string for filtering | no | ||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| recursiveIds | query | Optional list of folder ids, for which the children shall be fetched (ignored if recursive is false). The ids might be composed as nodeId/folderId to get children for folders in specific channels only. | yes | ||
| 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 | no | |
| tree | query | Whether folders shall be returned as tree(s). Subfolders will be attached to their mothers. This only makes sense, when recursive is true. | false | boolean | no |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| media type | data type | description |
|---|---|---|
| application/json | FolderListResponse (JSON) | A list of folders |
GET /folder
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"deleted" : [ "...", "..." ],
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "createfolder", "setperm" ],
"property2" : [ "read", "createoverview" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
| media type | data type |
|---|---|
| application/json | FolderCreateRequest (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | FolderLoadResponse (JSON) |
POST /folder/create
Content-Type: application/json
Accept: application/json
{
"publishDir" : "...",
"description" : "...",
"failOnDuplicate" : true,
"name" : "...",
"motherId" : "...",
"startpage" : true,
"templateId" : 12345,
"language" : "...",
"nodeId" : 12345,
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"folder" : {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "deletefolder", "linktemplate" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
},
"stagingStatus" : {
"packageName" : "...",
"included" : true
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the multichannelling exclusion and disinherit status for a list of folders
| name | type | description | constraints | multivalued |
|---|---|---|---|---|
| id | query | list of folder IDs | yes | |
| nodeId | query | node ID | int | no |
| media type | data type | description |
|---|---|---|
| application/json | MultiDisinheritResponse (JSON) | response containing the exclusion and disinherit status |
GET /folder/disinherit
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"exclude" : true,
"disinherit" : [ 12345, 12345 ],
"partialDisinherit" : [ 12345, 12345 ],
"inheritable" : [ 12345, 12345 ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Set the multichannelling exclusion and disinherit status for a list of folders
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| id | query | list of folder IDs | yes | ||
| nodeId | query | node ID | int | no | |
| wait | query | wait timeout in milliseconds | 0 | long | no |
| media type | data type | description |
|---|---|---|
| application/json | DisinheritRequest (JSON) | request object |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/disinherit
Content-Type: application/json
Accept: application/json
{
"exclude" : true,
"disinherit" : [ 12345, 12345 ],
"reinherit" : [ 12345, 12345 ],
"recursive" : true,
"disinheritDefault" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Find files by name, starting with the given folder id
| name | type | description | default | constraints |
|---|---|---|---|---|
| folderId | query | start folder id, if set to 0, the search is done over all folders | 0 | int |
| links | query | type of the links to the file ("backend" for backend links, "frontend" for frontend links) | backend | "backend" or "frontend" |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | 100 | int |
| query | query | string to be searched (currently, only page names are searched) | ||
| recursive | query | true when the search shall be done recursive, false if only flat in the given folder | true | boolean |
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int |
| media type | data type | description |
|---|---|---|
| application/json | FoundFilesListResponse (JSON) | list of found files |
GET /folder/findFiles
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "importpage", "updatetemplate" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "synchronizechannel", "updatefile" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
} ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Find pages by name, eventually starting with the given folder id
| name | type | description | default | constraints |
|---|---|---|---|---|
| folderId | query | start folder id, if set to 0, the search is done over all folders | 0 | int |
| links | query | type of the links to the page ("backend" for backend links, "frontend" for frontend links) | backend | "backend" or "frontend" |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | 100 | int |
| query | query | string to be searched (currently, only page names are searched) | ||
| recursive | query | true when the search shall be done recursive, false if only flat in the given folder | true | boolean |
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int |
| media type | data type | description |
|---|---|---|
| application/json | LegacyPageListResponse (JSON) | list of found pages |
GET /folder/findPages
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pages" : [ {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "deletefolder", "linkworkflow" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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" : { }
}
}, {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "createfolder", "synchronizechannel" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the list of folders in this folder
| media type | data type |
|---|---|
| application/json | FolderListRequest (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | LegacyFolderListResponse (JSON) | list of folders |
POST /folder/getFolders
Content-Type: application/json
Accept: application/json
{
"id" : "...",
"nodeId" : 12345,
"skipCount" : 12345,
"maxItems" : 12345,
"recursive" : true,
"sortBy" : "...",
"sortOrder" : "...",
"inherited" : true,
"search" : "...",
"editor" : "...",
"creator" : "...",
"editedBefore" : 12345,
"editedSince" : 12345,
"createdBefore" : 12345,
"createdSince" : 12345,
"tree" : true,
"recursiveIds" : [ "...", "..." ],
"addPrivileges" : true,
"privilegeMap" : true,
"wastebin" : "include",
"stagingPackageName" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"folders" : [ {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "createtemplate", "updatetagtypes" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
}, {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "deletetemplate", "updatetemplate" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"deleted" : [ "...", "..." ],
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load a list of folders specified in the given request. Folder ids for which no folders exist, or the user does not have the necessary permissions, are silently ignored.
| name | type | description | default | constraints |
|---|---|---|---|---|
| fillWithNulls | query | flag to have items, which cannot be loaded returned as "null" objects in the response (instead of just omitting them) | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | MultiFolderLoadRequest (JSON) | The request with he list of folder ids to load. |
| media type | data type | description |
|---|---|---|
| application/json | MultiFolderLoadResponse (JSON) | The list of found folders, for which the user has enough permissions. |
POST /folder/load
Content-Type: application/json
Accept: application/json
{
"addPrivileges" : true,
"package" : "...",
"ids" : [ 12345, 12345 ],
"forUpdate" : true,
"nodeId" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"folders" : [ {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "updatetagtypes", "viewpage" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
}, {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"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" : "OBJECTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "deletefile", "assignpermissions" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
} ],
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Move multiple folders to a different location
| media type | data type | description |
|---|---|---|
| application/json | MultiFolderMoveRequest (JSON) | request containing source and target information |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/move
Content-Type: application/json
Accept: application/json
{
"ids" : [ "...", "..." ],
"folderId" : 12345,
"nodeId" : 12345,
"foregroundTime" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Push a list of folders 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 /folder/push2master
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"masterId" : 12345,
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "template", "file" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Unlocalize folders 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 /folder/unlocalize
Content-Type: application/json
Accept: application/json
{
"ids" : [ 12345, 12345 ],
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "image", "image" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load the breadcrumb to the given folder
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | id of the folder. This can either be a localid or a globalid | ||
| nodeId | query | node id (for multichannelling) | int | |
| tags | query | true to include the folders tags, false (default)if not | false | boolean |
| wastebin | query | true to include folders from the wastebin, false (default) if not | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | LegacyFolderListResponse (JSON) | list of folders. the first entry is the root folder of the node, the last one the requested folder. |
GET /folder/breadcrumb/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"folders" : [ {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"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" : "CONTENTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "importpage", "updatefile" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
}, {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "updatetagtypes", "deletetemplate" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"deleted" : [ "...", "..." ],
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the object counts for objects in the specified folder
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | id of the folder | int | |
| folderId | query | Folder ID | ||
| inherited | query | true to only count inherited objects, false to count not inherited objects, null (default) to count both | boolean | |
| language | query | language code | ||
| nodeId | query | node id | int | |
| package | query | |||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" |
| media type | data type | description |
|---|---|---|
| application/json | FolderObjectCountResponse (JSON) | response containing the object counts |
GET /folder/count/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"folders" : 12345,
"pages" : 12345,
"templates" : 12345,
"images" : 12345,
"files" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete a single folder. Note that inherited or localized folders can't be deleted in a channel. However you can delete an inherited folder in the master and unlocalize a localized folder.
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder to be deleted. This can either be local or global id | |
| nodeId | query | int |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/delete/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the multichannelling exclusion and disinherit status of the folder
| name | type | description | constraints |
|---|---|---|---|
| id | path | folder ID | |
| nodeId | query | node ID | int |
| media type | data type | description |
|---|---|---|
| application/json | DisinheritResponse (JSON) | response containing the exclusion and disinherit status |
GET /folder/disinherit/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"exclude" : true,
"disinheritDefault" : true,
"disinherit" : [ 12345, 12345 ],
"inheritable" : [ 12345, 12345 ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Set the multichannelling exclusion and disinherit status
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | folder ID | ||
| nodeId | query | node ID | int | |
| wait | query | wait timeout in milliseconds | 0 | long |
| media type | data type | description |
|---|---|---|
| application/json | DisinheritRequest (JSON) | request object |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/disinherit/{id}
Content-Type: application/json
Accept: application/json
{
"exclude" : true,
"disinherit" : [ 12345, 12345 ],
"reinherit" : [ 12345, 12345 ],
"recursive" : true,
"disinheritDefault" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get externals links from all the pages inside the folder with id `folderId`.
| name | type | description | default | constraints |
|---|---|---|---|---|
| folderId | path | Id of the folder. | int | |
| recursive | query | If true, pages in subfolders will be included in the response. | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | FolderExternalLinksResponse (JSON) | list of pages including its external links (see FolderExternalLinksResponse). |
GET /folder/getExternalLinks/{folderId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pages" : [ {
"pageId" : 12345,
"pageName" : "...",
"links" : [ "...", "..." ]
}, {
"pageId" : 12345,
"pageName" : "...",
"links" : [ "...", "..." ]
} ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
get a list of files for this folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| folderId | path | id of the folder | no | ||
| broken | query | true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both | boolean | no | |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folder | query | True to add the folder information to the returned objects | false | boolean | no |
| folderId | query | Folder ID | no | ||
| inherited | query | true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| niceurl | query | optional regular expression to get files with a nice URL. | no | ||
| nodeId | query | node id for this folder - for use with multichannelling | int | no | |
| online | query | true to only return online files, false to only get offline files, null to get both online and offline files | boolean | no | |
| package | query | no | |||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| used | query | true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified, this filter will only check in the current channel | boolean | no | |
| usedIn | query | optional list of channel IDs for extending the "used" filter to multiple channels. | int | yes | |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| media type | data type | description |
|---|---|---|
| application/json | LegacyFileListResponse (JSON) | list of files |
GET /folder/getFiles/{folderId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "linkworkflow", "updatepage" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
}, {
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "deletetemplate", "publishpage" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the list of folders in this folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| id | path | local id of the folder. This can either be the local or globalid. | no | ||
| addPrivileges | query | Whether the privileges shall be added to the folders. | false | boolean | no |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folderId | query | Folder ID | no | ||
| inherited | query | true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pages. | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| nodeId | query | Node ID of the channel when used in multichannelling. | int | no | |
| package | query | no | |||
| privilegeMap | query | Whether the privileges shall be added to the folders as map. | false | boolean | no |
| privileges | query | true if the privileges shall be added to the folders, false if not | false | boolean | no |
| recId | query | optional list of folder ids, for which the children shall be fetched. if recursive is true (ignored if recursive is false). The ids might be composed as nodeId/folderId to get children for folders in specific channels only. | yes | ||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| recursiveIds | query | Optional list of folder ids, for which the children shall be fetched (ignored if recursive is false). The ids might be composed as nodeId/folderId to get children for folders in specific channels only. | yes | ||
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| tree | query | Whether folders shall be returned as tree(s). Subfolders will be attached to their mothers. This only makes sense, when recursive is true. | false | boolean | no |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| media type | data type | description |
|---|---|---|
| application/json | LegacyFolderListResponse (JSON) | list of folders |
GET /folder/getFolders/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"folders" : [ {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"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" : "CONTENTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "translatepage", "updatefolder" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
}, {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "updatetemplate", "updatefolder" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"deleted" : [ "...", "..." ],
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
get a list of images for this folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| folderId | path | id of the folder | no | ||
| broken | query | true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both | boolean | no | |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folder | query | True to add the folder information to the returned objects | false | boolean | no |
| folderId | query | Folder ID | no | ||
| inherited | query | true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| niceurl | query | optional regular expression to get files with a nice URL. | no | ||
| nodeId | query | node id for this folder - for use with multichannelling | int | no | |
| online | query | true to only return online files, false to only get offline files, null to get both online and offline files | boolean | no | |
| package | query | no | |||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| used | query | true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified, this filter will only check in the current channel | boolean | no | |
| usedIn | query | optional list of channel IDs for extending the "used" filter to multiple channels. | int | yes | |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| media type | data type | description |
|---|---|---|
| application/json | LegacyFileListResponse (JSON) | list of iamges |
GET /folder/getImages/{folderId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "updatetagtypes", "viewtemplate" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
}, {
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "viewfile", "deletetemplate" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get a list of items for this folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| folderId | path | id of the folder | no | ||
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folderId | query | Folder ID | no | ||
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| ispublisher | query | (optional) true when only the objects which were last published by the user shall be returned | false | boolean | no |
| langfallback | query | true if the language fallback shall be done when getting pages in a language, false if not. If a page is not present in the given language and langFallback is true, the language variant with highest priority in the node is used instead, otherwise the page will not be present in the list | true | boolean | no |
| language | query | code of the language in which the pages shall be fetched. | no | ||
| langvars | query | true when the language variants should be added to the pages | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| modified | query | (optional) true to restrict to modified objects, false to restrict to unmodified objects | boolean | no | |
| nodeId | query | node id for this folder - for use with multichanneling | int | no | |
| online | query | (optional) true to restrict to online objects, false to restrict to offline objects | boolean | no | |
| package | query | no | |||
| publishedbefore | query | Timestamp to search objects, which were published before a given time (0 for all objects) | 0 | int | no |
| publishedsince | query | Timestamp to search objects, which were published since a given time (0 for all objects) | 0 | int | no |
| publisher | query | Pattern for restricting objects by publisher | no | ||
| publisherId | query | IDs for restricting objects by publisher | int | yes | |
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| template | query | false | boolean | no | |
| type | query | list of types to return, e.g. page, file and/or image | "channel" or "file" or "folder" or "form" or "image" or "node" or "page" | yes |
| media type | data type | description |
|---|---|---|
| application/json | ItemListResponse (JSON) | list of items |
GET /folder/getItems/{folderId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ {
"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" : { }
}
}, {
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
get a list of pages for this folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| id | path | id of the folder. This can be the local or global id of the folder | no | ||
| contenttags | query | true if the contenttags shall be attached to all returned pages. Default is false | false | boolean | no |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| excludeMlId | query | List of markup language IDs for restricting to pages that have templates with none of the given markup languages | int | yes | |
| filename | query | (optional) search string for filenames (may be empty) | no | ||
| folder | query | true when the folder information should be added to the pages | false | boolean | no |
| folderId | query | Folder ID | no | ||
| includeMlId | query | List of markup language IDs for restricting to pages that have templates with one of the given markup languages | int | yes | |
| inherited | query | true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pages | boolean | no | |
| insync | query | (optional) Boolean#TRUE to restrict to pages that are currently in sync with their translation masters, Boolean#FALSE to restrict to pages that are currently not in sync with their translation masters, and NULL to not consider the translation status information at all. Setting this flag (to either true or false) will also add the translation status information. | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| ispublisher | query | (optional) true when only the objects which were last published by the user shall be returned | false | boolean | no |
| langfallback | query | true if the language fallback shall be done when getting pages in a language, false if not. If a page is not present in the given language and langFallback is true, the language variant with highest priority in the node is used instead, otherwise the page will not be present in the list | true | boolean | no |
| language | query | code of the language in which the pages shall be fetched. | no | ||
| langvars | query | true when the language variants should be added to the pages | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| modified | query | (optional) true to restrict to modified objects, false to restrict to unmodified objects | boolean | no | |
| niceurl | query | optional regular expression to get pages with a nice URL. | no | ||
| nodeId | query | node id of the channel when used in multichannelling | int | no | |
| objecttags | query | true if the objecttags shall be attached to all returned pages. Default is false | false | boolean | no |
| online | query | (optional) true to restrict to online objects, false to restrict to offline objects | boolean | no | |
| package | query | no | |||
| permission | query | List of folder permissions which must be granted for folders in order to include their pages in the result | "channelsync" or "create" or "createfolder" or "createform" or "createitems" or "createoverview" or "createtemplates" or "delete" or "deletefolder" or "deleteform" or "deleteitems" or "deletetemplates" or "edit" or "formreport" or "importitems" or "inheritance" or "linkoverview" or "linktemplates" or "publish" or "publishform" or "publishpages" or "read" or "readitems" or "readtemplates" or "setperm" or "translatepages" or "update" or "updateconstructs" or "updatefolder" or "updateform" or "updateinheritance" or "updateitems" or "updatetemplates" or "userassignment" or "view" or "viewform" or "wastebin" | yes | |
| planned | query | (optional) true to restrict to planned pages, false to restrict to unplanned pages | boolean | no | |
| priority | query | priority of the page | 0 | int | no |
| publishedbefore | query | Timestamp to search objects, which were published before a given time (0 for all objects) | 0 | int | no |
| publishedsince | query | Timestamp to search objects, which were published since a given time (0 for all objects) | 0 | int | no |
| publisher | query | Pattern for restricting objects by publisher | no | ||
| publisherId | query | IDs for restricting objects by publisher | int | yes | |
| queued | query | (optional) true to restrict to queued pages, false to restrict to unqueued pages | boolean | no | |
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| searchcontent | query | (optional) true, if also the content shall be searched, false if not | false | boolean | no |
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| template | query | true when the template information should be added to the pages | false | boolean | no |
| template_id | query | list of template ids | int | yes | |
| timedue | query | (optional) difference in seconds for searching pages, that will change their status due to timemanagement within the given timespan. When set to 0 (default), the timemanagement will not be considered. | 0 | int | no |
| translationstatus | query | true if the translationstatus information shall be added for every page, false if not. | false | boolean | no |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| wfown | query | (optional) true to restrict to pages owned by the user in a workflow. Defaults to false. | false | boolean | no |
| wfwatch | query | (optional) true to restrict to pages watched by the user in a workflow. Defaults to false. | false | boolean | no |
| media type | data type | description |
|---|---|---|
| application/json | LegacyPageListResponse (JSON) | list of pages |
GET /folder/getPages/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pages" : [ {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "wastebin", "linktemplate" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "linkworkflow", "assignpermissions" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the templates which are linked into the given folder
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| folderId | path | id of the folder. This can either be a localid or a globalid | no | ||
| checkPermission | query | true if the access permission should be checked for every template | true | boolean | no |
| createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int | no |
| createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int | no |
| creator | query | Pattern for restricting objects by creator | no | ||
| creatorId | query | IDs for restricting objects by creator. | int | yes | |
| editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int | no |
| editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int | no |
| editor | query | Pattern for restricting objects by editor | no | ||
| editorId | query | IDs for restricting objects by editor. | int | yes | |
| folderId | query | Folder ID | no | ||
| inherited | query | true to only return inherited templates in the given node, false to only get local/localized templates, null to get local and inherited templates | boolean | no | |
| iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean | no |
| iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean | no |
| maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
| nodeId | query | node id for this folder - for use with multichannelling | int | no | |
| package | query | no | |||
| recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean | no |
| reduce | query | true if the list should be reduced to the unique template occurrences only. valid only when InFolderParameterBean#recursive flag is set. | false | boolean | no |
| search | query | (optional) string to search files for - this will filter the results if either the ID, the name (partial match or the description (partial match) matches the given search string. | no | ||
| skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
| sortby | query | (optional) attribute to sort by. It is possible to sort by name, cdate, edate, pdate, filename, template, folder, masterNode, priority, excluded, deletedat. defaults to name | name | no | |
| sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
| wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" | no |
| media type | data type | description |
|---|---|---|
| application/json | TemplateListResponse (JSON) | list of templates |
GET /folder/getTemplates/{folderId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"templates" : [ {
"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" : "CONTENTTAG"
},
"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" : "CONTENTTAG"
}
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
}, {
"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
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load a single folder
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | id of the folder to load. This can be either the localid or a globalid | ||
| construct | query | if true, the construct information will be added to tags | false | boolean |
| nodeId | query | id of the node (channel) for which the folder shall be loaded (when multichannelling is used) | int | |
| package | query | name of a content staging package, to check the folder status in it | ||
| privileges | query | flag whether the privileges should be added to the reponse | false | boolean |
| update | query | true when the folder is fetched for updating. Currently, folders cannot be locked in the backend, but it is still recommended to set this parameter to true when the folder shall be modified. | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | FolderLoadResponse (JSON) | response containing the folder to load |
GET /folder/load/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"folder" : {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "createtemplate", "deletefile" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
},
"stagingStatus" : {
"packageName" : "...",
"included" : true
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get localization info for a folder and all subitems for a given channel and all master channels
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder. This can either be the local or global id | |
| nodeId | query | id of the node to start with | int |
| recursive | query | true if the localization info shall be fetched recursively, false if not | required boolean |
| media type | data type | description |
|---|---|---|
| application/json | LocalizationInfo (JSON) | localization info |
GET /folder/localizationinfo/{id}
Content-Type: */*
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" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the IDs an their respective node IDs of localized copies of the specified folder.
| name | type | description | constraints |
|---|---|---|---|
| id | path | The ID of the master folder. | int |
| media type | data type | description |
|---|---|---|
| application/json | LocalizationsResponse (JSON) | A map of folder IDs to node IDs of localized copies. |
GET /folder/localizations/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"masterId" : 12345,
"masterNodeId" : 12345,
"nodeIds" : {
"property1" : 12345,
"property2" : 12345
},
"total" : 12345,
"hidden" : 12345,
"online" : [ 12345, 12345 ],
"offline" : [ 12345, 12345 ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Localize the given folder
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder to localize | int |
| media type | data type | description |
|---|---|---|
| application/json | LocalizeRequest (JSON) | request |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/localize/{id}
Content-Type: application/json
Accept: application/json
{
"channelId" : 12345,
"foregroundTime" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Move the folder with id to a different location
| name | type | description |
|---|---|---|
| id | path | id of the folder to move |
| media type | data type | description |
|---|---|---|
| application/json | FolderMoveRequest (JSON) | request containing target information |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/move/{id}
Content-Type: application/json
Accept: application/json
{
"folderId" : 12345,
"nodeId" : 12345,
"foregroundTime" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the privileges of the current user on the given folder
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder. | int |
| media type | data type | description |
|---|---|---|
| application/json | PrivilegesResponse (JSON) | privileges response |
GET /folder/privileges/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"privileges" : [ "publishpage", "viewfile" ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Push a folder from a channel into a master
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder | int |
| media type | data type | description |
|---|---|---|
| application/json | PushToMasterRequest (JSON) | request |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/push2master/{id}
Content-Type: application/json
Accept: application/json
{
"masterId" : 12345,
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "file", "template" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Sanitize the given folder publish directory according to the configuration and settings of the given node
| media type | data type | description |
|---|---|---|
| application/json | FolderPublishDirSanitizeRequest (JSON) | request |
| media type | data type | description |
|---|---|---|
| application/json | FolderPublishDirSanitizeResponse (JSON) | response containing the sanitized publish directory |
POST /folder/sanitize/publishDir
Content-Type: application/json
Accept: application/json
{
"nodeId" : 1,
"publishDir" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"publishDir" : "...",
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Save a single folder
| name | type | description |
|---|---|---|
| id | path | folder id. This can either be a local or globalid |
| media type | data type | description |
|---|---|---|
| application/json | FolderSaveRequest (JSON) | folder save request |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/save/{id}
Content-Type: application/json
Accept: application/json
{
"folder" : {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"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" : "OBJECTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "updatepage", "linktemplate" ],
"privilegeBits" : "...",
"privilegeMap" : {
"privileges" : {
"property1" : true,
"property2" : true
},
"languages" : [ { }, { } ]
},
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ {
"id" : 12345,
"globalId" : "...",
"name" : "..."
}, {
"id" : 12345,
"globalId" : "...",
"name" : "..."
} ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
}
},
"nodeId" : 12345,
"tagsToSubfolders" : [ "...", "..." ],
"recursive" : true,
"failOnDuplicate" : true,
"foregroundTime" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Request to set a startpage for a page
| name | type | description |
|---|---|---|
| id | path | folder ID |
| media type | data type | description |
|---|---|---|
| application/json | StartpageRequest (JSON) | request containing the requested startpage |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | generic response |
POST /folder/startpage/{id}
Content-Type: application/json
Accept: application/json
{
"pageId" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Unlocalize the given folder
| name | type | description | constraints |
|---|---|---|---|
| id | path | id of the folder 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 /folder/unlocalize/{id}
Content-Type: application/json
Accept: application/json
{
"channelId" : 12345,
"recursive" : true,
"foregroundTime" : 12345,
"types" : [ "page", "template" ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get objects which are directly or indirectly linked by the specified folders,
which can be synchronised to a master channel along with the folders 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.
| name | type | description | constraints | multivalued |
|---|---|---|---|---|
| dstNodeId | query | The channel ID of the target channel | int | no |
| ids | query | The IDs of the folders to get linked objects for | int | yes |
| recursive | query | Whether objects in subfolders should be collected (optional, default: false) |
boolean | no |
| srcNodeId | query | The channel ID of the source channel | int | no |
| types | query | The object types which should be synchronised (optional, default: all types) | "file" or "folder" or "image" or "page" or "template" | yes |
| media type | data type | description |
|---|---|---|
| application/json | ReferencedSyncableObjectsListResponse (JSON) |
GET /folder/usage/syncableObjects
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"haveDependencies" : true,
"dependencies" : {
"property1" : {
"property1" : { },
"property2" : { }
},
"property2" : {
"property1" : { },
"property2" : { }
}
},
"pages" : [ {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "createpage", "deletefolder" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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" : { }
}
}, {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : 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" : [ "updatepage", "linktemplate" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"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" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "updatefolder", "deletefolder" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
}, {
"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,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "synchronizechannel", "createfolder" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : [ {
"iconCls" : "...",
"sizeX" : 12345,
"sizeY" : 12345,
"typeId" : 12345,
"dpiX" : 12345,
"dpiY" : 12345,
"gisResizable" : true,
"fpX" : 12345.0,
"fpY" : 12345.0,
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"folderName" : "...",
"channelId" : { },
"text" : "...",
"leaf" : true,
"cls" : "...",
"fileType" : "...",
"description" : "...",
"folderId" : 12345,
"fileSize" : 12345,
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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" : [ "deletepage", "viewpage" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "page",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
}, {
"iconCls" : "...",
"sizeX" : 12345,
"sizeY" : 12345,
"typeId" : 12345,
"dpiX" : 12345,
"dpiY" : 12345,
"gisResizable" : true,
"fpX" : 12345.0,
"fpY" : 12345.0,
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"folderName" : "...",
"channelId" : { },
"text" : "...",
"leaf" : true,
"cls" : "...",
"fileType" : "...",
"description" : "...",
"folderId" : 12345,
"fileSize" : 12345,
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"inherited" : true,
"path" : "...",
"forceOnline" : true,
"online" : true,
"broken" : true,
"disinheritedChannels" : [ {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"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" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : 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", "viewpage" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "channel",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"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" : { }
}
} ],
"imagesTotal" : 12345,
"imagesWithoutPermission" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete folders denoted by the set of IDs from the wastebin
| name | type | description | default | constraints |
|---|---|---|---|---|
| wait | query | time in ms for the request to be done in foreground | 0 | long |
| media type | data type | description |
|---|---|---|
| application/json | IdSetRequest (JSON) | request containing ID set |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | response object |
POST /folder/wastebin/delete
Content-Type: application/json
Accept: application/json
{
"ids" : [ "...", "..." ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Restore the denoted folders from the wastebin
| name | type | description | default | constraints |
|---|---|---|---|---|
| wait | query | time in ms for the request to be done in foreground | 0 | long |
| media type | data type | description |
|---|---|---|
| application/json | IdSetRequest (JSON) | request containing ID set |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | response object |
POST /folder/wastebin/restore
Content-Type: application/json
Accept: application/json
{
"ids" : [ "...", "..." ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Remove the folder denoted by the given id from the wastebin.
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | id of the folder to remove from the wastebin. This can either be a local or global id | ||
| wait | query | time in ms for the request to be done in foreground | 0 | long |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | response object |
POST /folder/wastebin/delete/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Restore the given folder from the wastebin
| name | type | description | default | constraints |
|---|---|---|---|---|
| id | path | id of the folder to restore from the wastebin. This can either be a local or global id | ||
| wait | query | time in ms for the request to be done in foreground | 0 | long |
| media type | data type | description |
|---|---|---|
| application/json | GenericResponse (JSON) | response object |
POST /folder/wastebin/restore/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}