FileResource Resource

Resource for loading and manipulating Files in GCN

GET /file

Get a list of files in the specified folder

Request Parameters
name type description default constraints multivalued
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
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
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
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
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
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
Response Body
media type data type description
application/json FileListResponse (JSON) A list of files

Example

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

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

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

POST /file/copy

Create a copy of the given file.

Request Body
media type data type
application/json FileCopyRequest (JSON)
Response Body
media type data type description
application/json FileUploadResponse (JSON)

Example

Request
POST /file/copy
Content-Type: application/json
Accept: application/json

                
{
  "newFilename" : "...",
  "file" : {
    "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" : "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" : "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" : [ "createtemplate", "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" : "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" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "nodeId" : 12345,
  "targetFolder" : {
    "id" : 12345,
    "channelId" : 12345
  }
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "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" : "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" : "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" : "FILENAME",
      "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" : [ "publishpage", "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" : "image",
      "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" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /file/create

Create a new file handling multipart form-data. The data and meta data is encoded within separate body parts.

Request Body
media type data type description
multipart/form-data object request with data for the file to be created
Response Body
media type data type description
application/json FileUploadResponse (JSON) response containing the file meta data

Example

Request
POST /file/create
Content-Type: multipart/form-data
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "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" : "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" : "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" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "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" : [ "updatetemplate", "createpage" ],
      "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" : { }
    },
    "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" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /file/create

Create a new file with the binary data loaded from a URL

Request Body
media type data type description
application/json FileCreateRequest (JSON) request
Response Body
media type data type description
application/json FileUploadResponse (JSON) response containing the file meta data

Example

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

                
{
  "overwriteExisting" : true,
  "folderId" : 12345,
  "nodeId" : 12345,
  "name" : "...",
  "description" : "...",
  "sourceURL" : "...",
  "niceURL" : "...",
  "alternateURLs" : [ "...", "..." ],
  "properties" : {
    "property1" : "...",
    "property2" : "..."
  }
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "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" : "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" : "PATH",
      "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" : [ "viewfolder", "createfile" ],
      "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" : "form",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /file/createSimple

Create a new file handling simple post data

Request Parameters
name type description default constraints
databodypart query Custom name for the file data body part    
description query File description    
folderId query Folder ID where to save the file in    
nodeId query Node ID    
overwrite query Whether a file with the same name would be overwritten false boolean
qqfile query Meta data filename    
Request Body
media type data type description
multipart/form-data object multipart/form-data request data
Response Body
media type data type description
application/json FileUploadResponse (JSON) response containing the file meta data

Example

Request
POST /file/createSimple
Content-Type: multipart/form-data
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "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" : "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" : "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" : "FILENAME",
      "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", "createtemplate" ],
      "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" : { }
    },
    "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" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /file/createSimple

Create a new file handling simple post data

Request Parameters
name type description default constraints
databodypart query    
description query File description    
folderId query Folder ID where to save the file in   required int
nodeId query Node ID 0 int
overwrite query Whether a file with the same name would be overwritten false boolean
qqfile query File name    
Response Body
media type data type description
application/json FileUploadResponse (JSON) response containing the file meta data

Example

Request
POST /file/createSimple
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "file" : {
    "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" : "PATH",
      "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" : "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" : [ "publishpage", "createtemplate" ],
      "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" : "node",
      "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" : { }
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/disinherit

Get the multichannelling exclusion and disinherit status for a list of pages

Request Parameters
name type description constraints multivalued
id query list of page IDs   yes
nodeId query node ID int no
Response Body
media type data type description
application/json MultiDisinheritResponse (JSON) response containing the exclusion and disinherit status

Example

Request
GET /file/disinherit
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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" : "..."
  }
}
                
              

POST /file/disinherit

Set the multichannelling exclusion and disinherit status for a list of pages

Request Parameters
name type description default constraints multivalued
id query list of page IDs     yes
nodeId query node ID   int no
wait query wait timeout in milliseconds 0 long no
Request Body
media type data type description
application/json DisinheritRequest (JSON) request object
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /file/disinherit
Content-Type: application/json
Accept: application/json

                
{
  "exclude" : true,
  "disinherit" : [ 12345, 12345 ],
  "reinherit" : [ 12345, 12345 ],
  "recursive" : true,
  "disinheritDefault" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/load

Load a list of files specified in the given request. File ids for which no files exist, or the user does not have the necessary permissions, are silently ignored.

Request Body
media type data type description
application/json MultiObjectLoadRequest (JSON) The request with he list of file ids to load.
Response Body
media type data type description
application/json MultiFileLoadResponse (JSON) The list of found files, for which the user has enough permissions.

Example

Request
POST /file/load
Content-Type: application/json
Accept: application/json

                
{
  "package" : "...",
  "ids" : [ 12345, 12345 ],
  "forUpdate" : true,
  "nodeId" : 12345
}
                
              
Response
HTTP/1.1 201 Created
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" : "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" : "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" : "FILENAME",
      "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" : [ "wastebin", "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" : "image",
      "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" : "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" : "FILENAME",
      "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" : "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" : [ "updatetemplate", "translatepage" ],
      "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" : "folder",
    "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" : "..."
  }
}
                
              

GET /file/localizationinfo

Get localization info for a list of files for a given channel and all master channels

Request Parameters
name type description constraints multivalued
id query list of file ids int yes
nodeId query id of the node to start with int no
Response Body
media type data type description
application/json LocalizationInfo (JSON) localization info

Example

Request
GET /file/localizationinfo
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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" : "..."
  }
}
                
              

