Create record in iSheet
Create record in iSheet
OVERVIEW
This method is used to update metadata records for a file metadata isheet, and it consists of three steps.
1) Upload file using the files API. Please note that when a file is added to a site which has file metadata isheet enabled, a isheet record is automatically created for the the uploaded file. You can then call the below method to obtain the isheet record ID.
2) Call the isheetRecordID to obtain the isheet record which is to be updated.
files/${fileid}/isheetRecordID
3) To insert a record into iSheet
4) Please note that the attachments cannot be added to an attachments column using this method. Functionality to add an attachment to the iSheets attachment column is not supported by the HighQ API at this time.
5) iSheets link column is also not supported through the API at this time.
Request
POST /isheet/item/create
Request XML
The request XML requires siteid, and sheetid parameters to determine the iSheet to which the records will be added.
In order to add the records to the correct columns a column and value mapping is provided, which is associated with a sequence parameter.
the headColumn defines the names of the columns to which the content will be added and raw data defines the values for those columns.
In addition to the OAuth parameters please use Content-Type of text/xml in the request headers.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sheet>
<metaData>
<siteid><![CDATA[ replace with integer id of the site]]></siteid>
<sheetid><![CDATA[ replace with integer id of the sheet]]></sheetid>
</metaData>
<head>
<headColumn sequence="0">
<columnValue><![CDATA[Provide the name of the column]]></columnValue>
</headColumn>
<headColumn sequence="1">
<columnValue><![CDATA[Provide the name of the column]]></columnValue>
</headColumn>
</head>
<data>
<item externalID="3">
<column sequence="0">
<rawData>
<text><![CDATA[value of this column]]></text>
</rawData>
</column>
<column sequence="1">
<rawData>
<text><![CDATA[44value of this column]]></text>
</rawData>
</column>
</item>
</data>
</sheet>
Parameters
|
Parameter Name |
Value |
Description |
|---|---|---|
|
siteid |
Int |
The ID of the site in which the iSheet exists |
| sheetid | int | The isheet ID to which the records are to be added |
| headcolumn | string | The name of the columns to which a value is to be added |
| sequence | int | A number represending the sequence of the column in the iSheet |
| externalID | int | Item ID of the item from the external system. This saves the external itemID of the item in the system, this should be used later on to execute the delete operation |
The following iSheet column types are supported at this time
- Single Line Text
- Multiple Line Text
- Choice
- Number
- Date and Time
In order to send html content in text fields please use the following syntax:
- For break line use the following syntax snipat:* <text><![CDATA[<br>br tag </br>]]></text>
- For anchor href link use the syntax snipat:* <text><![CDATA<a href="#>anchor tag</a>]></text>
- For Heading use the syntax snipat:* <text><![CDATA[<h1>h tag</h1>]]></text>
- For label use below syntax snipat: <text><![CDATA[<label width="30%">label tag </label>]]></text>
- Please note that the edit operation should use the externalID parameter to update the records. We have made amends to the documentation and taken out the need to provide iSheet itemID, that is not required and only externalID can be used to add and update iSheet records.
What are the three steps you are mentioning out of the 5 steps described? And what is the point of "2) Call the isheetRecordID to obtain the isheet record which is to be updated"? The iSheetRecordId is not used in the XML-post example? So confusing.
Dan Hey for clarity the API changes are coming in Collaborate 4.3 and we will be releasing the new API documentation close to the release of Collaborate 4.3
Hello Imran, is there any new documentation for the 4.2 API? Can we update an iSheet row using the API?
Fernando Deleon as pointed out in the documentation iSheets API is a legacy API, and at the moment we have made it available as it is. We plan to address such issues in the new iSheets API, which is scheduled to release in Collaborate 4.2
Hi,
The create API call seems to only work when you are an admin of some sort.
If you are not an admin, you get a 403 access denied.
This seems to be weird because when i proxy in as that non admin user, I can add meta data to a file with no problems (ie updating the isheet).
So that negates any permission issues.
Is this a known problem?
Thanks
Fernando
all good it works now ;)
Fernando Deleon please use our support system to raise the issue, as the technical support team will have to look into this issue for you.
Hi thanks for the ticket, I do get a bit further now. However, given the same post above i simply get back
Fernando Deleon our support team will enable this configuration for you, I have forward your request to them, you can track the ticket in our support system. Thanks
Ok so I tried the above on a file metadata isheet
the response i got is
Validation failed/ Forbidden
Isheet synchronization is not enable at site
Where do i enable iSheet synchronization??
The post i am sending is
Headers per usual... Authorization and set content-type to text/xml
Thank you
Your review has been submitted.
Comments
10 Comments