Get iSheet details
Get iSheet details
OVERVIEW
Gets a list of iSheets given a site ID. Specific type of iSheets e.g file metadata iSheet can be obtained by providing the type parameter.
Request
Get /isheets?siteid=${siteid}&type=${type}
Parameters
| Parameter Name | Value | Description |
|---|---|---|
| siteid | Int | The ID of the site for which the iSheets are to be obtained |
| type | string | Parameter to specify the type of iSheet to be obtained. The possible values are documentmetadata / foldermetadata / normal |
Response
If the authenticated user has access to the iSheets module for the specific site then this method call will return the iSheets in the site.
Response XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<isheets>
<isheet>
<name>SharePoint_Sheet</name>
<id> {Integer value of the }</id>
<type>{text value of one of the supported types}</type>
</isheet>
</isheets>
Peter Harris, if you haven't already done so, I would raise this with your TR Support Team. If you look at the comments above, I had the same issue a while back, and required the support team to fix.
when I call this method /isheets?siteid=${siteid} from our test server via https I recieve a 403 Forbidden error (whereas when I run the project using localhost it works) - i have tried /api/2 and /api/3 with no improvement. Also I can succesfully use the Get Sites and Get Isheet Column API methods on the server, its just this method that appears to be forbidden
Are there plans to deprecate this endpoint (and iSheets v1 in general) at some point in the future? The fact that this endpoint doesn't require admin privileges, unlike the replacement in iSheets v2, is helpful.
Andrew Quinn I have been told by the Support team that the configuration has been sorted out for you. Please try out your call now.
Andrew Quinn I think there is an issue with API Configuration for your instance, so I have raised a support request for it. The Support team will follow up and come back to you on it.
Why when calling this API method do I get a 403 with a response body of:
Validation failed/ Forbidden
Isheet synchronization is not enable at site
Other API (non-iSheet) calls return successfully, so it's not the authorisation token, and I'm performing as myself (System Admin) so no impersonation security. The endpoint I use is:
- ./api/1/isheets?siteid=nnn&type=normal
where nnn is my site ID.
Thanks
Thank you
Your review has been submitted.
Comments
6 Comments