Community articleDatabase 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 databases on a Domino® server.
Input
Method URI Description
GET /api/data Gets information about the databases on a Domino® server.
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 Title of the database.
@filepath
string No File path of the database relative to the Domino data directory.
@replicaid
string No Replica ID of the database.
@template
string No File name of the design template of the database, or an empty string if the database does not have a design template.
@href
string No The URL of the View/folder collection resource for the database.
Code Description
200
OK. Indicates that the request was handled successfully.
Examples
This request gets the list of databases on the server
GET /api/data

Response returned by the server
[
  {
    "@filepath":"admin4.nsf",
    "@replicaid":"8525786A034D582B",
    "@title":"Administration Requests",
    "@template":"StdR4AdminRequests",
    "@href":"\/admin4.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"AgentRunner.nsf",
    "@replicaid":"8525671400725208",
    "@title":"Java AgentRunner",
    "@template":"",
    "@href":"\/AgentRunner.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"Article.nsf",
    "@replicaid":"8525784E00618FED",
    "@title":"Article",
    "@template":"",
    "@href":"\/Article.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"catalog.nsf",
    "@replicaid":"8525786A076BF7BB",
    "@title":"Catalog (8)",
    "@template":"StdNotesCatalog",
    "@href":"\/catalog.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"certlog.nsf",
    "@replicaid":"8525786A004D5677",
    "@title":"ibm's Certification Log",
    "@template":"StdNotesCertificationLog",
    "@href":"\/certlog.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"certsrv.nsf",
    "@replicaid":"8525786A004D6F83",
    "@title":"Server Certificate Admin",
    "@template":"StdNotes50SSLAdmin",
    "@href":"\/certsrv.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"ddm.nsf",
    "@replicaid":"8525786A0A6BF7BB",
    "@title":"Domino Domain Monitor (8)",
    "@template":"StdDomainMonitor",
    "@href":"\/ddm.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"DDSTest.nsf",
    "@replicaid":"852578B500699C4E",
    "@title":"DDS Test",
    "@template":"",
    "@href":"\/DDSTest.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"doladmin.nsf",
    "@replicaid":"8525786A004D6744",
    "@title":"Offline Services",
    "@template":"DOLS Admin 1.0",
    "@href":"\/doladmin.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"events4.nsf",
    "@replicaid":"8525786A024D582B",
    "@title":"Monitoring Configuration",
    "@template":"StdR4Events",
    "@href":"\/events4.nsf\/api\/data\/collections"
  },
  {
    "@filepath":"XPagesExt.nsf",
    "@replicaid":"852578A40076834F",
    "@title":"XPages Extension Library Demo",
    "@template":"",
    "@href":"\/XPagesExt.nsf\/api\/data\/collections"
  }
]