iSheets API
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.  

Comments


10 Comments

Last Updated: Jun 09,2023