iSheets API
iSheets API version 2 - Common objects - iSheet item - common object - add/edit

iSheets API version 2 - Common objects - iSheet item - common object - add/edit

OVERVIEW

The iSheet record/item object consists of the following elements

 

<isheet recordcount="3">
    <data>
        <item itemsequence="1" externalid="3" alerteroption="1">
            <!-- single line column type -->
            <column attributecolumnid="101">
                <rawdata>
                    <value>
                        <![CDATA[name as defautl value]]>
                    </value>
                </rawdata>
            </column>
            
            <!-- multiple line column type -->
            <column attributecolumnid="102">
                <rawdata>
                    <value>
                        <![CDATA[name as defautl value]]>
                    </value>
                </rawdata>
            </column>
            
            <!-- choice type column -->
            <column attributecolumnid="103">
                <rawdata>
                    <choices>
                        <choice>
                             <id>101</id>
                        </choice>
                        <choice>
                             <id>{choice option id}</id>
                             <label><![CDATA[{choice option value}]]></label> (It is only applicable if "Include 'Other' option" property is enable.)
                        </choice>
                    </choices>
                </rawdata>
            </column>
            
            <!-- number type column -->
            <column attributecolumnid="104">
                <rawdata>
                    <value>
                        <![CDATA[10.00000000]]>
                    </value>
                </rawdata>
            </column>
            
            <!-- date and time column type -->
            <column attributecolumnid="105">
                <rawdata>
                    <date><![CDATA[15.11.2017]]></date> <!-- this must conform to the format set at the column level --> 
                    <time><![CDATA[11:14]]></time>
                </rawdata>
            </column>
            
            <!-- user lookup type column -->
            <column attributecolumnid="106">
                <rawdata>
                    <lookups>
                           <lookup>
                                 <id><![CDATA[110]]></id>
                           </lookup>
                           <lookup>
                                 <id><![CDATA[111]]></id>
                           </lookup>
                    </lookups>
                </rawdata>
            </column>
            
            <!-- hyperlink type column -->
            <column attributecolumnid="107">
                <rawdata>
                    <linkdisplayname><![CDATA[google.com]]></linkdisplayname>
                    <linkdisplayurl><![CDATA[http://www.google.com]]></linkdisplayurl>
                </rawdata>
            </column>
            
            <!-- image type column (as attachment) -->
            <column attributecolumnid="107">
                 <rawdata>
                        <attachments>
                            <attachment>
                                <id></id>
                            </attachment>
                        </attachments>
                </rawdata>
            </column>
            
            <!-- image type column (as URL) -->
            <column attributecolumnid="108">
                <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>
            </column>
            
            <!-- external attachment type column -->
            <column attributecolumnid="107">
                 <rawdata>
                        <attachments>
                            <attachment>
                                <id>101</id>
                            </attachment>
                            <attachment>
                                <id>102</id>
                            </attachment>
                        </attachments>
                </rawdata>
            </column>
            
            <!-- document link type column -->
            <column attributecolumnid="110">
                <rawdata>
                    <documents>
                        <document>
                            <docid>{document id}</docid>
                        </document>
                        <document>
                            <docid>{document id}</docid>
                        </document>
                    </documents>
                </rawdata>
            </column>
            
            <!-- folder link type column -->
            <column attributecolumnid="111">
                <rawdata>
                    <folders>
                        <folder>
                            <folderid>{folder's id}</folderid>
                        </folder>
                        <folder>
                            <folderid>{folder's id}</folderid>
                        </folder>
                    </folders>
                </rawdata>
            </column>
            
            <!-- isheet link type column -->
            <column attributecolumnid="112">
                <rawdata>
                    <isheetitems>
                        <isheetitem>
                            <recordid>{isheet record id}</recordid>
                        </isheetitem>
                        <isheetitem>
                            <recordid>{isheet record id}</recordid>
                        </isheetitem>
                    </isheetitems>
                </rawdata>
            </column>
           
            <!-- Lookup type column -->
            <column attributecolumnid="113">
                <rawdata>
                    <isheetitems>
                        <isheetitem>
                            <recordid>{isheet record id}</recordid>
                        </isheetitem>
                        <isheetitem>
                            <recordid>{isheet record id}</recordid>
                        </isheetitem>
                    </isheetitems>
                </rawdata>
            </column>
            
            <!-- join type column -->
            Doesn't support while Add/Edit isheet item
            
            <!-- calculate type column -->
            Doesn't support while Add/Edit isheet item
            
            <!-- Auto increment type column -->
            Doesn't support while Add/Edit isheet item
        </item>
        <item itemsequence="2" externalid="4" alerteroption="1">
        .
        .
        .
        </item>
        <item itemsequence="3" externalid="4" alerteroption="1">
        .
        .
        .
        </item>
    </data>
</isheet>

 

Note :

1. Please use the two following steps for adding an attachment to a record:

  • Use this api to add an attachment which will return an attachment ID
  • Use the attachment id from the previous step to populate the attachment/image field in the new record

2. alerteroption: This is only applicable if the iSheet configuration option "Eis selected.

  • Respect user preference
  • Send now to all users with access
  • Suppress all notifications

3. In the choice type column, we accept choice item id. Choice item ids are being served by Get columns API.

4. Date and time type column - We expect a string in the configured date format for that particular column. For example,  if column is configured to 'DD.MM.YYYY' then the string should be in the form of '15.11.2017'

5. Choice type column - If 'Include Other option' property is enabled then we will allow other values. For other option 'id=-1' and 'name={string}'

Comments


46 Comments

Last Updated: Jun 10,2023