Getting the Details of an Excel Spreadsheet

Returns the details of a Microsoft Excel spreadsheet stored on the CMS repository.

Request

GET <webi_URL>/spreadsheets/{spreadsheetId}

Where:
  • {spreadsheetId} is the spreadsheet identifier retrieved from the list of spreadsheets.
Response

Response type: application/xml or application/json

Response body: the details of the spreadsheet with the following information:

  • <id>: spreadsheet identifier
  • <cuid>: CUID of the spreadsheet
  • <name>: name of the spreadsheet
  • <folderId>: identifier of the folder of the CMS repository that contains the spreadsheet
  • <path>: path to the spreadsheet in the CMS repository directory
  • <updated>: date of last update
  • <createdBy>: name of spreadsheet creator
  • <file>: name of the Excel file
  • <size>: size of the spreadsheet in bytes
  • <mimeType>: mime type (application/vnd.ms-excel for Microsoft Excel 2003 or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for Microsoft Excel 2007)
  • <sheet>: name of the sheet contained in the spreadsheet
  • <range>: name of a named cell range in the spreadsheet

Example

XML response:

<spreadsheet> 
    <id>7168</id>  
    <cuid>AQJqfTLbR5RNoYhzV9DnCMA</cuid>  
    <name>MySheet</name>  
    <folderId>6206</folderId>  
    <path>Public Folders/Documents/</path>  
    <updated>2014-07-17T14:27:44.367+02:00</updated>  
    <createdBy>Administrator</createdBy>
    <file>myfile.xlsx</file>  
    <size>22444</size>  
    <mimeType>application/vnd.ms-excel</mimeType>  
    <sheets> 
        <sheet>sheet1</sheet>  
        <sheet>sheet2</sheet>  
        <sheet>sheet3</sheet>  
        <sheet>sheet4</sheet> 
    </sheets>
    <namedRanges> 
        <range>items</range>  
        <range>region</range>  
        <range>region_item_units_cost</range>  
        <range>sum_cost</range>  
        <range>sum_units</range> 
    </namedRanges> 
</spreadsheet>

JSON response:

{"spreadsheet":
    {"id":7168,
     "cuid":"AQJqfTLbR5RNoYhzV9DnCMA",
     "name":"MySheet",
     "folderId":6206,
     "path":"Public Folders\/Documents\/",
     "updated":"2014-07-17T10:34:19.763+02:00",
     "createdBy":"Administrator",
     "file":"myfile.xlsx",
     "size":22444,
     "mimeType":"application\/vnd.ms-excel",
     "sheets":
         [{"sheet":"sheet1"},
          {"sheet":"sheet2"},
          {"sheet":"sheet3"},
          {"sheet":"sheet4"}],
     "namedRanges":
         [{"range":"items"},
          {"range":"region"},
          {"range":"region_item_units_cost"},
          {"range":"sum_costs"},
          {"range":"sum_units"}]
    }
}