SharedFolderEntryBrief Data Type

User: david Date: 7/25/12 Time: 2:00 PM

Properties
name data type description
shares array of Share
Properties inherited from FolderEntryBrief
primary_file FileBrief Information about the primary file associated with this entry.
Properties inherited from BaseFolderEntryBrief
doc_level number
doc_number string
file_names array of string
total_reply_count number
Properties inherited from EntryBrief
entry_type string The type of entry. Possible values are:
  • entry
  • reply
  • user
  • group
Properties inherited from DefinableEntityBrief
permalinks array of Link
creation HistoryStamp Date and time that the entity was created and the user who created it.
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.
title string The title or displayable name of the entity.
description Description Description of the entity. For replies, this is the text of the comment.
permalink string A URL in the web application for this 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

{
  "shares" : [ {
    "permalinks" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "comment" : "...",
    "sharer" : {
      "id" : 12345,
      "href" : "..."
    },
    "sharing_date" : 12345,
    "days_to_expire" : 12345,
    "expiration" : 12345,
    "id" : 12345,
    "recipient" : {
      "email" : "...",
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "shared_entity" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "access" : {
      "role" : "...",
      "sharing" : { },
      "href" : "...",
      "links" : [ { }, { } ]
    },
    "href" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ]
  }, {
    "permalinks" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "comment" : "...",
    "sharer" : {
      "id" : 12345,
      "href" : "..."
    },
    "sharing_date" : 12345,
    "days_to_expire" : 12345,
    "expiration" : 12345,
    "id" : 12345,
    "recipient" : {
      "email" : "...",
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "shared_entity" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "access" : {
      "role" : "...",
      "sharing" : { },
      "href" : "...",
      "links" : [ { }, { } ]
    },
    "href" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ]
  } ],
  "primary_file" : {
    "id" : "...",
    "name" : "...",
    "version" : 12345,
    "length" : 12345,
    "md5" : "...",
    "mod_date" : 12345,
    "href" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ]
  },
  "doc_level" : 12345,
  "doc_number" : "...",
  "file_names" : [ "...", "..." ],
  "total_reply_count" : 12345,
  "entry_type" : "...",
  "permalinks" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ],
  "creation" : {
    "principal" : {
      "id" : 12345,
      "href" : "..."
    },
    "date" : 12345
  },
  "entity_type" : "...",
  "id" : 12345,
  "modification" : {
    "principal" : {
      "id" : 12345,
      "href" : "..."
    },
    "date" : 12345
  },
  "parent_binder" : {
    "path" : "...",
    "id" : 12345,
    "href" : "..."
  },
  "title" : "...",
  "description" : {
    "text" : "...",
    "format_str" : "..."
  },
  "permalink" : "...",
  "doc_type" : "...",
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}