NodeList Data Type

Model of a node list

Properties
name data type constraints description
items array of Node  
stagingStatus map of StagingStatus   Staging status of contained objects
messages array of Message   Messages contained in the response (which should be shown to the user)
hasMoreItems boolean required boolean True if more items are available to get (if paging was used)
responseInfo ResponseInfo  
numItems number required int Get total number of items available
perms map of array of Permission   User permissions on the returned items, if applicable and requested

Example

{
  "items" : [ {
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "folderId" : 12345,
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "publishDir" : "...",
    "edate" : 12345,
    "type" : "form",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "publishImageVariants" : true,
    "host" : "...",
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "hostProperty" : "...",
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "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,
    "inheritedFromName" : "...",
    "masterNodeId" : 12345,
    "urlRenderWayPages" : 12345,
    "urlRenderWayFiles" : 12345,
    "meshPreviewUrl" : "...",
    "meshPreviewUrlProperty" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "meshProjectName" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "FILENAME",
    "masterName" : "...",
    "contentRepositoryName" : "..."
  }, {
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "folderId" : 12345,
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "publishDir" : "...",
    "edate" : 12345,
    "type" : "folder",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "publishImageVariants" : true,
    "host" : "...",
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "hostProperty" : "...",
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "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,
    "inheritedFromName" : "...",
    "masterNodeId" : 12345,
    "urlRenderWayPages" : 12345,
    "urlRenderWayFiles" : 12345,
    "meshPreviewUrl" : "...",
    "meshPreviewUrlProperty" : "...",
    "insecurePreviewUrl" : true,
    "meshProject" : "...",
    "meshProjectName" : "...",
    "omitPageExtension" : true,
    "pageLanguageCode" : "PATH",
    "masterName" : "...",
    "contentRepositoryName" : "..."
  } ],
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "hasMoreItems" : true,
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "create", "createoverview" ],
    "property2" : [ "deleteitems", "userassignment" ]
  }
}