Folder Data Type

Folder metadata.

Properties
name data type description
library boolean
mirrored boolean
Properties inherited from Binder
path string The absolute path of the Binder.
library_info LibraryInfo Library information about the binder.
Properties inherited from DefinableEntity
permalinks array of Link
creation HistoryStamp Date and time that the entity was created and the user who created it.
description Description Description of the entity. For replies, this is the text of the comment.
entity_type string A string identifying the type of this entity. Possible values are user, group, folder, workspace and folderEntry.
id number An ID for the entity. This is guaranteed to be unique for each entity type, but not necessarily unique among all entities.

For example, there will only be 1 user with an ID of 12, but there might also be a folder with an ID of 12.

modification HistoryStamp The date and time when the entity was last modified and the user who modified it.
parent_binder ParentBinder Information about the binder where this entity resides.
permalink string A URL in the web application for this entity.
title string The title or displayable name of the entity.
Properties inherited from SearchableObject
doc_type string The indexed document type. Possible values are:
  • entry (folder entries, replies, users and groups)
  • binder (workspaces and folders)
  • file
Properties inherited from BaseRestObject
href string The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
links array of Link Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

{
  "library" : true,
  "mirrored" : true,
  "path" : "...",
  "library_info" : {
    "mod_date" : 12345,
    "disk_space" : 12345,
    "file_count" : 12345,
    "folder_count" : 12345,
    "mirrored_sync_date" : 12345,
    "mirrored" : true
  },
  "permalinks" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ],
  "creation" : {
    "principal" : {
      "id" : 12345,
      "href" : "..."
    },
    "date" : 12345
  },
  "description" : {
    "text" : "...",
    "format_str" : "..."
  },
  "entity_type" : "...",
  "id" : 12345,
  "modification" : {
    "principal" : {
      "id" : 12345,
      "href" : "..."
    },
    "date" : 12345
  },
  "parent_binder" : {
    "path" : "...",
    "id" : 12345,
    "href" : "..."
  },
  "permalink" : "...",
  "title" : "...",
  "doc_type" : "...",
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}