definableEntityBrief Data Type

Base class for BinderBrief, FolderEntryBrief, ReplyBrief, UserBrief and GroupBrief objects. Brief objects are typically returned in list results because they are more efficient to build than their full counterparts.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
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 permalinks  
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 Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<d----->
  <permalinks>
    <permalink>
      <href>...</href>
      <rel>...</rel>
    </permalink>
  </permalinks>
  <creation>
    <principal>
      <id>...</id>
      <href>...</href>
    </principal>
    <date>...</date>
  </creation>
  <entity_type>...</entity_type>
  <id>...</id>
  <modification>
    <principal>
      <id>...</id>
      <href>...</href>
    </principal>
    <date>...</date>
  </modification>
  <parent_binder>
    <path>...</path>
    <id>...</id>
    <href>...</href>
  </parent_binder>
  <title>...</title>
  <description>
    <text>...</text>
    <format_str>...</format_str>
  </description>
  <permalink>...</permalink>
  <doc_type>...</doc_type>
  <href>...</href>
  <links>
    <link/>
  </links>
</d----->