Get iSheet Columns
OVERVIEW
API method to get column details of an iSheet
Request
GET isheets/${isheetid}/columns}
Parameters
Parameter Name |
Value |
Description |
---|---|---|
isheetid |
Int |
The ID of the iSheet for which the column details are to be obtained |
Response XML
The API method returns all of the iSheet columns with the exception of system generated columns.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<columns>
<column>
<title>SingleLine</title>
<type>Single Line Text</type>
<mandatory>false</mandatory>
<columnID>12</columnID>
<column>
<title>NumberCol</title>
<type>Number</type>
<mandatory>false</mandatory>
<columnID>16</columnID>
</column>
<column>
<title>DateTimeCol</title>
<type>Date and Time</type>
<mandatory>false</mandatory>
<columnID>17</columnID>
</column>
</columns>
Permissions
This API method is available to the site admin , content admin and internal admin.
Bob Shaeffer - try Get columns. This is the old iSheet API
What is the proper format for this command? GET isheets/${isheetid}/columns} is not correct.
Nevermind...I found it "{{hostname}}/api/{{apiversion}}/isheets/admin/{{isheetid}}/columns"
If a column is of type 'Choice', is there an API call to get the available choices?
Andrew Quinn as part of Collaborate 4.2 iSheet API is being completely redone, the existing iSheets API was built to support one of our integrations and it was never built for the clients and partners to use it, but due to high demand, we had to expose it out. The existing API lacks a lot of capabilities which we plan to address in the Collaborate 4.2 release. Thank you for your feedback Andrew, I will make sure that the permissions follow the same rule as in Collaborate web-based interface and Martin Dentith we plan to develop methods to get a list of iSheets for a site and individual iSheet structure using the API.
Please let me know if you would like to discuss your specific use case requirements with me, as it will really help us to make sure that we cover all required methods in our new iSheets API.
Imran Aziz, Stuart Barr Why is this an admin-only ability? This would be extremely useful for code (running under an impersonated user). If the user has access to the iSheet, then they should be able to call this method. Can we please (pretty please) make this based on iSheet permissions, and not just admins. We don't use magic numbers here because we have both a UAT instance and a production instance so Column ID's are different. So to be able to ascertain Column ID (by Title) at runtime is incredibly important.
Hi Any chance you are developing a method that will export iSheet Name and view (and the columns and column information for that iSheet name and view grouped accordingly) exportable as an XML? The two examples you have got (Get iSheet Details, Ste iSheet columns) come close to what I am looking for but I am looking for the above specific requiremen preferably. Many thanks
Comments
7 Comments