Community articleView/folder design GET8.5.3 UP1
Added by IBM contributorIBM on October 25, 2013
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Gets information on the columns in a view or folder.
Input
Method URI Description
GET /{database}/api/data/collections/unid/{unid}/design Gets information on the columns in a view or folder. Use this URI to read the information by view or folder UNID.
GET /{database}/api/data/collections/name/{name}/design Gets information on the columns in a view or folder. Use this URI to read the information by view or folder name.
Name Type Optional Description
database
string No Path name of a database on the server relative to the data directory.
unid
string No Universal ID of a view or folder in the database.
name
string No Name or alias of a view or folder in the database.
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
@columnnumber
int No Position of the column in the view or folder, where 1 is the first column.
@name
string No The name of the column.
@title
string No The title of the column.
@width
int No The width of the column.
@alignment
int No The alignment of the column.
@hidden
boolean No true if the column is hidden.
@response
boolean No true if the column is for responses.
@twistie
boolean No true if the column is a twistie.
@field
boolean No true if the column is a field.
@category
boolean No true if the column is a category.
Code Description
200
OK. Indicates that the request was handled successfully.
Examples
This request gets information on the columns in the AllContacts view in XPagesExt.nsf
GET /XPagesExt.nsf/api/data/collections/name/AllContacts/design

Response returned by the server
[
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":4,
    "@title":"#",
    "@field":false,
    "@hidden":false,
    "@name":"$0",
    "@category":false,
    "@columnNumber":1
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":10,
    "@title":"Id",
    "@field":true,
    "@hidden":false,
    "@name":"Id",
    "@category":false,
    "@columnNumber":2
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":10,
    "@title":"First Name",
    "@field":true,
    "@hidden":false,
    "@name":"FirstName",
    "@category":false,
    "@columnNumber":3
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":12,
    "@title":"Last Name",
    "@field":true,
    "@hidden":false,
    "@name":"LastName",
    "@category":false,
    "@columnNumber":4
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":16,
    "@title":"EMail",
    "@field":true,
    "@hidden":false,
    "@name":"EMail",
    "@category":false,
    "@columnNumber":5
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":10,
    "@title":"City",
    "@field":true,
    "@hidden":false,
    "@name":"City",
    "@category":false,
    "@columnNumber":6
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":14,
    "@title":"State",
    "@field":true,
    "@hidden":false,
    "@name":"State",
    "@category":false,
    "@columnNumber":7
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":14,
    "@title":"Created",
    "@field":false,
    "@hidden":false,
    "@name":"Created",
    "@category":false,
    "@columnNumber":8
  },
  {
    "@response":false,
    "@twistie":false,
    "@alignment":0,
    "@width":27,
    "@title":"Name",
    "@field":false,
    "@hidden":false,
    "@name":"$10",
    "@category":false,
    "@columnNumber":9
  }
]