POST /file/move

Move multiple files to another folder

Request Body
media type data type description
application/json MultiObjectMoveRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /file/move
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ],
  "folderId" : 12345,
  "nodeId" : 12345,
  "allLanguages" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/push2master

Push a list of pages from a channel into a master

Request Body
media type data type description
application/json MultiPushToMasterRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /file/push2master
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "folder", "file" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/unlocalize

Unlocalize files in a channel

Request Body
media type data type description
application/json MultiUnlocalizeRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /file/unlocalize
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "page", "template" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/delete/{id}

Delete the file denoted by id

Request Parameters
name type description constraints
id path id of the File to delete  
nodeId query id of the node (channel) of the file int
Response Body
media type data type description
application/json GenericResponse (JSON) response object

Example

Request
POST /file/delete/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /file/disinherit/{id}

Get the multichannelling exclusion and disinherit status of the file

Request Parameters
name type description constraints
id path file ID  
nodeId query node ID int
Response Body
media type data type description
application/json DisinheritResponse (JSON) response containing the exclusion and disinherit status

Example

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

                
...
                
              
Response
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" : "..."
  }
}
                
              

POST /file/disinherit/{id}

Set the multichannelling exclusion and disinherit status

Request Parameters
name type description default constraints
id path file ID    
nodeId query ID   int
wait query wait timeout in milliseconds 0 long
Request Body
media type data type description
application/json DisinheritRequest (JSON) request object
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "exclude" : true,
  "disinherit" : [ 12345, 12345 ],
  "reinherit" : [ 12345, 12345 ],
  "recursive" : true,
  "disinheritDefault" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /file/load/{id}

Load the file (without data)

Request Parameters
name type description default constraints
id path id of the file    
construct query if true, the construct information will be added to tags false boolean
nodeId query id of the node (channel) for which the image shall be loaded (when multichannelling is used).   int
package query name of a content staging package, to check the file status in it    
update query true when the file is fetched for updating. Currently, files cannot be locked in the backend, but it is still recommended to set this parameter to true when the file shall be modified. false boolean
Response Body
media type data type description
application/json FileLoadResponse (JSON) response containing the file

Example

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

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

                
{
  "file" : {
    "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" : "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" : "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" : [ "viewfile", "deletefile" ],
      "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" : { }
    },
    "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" : { }
    }
  },
  "stagingStatus" : {
    "packageName" : "...",
    "included" : true
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/localizationinfo/{id}

Get localization info for a file for a given channel and all master channels

Request Parameters
name type description constraints
id path id of the file int
nodeId query id of the node to start with int
Response Body
media type data type description
application/json LocalizationInfo (JSON) localization info

Example

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

                
...
                
              
Response
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 /file/localizations/{id}

Get the IDs an their respective node IDs of localized copies of the specified file.

Request Parameters
name type description constraints
id path The ID of the master file. int
Response Body
media type data type description
application/json LocalizationsResponse (JSON) A map of folder IDs to node IDs of localized copies.

Example

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

                
...
                
              
Response
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" : "..."
  }
}
                
              

POST /file/localize/{id}

Localize the given file

Request Parameters
name type description constraints
id path id of the file to localize int
Request Body
media type data type description
application/json LocalizeRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "channelId" : 12345,
  "foregroundTime" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/move/{id}

Mpve the given file to another folder

