Community articleView/folder collection GET8.5.3 UP1
Added by IBM contributorIBM | Edited by IBM contributorDave Delay on March 14, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Gets information about the views and folders in a database.
Input
Method URI Description
GET /{database}/api/data/collections Gets information about the views and folders in a database.
Name Type Optional Description
database
string No Path name of a database on the server relative to the data directory.
Name Type Optional Description
compact
boolean Yes Controls compacting of the JSON output. Compacting removes extraneous white space.
Output
Content Type: application/json
Use the table below that represents the returned fields:
Name Type Optional Description
@title
string No Name of the view or folder.
@folder
boolean No false for a view, true for a folder.
@private
boolean No false for shared, true for private.
@modified
string No Last modification date and time for the view or folder.
@unid
string No Universal ID of the view or folder.
@href
string No The URL of the View/folder entries resource for the view or folder.
Code Description
200
OK. Indicates that the request was handled successfully.
Examples
This request gets information about the views and folders in XPagesExt.nsf
GET /XPagesExt.nsf/api/data/collections

Response returned by the server
[
  {
    "@private":false,
    "@unid":"45DF1A4D8B8C1027852578650065F565",
    "@title":"",
    "@modified":"2011-06-03T21:34:29Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/45DF1A4D8B8C1027852578650065F565",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"F598C2D31E4E12F68525786500660B7E",
    "@title":"TestCalendarOutline",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/F598C2D31E4E12F68525786500660B7E",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"22E1DD3B2AD793B08525786500660B8E",
    "@title":"TestCalendarName",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/22E1DD3B2AD793B08525786500660B8E",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"C256E4FBAD8B3BF28525786500660B9C",
    "@title":"AuthorCloud",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/C256E4FBAD8B3BF28525786500660B9C",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"D8A615CC990009E08525786500660BB7",
    "@title":"AllTypes",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/D8A615CC990009E08525786500660BB7",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"274ED25D4B0D693C8525786500660BC3",
    "@title":"AllThreadsByDate",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/274ED25D4B0D693C8525786500660BC3",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"DEEA0FD7275082C18525786500660BD0",
    "@title":"AllThreadsByAuthor",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/DEEA0FD7275082C18525786500660BD0",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"0D5D40CAD0399F598525786500660BDC",
    "@title":"AllThreads",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/0D5D40CAD0399F598525786500660BDC",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"0E127D68E89FC4818525786500660BE8",
    "@title":"AllStates",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/0E127D68E89FC4818525786500660BE8",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"B7F0FD3ACBBB165B8525786500660BF5",
    "@title":"AllNames",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/B7F0FD3ACBBB165B8525786500660BF5",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"0DE3FFC0DE40A6768525786500660C01",
    "@title":"AllMeetings",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/0DE3FFC0DE40A6768525786500660C01",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"55D2FAF525AF1CB98525786500660C0E",
    "@title":"AllEMails",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/55D2FAF525AF1CB98525786500660C0E",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"C5B675BD602A76068525786500660C1A",
    "@title":"AllContactsByState",
    "@modified":"2011-06-03T21:34:30Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/C5B675BD602A76068525786500660C1A",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"CD40A953ABDE036A8525786500660C27",
    "@title":"AllContacts",
    "@modified":"2011-06-21T15:31:12Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/CD40A953ABDE036A8525786500660C27",
    "@folder":false
  },
  {
    "@private":false,
    "@unid":"7B53FDDEE90C5E918525786500660E03",
    "@title":"Folder2",
    "@modified":"2011-06-03T21:34:31Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/7B53FDDEE90C5E918525786500660E03",
    "@folder":true
  },
  {
    "@private":false,
    "@unid":"A01D1A3F6BEAE5588525786500660E22",
    "@title":"Folder1",
    "@modified":"2011-06-03T21:34:31Z",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections\/unid\/A01D1A3F6BEAE5588525786500660E22",
    "@folder":true
  }
]