Response for a folder usage request.
| name | data type | constraints | description |
|---|---|---|---|
| withoutPermission | number | required int | Get the number of folders without permission |
| total | number | required int | Get the total number of folders |
Properties inherited from LegacyFolderListResponse |
|||
| folders | array of Folder | Get the list of folders | |
| hasMoreItems | boolean | True if more items are available (paging) | |
| numItems | number | Get total number of items present | |
| deleted | array of string | List of folderIds (or [nodeId/folderId]s), which were requested to be opened (when getting folder structures), but do not exist in the backend (at least not visible for the user) | |
Properties inherited from StagingResponse |
|||
| stagingStatus | map of StagingStatus | Staging status of contained objects | |
Properties inherited from GenericResponse |
|||
| messages | array of Message | Messages contained in the response (which should be shown to the user) | |
| responseInfo | ResponseInfo | ||
Example
{
"withoutPermission" : 12345,
"total" : 12345,
"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" : "OBJECTTAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "createpage", "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,
"publishImageVariants" : true,
"host" : "...",
"hostProperty" : "...",
"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" : "...",
"meshPreviewUrlProperty" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "FILENAME",
"masterName" : "...",
"contentRepositoryName" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "image",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"publishImageVariants" : true,
"host" : "...",
"hostProperty" : "...",
"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" : "...",
"meshPreviewUrlProperty" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "FILENAME",
"masterName" : "...",
"contentRepositoryName" : "...",
"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" : { }
}
}, {
"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" : "TEMPLATETAG"
}
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "publishpage", "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,
"publishImageVariants" : true,
"host" : "...",
"hostProperty" : "...",
"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" : "...",
"meshPreviewUrlProperty" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "FILENAME",
"masterName" : "...",
"contentRepositoryName" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"publishImageVariants" : true,
"host" : "...",
"hostProperty" : "...",
"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" : "...",
"meshPreviewUrlProperty" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "FILENAME",
"masterName" : "...",
"contentRepositoryName" : "...",
"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" : "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" : "..."
}
}