iSheets API version 2 - Common objects - iSheet record/item - common object - Get
iSheets API version 2 - Common objects - iSheet record/item - common object - Get
OVERVIEW
The iSheet record/item object consists of the following elements
<isheet recordcount="100" totalrecordcount="1124">
<metadata>
<sitename siteid="13"><![CDATA[Test site]]></sitename>
<sheetname sheetid="1018"><![CDATA[Test iSheet]]></sheetname>
<viewname viewid="1040"><![CDATA[Default view]]></viewname>
</metadata>
<head>
<headcolumn sequence="1" columntypealias="SHEET_COLUMN_TYPE_SINGLE_LINE_TEXT" columntypeid="1" columnid="1133">
<columnvalue><![CDATA[single line - field title]]></columnvalue>
</headcolumn>
<headcolumn sequence="6" columntypealias="SHEET_COLUMN_TYPE_MULTIPLE_LINE_TEXT" columntypeid="2" columnid="1134">
<columnvalue><![CDATA[Multiline text (textarea)]]></columnvalue>
</headcolumn>
.
.
<!-- advance lookup type column (we can differentiate by "parentcolumnid" attribute in this headcolumn tag
<headcolumn sequence="27" columntypealias="SHEET_COLUMN_TYPE_SINGLE_LINE_TEXT" columnid="1149" parentcolumnid="1240" columntypeid="1">
<columnvalue><![CDATA[iSheet lookup (with all types of column isheet [template] ):single line]]></columnvalue>
</headcolumn>
</head>
<data>
<item itemsequence="1" itemid="1076" externalid="3">
<!-- user lookup type column -->
<column sequence="1" attributecolumnid="1129">
<rawdata>
<lookups>
<lookup>
<id><![CDATA[110]]></id>
<email><![CDATA[test.user1@test.com]]></email>
</lookup>
<lookup>
<id><![CDATA[111]]></id>
<email><![CDATA[test.user1@test.com]]></email>
</lookup>
</lookups>
</rawdata>
<displaydata>
<lookupusers>
<lookupuser>
<userdisplayname><![CDATA[Test User1]]></userdisplayname>
<orgname><![CDATA[Test]]></orgname>
<email><![CDATA[test.user1@test.com]]></email>
<httpurl>{http link for user's profile page}</httpurl>
<apiurl>{api link for user's profile page}</apiurl>
</lookupuser>
<lookupuser>
<userdisplayname><![CDATA[Test User2]]></userdisplayname>
<orgname><![CDATA[Test]]></orgname>
<email><![CDATA[test.user2@test.com]]></email>
<httpurl>{http link for user's profile page}</httpurl>
<apiurl>{api link for user's profile page}</apiurl>
</lookupuser>
</lookupusers>
</displaydata>
</column>
<!-- date and time column type -->
<column sequence="2" attributecolumnid="1130">
<rawdata>
<date><![CDATA[15.11.2017]]></date>
<time><![CDATA[11:14]]></time>
</rawdata>
<displaydata>
<value>
<![CDATA[09 Oct 2017 14:20]]>
</value>
</displaydata>
</column>
<!-- single line column type -->
<column sequence="5" attributecolumnid="1133">
<rawdata>
<value>
<![CDATA[name as defautl value]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[name as defautl value]]>
</value>
</displaydata>
</column>
<!-- multiple line column type -->
<column sequence="6" attributecolumnid="1134">
<rawdata>
<value>
<![CDATA[default value]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[default value]]>
</value>
</displaydata>
</column>
<!-- choice type column -->
<column sequence="8" attributecolumnid="1136">
<rawdata>
<choices>
<choice style="color:#FF0000">
<label><![CDATA[Option 1]]></label>
</choice>
<choice style="color:#FF0000">
<label><![CDATA[Option 2]]></label>
</choice>
</choices>
</rawdata>
<displaydata>
<choices>
<choice style="color:#FF0000">
<id>1</id>
<label><![CDATA[Option 1]]></label>
</choice>
<choice style="color:#FF0000">
<id>2</id>
<label><![CDATA[Option 2]]></label>
</choice>
</choices>
</displaydata>
</column>
<!-- number type column -->
<column sequence="11" attributecolumnid="1139">
<rawdata>
<value>
<![CDATA[10.00000000]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[10 %]]>
</value>
</displaydata>
</column>
<!-- hyperlink type column -->
<column sequence="15" attributecolumnid="1143">
<rawdata>
<linkdisplayname><![CDATA[google.com]]></linkdisplayname>
<linkdisplayurl><![CDATA[http://www.google.com]]></linkdisplayurl>
</rawdata>
<displaydata>
<linkdisplayname><![CDATA[google.com]]></linkdisplayname>
<linkdisplayurl><![CDATA[http://www.google.com]]></linkdisplayurl>
</displaydata>
</column>
<!-- image type column (as attachment) -->
<column sequence="16" attributecolumnid="1144">
<rawdata>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
</rawdata>
<displaydata>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
</displaydata>
</column>
<!-- image type column (as URL) -->
<column sequence="17" attributecolumnid="1145">
<rawdata>
<value>
<![CDATA[https://www.google.co.in/url?sa=i&rct=j&q=&esrc=s&source=images&cd=&cad=rja&uact=8&ved=0ahUKEwjX06Ls3ePWAhUWSY8KHXzDBYkQjRwIBw&url=https%3A%2F%2Fwww.pexels.com%2Fsearch%2Fnature%2F&psig=AOvVaw1vf-r36jaC7O-X0nRm2Sc0&ust=1507645110946954]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[https://www.google.co.in/url?sa=i&rct=j&q=&esrc=s&source=images&cd=&cad=rja&uact=8&ved=0ahUKEwjX06Ls3ePWAhUWSY8KHXzDBYkQjRwIBw&url=https%3A%2F%2Fwww.pexels.com%2Fsearch%2Fnature%2F&psig=AOvVaw1vf-r36jaC7O-X0nRm2Sc0&ust=1507645110946954]]>
</value>
</displaydata>
</column>
<!-- external attachment type column -->
<column sequence="18" attributecolumnid="1146">
<rawdata>
<attachments>
<attachment>
<id>{isheet item attachment id}</id>
<attachmentname><![CDATA[attachment1]]></attachmentname>
<attachmentextension><![CDATA[png]]></attachmentextension>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
<!-- we have no any redirection for isheet item attachment so we have no http link for now -->
</attachment>
<attachment>
<id>{isheet item attachment id}</id>
<attachmentname><![CDATA[attachment2]]></attachmentname>
<attachmentextension><![CDATA[png]]></attachmentextension>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
<!-- we have no any redirection for isheet item attachment so we have no http link for now -->
</attachment>
</attachments>
</rawdata>
<displaydata>
<attachments>
<attachment>
<id>{isheet item attachment id}</id>
<attachmentname><![CDATA[attachment1]]></attachmentname>
<attachmentextension><![CDATA[png]]></attachmentextension>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
<!-- we have no any redirection for isheet item attachment so we have no http link for now -->
</attachment>
<attachment>
<id>{isheet item attachment id}</id>
<attachmentname><![CDATA[attachment2]]></attachmentname>
<attachmentextension><![CDATA[png]]></attachmentextension>
<apiurl>http://vijay.local.com/vijay_3_4/api/3/isheet/item/attachment?siteID={siteID}&sheetId={sheetId}&itemId={itemId}&columnID={columnID}&attachmentID={attachmentID}</apiurl>
<!-- we have no any redirection for isheet item attachment so we have no http link for now -->
</attachment>
</attachments>
</displaydata>
</column>
<!-- document link type column -->
<column sequence="19" attributecolumnid="1147">
<rawdata>
<documents>
<document>
<docid>{document id}</docid>
<docname><![CDATA[site_admin_v4_redesign_estimation]]></docname>
<docextension><![CDATA[txt]]></docextension>
<docindex><![CDATA[2]]></docindex>
<httplink></httplink>
<apilink></apilink>
</document>
<document>
<docid>{document id}</docid>
<docname><![CDATA[Word_file]]></docname>
<docextension><![CDATA[docx]]></docextension>
<docindex><![CDATA[3]]></docindex>
<httplink></httplink>
<apilink></apilink>
</document>
</documents>
</rawdata>
<displaydata>
<documents>
<document>
<docid>{document id}</docid>
<docname><![CDATA[site_admin_v4_redesign_estimation]]></docname>
<docextension><![CDATA[txt]]></docextension>
<docindex><![CDATA[2]]></docindex>
<httplink></httplink>
<apilink></apilink>
</document>
<document>
<docid>{document id}</docid>
<docname><![CDATA[Word_file]]></docname>
<docextension><![CDATA[docx]]></docextension>
<docindex><![CDATA[3]]></docindex>
<httplink></httplink>
<apilink></apilink>
</document>
</documents>
</displaydata>
</column>
<!-- folder link type column -->
<column sequence="20" attributecolumnid="1148">
<rawdata>
<folders>
<folder>
<folderid>{folder's id}</folderid>
<foldername><![CDATA[site folder]]></foldername>
<folderindex/>
<folderpath><![CDATA[/]]></folderpath>
<httplink>{http link of this folder location}</httplink>
</folder>
<folder>
<folderid>{folder's id}</folderid>
<foldername><![CDATA[Test folder]]></foldername>
<folderIndex><![CDATA[1]]></folderIndex>
<folderpath><![CDATA[/Test folder]]></folderpath>
<httplink>{http link of this folder location}</httplink>
</folder>
</folders>
</rawdata>
<displaydata>
<folders>
<folder>
<folderid>{folder's id}</folderid>
<foldername><![CDATA[site folder]]></foldername>
<folderindex/>
<folderpath><![CDATA[/]]></folderpath>
<httplink>{http link of this folder location}</httplink>
</folder>
<folder>
<folderid>{folder's id}</folderid>
<foldername><![CDATA[Test folder]]></foldername>
<folderIndex><![CDATA[1]]></folderIndex>
<folderpath><![CDATA[/Test folder]]></folderpath>
<httplink>{http link of this folder location}</httplink>
</folder>
</folders>
</displaydata>
</column>
<!-- isheet link type column -->
<column sequence="21" attributecolumnid="1149">
<rawdata>
<isheetitems>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
</isheetitem>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
</isheetitem>
</isheetitems>
</rawdata>
<displaydata>
<isheetitems>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
</isheetitem>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
</isheetitem>
</isheetitems>
</displaydata>
</column>
<!-- Lookup type column -->
<column sequence="21" attributecolumnid="1149" parentcolumnid="1240">
<rawdata>
<isheetitems>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
</isheetitems>
</rawdata>
<displaydata>
<isheetitems>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
<isheetitem>
<recordid>{isheet record id}</recordid>
<linkname><![CDATA[isheet link - default value]]></linkname>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
</isheetitems>
</displaydata>
</column>
<!-- join type column -->
<column sequence="24" attributecolumnid="1153">
<rawdata>
<isheetitem>
<linkname><![CDATA[link name - as fixed]]></linkname>
<recordid></recordid>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
</rawdata>
<displaydata>
<isheetitem>
<linkname><![CDATA[link name - as fixed]]></linkname>
<recordid></recordid>
<apilink></apilink>
<httplink></httplink>
</isheetitem>
</displaydata>
</column>
<!-- calculate type column -->
<column sequence="25" attributecolumnid="1154">
<rawdata>
<value>
<![CDATA[50.00000000]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[50 %]]>
</value>
</displaydata>
</column>
<!-- Auto increment type column -->
<column sequence="26" attributecolumnid="1155">
<rawdata>
<value>
<![CDATA[PR00010SF]]>
</value>
</rawdata>
<displaydata>
<value>
<![CDATA[PR00010SF]]>
</value>
</displaydata>
</column>
</item>
<item itemsequence="2" itemid="1077" externalid="4">
.
.
.
</item>
<item itemsequence="3" itemid="1078" externalid="4">
.
.
.
</item>
</data>
</isheet>
Note : We can differentiate the lookup type column with the use of attribute 'parentcolumnid' in 'headcolumn' tag and in 'column' tag
Hi Imran Aziz when a request is made to a choice column that has an image (That is uploaded to highq) attached to the choice value it would be great if a link to said image came with the request.
Andrew Quinn thank you again for raising the issue, I will raise an internal bug report for this issue.
Hi Imran Aziz, there is a small bug in this endpoint regarding the data returned for a folder link type column. The folder name has the same value as the folder path. Example response received below. Thanks in advance, Andrew
{
"sequence": "2",
"attributecolumnid": "99999",
"displaydata": {
"folders": {
"folder": {
"folderindex": "1.1",
"folderpath": "/Test/Test Sub #1",
"foldername": "/Test/Test Sub #1",
"folderid": "999",
"httplink": "https://******.highq.com/******/documentHome.action?metaData.siteID=999999&metaData.parentFolderID=999"
}
}
},
"rawdata": {
"folders": {
"folder": {
"folderindex": "1.1",
"folderpath": "/Test/Test Sub #1",
"foldername": "/Test/Test Sub #1",
"folderid": "999",
"httplink": "https://******.highq.com/******/documentHome.action?metaData.siteID=999999&metaData.parentFolderID=999"
}
}
}
}
Thank you
Your review has been submitted.
Comments
3 Comments