FolderSaveRequest Data Type

Request object for a request to save a folder

Properties
name data type description
folder Folder the folder
nodeId number Node ID, when setting the publish directory recursively.
tagsToSubfolders array of string List of object tags, that shall be passed on to subfolders. May contain names (with or without the prefix 'object.') or IDs
recursive boolean True to set the publish directory recursively, false (default) to only change this given folder
failOnDuplicate boolean True if saving the folder with a duplicate name will fail. If false (default) the name will be made unique before saving
foregroundTime number Number of seconds, the job may run in the foreground

Example

{
  "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" : [ "importpage", "wastebin" ],
    "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" : "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" : "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" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "nodeId" : 12345,
  "tagsToSubfolders" : [ "...", "..." ],
  "recursive" : true,
  "failOnDuplicate" : true,
  "foregroundTime" : 12345
}