Request Parameters
name type description
id path file id
Request Body
media type data type description
application/json ObjectMoveRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "folderId" : 12345,
  "nodeId" : 12345,
  "allLanguages" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/push2master/{id}

Push a file from a channel into a master

Request Parameters
name type description constraints
id path id of the file int
Request Body
media type data type description
application/json PushToMasterRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "masterId" : 12345,
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "file", "folder" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/save/{id}

Save the given file

Request Parameters
name type description constraints
id path int
Request Body
media type data type description
application/json FileSaveRequest (JSON) request with the file to be saved
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "file" : {
    "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" : "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" : "PATH",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "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" : [ "viewfolder", "deletefile" ],
      "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" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "failOnDuplicate" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/save/{id}

Save the posted content into the given file

Request Parameters
name type description constraints
id path id of the file int
Request Body
media type data type description
multipart/form-data object request with data for the file to be created
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /file/save/{id}
Content-Type: multipart/form-data
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/unlocalize/{id}

Unlocalize the given file

Request Parameters
name type description constraints
id path id of the file to unlocalize int
Request Body
media type data type description
application/json UnlocalizeRequest (JSON) request
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

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

                
{
  "channelId" : 12345,
  "recursive" : true,
  "foregroundTime" : 12345,
  "types" : [ "folder", "folder" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /file/usage/file

Get the files using one of the given files

Request Parameters
name type description default constraints multivalued
files query true (default) if the files shall be returned, false for only returning the counts true boolean no
id query list of file ids, for which the usage shall be fetched   int yes
maxItems query maximum number of items to be returned, set to -1 for returning all items -1 int no
nodeId query id of the node   int 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. 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
Response Body
media type data type description
application/json FileUsageListResponse (JSON) response

Example

Request
GET /file/usage/file
Content-Type: */*
Accept: application/json

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

                
{
  "withoutPermission" : 12345,
  "total" : 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" : "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" : "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" : "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" : [ "createpage", "deletepage" ],
      "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" : { }
    },
    "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" : "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" : "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" : "PATH",
      "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" : [ "updatepage", "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" : "page",
    "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 /file/usage/folder

Get the folders using one of the given files.

Request Parameters
name type description default constraints multivalued
folders query true (default) if the folders shall be returned, false for only returning the counts true boolean no
id query list of file ids, for which the usage shall be fetched   int yes
maxItems query maximum number of items to be returned, set to -1 for returning all items -1 int no
nodeId query id of the node   int 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. 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
Response Body
media type data type description
application/json FolderUsageListResponse (JSON) response

Example

Request
GET /file/usage/folder
Content-Type: */*
Accept: application/json

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

                
{
  "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" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "linkworkflow", "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" : "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" : "PATH",
      "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" : "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" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "updatefile", "createfile" ],
    "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" : "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" : { }
    } ],
    "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" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "deleted" : [ "...", "..." ],
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/usage/image

Get the images using one of the given files

Request Parameters
name type description default constraints multivalued
files query true (default) if the files shall be returned, false for only returning the counts true boolean no
id query list of file ids, for which the usage shall be fetched   int yes
maxItems query maximum number of items to be returned, set to -1 for returning all items -1 int no
nodeId query id of the node   int 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. 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
Response Body
media type data type description
application/json FileUsageListResponse (JSON) response

Example

Request
GET /file/usage/image
Content-Type: */*
Accept: application/json

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

                
{
  "withoutPermission" : 12345,
  "total" : 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" : "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" : "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" : { }
    }, {
      "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,
    "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", "deletefile" ],
      "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" : { }
    },
    "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" : "file",
    "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" : "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" : { }
    }, {
      "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" : "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" : [ "viewpage", "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" : "file",
      "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 /file/usage/page

Get the pages using one of the given files

Request Parameters
name type description default constraints multivalued
contenttags query True if the contenttags shall be attached to all returned pages. Default is false false boolean no
folder query True for adding folder info to the pages. Default is false. false boolean no
id query list of file ids, for which the usage shall be fetched   int yes
langvars query True for adding the language variants to the pages. Default is false. false boolean no
maxItems query maximum number of items to be returned, set to -1 for returning all items -1 int no
nodeId query id of the node   int no
objecttags query True if the objecttags shall be attached to all returned pages. Default is false. false boolean no
pages query true (default) if the pages shall be returned, false for only returning the counts true 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. 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 for adding template info to the pages. Default is false. false boolean no
translationstatus query True if the translationstatus information shall be added for every page. Default is false. false boolean no
Response Body
media type data type description
application/json PageUsageListResponse (JSON) response

Example

Request
GET /file/usage/page
Content-Type: */*
Accept: application/json

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

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "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" : [ "translatepage", "wastebin" ],
      "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" : "node",
      "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" : "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,
    "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" : "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" : [ "viewtemplate", "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" : { }
    },
    "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" : "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" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/usage/syncableObjects

Get objects which are directly or indirectly linked by the specified files, which can be synchronised to a master channel along with the files 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.

Request Parameters
name type description constraints multivalued
dstNodeId query The channel ID of the target channel int no
ids query The IDs of the files to get linked objects for int yes
srcNodeId query The channel ID of the source channel int no
Response Body
media type data type description
application/json ReferencedSyncableObjectsListResponse (JSON)

Example

Request
GET /file/usage/syncableObjects
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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" : [ "createtemplate", "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" : "node",
      "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" : "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" : "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" : "image",
    "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" : "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" : [ "assignpermissions", "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" : "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" : "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" : "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" : "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" : "channel",
    "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" : "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" : "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" : "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" : [ "updatetagtypes", "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" : "file",
      "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" : "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" : "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" : "FILENAME",
      "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" : [ "viewpage", "viewfolder" ],
      "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" : { }
    }
  } ],
  "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" : "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" : "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" : "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" : [ "viewpage", "updatetagtypes" ],
      "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" : "form",
    "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" : "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" : "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" : "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" : [ "publishpage", "updatetagtypes" ],
      "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" : "image",
      "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" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "imagesTotal" : 12345,
  "imagesWithoutPermission" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/usage/template

