FileResource Resource

Resource for loading and manipulating Files in GCN

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}
Accept: application/json

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

                
...
                
              

GET /file/load/{id}

Load the file (without data)

Request Parameters
name type description default constraints
id path id of the file    
nodeId query id of the node (channel) for which the image shall be loaded (when multichannelling is used).   int
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}
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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

                
{
  "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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  }, {
    "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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "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    
overwrite query false boolean
qqfile query    
Request Body
media type data type description
multipart/form-data (custom) 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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "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   int
nodeId query Node ID 0 int
overwrite query 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
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  },
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "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 (custom) 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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  },
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "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
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  }
}
                
              
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  },
  "failOnDuplicate" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "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 (custom) 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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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}
Accept: application/json

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

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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}
Accept: application/json

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

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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}
Accept: application/json

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

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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
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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "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 name   no
sortorder query asc   no
Response Body
media type data type description
application/json FolderUsageListResponse (JSON) response

Example

Request
GET /file/usage/folder
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "viewfile", "deletefile" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "page",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  }, {
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "motherId" : 12345,
    "publishDir" : "...",
    "description" : "...",
    "nodeId" : 12345,
    "inherited" : true,
    "atposidx" : "...",
    "startPageId" : { },
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "translatepage", "deletefile" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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,
  "deleted" : [ "...", "..." ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /file/usage/page

Get the pages using one of the given files

Request Parameters
name type description default constraints multivalued
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
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 name   no
sortorder query asc   no
template query true for adding template info to the pages, default is false false boolean no
Response Body
media type data type description
application/json PageUsageListResponse (JSON) response

Example

Request
GET /file/usage/page
Accept: application/json

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

                
{
  "withoutPermission" : 12345,
  "total" : 12345,
  "pages" : [ {
    "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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "start" : 12345,
      "end" : 12345,
      "monday" : true,
      "tuesday" : true,
      "wednesday" : true,
      "thursday" : true,
      "friday" : true,
      "saturday" : true,
      "sunday" : true,
      "at" : 12345
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "status" : 12345,
    "online" : 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" : [ "updatetagtypes", "updatefile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "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" : { }
    } ],
    "pageStatus" : "offline",
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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" : { }
    }
  }, {
    "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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "pageVariants" : [ { }, { } ],
    "readOnly" : true,
    "timeManagement" : {
      "start" : 12345,
      "end" : 12345,
      "monday" : true,
      "tuesday" : true,
      "wednesday" : true,
      "thursday" : true,
      "friday" : true,
      "saturday" : true,
      "sunday" : true,
      "at" : 12345
    },
    "path" : "...",
    "url" : "...",
    "liveUrl" : "...",
    "status" : 12345,
    "online" : 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" : [ "viewpage", "createfile" ],
      "privilegeBits" : "...",
      "privilegeMap" : { },
      "path" : "...",
      "masterId" : 12345,
      "channelsetId" : 12345,
      "channelId" : 12345,
      "isMaster" : true,
      "disinheritedChannels" : [ { }, { } ],
      "excluded" : true,
      "disinheritDefault" : true,
      "disinherited" : true,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "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" : { }
    } ],
    "pageStatus" : "offline",
    "contentId" : 12345,
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "node",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "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 name   no
sortorder query 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
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" : "..."
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "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" : "..."
    },
    "inherited" : true,
    "folderId" : 12345,
    "masterId" : 12345,
    "path" : "...",
    "templateTags" : {
      "property1" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "mandatory" : true,
        "editableInPage" : true,
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "objectTags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "source" : "...",
    "channelSetId" : 12345,
    "channelId" : 12345,
    "master" : true
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "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 name   no
sortorder query asc   no
Response Body
media type data type description
application/json FileUsageListResponse (JSON) response

Example

Request
GET /file/usage/image
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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 name   no
sortorder query asc   no
Response Body
media type data type description
application/json FileUsageListResponse (JSON) response

Example

Request
GET /file/usage/file
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,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "typeId" : 12345,
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "folderName" : "...",
    "channelId" : { },
    "text" : "...",
    "leaf" : true,
    "cls" : "...",
    "iconCls" : "...",
    "fileType" : "...",
    "description" : "...",
    "folderId" : 12345,
    "fileSize" : 12345,
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "url" : "...",
    "liveUrl" : "...",
    "inherited" : true,
    "path" : "...",
    "forceOnline" : true,
    "online" : true,
    "broken" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "image",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "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,
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "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,
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "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" : [ "image", "file" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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" : [ "image", "folder" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "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", "image" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "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" : [ "image", "page" ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "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}
Accept: application/json

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

                
{
  "masterId" : 12345,
  "masterNodeId" : 12345,
  "nodeIds" : {
    "property1" : 12345,
    "property2" : 12345
  },
  "status" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "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
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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "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}
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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "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}
Accept: application/json

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

                
{
  "exclude" : true,
  "disinheritDefault" : true,
  "disinherit" : [ 12345, 12345 ],
  "inheritable" : [ 12345, 12345 ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "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   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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTLICENSED",
    "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
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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "PERMISSION",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

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" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "responseMessage" : "...",
    "property" : "..."
  }
}