binderBrief Data Type

Minimal information about a binder. BinderBrief objects are typically returned in list results because they are more efficient to build than full Binder objects.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
home_dir boolean element 0/1 Whether this folder represents a user's home directory on an external file server.
library boolean element 0/1 Whether this is library binder. Library folders require that all of the files in the folder have unique file names.
library_info libraryInfo element 0/1 Library information about the binder.
mirrored boolean element 0/1 Whether this is a mirrored binder. These are folders that are synced with an external source such as a file server.
path string element 0/1  
Properties inherited from definableEntityBrief
creation historyStamp element 0/1 Date and time that the entity was created and the user who created it.
description description element 0/1 Description of the entity. For replies, this is the text of the comment.
entity_type string element 0/1 A string identifying the type of this entity. Possible values are user, group, folder, workspace and folderEntry.
id long element 0/1 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 element 0/1 The date and time when the entity was last modified and the user who modified it.
parent_binder parentBinder element 0/1 Information about the binder where this entity resides.
permalink link element 0/unbounded  
permalink string element 0/1 A URL in the web application for this entity.
title string element 0/1 The title or displayable name of the entity.
Properties inherited from searchableObject
doc_type string element 0/1 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 element 0/1 The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<binder_brief>
  <library>...</library>
  <mirrored>...</mirrored>
  <home_dir>...</home_dir>
  <path>...</path>
  <library_info>
    <mod_date>...</mod_date>
    <disk_space>...</disk_space>
    <file_count>...</file_count>
    <folder_count>...</folder_count>
    <mirrored_sync_date>...</mirrored_sync_date>
    <mirrored>...</mirrored>
  </library_info>
  <permalinks>
    <permalink>
      <href>...</href>
      <rel>...</rel>
    </permalink>
  </permalinks>
  <creation>
    <principal/>
    <date>...</date>
  </creation>
  <entity_type>...</entity_type>
  <id>...</id>
  <modification>
    <principal/>
    <date>...</date>
  </modification>
  <parent_binder>
    <path>...</path>
  </parent_binder>
  <title>...</title>
  <description>
    <text>...</text>
    <format_str>...</format_str>
  </description>
  <permalink>...</permalink>
  <doc_type>...</doc_type>
</binder_brief>