iSheets API version 2 - Common objects - Column object

The column object consists of the following elements:

Common fields

<column>

    <columnid></columnid>

    <name></name> (String)

    <type></type> (Numeric) {Type of the column, column types are obtained from a call to the column types API}

    <systemgeneratedtype></systemgeneratedtype> (String) <!-- this tag is supported from Collaborate 5.0 onwards -->

    <columntype>{ISHEET_CUSTOM / TASK_STANDARD}</columntype> 

    <section></section> (Numeric) {ID of the section obtained from the sections call}

    <description><![CDATA[]]></description> (This is a multiline text)

    <addtodefaultview>{0/1}</addtodefaultview>

    <columnconditionstate>Display field / Hide field</columnconditionstate>

    <columnconditions>

       list of rows of column condition common object

    </columnconditions>

    <columnspecificdetail></columnspecificdetail> (you can check fields below based on column type)

</column>

Column specific details

1. Single line text

<columnspecificdetail>

    <defaultvalue></defaultvalue> (String)

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <maxchars></maxchars> (numeric value of no of maximum characters for a column)

    <allowfieldfromanotherisheet>{0/1}</allowfieldfromanotherisheet>

    <lookupglossarysheetid>{isheet id}</lookupglossarysheetid> (only applicable if allowfieldfromanotherisheet = 1)

    <lookupglossarysheetviewid>{isheet view id}</lookupglossarysheetviewid> (only applicable if allowfieldfromanotherisheet = 1)

</columnspecificdetail>

2. Multiple line text

<columnspecificdetail>

    <defaultvalue></defaultvalue> (String)

    <width></width> (numeric value for the column width that applies to the interface)

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <allowrichhtmltext>{0/1}</allowrichhtmltext>

    <numberoflines></numberoflines> (numeric value of no of line in text area)

    <allowfieldfromanotherisheet>{0/1}</allowfieldfromanotherisheet>

    <lookupglossarysheetid>{isheet id}</lookupglossarysheetid> (only applicable if allowfieldfromanotherisheet = 1)

    <lookupglossarysheetviewid>{isheet view id}</lookupglossarysheetviewid> (only applicable if allowfieldfromanotherisheet = 1)

</columnspecificdetail>

3. Choice

<columnspecificdetail>

    <defaultvalue></defaultvalue> (String but from entered choice value)

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <displaymethod>DROPDOWN/RADIO/CHECKBOX</displaymethod>

    <includeotheroption>{0/1}</includeotheroption>

    <singleormultileselectioninsearch>SINGLE/MULTIPLE</singleormultileselectioninsearch>

    <choices>

        <choice>

            <id></id> (this will be used while get list of columns or get column detail)

            <label></label> (String)

        </choice>

        <choice>

            <id></id>

            <label></label>

        </choice>

    </choices>

    <includeinalertpreferences>{0/1}</includeinalertpreferences>

</columnspecificdetail>

4. Number

<columnspecificdetail>

    <defaultvalue></defaultvalue> (Numeric but if max and min value is set then Default value must be less than or equal to maximum value.)

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <min></min> (Numeric) {min value of this number field}

    <max></max> (Numeric) {max value of this number field}

    <decimalplaces>0/1/2/3/4/5</decimalplaces> (value for decimal places)

    <showthousandseparators>{0/1}</showthousandseparators>

    <showaspercentage>{0/1}</showaspercentage>

</columnspecificdetail>

5. Date and time

<columnspecificdetail>

    <formattype>DATE_ONLY/DATE_TIME</formattype>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <dateformat><![CDATA[]]></dateformat> (value from, DD MMM YYYY, DD/MM/YYYY, MM/DD/YYYY, DD.MM.YYYY)

    <defaultvalue>NONE/TODAY/CUSTOM</defaultvalue>

    <defaultdateandtime>28/07/2017 15:30</defaultdateandtime> (date and time should be in fix format of DD/MM/YYYY HH:MM)

</columnspecificdetail>

