replyBrief Data Type

Minimal information about a Reply. 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 description
parent_entry longIdLinkPair element 0/1 The parent reply or folder entry.
top_entry longIdLinkPair element 0/1 The top level folder entry for this reply.
Properties inherited from baseFolderEntryBrief
doc_level int element 0/1  
doc_number string element 0/1  
file_name string element 0/unbounded  
total_reply_count int element 0/1  
Properties inherited from entryBrief
entry_type string element 0/1 The type of entry. Possible values are:
  • entry
  • reply
  • user
  • group
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

<reply_brief>
  <parent_entry>
    <id>...</id>
    <href>...</href>
  </parent_entry>
  <top_entry>
    <id>...</id>
    <href>...</href>
  </top_entry>
  <doc_level>...</doc_level>
  <doc_number>...</doc_number>
  <file_names>
    <file_name>...</file_name>
  </file_names>
  <total_reply_count>...</total_reply_count>
  <entry_type>...</entry_type>
</reply_brief>