Getting the List of Excel Spreadsheets

Usage

Returns the Microsoft Excel spreadsheets stored in the CMS repository.

Request

GET /spreadsheets?offset=<offset>&limit=<limit>

Where:
  • <offset> indicates the position in the list, from which documents are returned. It must be greater than or equal to 0. The default value is 0. This parameter is optional.
  • <limit> indicates the number of documents in the list. Its range is [0, 50]. The default value is 10. This parameter is optional.
Response

Response type: application/xml or application/json

Response body: the list of spreadsheets. Each <spreadsheet> element has the following children:

  • <id>: identifier of the spreadsheet on the CMS repository
  • <cuid>: CUID of the spreadsheet on the CMS repository
  • <name>: name of the spreadsheet
  • <description>: description of the spreadsheet
  • <folderId>: identifier of the folder of the CMS repository that contains the spreadsheet

Example

XML response:
<spreadsheets>
    <spreadsheet>
        <id>6535</id>  
        <cuid>FljHNFCAVAMAzgUAAFD5eRsAAFBWoELQ</cuid>  
        <name>MySheet</name>  
        <description>one of my spreadsheets</description>  
        <folderId>6532</folderId> 
    </spreadsheet>  
    <spreadsheet> 
        <id>6641</id>  
        <cuid>AbbqtvKKLoBFjhvhSqb5S7w</cuid>  
        <name>MySheet2</name>  
        <folderId>6206</folderId> 
    </spreadsheet>  
    <spreadsheet> 
        <id>6541</id>  
        <cuid>FjdAO1D.igIAzgUAAFCJCBoAAFBWoELQ</cuid>  
        <name>MySheet3</name>  
        <description>one of my spreadsheets</description>  
        <folderId>6539</folderId> 
    </spreadsheet> 
</spreadsheets>

JSON response:

{"spreadsheets":
    {"spreadsheet":
        [{"id":6535,
          "cuid":"FljHNFCAVAMAzgUAAFD5eRsAAFBWoELQ",
          "name":"MySheet",
          "description":"one of my spreadsheets",
          "folderId":6532},
         {"id":6641,"cuid":"AbbqtvKKLoBFjhvhSqb5S7w",
          "name":"MySheet2",
          "folderId":6206},
         {"id":6541,
          "cuid":"FjdAO1D.igIAzgUAAFCJCBoAAFBWoELQ",
          "name":"MySheet3",
          "description":"one of my spreadsheets",
          "folderId":6539}]
    }
}