6. User lookup

<columnspecificdetail>

    <sheetlookup>SHEET_LOOKUP_ALL_SYSTEM_USERS/SHEET_LOOKUP_ALL_SITE_USERS/SHEET_LOOKUP_CONTENT_ADMINISTRATORS/SHEET_LOOKUP_SITE_ADMINISTRATORS</sheetlookup>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

    <allowsearch>{0/1}</allowsearch>

    <fielddisplay>Username/Email Address/Username, Organisation</fielddisplay>

    <allowmultipleusers>{0/1}</allowmultipleusers>

</columnspecificdetail>

7. Hyperlink

<columnspecificdetail>

    <allowsearch>{0/1}</allowsearch>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

</columnspecificdetail>

8. Image

<columnspecificdetail>

    <methodtype>IMAGE_AS_ATTACHMENT/IMAGE_AS_URL</methodtype>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <mandatory>{0/1}</mandatory>

</columnspecificdetail>

9. Attachment

<columnspecificdetail>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

</columnspecificdetail>

10. File link

<columnspecificdetail>

    <allowsearch>{0/1}</allowsearch>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

</columnspecificdetail>

11. Folder link

<columnspecificdetail>

    <allowsearch>{0/1}</allowsearch>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

</columnspecificdetail>

12. iSheet link

<columnspecificdetail>

    <defaultvalue></defaultvalue> (String)

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <allowsearch>{0/1}</allowsearch>

    <sheetids></sheetids> (This field is mandatory. Mutiple isheets with comma seperator)

    <allowuserstorenamelinks>{0/1}</allowuserstorenamelinks>

</columnspecificdetail>

13. Lookup

<columnspecificdetail>

    <sheetid></sheetid> (isheet looup id)

    <columnids></columnids> (isheet lookup's columns with comma seperator)

    <viewid></viewid> (Numeric)

    <allowmultiplevalues>{0/1}</allowmultiplevalues>

    <restrictdelete>{0/1}</restrictdelete>

    <displaycolumnnameprefix>{0/1}</displaycolumnnameprefix>

</columnspecificdetail>

14. Join

<columnspecificdetail>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <linkname></linkname> (String)

    <sheetid></sheetid> (Numeric)

    <viewid></viewid> (Numeric)

    <joinconditions>

        <joincondition>

            <currentsheetcolumnid></currentsheetcolumnid> (Numeric)

            <targetsheetcolumnid></targetsheetcolumnid> (Numeric)

        </joincondition>

        <joincondition>

            <currentsheetcolumnid></currentsheetcolumnid>

            <targetsheetcolumnid></targetsheetcolumnid>

        </joincondition>

    </joinconditions>

</columnspecificdetail>

15. Calculation

<columnspecificdetail>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <formula><![CDATA[]]></formula> (For ex. (col_1-col_2)/(col_3*col_4)+col_5+10)

    <decimalplaces>0/1/2/3/4/5</decimalplaces> (value for decimal places)

    <showthousandseparators>{0/1}</showthousandseparators>

    <showaspercentage>{0/1}</showaspercentage>

    <allowsearch>{0/1}</allowsearch>

</columnspecificdetail>

16. Auto increment

<columnspecificdetail>

    <columnwidth></columnwidth> (numeric value for the column width that applies to the interface)

    <startvalue></startvalue> (Numeric)

    <prefix></prefix> (String)

    <postfix></postfix> (String)

    <minlength></minlength> (Numeric)

    <allowsearch>{0/1}</allowsearch>

</columnspecificdetail>

Note :

1. 'addtodefaultview' is only applicable while adding columns.

2. columntype : ISHEET_CUSTOM / TASK_STANDARD

         - This tag is only applicable if iSheet is 'Task custom metadata'

         - This tag is only applicable for CRUD API of iSheet view

         - This tag is supported from Collaborate 5.0 only.

         - If columntype = TASK_STANDARD then column id should be from the below possible values. (and 'type' tag will not be considered)