Get the templates using one of the given files

Request Parameters
name type description default constraints multivalued
id query list of file ids, for which the usage shall be fetched   int yes
maxItems query maximum number of items to be returned, set to -1 for returning all items -1 int no
nodeId query id of the node   int 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. 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
templates query true (default) if the templates shall be returned, false for only returning the counts true boolean no
Response Body
media type data type description
application/json TemplateUsageListResponse (JSON) response

Example

Request
GET /file/usage/template
Content-Type: */*
Accept: application/json

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

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "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" : "TEMPLATETAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "objectTags" : {
      "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"
      }
    },
    "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" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "construct" : { },
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/usage/total

Get the total usage information for the given files.

Request Parameters
name type description constraints multivalued
id query int yes
nodeId query id of the node int no
Response Body
media type data type description
application/json TotalUsageResponse (JSON) response

Example

Request
GET /file/usage/total
Content-Type: */*
Accept: application/json

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

                
{
  "infos" : {
    "property1" : {
      "total" : 12345,
      "pages" : 12345,
      "folders" : 12345,
      "templates" : 12345,
      "files" : 12345,
      "images" : 12345
    },
    "property2" : {
      "total" : 12345,
      "pages" : 12345,
      "folders" : 12345,
      "templates" : 12345,
      "files" : 12345,
      "images" : 12345
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /file/wastebin/delete

Remove the given files from the wastebin

Request Parameters
name type description default constraints
wait query time in ms for the request to be done in foreground 0 long
Request Body
media type data type description
application/json IdSetRequest (JSON) request containing the file IDs
Response Body
media type data type description
application/json GenericResponse (JSON) response object

Example

Request
POST /file/wastebin/delete
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/wastebin/restore

Restore the given files from the wastebin

Request Parameters
name type description default constraints
wait query time in ms for the request to be done in foreground 0 long
Request Body
media type data type description
application/json IdSetRequest (JSON) request containing the file IDs
Response Body
media type data type description
application/json GenericResponse (JSON) response object

Example

Request
POST /file/wastebin/restore
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /file/content/load/{id}

Load the file with given id

Request Parameters
name type description
id path file id. This can either be the localid or a globalid
Response Body
media type data type description
application/json object (JSON) response containing file binary data

Example

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

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

                
...
                
              

POST /file/wastebin/delete/{id}

Remove the file denoted by the given id from the wastebin.

Request Parameters
name type description default constraints
id path id of the file 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
Response Body
media type data type description
application/json GenericResponse (JSON) response object

Example

Request
POST /file/wastebin/delete/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /file/wastebin/restore/{id}

Restore the given file from the wastebin

Request Parameters
name type description default constraints
id path id of the file 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
Response Body
media type data type description
application/json GenericResponse (JSON) response object

Example

Request
POST /file/wastebin/restore/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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