iSheets API version 2 - iSheet admin - API - iSheet CRUD operations - List of iSheets
OVERVIEW
Method to get a list of iSheets in a site. This method includes the iSheet structure as seen in the iSheet admin interface. Please note that this method is only available to site and content admins.
Request URI
GET /api/3/isheets/admin?siteid={siteid}
Request Parameters
Parameter Name | Parameter Value | Description |
---|---|---|
siteid | A numeric value representing the site ID | The ID of the site for which the iSheets are to be obtained. |
type |
String |
Type parameter is not mandatory. Blank or Null will return all iSheets including metadata iSheets. |
Response Body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<isheets>
{List of iSheet Objects}
</isheets>
Andrew Quinn sure will follow up on these improvements.
Hi Imran Aziz, can I request an enhancement for alternative end-points:
- GET /api/3/isheets/admin/{isheetid}
- GET /api/3/isheets/admin?list={csv of isheetid}
Reason being that when developing solutions, sometimes you may not have what site a sheet belongs to, in which case the only way you can get iSheet details is to get all sites in the instance, then get all iSheets in these sites (using List of iSheets) until the iSheet (id) is found.
For the second end-point, providing a list of iSheets allows for more succinct and better performant API calls (server and client). This would allow retrieving multiple iSheets (potentially across sites), but also List of iSheets returns all iSheets details of that site, even if you are only after one or two specific iSheets.
I've also requested an enhancement in iSheet Objects which is related to these enhancements, the addition of site id as a property to the iSheet object, so that sites can be determined from iSheet objects retrieved.
Thanks, Andrew
Andrew Quinn makes sense and thanks for explaining the use case. I have added your request to our backlog
Hi Imran, can we have a version of this API call for non-admin callers? Use case would be a site Home dashboard in Collaborate that uses the API's to auto-discover iSheets available for the current user. This could be useful for a dashboard that only displays panels/data if the user has access to the iSheet. Also in our case, we have two instances, UAT and Production, so having the ability to auto-discover means we don't have to have magic numbers (iSheet/Views ID's) in the code we produce. Thanks in advance.
Comments
4 Comments