HighQ 5.3 changes for the iSheet module
OVERVIEW
To truncate text in a multi-line column, we have made the following changes to the process of getting, creating and updating an iSheet.
We have added two fields, detailed below:
1 : <setcharlimittruncatemultilinetextenabled>{0/1}</setcharlimittruncatemultilinetextenabled> : This filed is added to enable(1) or disable(0) truncate text feature in isheet for all multiline columns.
2 : <setcharlimittruncatemultilinetextval>{Numeric value from 1 to 10000}</setcharlimittruncatemultilinetextval> : if the above field is enabled, then we can decide character limit for mlt column ranging from 1 to 10000
(1) List of iSheets API calls:
While requesting this call, the two fields listed above will display as an output for each iSheet object within a particular site.
if the value for <setcharlimittruncatemultilinetextenabled> is 1 i.e. enabled, then it will receive the value of <setcharlimittruncatemultilinetextval>, which has been saved by the user
but the default value of <setcharlimittruncatemultilinetextval> is set as 255 , even if <setcharlimittruncatemultilinetextenabled> is set as 0.
(2) Add iSheet API call:
Request body:
<isheet>
<id>{iSheet id}</id>
<title>{The title of the isheet}</title> {This is a required parameter}
<description>{Provide description for the isheet}</description>
<status>Active / Pending</status>
<type>{text value of the supported types, possible values are documentmetadata / foldermetadata / taskmetadata / normal}</type>
<accesstype>{Possible values are public / private {default value is private}}</accesstype>
<viewlink>{Possible values are 0/1. This Properties determines if the 'view' link is visible to all users or not}</viewlink>
<allowsections>{0/1}</allowsections>
<allowlookup>{0/1}</allowlookup>
<displayisheet>{0/1}</displayisheet>
<searchasdefaultview>{0/1}</searchasdefaultview>
<enableversion>{0/1}</enableversion>
<enablesheetalerter>{0/1}</enablesheetalerter>
<alertercondition>CData{condition listed in a CData object}</alertercondition>
<overrideitemmodifieddate>{0/1} </overrideitemmodifieddate>
<enablebulkinsertupdate>{0/1} </enablebulkinsertupdate>
<fielddescriptions>{SLIDE_IN / INLINE}</fielddescriptions>
<enablerowlocking>{0/1}</enablerowlocking>
<setcharlimittruncatemultilinetextenabled>{0/1}</setcharlimittruncatemultilinetextenabled>
<setcharlimittruncatemultilinetextval>{Numeric value from 1 to 10000}</setcharlimittruncatemultilinetextval>
<columns>
A list of column object column objects
</columns>
</isheet>
Below is a list of scenarios, once you have created a sheet:
a) if both the new tags already exist, then they cannot be left blank and there must be proper values, otherwise a validation message will be shown
b) If <setcharlimittruncatemultilinetextenabled> is set as 1(enabled) and the <setcharlimittruncatemultilinetextval> tag does not exist in the request body, then a default value of 255 will be stored in the database for <setcharlimittruncatemultilinetextval>.
c) If <setcharlimittruncatemultilinetextenabled> is set as 0 (disabled) and the <setcharlimittruncatemultilinetextval> tag exists (with any value set within this tag) or no value set within the request body, then a default value of 255 will be stored in the database for <setcharlimittruncatemultilinetextval> but this functionality will not work since the value of <setcharlimittruncatemultilinetextenabled> is 0.
d) If both tags do not exists then <setcharlimittruncatemultilinetextenabled> will be set as 0 (disabled) and <setcharlimittruncatemultilinetextval> and the default value of 255 will be stored in the database.
(3) Edit iSheet API call:
Request body:
<isheet>
<id>{iSheet id}</id>
<title>{The title of the isheet}</title> {This is a required parameter}
<description>{Provide description for the isheet}</description>
<status>Active / Pending</status>
<type>{text value of the supported types, possible values are documentmetadata / foldermetadata / taskmetadata / normal}</type>
<accesstype>{Possible values are public / private {default value is private}}</accesstype>
<viewlink>{Possible values are 0/1. This Properties determines if the 'view' link is visible to all users or not}</viewlink>
<allowsections>{0/1}</allowsections>
<allowlookup>{0/1}</allowlookup>
<displayisheet>{0/1}</displayisheet>
<searchasdefaultview>{0/1}</searchasdefaultview>
<enableversion>{0/1}</enableversion>
<enablesheetalerter>{0/1}</enablesheetalerter>
<alertercondition>CData{condition listed in a CData object}</alertercondition>
<overrideitemmodifieddate>{0/1} </overrideitemmodifieddate>
<enablebulkinsertupdate>{0/1} </enablebulkinsertupdate>
<fielddescriptions>{SLIDE_IN / INLINE}</fielddescriptions>
<enablerowlocking>{0/1}</enablerowlocking>
<setcharlimittruncatemultilinetextenabled>{0/1}</setcharlimittruncatemultilinetextenabled>
<setcharlimittruncatemultilinetextval>{Numeric value from 1 to 10000}</setcharlimittruncatemultilinetextval>
<columns>
A list of column object column objects
</columns>
</isheet>
Below is a list of scenarios, once you have created a sheet:
a) if both the new tags already exist, then they cannot be left blank and there must be proper values, otherwise a validation message will be shown
b) If <setcharlimittruncatemultilinetextenabled> is set as 1(enabled) and the <setcharlimittruncatemultilinetextval> tag does not exist in the request body, then a default value of 255 will be stored in the database for <setcharlimittruncatemultilinetextval>.
c) If <setcharlimittruncatemultilinetextenabled> is set as 0 (disabled) and the <setcharlimittruncatemultilinetextval> tag exists (with any value set within this tag) or no value set within the request body, then a default value of 255 will be stored in the database for <setcharlimittruncatemultilinetextval> but this functionality will not work since the value of <setcharlimittruncatemultilinetextenabled> is 0.
d) If both tags do not exists then <setcharlimittruncatemultilinetextenabled> will be set as 0 (disabled) and <setcharlimittruncatemultilinetextval> and the default value of 255 will be stored in the database.
Comments
0 Comments