@wanasapps/deluge-core 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2648 @@
1
+ {
2
+ "source": "https://www.zoho.com/deluge/help/ (scraped 2026-09-03)",
3
+ "functions": [
4
+ {
5
+ "category": "Collection",
6
+ "name": "clear",
7
+ "syntax": "<collectionVariable>.clear();",
8
+ "returns": "",
9
+ "overview": "The clear function empties a given collection.",
10
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\n\nThe variable from which key value pairs or elements will be removed."
11
+ },
12
+ {
13
+ "category": "Collection",
14
+ "name": "containsKey",
15
+ "syntax": "To check if a key is present in a collection:\n\n<variable> = <collectionVariable>.containsKey(<key>);\n\n(OR)\nTo check if an index value is present in a collection:\n\n<variable> = <collectionVariable>.containsKey(<index>);",
16
+ "returns": "BOOLEAN",
17
+ "overview": "The containsKey function checks if a specified key or an index value is present in a collection.",
18
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will hold the returned boolean value.\n\n<collectionVariable>\nCOLLECTION\n\nThe variable in which the key or the index will be looked for.\n\n<key>\nTEXT/NUMBER/DECIMAL/DATE/BOOLEAN\n\nThe key to be searched for in the collection.\n\n<index>\nNUMBER\nThe index value to be searched for in the collection."
19
+ },
20
+ {
21
+ "category": "Collection",
22
+ "name": "containsValue",
23
+ "syntax": "<variable> = <collectionVariable>.containsValue(<value>);",
24
+ "returns": "BOOLEAN",
25
+ "overview": "The containsValue function checks if a specified value is present in a collection.",
26
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will hold the returned boolean value.\n\n<collectionVariable>\nCOLLECTION\n\nThe variable in which the value will be looked for.\n\n<value>\nAny Data Type\nThe value to be searched for in the collection."
27
+ },
28
+ {
29
+ "category": "Collection",
30
+ "name": "delete",
31
+ "syntax": "The following syntax is used for deleting an element from index-value collection:\n<collectionVariable>.delete(<value>);\n\n(OR)\nThe following is applicable for deleting an element using its key from key-value collection:\n<collectionVariable>.delete(<element>);",
32
+ "returns": "",
33
+ "overview": "The delete function deletes a specified element, or a specified value (along with the key) from a collection.",
34
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable in which a key value pair or an element will be deleted.\n\n<value>\n-\nThe value which will be deleted along with the key.\nNo action is taken if the specified value is not found.\n\n<element>\n-\nThe element which will be deleted.\nNo action is taken if the specified element is not found.\n\nNote: \nLearn about deleteKeys function that deletes specified elements, or keys.\nLearn about deleteKey function deletes an element based on a specified index, or a specified key along with its value"
35
+ },
36
+ {
37
+ "category": "Collection",
38
+ "name": "deleteAll",
39
+ "syntax": "To delete values along with the keys:\n\n<collectionVariable>.deleteAll(<valuesList>);\n\n(OR)\nTo delete elements:\n\n<collectionVariable>.deleteAll(<elementsList>);",
40
+ "returns": "",
41
+ "overview": "The deleteAll function deletes specified elements, or specified values (along with the keys) from a collection.",
42
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable from which key value pairs or elements will be deleted.\n\n<valuesList>\nLIST\nValues which will be deleted along with the keys.\n\n<elementsList>\nLIST\nElement which will be deleted."
43
+ },
44
+ {
45
+ "category": "Collection",
46
+ "name": "deleteKey",
47
+ "syntax": "To delete a key-value pair based on the key:\n\n<collectionVariable>.deleteKey(<key>);\n\n(OR)\nTo delete an element based on its index:\n\n<collectionVariable>.deleteKey( <elementIndex> );",
48
+ "returns": "",
49
+ "overview": "The deleteKey function deletes an element based on a specified index, or a specified key along with its value in a collection.",
50
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable in which a key value pair will be deleted.\n\n<key>\n-\nThe key which will be deleted along with the value.\nNo action is taken if the specified key is not found.\n\n<elementIndex>\nNUMBER\nThe index of the element which will be deleted.\nIf the specified index is not found, a runtime error will be encountered.\nIndex starts from 0."
51
+ },
52
+ {
53
+ "category": "Collection",
54
+ "name": "deleteKeys",
55
+ "syntax": "To delete keys along with their values:\n\n<collectionVariable>.deleteKeys(<keysList>);\n\n(OR)\nTo delete elements based on index values:\n\n<collectionVariable>.deleteKeys(<indexList>);",
56
+ "returns": "",
57
+ "overview": "The deleteKeys function deletes specified elements, or keys(along with their values) from a collection.",
58
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable from which key-value pairs will be deleted.\n\n<keysList>\nLIST\nThe keys which will be deleted along with the values.\n\n<indexList>\nLIST\nIndex values of elements which will be deleted.\nIndex starts from 0."
59
+ },
60
+ {
61
+ "category": "Collection",
62
+ "name": "distinct",
63
+ "syntax": "<variable> = <collectionVariable>.distinct();\n\n where,",
64
+ "returns": "LIST",
65
+ "overview": "The distinct function returns the unique values (from key value pairs), or unique elements, present in a collection.",
66
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will hold the returned list.\n\n<collectionVariable>\nCOLLECTION\nThe variable from which the unique values or unique elements will be returned."
67
+ },
68
+ {
69
+ "category": "Collection",
70
+ "name": "duplicate",
71
+ "syntax": "<variable> = <collectionVariable>.duplicate(<startIndex>, <endIndex>);",
72
+ "returns": "LIST",
73
+ "overview": "The duplicate function returns the elements present in the given start index (inclusive) and end index (non inclusive).",
74
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will hold the returned list.\n\n<collectionVariable>\nCOLLECTION\nVariable from which the elements in the specified indices will be returned.\n\n<startIndex>\n<endIndex>\n(optional)\n\nNUMBER\nThe start and end indices of the elements which needs to be duplicated.\nIndex starts from 0.\nIf the value for endIndex is greater than the list size, a runtime error will be encountered.\nIf the indices are not specified, the function duplicates and returns the entire list."
75
+ },
76
+ {
77
+ "category": "Collection",
78
+ "name": "get",
79
+ "syntax": "<variable> = <collection>.get(<indexValue>);\n\n(OR)\n\n<variable> = <collection>.get(<key>);",
80
+ "returns": "ANY DATA TYPE",
81
+ "overview": "The get function retrieves values from a collection using either an index or a key.",
82
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nANY DATA TYPE\nVariable which will contain the returned element or key.\n\n<collection>\nCOLLECTION\nThe collection from which the specified value or element needs to be retrieved.\n\n<indexValue>\nNUMBER\nThe index of the element which will be returned.\nNote: The range of the index is from 0 through the collection size - 1. Indices outside this range will yield a null.\n\n<key>\nANY DATA TYPE\nThe key for which the value will be returned."
83
+ },
84
+ {
85
+ "category": "Collection",
86
+ "name": "getKey",
87
+ "syntax": "To get the key of a specified value:\n\n<variable> = <collectionVariable>.getKey(<value>);\n\n(OR)\nTo get the index value of an element:\n\n<variable> = <collectionVariable>.getKey(<element>);",
88
+ "returns": "Data type of the return value will depend on the data type o",
89
+ "overview": "The getKey function returns the key of a specified value, or the index of a specified element, in a collection.",
90
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nAS APPLICABLE\nVariable which will hold the returned value.\n\n<collectionVariable>\nCOLLECTION\nThe variable from which the key or the index will be returned.\n\n<value>\nAS APPLICABLE\nThe value whose key will be returned.\nThis function returns null if the specified value is not found.\n\n<element>\nAS APPLICABLE\nThe element whose index value will be returned.This function returns -1 if the specified element is not found."
91
+ },
92
+ {
93
+ "category": "Collection",
94
+ "name": "getLastKey",
95
+ "syntax": "To get the key of a specified value's last occurrence:\n\n<variable> = <collectionVariable>.getLastKey(<value>);\n\n(OR)\nTo get the index value of an element's last occurrence:\n\n<variable> = <collectionVariable>.getLastKey(<element>);\n\n where,",
96
+ "returns": "Data type of the return value will depend on the data type o",
97
+ "overview": "The getLastKey function returns the key of a specified value's last occurrence, or the index of a specified element's last occurrence, in a collection.",
98
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nVariable which will hold the returned value.\nAS APPLICABLE\n\n<collectionVariable>\nCOLLECTION\nThe variable from which the key or the index will be returned.\n\n<value>\n\nAS APPLICABLE\nThe value whose key will be returned.\nThis function returns null if the specified value is not found.\n\n<element>\nAS APPLICABLE\nThe element whose index value will be returned.\nThis function returns -1 if the specified element is not found."
99
+ },
100
+ {
101
+ "category": "Collection",
102
+ "name": "insert",
103
+ "syntax": "To insert key-value pairs:\n\n<collectionVariable>.insert(<key> : <value>);\n\n(OR)\nTo insert elements:\n\n<collectionVariable>.insert( <element> );",
104
+ "returns": "",
105
+ "overview": "The insert function adds specified elements or key-value pairs to a collection.",
106
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable to which the key-value pairs or elements will be added.\nIf the variable contains key-value pairs, this function will only accept key-value pairs as arguments. If an element is specified, a runtime error will be encountered.\nIf the variable contains elements, this function will only accept elements as arguments. If a key-value pair is specified, a runtime error will be encountered.\n\n<key>\nALL DATA TYPES\nThe key which will be inserted.\nIf a duplicate key is specified, its new value will overwrite its existing value, and the new key-value pair will not get added.\n\n<value>\nALL DATA TYPES\nThe value which will be "
107
+ },
108
+ {
109
+ "category": "Collection",
110
+ "name": "insertAll",
111
+ "syntax": "To insert key-value pairs:\n\n<collectionVariable>.insertAll(<keyValueList>);\n\n(OR)\nTo insert elements:\n\n<collectionVariable>.insertAll(<elementList>);",
112
+ "returns": "",
113
+ "overview": "The insertAll function adds a list of specified elements or key-value pairs to a collection.",
114
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nDECIMAL\nThe variable to which the list of key-value pairs or elements will be added.\nIf the variable contains key-value pairs, this function will only accept key-value pairs as arguments. If elements are specified, a runtime error will be encountered.\nIf the variable contains elements, this function will only accept elements as arguments. If key-value pairs are specified, a runtime error will be encountered.\n\n<keyValueList>\nLIST\nThe list of key value pairs which will be inserted.\nIf a duplicate key is specified, its new value will overwrite its existing value, and the new key-value pair will not get added.\n\n<elementList>\nLIST\nThe l"
115
+ },
116
+ {
117
+ "category": "Collection",
118
+ "name": "intersect",
119
+ "syntax": "<variable> = <collectionVariable1>.intersect(<collectionVariable2>);\n\n where,",
120
+ "returns": "DECIMAL",
121
+ "overview": "The intersect function returns the common elements present in two given collections.",
122
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will hold the returned list.\n\n<collectionVariable1>\n<collectionVariable2>\n\nCOLLECTION\nVariables from which the common elements will be returned."
123
+ },
124
+ {
125
+ "category": "Collection",
126
+ "name": "isEmpty",
127
+ "syntax": "<variable> = <expression>.isEmpty();",
128
+ "returns": "BOOLEAN",
129
+ "overview": "The isEmpty function takes an expression as argument.",
130
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\nTEXT/LIST/MAP/COLLECTION\nVariable which will hold the expression awaiting the empty validation."
131
+ },
132
+ {
133
+ "category": "Collection",
134
+ "name": "keys",
135
+ "syntax": "<variable> = <collectionVariable>.keys();",
136
+ "returns": "LIST",
137
+ "overview": "The keys function returns the keys (from key value pairs), or elements, present in a collection.",
138
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will hold the returned list.\n\n<collectionVariable>\nCOLLECTION\nThe variable from which the keys or elements will be returned."
139
+ },
140
+ {
141
+ "category": "Collection",
142
+ "name": "size",
143
+ "syntax": "<variable> = <collectionVariable>.size();",
144
+ "returns": "NUMBER",
145
+ "overview": "The size function returns the number of values or elements present in a collection.",
146
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will hold the returned value.\n\n<collectionVariable>\nCOLLECTION\nThe variable whose size will be returned."
147
+ },
148
+ {
149
+ "category": "Collection",
150
+ "name": "sort",
151
+ "syntax": "<collectionVariable>.sort(<booleanValue>);",
152
+ "returns": "",
153
+ "overview": "The sort function sorts the elements, or key value pairs based on values in a collection.",
154
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable in which elements or key value pairs will be sorted.\n\n<booleanValue>\n(optional)\n\nBOOLEAN\nApplicable values are true and false.\nThe value true sorts in ascending(default) order, and the value false sorts in descending order.\nIn a string list, special characters, upper case, and lower case letters are sorted in the following order:\n! \" # $ % & ' ( ) * + , - . / <numerical values> : ; < = > ? @ <capital letters> [ ] ^ _ ` <small letters> { | } ~"
155
+ },
156
+ {
157
+ "category": "Collection",
158
+ "name": "sortKey",
159
+ "syntax": "<collectionVariable>.sortKey(<booleanValue>);",
160
+ "returns": "",
161
+ "overview": "The sortKey function sorts the keys in a collection containing key-value pairs.",
162
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable in which key value pairs will be sorted.\n\n<booleanValue>\n(optional)\n\nBOOLEAN\nApplicable values are true and false.\nThe value true sorts in ascending(default) order, and the value false sorts in descending order.\nIn a string list, special characters, upper case, and lower case letters are sorted in the following order:\n! \" # $ % & ' ( ) * + , - . / <numerical values> : ; < = > ? @ <capital letters> [ ] ^ _ ` <small letters> { | } ~"
163
+ },
164
+ {
165
+ "category": "Collection",
166
+ "name": "update",
167
+ "syntax": "To update the value of a key:\n\n<collectionVariable>.update(<key>, <updateValue>);\n\n(OR)\nTo update an element:\n\n<collectionVariable>.update(<elementIndex>, <updatedValue>);",
168
+ "returns": "",
169
+ "overview": "The update function updates a specified value of a key or a specified element in a collection.",
170
+ "params": "where,\nParameter\nData type\nDescription\n\n<collectionVariable>\nCOLLECTION\nThe variable in which the value of a key or an element will be updated.\n\n<key>\nAll Data Types\nThe key whose value will be updated.\nIf a new key is specified, the key-value pair will get added as a new pair. \n\n<elementIndex>\nNUMBER\nThe index of the element which will be updated with a new value.\nIf the specified index does not exist, a runtime error will be encountered.\n\n<updatedValue>\nALL DATA TYPES\nThe value which will replace the existing value."
171
+ },
172
+ {
173
+ "category": "Collection",
174
+ "name": "values",
175
+ "syntax": "<variable>=<collectionVariable>.values();",
176
+ "returns": "LIST",
177
+ "overview": "The values function returns the values (from key value pairs), or elements, present in a collection.",
178
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will hold the returned list.\n\n<collectionVariable>\nCOLLECTION\nThe variable from which the values or elements will be returned."
179
+ },
180
+ {
181
+ "category": "Common / conversion",
182
+ "name": "encodeUrl",
183
+ "syntax": "<variable> = encodeUrl( <urlExpression> );",
184
+ "returns": "Text",
185
+ "overview": "The encodeUrl() function takes urlExpression as an argument and encodes \"all space characters\" and other characters disallowed in a URL string, and returns the encoded string.",
186
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned encoded url.\nTEXT\n\n<string>\nThe expression which will be encoded.\nTEXT"
187
+ },
188
+ {
189
+ "category": "Common / conversion",
190
+ "name": "getJson",
191
+ "syntax": "<variable> = <input>.getJson(<key>);",
192
+ "returns": "The return type will depend on the data type of the returned",
193
+ "overview": "The getJSON function retrieves values from a JSON formatted text or a key-value collection, using a key.",
194
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nAny datatype\nVariable that holds the returned value. Datatype of this parameter depends on the type of the returned value.\n\n<input>\nTEXT\nor\nKEY-VALUE\nThe JSON formatted text or the key-value collection from which the specified key's value needs to be fetched.\nNote:\nIf the input is not a JSON formatted TEXT or is not a KEY-VALUE collection, a runtime error will be thrown.\n\n<key>\nAny datatype\nThe key whose value needs to be returned.\nIf the specified key is not found, null value will be returned."
195
+ },
196
+ {
197
+ "category": "Common / conversion",
198
+ "name": "isFile",
199
+ "syntax": "<variable> = <file_object>.isFile();\n\n(OR)\n\n<variable> = isFile(<file_object>);",
200
+ "returns": "BOOLEAN",
201
+ "overview": "The isFile function takes a file object as an argument and returns true if it is a valid file.",
202
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<file_object>\nAny datatype\nThe file object fetched from the cloud/web.\nLearn more about fetching files from the web here."
203
+ },
204
+ {
205
+ "category": "Common / conversion",
206
+ "name": "isBlank",
207
+ "syntax": "<variable> = isBlank(<expression>);\n\n (or)\n <variable> = <expression>.isBlank();",
208
+ "returns": "BOOLEAN",
209
+ "overview": "The isBlank function takes an expression as an argument, and returns true if it is a blank value.",
210
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\nANY DATA TYPE\nThe expression which needs to be checked for blank values.\nFind how isBlank operates on different values and returns corresponding boolean values."
211
+ },
212
+ {
213
+ "category": "Common / conversion",
214
+ "name": "isDate",
215
+ "syntax": "<variable> = isDate( <expression> );\n(or)<variable> = <expression>.isDate();",
216
+ "returns": "BOOLEAN",
217
+ "overview": "The isDate() function takes an expression as an argument, and returns true if it is a valid date-time value.",
218
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\n-\nThe expression which needs to be checked. \nText values containing a valid date-time value will return true, and which do not contain a valid date-time value will throw an error.\nList and key-value data type will return a null value."
219
+ },
220
+ {
221
+ "category": "Common / conversion",
222
+ "name": "isNull",
223
+ "syntax": "For all services except Zoho Creator,\n<variable> = <expression>.isNull();\n\nFor all services,\n<variable> = isNull(<expression>);",
224
+ "returns": "BOOLEAN",
225
+ "overview": "The isNull function takes an expression as an argument, and returns true if it is a null value.",
226
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\nANY DATA TYPE\nVariable which will hold the expression awaiting null validation."
227
+ },
228
+ {
229
+ "category": "Common / conversion",
230
+ "name": "isNumber",
231
+ "syntax": "<variable> = isNumber( <expression> );\n(or)<variable> = <expression>.isNumber();\nValid numerical values in single or double quotes will return true.\nList and Key-value data type will always return a null value.",
232
+ "returns": "Boolean",
233
+ "overview": "The isNumber() function takes an expression as an argument, and returns true if it is a valid numerical value.",
234
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\n\n-"
235
+ },
236
+ {
237
+ "category": "Common / conversion",
238
+ "name": "isText",
239
+ "syntax": "<variable> = isText( <expression> );",
240
+ "returns": "BOOLEAN",
241
+ "overview": "The isText() function takes an expression as an argument, and returns true if it is a valid text value.",
242
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\n-\nThe expression which needs to be checked. \nEmpty double quotes (with or without spaces) will return true.\nNumerical values in double quotes will return false unless accompanied with letters.\nList, Key-value, Boolean data types will return null.\nEmpty single quotes (date and time values) will return null."
243
+ },
244
+ {
245
+ "category": "Common / conversion",
246
+ "name": "toNumber",
247
+ "syntax": "<variable> = <expression>.toNumber();\n\n(OR)\n\n<variable> = toNumber(<expression>);\n\n(OR)\n\n<variable> = <expression>.toLong();\n\n(OR)\n\n<variable> = toLong(<expression>);",
248
+ "returns": "NUMBER",
249
+ "overview": "The toLong function takes an expression as an argument, and returns a number.",
250
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the converted number.\n\n<expression>\nNUMBER/DECIMAL/DATE-TIME/TEXT\nThe expression which will resolve to a number.\nNote:\nDate-time values will be converted into their equivalent number of milliseconds starting from '31-Dec-1969 16:00:00' (which is equivalent to 0).\nFor instance, '31-Dec-1969 16:00:01'.toNumber() will yield 1000 and '31-Dec-1969 15:59:59'.toNumber() will yield -1000 and so on.\nDecimals will be truncated off their fraction parts.\nEmpty texts will throw an error during runtime."
251
+ },
252
+ {
253
+ "category": "Common / conversion",
254
+ "name": "toText",
255
+ "syntax": "<variable> = <expression>.toText(<dateTimeFormat>, <timeZone>);\n\n(OR)\n<variable> = toText(<expression>, <dateTimeFormat>, <timeZone>);\n\n(OR)\n<variable> = <expression>.toString(<dateTimeFormat>, <timeZone>);\n\n(OR)\n<variable> = toString(<expression>, <dateTimeFormat>, <timeZone>);",
256
+ "returns": "TEXT",
257
+ "overview": "The toText function takes an expression, and returns it as text.",
258
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<expression>\nALL DATA TYPES\nThe expression which will be returned in text format.\n\n<dateTimeFormat>\n(optional)\n\nTEXT\nThe format in which the date time value will be returned.\nNote:\nApplicable only when the given expression is of date-time or number (milliseconds) data type.\nWithin this param, you can only specify date-time literals which represent the respective components of a date or time value. Text can be quoted in single quotes to avoid interpretation. If any other value apart from date-time literals are specified without single quotes, the function will return null.\nIf this param is"
259
+ },
260
+ {
261
+ "category": "Common / conversion",
262
+ "name": "toDate",
263
+ "syntax": "<variable> = <expression>.toDate(<dateTimeMapping>);\n\n(OR)\n\n<variable> = toDate(<expression>, <dateTimeMapping>);",
264
+ "returns": "DATE-TIME",
265
+ "overview": "The toDate function takes an expression as an argument, and returns the expression (containing a date-time value) in the date format as specified in application settings.",
266
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME\nVariable which will contain the returned date value.\n\n<expression>\nTEXT/NUMBER/DATE-TIME\nThe expression (containing a valid date time format) which will be returned in date format.\nWhen the data type is NUMBER:\nthe number 1 stands for the date-time value 31-Dec-1969, and every increase in 1000 will add 1 second to the date value, and every decrease in 1000 will subtract 1 second from the date value. So, the number 1000 will return a date value of 31-Dec-1969.\nthe dateTimeMapping param is ignored.\nWhen the data type is Date-Time, the additional parameters (mentioned below) are ignored. And, the function will throw a runtime error if"
267
+ },
268
+ {
269
+ "category": "Common / conversion",
270
+ "name": "toDateTimeString",
271
+ "syntax": "<result>=<input_data>.toDateTimeString(<dateTimeFormat>,<timeZone>);\n\n(or)\n<result>=toDateTimeString(<input_data>,<dateTimeFormat>,<timeZone>);",
272
+ "returns": "TEXT",
273
+ "overview": "The toDateTimeString function is a built-in function used for managing date and time data efficiently.",
274
+ "params": "where,\nParameter\nData type\nDescription\n\n<result>\nTEXT\nResult that will contain the returned date value.\nNote:The date-time format and timezone will be converted to the preference specified using <dateTimeFormat> and <timeZone> parameters.\n\n<input_data>\nNUMBER\nThe data is returned in the specified date-time format or timezone as indicated in the input.\nNote:\nThis task accepts the Epoch timestamp in milliseconds only.\nThe input format for date-time and timezone is determined by the service settings.\nThe numeric value 0 represents the date-time value of 01-Jan-1970 in the UTC timezone. Each increase of 1000 adds one second to the date value, while each decrease of 1000 subtracts one second. For"
275
+ },
276
+ {
277
+ "category": "Common / conversion",
278
+ "name": "toDecimal",
279
+ "syntax": "<variable> = <expression>.toDecimal();\n\n(OR)\n\n<variable> = toDecimal(<expression>);",
280
+ "returns": "DECIMAL",
281
+ "overview": "The toDecimal function takes an expression as an argument, and returns a decimal value.;",
282
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDECIMAL\nVariable which will contain the converted decimal value.\n\n<expression>\nDECIMAL/NUMBER/TEXT\nThe expression which will be returned in decimal format.\nEmpty texts will throw an error during runtime.\nText should contain only numerical values."
283
+ },
284
+ {
285
+ "category": "Common / conversion",
286
+ "name": "toJSONList",
287
+ "syntax": "<variable> = <json_text>.toJSONList();",
288
+ "returns": "LIST",
289
+ "overview": "The toJSONList function takes a text JSON array as an argument, and returns it as a list.",
290
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will contain the converted JSON list.\n\n<json_text>\nTEXT\nThe text JSON array which needs to be converted to JSON List.\nNote:\nIf the text is not in JSON format, a runtime error will be thrown."
291
+ },
292
+ {
293
+ "category": "Common / conversion",
294
+ "name": "toLong",
295
+ "syntax": "<variable> = <expression>.toLong();\n\n(OR)\n\n<variable> = toLong(<expression>);\n\n(OR)\n\n<variable> = <expression>.toNumber();\n\n(OR)\n\n<variable> = toNumber(<expression>);",
296
+ "returns": "NUMBER",
297
+ "overview": "The toLong function takes an expression as an argument, and returns a number.",
298
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the converted number.\n\n<expression>\nNUMBER/DECIMAL/DATE-TIME/TEXT\nThe expression which will resolve to a number.\nNote:\nDate-time values will be converted into their equivalent number of milliseconds starting from '31-Dec-1969 16:00:00' (which is equivalent to 0).\nFor instance, '31-Dec-1969 16:00:01'.toLong() will yield 1000 and '31-Dec-1969 15:59:59'.toLong() will yield -1000 and so on.\nDecimals will be truncated off their fraction parts.\nEmpty texts will throw an error during runtime."
299
+ },
300
+ {
301
+ "category": "Common / conversion",
302
+ "name": "toString",
303
+ "syntax": "<variable>=<expression>.toString(<dateTimeFormat>,<timeZone>);\n\n(OR)\n<variable>=toString(<expression>,<dateTimeFormat>,<timeZone>);\n\n(OR)\n<variable>=<expression>.toText(<dateTimeFormat>,<timeZone>);\n\n(OR)\n<variable>=toText(<expression>,<dateTimeFormat>,<timeZone>);",
304
+ "returns": "TEXT",
305
+ "overview": "The toString function takes an expression as input and returns it as text.",
306
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<expression>\nALL DATA TYPES\nThe expression which will be returned in text format.\n\n<dateTimeFormat>\n(optional)\n\nTEXT\nThe format in which the date time value will be returned.\nNote:\nApplicable only when the given expression is of date-time or number data type. The number type is currently supported in all services except Zoho Creator.\nWithin this param, you can only specify date-time literals which represent the respective components of a date or time value. Text can be quoted in single quotes to avoid interpretation. If any other value apart from date-time literals are specified without s"
307
+ },
308
+ {
309
+ "category": "Common / conversion",
310
+ "name": "toTime",
311
+ "syntax": "<variable> = <expression>.toTime(<dateTimeMapping>, <timeZone>);",
312
+ "returns": "DATE-TIME",
313
+ "overview": "The toTime function takes expression, dateTimeMapping, and timeZone as arguments.",
314
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME\nVariable which will contain the formatted date-time value.\n\n<expression>\nTEXT/NUMBER/DATE-TIME\nThe expression (containing a valid date time format) which will be returned in date format.\nWhen the data type is NUMBER:\nthe number 1 stands for the date-time value 31-Dec-1969, and every increase in 1000 will add 1 second to the date value, and every decrease in 1000 will subtract 1 second from the date value. So, the number 1000 will return a date value of 31-Dec-1969.\nthe dateTimeMapping param is ignored.\nWhen the data type is Date-time, the additional parameters (mentioned below) are ignored. And, the function will throw a runtime er"
315
+ },
316
+ {
317
+ "category": "Date-time",
318
+ "name": "addBusinessDay",
319
+ "syntax": "<variable> = <dateTimeValue>.addBusinessDay(<numberOfBusinessDays>, [<weekends>], [<holidays>]);\n\n(OR)\n\n<variable> = addBusinessDay(<dateTimeValue>, <numberOfBusinessDays>, [<weekends>], [<holidays>]);",
320
+ "returns": "Date-Time",
321
+ "overview": "The addBusinessDay() function takes dateTimeValue and numberOfBusinessDays as arguments.",
322
+ "params": "Parameter\nData type\nDescription\n\nvariable\nDATE-TIME\nVariable which will contain the returned date-time value.\n\ndateTimeValue\nDATE-TIME\nThe date-time value to which the specified number of business days will be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specifi"
323
+ },
324
+ {
325
+ "category": "Date-time",
326
+ "name": "addDay",
327
+ "syntax": "<variable>=<dateTimeValue>.addDay(<numberOfDays>);\n(OR)\n<variable>=addDay(<dateTimeValue>, <numberOfDays>);",
328
+ "returns": "Date-Time",
329
+ "overview": "The addDay() function takes dateTimeValue and numberOfDays as arguments.",
330
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nNUMBER\n\n<dateTimeValue>\nThe date-time value to which the specified number of days will be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2 "
331
+ },
332
+ {
333
+ "category": "Date-time",
334
+ "name": "addHour",
335
+ "syntax": "<variable> = <dateTimeValue>.addHour(<numberOfHours>);\n\n(OR)\n\n<variable> = addHour(<dateTimeValue>, <numberOfHours>);\n\n(OR)\n\n<variable> = <timeValue>.addHour(<numberOfHours>);\n\n(OR)\n\n<variable> = addHour(<timeValue>, <numberOfHours>);",
336
+ "returns": "The return type of the function depends on the value it acts",
337
+ "overview": "The addHour function takes a date-time or time value and numberOfHours as arguments.",
338
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value to which the specified number of hours should be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour val"
339
+ },
340
+ {
341
+ "category": "Date-time",
342
+ "name": "addMinutes",
343
+ "syntax": "<variable> = <dateTimeValue>.addMinutes(<numberOfMins>);\n\n(OR)\n\n<variable> = addMinutes(<dateTimeValue>, <numberOfMins>);\n\n(OR)\n\n<variable> = <timeValue>.addMinutes(<numberOfMins>);\n\n(OR)\n\n<variable> = addMinutes(<timeValue>, <numberOfMins>);",
344
+ "returns": "The return type of the function depends on the value it acts",
345
+ "overview": "The addMinutes function takes a date-time or time value and numberOfMins as arguments.",
346
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value to which the specified number of hours should be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour val"
347
+ },
348
+ {
349
+ "category": "Date-time",
350
+ "name": "addMonth",
351
+ "syntax": "<variable>=<dateTimeValue>.addMonth(<numberOfMonths>);\n(OR)\n<variable>=addMonth(<dateTimeValue>, <numberOfMonths>);",
352
+ "returns": "Date-Time",
353
+ "overview": "The addMonth() function takes dateTimeValue and numberOfMonths as arguments.",
354
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nNUMBER\n\n<dateTimeValue>\nThe date-time value to which the specified number of months will be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than "
355
+ },
356
+ {
357
+ "category": "Date-time",
358
+ "name": "addSeconds",
359
+ "syntax": "<variable> = <dateTimeValue>.addSeconds(<numberOfSecs>);\n\n(OR)\n\n<variable> = addSeconds(<dateTimeValue>, <numberOfSecs>);\n\n(OR)\n\n<variable> = <timeValue>.addSeconds(<numberOfSecs>);\n\n(OR)\n\n<variable> = addSeconds(<timeValue>, <numberOfSecs>);",
360
+ "returns": "The return type of the function depends on the value it acts",
361
+ "overview": "The addSecondsfunction takes a date-time or time value and numberOfSecs as arguments.",
362
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value to which the specified number of seconds should be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour v"
363
+ },
364
+ {
365
+ "category": "Date-time",
366
+ "name": "addWeek",
367
+ "syntax": "<variable>=<dateTimeValue>.addWeek(<numberOfWeeks>);\n(OR)\n<variable>=addWeek(<dateTimeValue>, <numberOfWeeks>);",
368
+ "returns": "Number",
369
+ "overview": "The addWeek() function takes dateTimeValue and numberOfWeeks as arguments.",
370
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nNUMBER\n\n<dateTimeValue>\nThe date-time value to which the specified number of weeks will be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2"
371
+ },
372
+ {
373
+ "category": "Date-time",
374
+ "name": "addYear",
375
+ "syntax": "<variable>=<dateTimeValue>.addYear(<numberOfYears>);\n(OR)\n<variable>=addYear(<dateTimeValue>, <numberOfYears>);",
376
+ "returns": "Date-Time",
377
+ "overview": "The addYear() function takes dateTimeValue and numberOfYears as arguments.",
378
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nNUMBER\n\n<dateTimeValue>\nThe date-time value to which the specified number of years will be added.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2"
379
+ },
380
+ {
381
+ "category": "Date-time",
382
+ "name": "day",
383
+ "syntax": "<variable> = <dateTimeValue>.day();\n(OR)\n<variable> = day(<dateTimeValue>);\n(OR)\n<variable>= <dateTimeValue>.getDay();\n(OR)\n<variable> = getDay(<dateTimeValue>);",
384
+ "returns": "Number",
385
+ "overview": "The day() function takes a dateTimeValue as an argument, and returns the date value from it.",
386
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value from which the date value will be returned.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported d"
387
+ },
388
+ {
389
+ "category": "Date-time",
390
+ "name": "days360",
391
+ "syntax": "<variable> = <startDateTimeValue>.days360( <endDateTimeValue> );\n(OR)\n<variable> = days360(<startDateTimeValue>, <endDateTimeValue> );",
392
+ "returns": "Number",
393
+ "overview": "The days360() function takes startDateTimeValue and endDateTimeValue as arguments.",
394
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<startDateTimeValue>\nThe starting date-time value.\nDATE-TIME\n\n<endDateTimeValue>\nThe ending date-time value.\nDATE-TIME\n\nNote:\nRefer this help document to learn about the supported date-time formats.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2 digits.\nthe date value exceeds the number of days in that month. an incorrect month value is specified.\nthe year value has more than 4 digits."
395
+ },
396
+ {
397
+ "category": "Date-time",
398
+ "name": "daysBetween",
399
+ "syntax": "<variable> = <startDateValue>.daysBetween( <endDateValue>);\n(OR)\n<variable> = daysBetween(<startDateValue>,<endDateValue>);",
400
+ "returns": "Number",
401
+ "overview": "The daysBetween function takes startDateValue and endDateValue as arguments and returns the number of days between them.",
402
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the number of days between the given start and end dates.\n\n<startDateValue>\nDATE-TIME\nThe starting date.\n\n<endDateValue>\nDATE-TIME\nThe ending date.\n\nA runtime error will be encountered if: \nthe hour value, or minute value, or second value, is specified in more than 2 digits\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported date-time formats."
403
+ },
404
+ {
405
+ "category": "Date-time",
406
+ "name": "edate",
407
+ "syntax": "<variable> = <dateTimeValue>.edate(<numberOfMonths> );\n(OR)\n<variable >= edate(<dateTimeValue>, <numberOfMonths>);",
408
+ "returns": "Date-Time",
409
+ "overview": "The edate() function takes dateTimeValue and numberOfMonths as arguments.",
410
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value to which the specified number of months will be added.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported date-time formats.\n\nDATE-TIME\n\n<numberOfMonths>\nVariable which will contain the returned date-tim"
411
+ },
412
+ {
413
+ "category": "Date-time",
414
+ "name": "eomonth",
415
+ "syntax": "<variable>=<dateTimeValue>.eomonth(<numberOfMonths>);\n(OR)\n<variable>=eomonth(<dateTimeValue>, <numberOfMonths>);",
416
+ "returns": "Date-Time",
417
+ "overview": "The eomonth() function takes dateTimeValue and numberOfMonths as arguments.",
418
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value to which the specified number of months will be added, and the last date value will be returned from the resulted date-time value.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe year value has more than 4 digits.\nRefer this help document to learn about the supported date-time formats.\n\nDATE-TIM"
419
+ },
420
+ {
421
+ "category": "Date-time",
422
+ "name": "getYear",
423
+ "syntax": "<variable> = <dateTimeValue>.getYear();\n(OR)\n<variable> = getYear( <dateTimeValue> );\n(OR)\n<variable> = <dateTimeValue>.year();\n(OR)\n<variable> = year( <dateTimeValue> );",
424
+ "returns": "Number",
425
+ "overview": "The getYear() function takes a dateTimeValue as an argument, and returns the year value from it.",
426
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value from which the year value will be returned.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 di"
427
+ },
428
+ {
429
+ "category": "Date-time",
430
+ "name": "getDay",
431
+ "syntax": "<variable> = <dateTimeValue>.getDay();\n(OR)\n<variable> = getDay( <dateTimeValue>);\n(OR)\n<variable> = <dateTimeValue>.day();\n(OR)\n<variable> = day( <dateTimeValue>);",
432
+ "returns": "Number",
433
+ "overview": "The getDay() function takes a dateTimeValue as an argument, and returns the date value from it.",
434
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value from which the date value will be returned.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 di"
435
+ },
436
+ {
437
+ "category": "Date-time",
438
+ "name": "getDayOfYear",
439
+ "syntax": "<variable> = <dateTimeValue>.getDayOfYear();\n where,",
440
+ "returns": "Number",
441
+ "overview": "The getDayOfYear function takes a dateTimeValue as an argument, and returns a number representing the day of the year on which the specified dateTimeValue falls.",
442
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number of the day in the year.\nNUMBER\n\n<dateTimeValue>\nThe date-time value based on which a number will be returned.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date"
443
+ },
444
+ {
445
+ "category": "Date-time",
446
+ "name": "getHour",
447
+ "syntax": "<variable> = <dateTimeValue>.getHour();\n\n(OR)\n\n<variable> = getHour(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getHour();\n\n(OR)\n\n<variable> = getHour(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.hour();\n\n(OR)\n\n<variable> = hour(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.hour();\n\n(OR)\n\n<variable> = hour(<timeValue>);",
448
+ "returns": "NUMBER",
449
+ "overview": "The getHour function takes a date-time or time value and returns the hour value.",
450
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the hours returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the hours component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second va"
451
+ },
452
+ {
453
+ "category": "Date-time",
454
+ "name": "getMinutes",
455
+ "syntax": "<variable> = <dateTimeValue>.getMinutes();\n\n(OR)\n\n<variable> = getMinutes(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getMinutes();\n\n(OR)\n\n<variable> = getMinutes(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.minute();\n\n(OR)\n\n<variable> = minute(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.minute();\n\n(OR)\n\n<variable> = minute(<timeValue>);",
456
+ "returns": "NUMBER",
457
+ "overview": "The getMinutes function takes a date-time or time value and returns the minute value.",
458
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the minutes returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the minutes component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or secon"
459
+ },
460
+ {
461
+ "category": "Date-time",
462
+ "name": "getMonth",
463
+ "syntax": "<variable> = <dateTimeValue>.getMonth();\n(OR)\n<variable> = getMonth( <dateTimeValue>);\n(OR)\n<variable> = <dateTimeValue>.month();\n(OR)\n<variable> = month( <dateTimeValue>);",
464
+ "returns": "Number",
465
+ "overview": "The getMonth() function takes a dateTimeValue as an argument, and returns the numerical value of the month.",
466
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value from which the month's numerical value will be returned.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 digits.\nRefer this help document to learn about the suppo"
467
+ },
468
+ {
469
+ "category": "Date-time",
470
+ "name": "getSeconds",
471
+ "syntax": "<variable> = <dateTimeValue>.getSeconds();\n\n(OR)\n\n<variable> = getSeconds(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getSeconds();\n\n(OR)\n\n<variable> = getSeconds(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.second();\n\n(OR)\n\n<variable> = second(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.second();\n\n(OR)\n\n<variable> = second(<timeValue>);",
472
+ "returns": "NUMBER",
473
+ "overview": "The getSeconds function takes a date-time or time value and returns the seconds value.",
474
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the seconds returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the seconds component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or secon"
475
+ },
476
+ {
477
+ "category": "Date-time",
478
+ "name": "getWeekOfYear",
479
+ "syntax": "<variable> = <dateTimeValue>.getWeekOfYear([start_day]);\n(OR)\n<variable> = getWeekOfYear( <dateTimeValue>, [start_day]);",
480
+ "returns": "Number",
481
+ "overview": "The getWeekOfYear() function takes a dateTimeValue as an argument, and returns a number representing the week of the year in which the specified dateTimeValue falls.",
482
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned number.\n\n<dateTimeValue>\nDATE-TIME\nThe date-time value based on which a number will be returned.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is spe"
483
+ },
484
+ {
485
+ "category": "Date-time",
486
+ "name": "hour",
487
+ "syntax": "<variable> = <dateTimeValue>.hour();\n\n(OR)\n\n<variable> = hour(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.hour();\n\n(OR)\n\n<variable> = hour(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.getHour();\n\n(OR)\n\n<variable> = getHour(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getHour();\n\n(OR)\n\n<variable> = getHour(<timeValue>);",
488
+ "returns": "NUMBER",
489
+ "overview": "The hour function takes a date-time or time value and returns the hour value.",
490
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the hours returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the hours component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second va"
491
+ },
492
+ {
493
+ "category": "Date-time",
494
+ "name": "hoursBetween",
495
+ "syntax": "<variable> = <startDateTimeValue>.hoursBetween(<endDateTimeValue>);\n\n(OR)\n\n<variable> = hoursBetween(<startDateTimeValue>, <endDateTimeValue>);",
496
+ "returns": "Number",
497
+ "overview": "The hoursBetween function takes two date-time values as arguments and returns the number of hours between them.",
498
+ "params": "where:\nParameter\nData type\nDescription\n\nvariable\nNUMBER\nThe number of hours between the specified start and end date-time values,\n\nstartDateTimeValue\nDATE-TIME\nThe starting date-time value.\n\nendDateTimeValue\nDATE-TIME\nThe ending date-time value.\n\nNote:Please refer this help document to learn about the supported date-time formats.\nThis function does not calculate the minutes and seconds difference between the start and end time.\nIf the start date-time is larger than the end date-time, the function returns a negative value.\nA runtime error will be encountered if:Date value exceeds the number of days in that month.\nIncorrect month value is specified.\nIncorrect year value is specified."
499
+ },
500
+ {
501
+ "category": "Date-time",
502
+ "name": "minute",
503
+ "syntax": "<variable> = <dateTimeValue>.minute();\n\n(OR)\n\n<variable> = minute(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.minute();\n\n(OR)\n\n<variable> = minute(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.getMinutes();\n\n(OR)\n\n<variable> = getMinutes(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getMinutes();\n\n(OR)\n\n<variable> = getMinutes(<timeValue>);",
504
+ "returns": "NUMBER",
505
+ "overview": "The minute function takes a date-time or time value and returns the minute value.",
506
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the minutes returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the minutes component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or secon"
507
+ },
508
+ {
509
+ "category": "Date-time",
510
+ "name": "month",
511
+ "syntax": "<variable> = <dateTimeValue>.month();\n(OR)\n<variable> = month(<dateTimeValue>);\n(OR)\n<variable> = <dateTimeValue>.getMonth();\n(OR)\n<variable> = getMonth(<dateTimeValue>);",
512
+ "returns": "Number",
513
+ "overview": "The month() function takes a dateTimeValue as an argument and returns the numerical value of the month.",
514
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value from which the month's numerical value will be returned.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about th"
515
+ },
516
+ {
517
+ "category": "Date-time",
518
+ "name": "monthsBetween",
519
+ "syntax": "<variable> = <startDateTimeValue>.monthsBetween(<endDateTimeValue>);\n(OR)\n<variable> = monthsBetween(<startDateTimeValue>,<endDateTimeValue>);",
520
+ "returns": "Number",
521
+ "overview": "The monthsBetween() function takes startDateTimeValue and endDateTimeValue as arguments.",
522
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<startDateTimeValue>\nThe starting date-time value.\n\nDATE-TIME\n\n<endDateTimeValue>\nThe ending date-time value.\n\nDATE-TIME\n\nNote:The time value is not taken into account while using this function.\nPlease refer this help document to learn about the supported date-time formats.\nA runtime error will be encountered in Zoho Creator if:\nthe hour value, or minute value, or second value, is specified in more than 2 digits.\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe year value has more than 4 digits."
523
+ },
524
+ {
525
+ "category": "Date-time",
526
+ "name": "now",
527
+ "syntax": "<variable> = now;",
528
+ "returns": "Date-Time",
529
+ "overview": "The now function returns the current date-time value, in the format selected in Application settings.",
530
+ "params": ""
531
+ },
532
+ {
533
+ "category": "Date-time",
534
+ "name": "second",
535
+ "syntax": "<variable> = <dateTimeValue>.second();\n\n(OR)\n\n<variable> = second(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.second();\n\n(OR)\n\n<variable> = second(<timeValue>);\n\n(OR)\n\n<variable> = <dateTimeValue>.getSeconds();\n\n(OR)\n\n<variable> = getSeconds(<dateTimeValue>);\n\n(OR)\n\n<variable> = <timeValue>.getSeconds();\n\n(OR)\n\n<variable> = getSeconds(<timeValue>);",
536
+ "returns": "NUMBER",
537
+ "overview": "The second function takes a date-time or time value and returns the seconds value.",
538
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the seconds returned.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the seconds component should be obtained.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or secon"
539
+ },
540
+ {
541
+ "category": "Date-time",
542
+ "name": "subBusinessDay",
543
+ "syntax": "<variable> = <dateTimeValue>.subBusinessDay(<numberOfBusinessDays>, [<weekends>], [<holidays>]);\n\n(OR)\n\n<variable> = subBusinessDay(<dateTimeValue>, <numberOfBusinessDays>, [<weekends>], [<holidays>]);",
544
+ "returns": "Date-Time",
545
+ "overview": "The subBusinessDay() function takes dateTimeValue and numberOfBusinessDays as arguments.",
546
+ "params": "Parameter\nData type\nDescription\n\nvariable\nDATE-TIME\nVariable which will contain the returned date-time value.\n\ndateTimeValue\nDATE-TIME\nThe date-time value from which the specified number of business days will be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is "
547
+ },
548
+ {
549
+ "category": "Date-time",
550
+ "name": "subDay",
551
+ "syntax": "<variable> = <dateTimeValue>.subDay( <numberOfDays> );\n(OR)\n<variable> = subDay( <dateTimeValue>, <numberOfDays> );",
552
+ "returns": "Date-Time",
553
+ "overview": "The subDay() function takes dateTimeValue and numberOfDays as arguments.",
554
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value from which the specified number of days will be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in mo"
555
+ },
556
+ {
557
+ "category": "Date-time",
558
+ "name": "subHour",
559
+ "syntax": "<variable> = <dateTimeValue>.subHour(<numberOfHours>);\n\n(OR)\n\n<variable> = subHour(<dateTimeValue>, <numberOfHours>);\n\n(OR)\n\n<variable> = <timeValue>.subHour(<numberOfHours>);\n\n(OR)\n\n<variable> = subHour(<timeValue>, <numberOfHours>);",
560
+ "returns": "The return type of the function depends on the value it acts",
561
+ "overview": "The subHourfunction takes a date-time or time value and numberOfHours as arguments.",
562
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the specified number of hours should be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe h"
563
+ },
564
+ {
565
+ "category": "Date-time",
566
+ "name": "subMinutes",
567
+ "syntax": "<variable> = <dateTimeValue>.subMinutes(<numberOfMins>);\n\n(OR)\n\n<variable> = subMinutes(<dateTimeValue>, <numberOfMins>);\n\n(OR)\n\n<variable> = <timeValue>.subMinutes(<numberOfMins>);\n\n(OR)\n\n<variable> = subMinutes(<timeValue>, <numberOfMins>);",
568
+ "returns": "The return type of the function depends on the value it acts",
569
+ "overview": "The subMinutes function takes a date-time or time value and numberOfMins as arguments.",
570
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the specified number of minutes should be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe"
571
+ },
572
+ {
573
+ "category": "Date-time",
574
+ "name": "subMonth",
575
+ "syntax": "<variable> = <dateTimeValue>.subMonth( <numberOfMonths> );\n(OR)\n<variable> = subMonth( <dateTimeValue>, <numberOfMonths> );",
576
+ "returns": "Date-Time",
577
+ "overview": "The subMonth() function takes dateTimeValue and numberOfMonths as arguments.",
578
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value from which the specified number of months will be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in "
579
+ },
580
+ {
581
+ "category": "Date-time",
582
+ "name": "subSeconds",
583
+ "syntax": "<variable> = <dateTimeValue>.subSeconds(<numberOfSecs>);\n\n(OR)\n\n<variable> = subSeconds(<dateTimeValue>, <numberOfSecs>);\n\n(OR)\n\n<variable> = <timeValue>.subSeconds(<numberOfSecs>);\n\n(OR)\n\n<variable> = subSeconds(<timeValue>, <numberOfSecs>);",
584
+ "returns": "The return type of the function depends on the value it acts",
585
+ "overview": "The subSeconds function takes a date-time or time value and numberOfSecs as arguments.",
586
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDATE-TIME/TIME\nVariable which will contain the calculated date-time or time value.\n\n<dateTimeValue>(if the value is date-time)\n\nDATE-TIME\nThe date-time value from which the specified number of seconds should be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe"
587
+ },
588
+ {
589
+ "category": "Date-time",
590
+ "name": "subWeek",
591
+ "syntax": "<variable> = <dateTimeValue>.subWeek( <numberOfWeeks> );\n(OR)\n<variable> = subWeek( <dateTimeValue>, <numberOfWeeks> );",
592
+ "returns": "Date-Time",
593
+ "overview": "The subWeek() function takes dateTimeValue and numberOfWeeks as arguments.",
594
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value from which the specified number of weeks will be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in m"
595
+ },
596
+ {
597
+ "category": "Date-time",
598
+ "name": "subYear",
599
+ "syntax": "<variable> = <dateTimeValue>.subYear( <numberOfYears> );\n(OR)\n<variable> = subYear( <dateTimeValue>, <numberOfYears> );",
600
+ "returns": "Date-Time",
601
+ "overview": "The subYear() function takes dateTimeValue and numberOfYears as arguments.",
602
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe date-time value from which the specified number of years will be subtracted.\nThe date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.\nIf the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in m"
603
+ },
604
+ {
605
+ "category": "Date-time",
606
+ "name": "today",
607
+ "syntax": "<variable> = today;",
608
+ "returns": "Date-Time",
609
+ "overview": "The today function returns the current date value (without the time value, time value is set as 00:00:00), in the format selected in your service settings.",
610
+ "params": ""
611
+ },
612
+ {
613
+ "category": "Date-time",
614
+ "name": "toStartOfMonth",
615
+ "syntax": "<variable> = <dateTimeValue>.toStartOfMonth();\n(OR)\n<variable> = toStartOfMonth(<dateTimeValue>);",
616
+ "returns": "Date-Time",
617
+ "overview": "The toStartOfMonth() function takes a dateTimeValue as an argument, and returns the starting date of the month the dateTimeValue falls in.",
618
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe starting date of the month this date-time falls in, will be returned.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year va"
619
+ },
620
+ {
621
+ "category": "Date-time",
622
+ "name": "toStartOfWeek",
623
+ "syntax": "<variable> = <dateTimeValue>.toStartOfWeek();\n(OR)\n<variable> = toStartOfWeek(<dateTimeValue>);",
624
+ "returns": "Date-Time",
625
+ "overview": "The toStartOfWeek() function takes a dateTimeValue as an argument, and returns the starting date of the week the dateTimeValue falls in.",
626
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned date-time value.\nDATE-TIME\n\n<dateTimeValue>\nThe starting date of the week this date-time value falls in, will be returned.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe ye"
627
+ },
628
+ {
629
+ "category": "Date-time",
630
+ "name": "totalMonths",
631
+ "syntax": "<variable> = <startDateTimeValue>.totalMonths(<endDateTimeValue>);\n(OR)\n<variable> = totalMonths(<startDateTimeValue>, <endDateTimeValue>);",
632
+ "returns": "Number",
633
+ "overview": "The totalMonths() function takes startDateTimeValue and endDateTimeValue as arguments.",
634
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned number.\n\n<startDateTimeValue>\nDATE-TIME\nThe starting date-time value.\n\n<endDateTimeValue>\nDATE-TIME\nThe ending date-time value.\n\nNote:The time value is not taken into account while using this function.\nPlease refer this help document to learn about the supported date-time formats."
635
+ },
636
+ {
637
+ "category": "Date-time",
638
+ "name": "totalYears",
639
+ "syntax": "<variable> = <startDateTimeValue>.totalYears(<endDateTimeValue>);\n(OR)\n<variable> = totalYears(<startDateTimeValue>,<endDateTimeValue>);",
640
+ "returns": "Number",
641
+ "overview": "The totalYears() function takes startDateTimeValue and endDateTimeValue as arguments.",
642
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned number.\n\n<startDateTimeValue>\nDATE TIME\nThe starting date-time value.\n\n<endDateTimeValue>\nDATE TIME\nThe ending date-time value.\n\nA runtime error will be encountered if:\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported date-time formats."
643
+ },
644
+ {
645
+ "category": "Date-time",
646
+ "name": "unixEpoch",
647
+ "syntax": "<variable> = <dateText>.unixEpoch([<timeZone>]);",
648
+ "returns": "NUMBER",
649
+ "overview": "The unixEpoch function calculates the number of milliseconds that have elapsed since 00:00:00 UTC on 1 January 1970.",
650
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned value.\n\n<dateText>\nTEXT\nThe expression which will be returned in text format.\n\n<timeZone>\n(optional)\n\nTEXT\nTime zone in which the time elapsed in milliseconds should be calculated.\nValue must be specified exactly as given in the TZ database name.\n\nIf no timezone or an invalid timezone is provided, the timezone is defaulted to GMT."
651
+ },
652
+ {
653
+ "category": "Date-time",
654
+ "name": "weekday",
655
+ "syntax": "<variable> = <dateTimeValue>.weekday();\n(OR)\n<variable> = weekday(<dateTimeValue>);\n(OR)\n<variable> = <dateTimeValue>.getDayOfWeek();\n(OR)\n<variable> = getDayOfWeek(<dateTimeValue>);",
656
+ "returns": "Number",
657
+ "overview": "The weekday() function takes a dateTimeValue as an argument, and returns a number representing the day of the week on which the specified dateTimeValue falls.",
658
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<dateTimeValue>\nThe date-time value based on which a number will be returned.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe specified 2 digit date value exceeds the number of days in that month.\nan incorrect month value is specified in 3 or more characters.\nThe function returns a null value if:\nthe month value is specified in less than 3 characters.\nthe hour value, or the minutes value, or the seconds value is specified in more than 2 digits.\nthe date value is specified in more than 2 digits.\nthe year value has more than 4 digi"
659
+ },
660
+ {
661
+ "category": "Date-time",
662
+ "name": "workday",
663
+ "syntax": "<variable> = <dateTimeValue>.workday( <numberOfBusinessDays>, [<weekends>], [<holidays>]);\n(OR)\n<variable> = workday(<dateTimeValue>, <numberOfBusinessDays>, [<weekends>], [<holidays>]);",
664
+ "returns": "Date-Time",
665
+ "overview": "The workday() function takes dateTimeValue and numberOfBusinessDays as arguments.",
666
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nDATE-TIME\nVariable which will contain the returned date value.\n\n<dateTimeValue>\nDATE-TIME\nThe date-time value to which the specified number of business days will be added.\nThe time value is not taken into account while using this function.\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2 digits.\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported date-time formats.\nNote: \nIn services other than Zoho Creator, the value of this parameter can"
667
+ },
668
+ {
669
+ "category": "Date-time",
670
+ "name": "yearsBetween",
671
+ "syntax": "<variable> = <startDateTimeValue>.yearsBetween(<endDateTimeValue>);\n(OR)\n<variable> = yearsBetween(<startDateTimeValue>,<endDateTimeValue>);",
672
+ "returns": "Number",
673
+ "overview": "The yearsBetween() function takes startDateTimeValue and endDateTimeValue as arguments.",
674
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<startDateTimeValue>\nThe starting date-time value.\n\nDATE TIME\n\n<endDateTimeValue>\nThe ending date-time value..\n\nDATE TIME\n\nA runtime error will be encountered if:\nthe hour value, or minute value, or second value, is specified in more than 2 digits\nthe date value exceeds the number of days in that month.\nan incorrect month value is specified.\nthe year value has more than 4 digits.\nPlease refer this help document to learn about the supported date-time formats."
675
+ },
676
+ {
677
+ "category": "Encryption",
678
+ "name": "aesDecode",
679
+ "syntax": "<variable> = zoho.encryption.aesDecode(<encryption_key>, <encrypted_value>, <encryption_iv>);",
680
+ "returns": "TEXT",
681
+ "overview": "The aesDecode function takes encryption_key and encrypted_value as arguments, and returns the decrypted (original) text using AES (Advanced Encryption Standard).",
682
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the decrypted text value.\n\n<encryption_key>\nTEXT\nThe key used during encryption of the text.\n\n<encrypted_value>\nTEXT\nThe encrypted text that need to be decrypted.\n\n<encryption_iv>\n(optional)\n\nTEXT\nAn initialization vector that offers stronger security for the encryption.\nNote:This parameter should be of 16 characters.\nThe same IV number that is used for encryption should be provided while decrypting the encrypted text."
683
+ },
684
+ {
685
+ "category": "Encryption",
686
+ "name": "aesDecode128",
687
+ "syntax": "<variable> = zoho.encryption.aesDecode128(<encryption_key>, <encrypted_value>, <encryption_iv>, <iteration_count>);",
688
+ "returns": "TEXT",
689
+ "overview": "The aesDecode128 function takes encryption_key and encrypted_value as arguments, and returns the decrypted (original) text using AES (Advanced Encryption Standard).",
690
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the decrypted text value.\n\n<encryption_key>\nTEXT\nThe key used during encryption of the text.\n\n<encrypted_value>\nTEXT\nThe encrypted text that need to be decrypted.\n\n<encryption_iv>\n(optional)\n\nTEXT\nAn initialization vector that offers stronger security for the encryption.\nNote:This parameter should be of 16 characters.\nThe same IV number that is used for encryption should be provided while decrypting the encrypted text.\n\n<iteration count>\n(optional)\n\nTEXT\nThe number of times the function is repeatedly performed to produce the final encryption key. By default, this number is 0 if this parameter is not included."
691
+ },
692
+ {
693
+ "category": "Encryption",
694
+ "name": "aesEncode",
695
+ "syntax": "<variable> = zoho.encryption.aesEncode(<encryption_key>, <encryption_value>, <encryption_iv>);",
696
+ "returns": "TEXT",
697
+ "overview": "The aesEncode function takes encryption_key and encryption_value as arguments, and returns an encrypted text using AES (Advanced Encryption Standard).",
698
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the encrypted text.\n\n<encryption_key>\nTEXT\nThe key used during encryption of the text.\nNote:\nThe same <encryption_key> needs to be used while performing decryption.\n\n<encryption_value>\nTEXT\nThe piece of text that needs to be encrypted.\n\n<encryption_iv>\n(optional)\n\nTEXT\nAn initialization vector that offers stronger security for encryption.\nNote:\nThis parameter should be of 16 characters.\nThe same IV number that is used for encryption should be provided while decrypting the encrypted text."
699
+ },
700
+ {
701
+ "category": "Encryption",
702
+ "name": "aesEncode128",
703
+ "syntax": "<variable> = zoho.encryption.aesEncode128(<encryption_key>, <encryption_value>, <encryption_iv>, <iteration_count>);",
704
+ "returns": "TEXT",
705
+ "overview": "The aesEncode128 function takes encryption_key and encryption_value as arguments, and returns an encrypted text using AES (Advanced Encryption Standard).",
706
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the encrypted text.\n\n<encryption_key>\nTEXT\nThe key used during encryption of the text.\nNote: \nThe <encryption_key> needs to be used while performing decryption.\nThe <encryption_key> can contain upto 16 characters.\n\n<encryption_value>\nTEXT\nThe piece of text that needs to be encrypted.\n\n<encryption_iv>\n(optional)\n\nTEXT\nAn initialization vector that offers stronger security for the encryption.\nNote:\nThis parameter should be of 16 characters.\nThe same IV number that is used for encryption should be provided while decrypting the encrypted text.\n\n<iteration_count>\n(optional)\n\nTEXT\nThe number of times the function i"
707
+ },
708
+ {
709
+ "category": "Encryption",
710
+ "name": "urlDecode",
711
+ "syntax": "<variable> = zoho.encryption.urlDecode( <string> );",
712
+ "returns": "Text",
713
+ "overview": "The urlDecode() function takes an encoded text as an argument, and returns it after decrypting it.",
714
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nTEXT\n\n<string>\nThe text to be decrypted.\nExcept TEXT, all other data types will return null. \n\nTEXT"
715
+ },
716
+ {
717
+ "category": "Encryption",
718
+ "name": "urlEncode",
719
+ "syntax": "<variable> = zoho.encryption.urlEncode( <string> );",
720
+ "returns": "Text",
721
+ "overview": "The urlEncode() function takes a text as an argument, and returns it after encoding it.",
722
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nTEXT\n\n<string>\nThe text to be encoded.\nExcept TEXT, all other data types will return null. \n\nTEXT"
723
+ },
724
+ {
725
+ "category": "List",
726
+ "name": "add",
727
+ "syntax": "<listVariable>.add( <addElement >);",
728
+ "returns": "",
729
+ "overview": "The add() function takes listVariable and addElement as arguments, and adds the specified element(addElement) to the list variable(listVariable).",
730
+ "params": "Parameter\nDescription\nData type\n\n<listVariable>\nThe list variable to which the element will be added.\nLIST\n\n<addElement>\nThe element to be added to the list.\nA list can be specified, but please note that it will be considered as an individual element in the parent list.\nElements of different data-types can be accommodated in the same list if the list is not restricted to a specific data type.\n\nLIST"
731
+ },
732
+ {
733
+ "category": "List",
734
+ "name": "addAll",
735
+ "syntax": "<listVariableOne>.addAll( <listVariableTwo> );",
736
+ "returns": "",
737
+ "overview": "The addAll() function takes listVariableOne and listVariableTwo as arguments, and adds all elements present in listVariableTwo to listVariableOne.",
738
+ "params": "Parameter\nDescription\nData type\n\n<listVariableOne>\nThe list variable to which the elements will be added .\nNUMBER\n\n<listVariableTwo>\nThe list variable whose elements will be added\nElements of different data-types can be accommodated in the same list if the list is not restricted to a specific data type\n\nLIST"
739
+ },
740
+ {
741
+ "category": "List",
742
+ "name": "clear",
743
+ "syntax": "<listVariable>.clear();",
744
+ "returns": "",
745
+ "overview": "The clear() function takes a listVariable as an argument, and removes all elements from the list.",
746
+ "params": "Parameter\nDescription\nData type\n\n<listVariable>\nThe list variable whose elements will be removed.\nNUMBER"
747
+ },
748
+ {
749
+ "category": "List",
750
+ "name": "contains",
751
+ "syntax": "<variable> = <listVariable>.contains( <searchElement> );",
752
+ "returns": "Boolean",
753
+ "overview": "The contains() function takes listVariable and searchElement as arguments.",
754
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned boolean value.\nBOOLEAN\n\n<listVariable>\nThe list variable in which the element will be searched for.\nLIST\n\n<searchElement>\nThe element to be searched for in the list variable.\nALL DATA TYPES"
755
+ },
756
+ {
757
+ "category": "List",
758
+ "name": "distinct",
759
+ "syntax": "<variable> = <listVariable>.distinct();",
760
+ "returns": "List",
761
+ "overview": "The distinct() function takes a listVariable as argument, and returns the list only with unique values in it.",
762
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned list.\nLIST\n\n<listVariable>\nThe list from which only unique elements will be returned.\nLIST"
763
+ },
764
+ {
765
+ "category": "List",
766
+ "name": "get",
767
+ "syntax": "<variable> = <listVariable>.get( <indexValue> );",
768
+ "returns": "The return type will depend on the data type of the returned",
769
+ "overview": "The get() function takes listVariable and indexValue as arguments.",
770
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned element.\nAS APPLICABLE\n\n<listVariable>\nThe list variable from which the element in the specified indexValue will be returned.\nLIST\n\n<indexValue>\nThe index of the element which will be returned.\nValue should not be a negative number. If a negative number is specified, a runtime error will be encountered.\nValue should not exceed the list size. Ideally, this limit will be list size minus 1, since index starts from 0.\n\nNUMBER"
771
+ },
772
+ {
773
+ "category": "List",
774
+ "name": "indexOf",
775
+ "syntax": "<variable> = <listVariable> .indexOf(<searchElement>);",
776
+ "returns": "Number",
777
+ "overview": "The indexOf() function takes listVariable and searchElement as arguments.",
778
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned index number.\nNUMBER\n\n<listVariable>\nThe list variable from which the index number of the element will be returned.\nLIST\n\n<searchElement>\nThe element whose first occurrence will be checked in the list.\nAS APPLICABLE"
779
+ },
780
+ {
781
+ "category": "List",
782
+ "name": "intersect",
783
+ "syntax": "<variable> = <listVariableOne>.intersect( <listVariableTwo> );",
784
+ "returns": "List",
785
+ "overview": "The intersect() function takes listVariableOne and listVariableTwo as arguments, and returns a list containing common elements from both the given lists.",
786
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned list.\nLIST\n\n<listVariableOne>\nThe first list variable from which the common elements will be returned.\nLIST\n\n<listVariableTwo>\nThe second list variable from which the common elements will be returned.\nLIST"
787
+ },
788
+ {
789
+ "category": "List",
790
+ "name": "lastIndexOf",
791
+ "syntax": "<variable> = <listVariable>.lastIndexOf( <searchElement> );",
792
+ "returns": "Number",
793
+ "overview": "The lastIndexOf() function takes listVariable and searchElement as arguments.",
794
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned index number.\nNUMBER\n\n<listVariable>\nThe list variable from which the index number of the element will be returned.\nLIST\n\n<searchElement>\nThe element whose last occurrence will be checked in the list.\nAS APPLICABLE"
795
+ },
796
+ {
797
+ "category": "List",
798
+ "name": "remove",
799
+ "syntax": "<variable> = <listVariable>.remove( <indexValue> );",
800
+ "returns": "Text",
801
+ "overview": "The remove() function takes listVariable and indexValue as arguments.",
802
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<listVariable>\nLIST\nThe list variable from which the element will be removed and returned.\n\n<indexValue>\nNUMBER\nThe index of the element which will be removed from the list, and returned.\nValue should not be a negative number. If a negative number is specified, a runtime error will be encountered.\nValue should not exceed the list size. Ideally, this limit will be list size minus 1, since index starts from 0."
803
+ },
804
+ {
805
+ "category": "List",
806
+ "name": "removeAll",
807
+ "syntax": "<listVariable>.removeAll(<removeListVariable>);",
808
+ "returns": "",
809
+ "overview": "The removeAll() function takes listVariable and removeListVariable as arguments.",
810
+ "params": "Parameter\nDescription\nData type\n\n<listVariable>\nThe list variable from which the elements present in removeListVariable will be removed.\nLIST\n\n<removeListVariable>\nThe elements present in this list will be removed from listVariable.\nIf removeListVariable is not found, listVariable will be returned as it is.\n\nLIST"
811
+ },
812
+ {
813
+ "category": "List",
814
+ "name": "removeElement",
815
+ "syntax": "<listVariable>.removeElement(<searchElement>);",
816
+ "returns": "",
817
+ "overview": "The removeElement() function takes listVariable and searchElement as arguments, and removes the searchElement from listVariable.",
818
+ "params": "Parameter\nDescription\nData type\n\n<listVariable>\nThe list variable from which the element will be removed.\nLIST\n\n<listVariable>\nThe element to be removed from the list.\nIf the searchElement is not found, the list is returned as it is.\nIf the list is a data type specific list, the data type of the specified value must match the data type of the list. If not, a runtime error will be encountered.\n\nAS APPLICABLE"
819
+ },
820
+ {
821
+ "category": "List",
822
+ "name": "size",
823
+ "syntax": "<variable> = <listVariable>.size();",
824
+ "returns": "Number",
825
+ "overview": "The size() function takes a listVariable as argument, and returns the count of elements in that list.",
826
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nNUMBER\n\n<listVariable>\nThe list variable whose count of elements will be returned.\nLIST"
827
+ },
828
+ {
829
+ "category": "List",
830
+ "name": "sort",
831
+ "syntax": "<variable> = <listVariable>.sort(<booleanValue>);",
832
+ "returns": "List",
833
+ "overview": "The sort() function takes listVariable and booleanValue as arguments.",
834
+ "params": "Parameter\nDescription\nData type\n\n<variable>\n(optional)\n\nVariable which will contain the returned list.\nLIST\n\n<listVariable>\nThe list variable whose elements will be sorted.\nIf the list contains elements of different data types, the function will return null.\n\nLIST\n\n<booleanValue>\n(optional)\n\nApplicable values are: true or false.\nBOOLEAN"
835
+ },
836
+ {
837
+ "category": "List",
838
+ "name": "subList",
839
+ "syntax": "<variable> = <listVariable>.subList( <start_index>, <end_index> );",
840
+ "returns": "List",
841
+ "overview": "The subList() function takes listVariable , start_index and end_index as arguments.",
842
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned list.\nLIST\n\n<listVariable>\nThe list from which the elements will be returned.\nLIST\n\n<start_index>\nThe index starting from which the elements will be returned from the list.\nIf a negative value is specified, an error will be encountered during runtime.\n\nNUMBER\n\n<end_index>\nThe index till which the elements will be returned from the string. If omitted, the rest of the list will be returned.\nThe end_index should not exceed the count of elements in the list. If it does, an error will be encountered during runtime.\n\nNUMBER"
843
+ },
844
+ {
845
+ "category": "List",
846
+ "name": "toListString",
847
+ "syntax": "<variable>=<expression>.toListString();",
848
+ "returns": "LIST",
849
+ "overview": "The toListString function converts comma-separated values into a list.",
850
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will contain the created list.\n\n<expression>\nLIST/TEXT\nThe set of values that should be converted as a list containing text items."
851
+ },
852
+ {
853
+ "category": "Key-value (Map)",
854
+ "name": "clear",
855
+ "syntax": "<mapVariable>.clear();",
856
+ "returns": "",
857
+ "overview": "The clear() function takes a mapVariable as an argument, and removes all key-values pairs from the map.",
858
+ "params": "Parameter\nDescription\nData type\n\n<mapVariable>\nThe map variable whose key-value pairs will be removed.\nKEY-VALUE"
859
+ },
860
+ {
861
+ "category": "Key-value (Map)",
862
+ "name": "containKey",
863
+ "syntax": "<variable> = <mapVariable>.containKey( <searchkey> );",
864
+ "returns": "Boolean",
865
+ "overview": "The containKey() function takes mapVariable and searchKey as arguments.",
866
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned boolean value.\nBOOLEAN\n\n<mapVariable>\nThe map variable in which the key will be searched for.\nKEY-VALUE\n\n<searchkey>\nThe key to be searched for in the map variable.\nTEXT"
867
+ },
868
+ {
869
+ "category": "Key-value (Map)",
870
+ "name": "containValue",
871
+ "syntax": "<variable> = <mapVariable>.containValue( <searchValue> );",
872
+ "returns": "Boolean",
873
+ "overview": "The containValue() function takes mapVariable and searchValue as arguments.",
874
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned boolean value..\nBOOLEAN\n\n<mapVariable>\nThe map variable in which the value will be searched for.\nKEY-VAlUE\n\n<searchValue>\nThe value to be searched for in the map variable.\nTEXT"
875
+ },
876
+ {
877
+ "category": "Key-value (Map)",
878
+ "name": "get",
879
+ "syntax": "<variable> = <mapVariable>.get(<searchkey>);",
880
+ "returns": "The return type will depend on the data type of the returned",
881
+ "overview": "The get() function takes mapVariable and searchKey as arguments.",
882
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nAS APPLICABLE\n\n<mapVariable>\nThe map variable from which the value will be returned.\nKEY-VALUE\n\n<searchkey>\nThe key whose corresponding value will be returned\nAS APPLICABLE"
883
+ },
884
+ {
885
+ "category": "Key-value (Map)",
886
+ "name": "isEmpty",
887
+ "syntax": "<variable> = <expression>.isEmpty();",
888
+ "returns": "BOOLEAN",
889
+ "overview": "The isEmpty function takes an expression as argument.",
890
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\nTEXT/LIST/MAP/COLLECTION\nVariable which will hold the expression awaiting the empty validation."
891
+ },
892
+ {
893
+ "category": "Key-value (Map)",
894
+ "name": "keys",
895
+ "syntax": "<variable> = <mapVariable>.keys();\n\n Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned list.\nList\n\n<mapVariable>\nThe map variable from which the keys will be returned.\nKEY-VALUE",
896
+ "returns": "List",
897
+ "overview": "The keys() function takes a mapVariable as argument, and returns all the keys in the map in a list format.",
898
+ "params": ""
899
+ },
900
+ {
901
+ "category": "Key-value (Map)",
902
+ "name": "put",
903
+ "syntax": "<mapVariable>.put( <key>, <value> );",
904
+ "returns": "",
905
+ "overview": "The put() function takes mapVariable, key and value as arguments, and adds the key-value pair to the mapVariable.",
906
+ "params": "Parameter\nDescription\nData type\n\n<mapVariable>\nThe map to which the key-value pair will be added.\nKEY-VALUE\n\n<key>\nThe key to be added to the map.\nIf a duplicate key is specified, its new value will overwrite its existing value, and the new key-value pair will not get added.\n\nKEY-VALUE\n\n<value>\nThe value to be added to the map.\nAS APPLICABLE"
907
+ },
908
+ {
909
+ "category": "Key-value (Map)",
910
+ "name": "putAll",
911
+ "syntax": "<mapVariableOne>.putAll( <mapVariableTwo> );",
912
+ "returns": "",
913
+ "overview": "The putAll() function takes mapVariableOne and mapVariableTwo as arguments, and adds all key-value pairs present in mapVariableTwo to mapVariableOne.",
914
+ "params": "Parameter\nDescription\nData type\n\n<mapVariableOne>\nThe map variable to which the key-value pairs will be added.\nKEY-VALUE\n\n<mapVariableTwo>\nThe map variable from which the value will be returned.\nIf a duplicate key is specified, its new value will overwrite the existing value in mapVariable1, and the new key-value pair will not get added.\n/td>\nKEY-VALUE"
915
+ },
916
+ {
917
+ "category": "Key-value (Map)",
918
+ "name": "remove",
919
+ "syntax": "<mapVariable>.remove( <key>);",
920
+ "returns": "",
921
+ "overview": "The remove() function takes mapVariable and key as arguments, and removes the specified key along with its value from mapVariable.",
922
+ "params": "Parameter\nDescription\nData type\n\n<mapVariable>\nThe map variable from which the key-value pair will be removed.\nKEY-VALUE\n\n<key>\nThe key which will be removed along with the value.\nIf the specified key is not found, mapVariable will be returned as it is.\n\nAS APPLICABLE"
923
+ },
924
+ {
925
+ "category": "Key-value (Map)",
926
+ "name": "size",
927
+ "syntax": "<variable>= <mapVariable>.size();",
928
+ "returns": "Number",
929
+ "overview": "The size() function takes a mapVariable as argument, and returns the count of key-value pairs in the map.",
930
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned number.\nNUMBER\n\n<mapVariable>\nThe map variable whose count of key-value pairs will be returned.\nKEY-VALUE"
931
+ },
932
+ {
933
+ "category": "Number",
934
+ "name": "abs",
935
+ "syntax": "<variable> = <number>.abs();\n(OR)\n<variable> = abs(<number> );",
936
+ "returns": "Decimal",
937
+ "overview": "The abs() function takes a number as an argument, and returns the absolute value of that number, i.e., the number without a sign.",
938
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose absolute value will be returned.\nNUMBER or DECIMAL"
939
+ },
940
+ {
941
+ "category": "Number",
942
+ "name": "acos",
943
+ "syntax": "<variable> = <number>.acos();\n(OR)\n<variable> = acos(<number> );",
944
+ "returns": "Decimal",
945
+ "overview": "The acos() function takes a number (representing a trignometric cosine) as an argument, and returns the angle (measured in radians) of that number.",
946
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose inverse cosine value will be returned.\nNUMBER or DECIMAL"
947
+ },
948
+ {
949
+ "category": "Number",
950
+ "name": "acosh",
951
+ "syntax": "<variable> = <number>.acosh();\n(OR)\n<variable> = acosh(<number>);",
952
+ "returns": "NUMBER",
953
+ "overview": "The acosh() function returns the hyperbolic arccosine or inverse hyperbolic cosine (in radians) of a number.",
954
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned hyperbolic arccosine.\n\n<number>\nNUMBER\nThe number whose hyperbolic arccosine value will be returned."
955
+ },
956
+ {
957
+ "category": "Number",
958
+ "name": "asin",
959
+ "syntax": "<variable> = <number>.asin();\n(OR)\n<variable> = asin(<number> );",
960
+ "returns": "Decimal",
961
+ "overview": "The asin() function takes a number (representing a trigonometric sine) as an argument, and returns the angle (measured in radians) of that number.",
962
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose inverse sine value will be returned.\nNUMBER or DECIMAL"
963
+ },
964
+ {
965
+ "category": "Number",
966
+ "name": "asinh",
967
+ "syntax": "<variable> = <number>.asinh();\n(OR)\n<variable> = asinh(<number>);",
968
+ "returns": "NUMBER",
969
+ "overview": "The asinh() function returns the hyperbolic arcsine or inverse hyperbolic sine (in radians) of a number.",
970
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned hyperbolic arcsine.\n\n<number>\nNUMBER\nThe number whose hyperbolic arcsine value will be returned."
971
+ },
972
+ {
973
+ "category": "Number",
974
+ "name": "atan",
975
+ "syntax": "<variable> = <number>.atan();\n(OR)\n<variable> = atan(<number> );",
976
+ "returns": "Decimal",
977
+ "overview": "The atan() function takes a number (representing a trigonometric tangent) as an argument, and returns the angle (measured in radians) of that number.",
978
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nNUMBER\n\n<number>\nThe number whose inverse tangent value will be returned.\nNUMBER or DECIMAL"
979
+ },
980
+ {
981
+ "category": "Number",
982
+ "name": "atan2",
983
+ "syntax": "<variable> = atan2(<y-axis>, <x-axis>);\n(or)<variable> = <y-axis>.atan2(<x-axis>);",
984
+ "returns": "NUMBER",
985
+ "overview": "The atan2() function returns the angle (in radians) between the positive x-axis and the ray from (0,0) to the specified point (x,y).",
986
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned value.\n\n<y-axis>\nNUMBER\nThe y-axis value of the point whose atan2 value needs to be returned.\n\n<x-axis>\nNUMBER\nThe x-axis value of the point whose atan2 value needs to be returned."
987
+ },
988
+ {
989
+ "category": "Number",
990
+ "name": "atanh",
991
+ "syntax": "<variable> = <number>.atanh();\n(OR)\n<variable> = atanh(<number>);",
992
+ "returns": "NUMBER",
993
+ "overview": "The atanh() function returns the hyperbolic arctangent or inverse hyperbolic tangent (in radians) of a number.",
994
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned hyperbolic arctangent.\n\n<number>\nNUMBER\nThe number whose hyperbolic arctangent value will be returned."
995
+ },
996
+ {
997
+ "category": "Number",
998
+ "name": "average",
999
+ "syntax": "<variable> = <numberList>.average();\n(OR)\n<variable> = average(<numberList> );",
1000
+ "returns": "Decimal",
1001
+ "overview": "The average() function takes numberList as an argument, and returns the average of numbers present in the list.",
1002
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe list from which the average value will be returned.\nNumerical values can be specified in double quotes.\n\nNUMBER LIST or DECIMAL LIST"
1003
+ },
1004
+ {
1005
+ "category": "Number",
1006
+ "name": "ceil",
1007
+ "syntax": "<variable> = <decimalValue>.ceil();\n(OR)\n<variable> = ceil( <decimalValue>);",
1008
+ "returns": "Number",
1009
+ "overview": "The ceil() function takes a decimalValue as an argument, and returns the nearest largest integer to the given decimal value.",
1010
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nNUMBER\n\n<decimalValue>\nThe nearest largest integer to this value will be returned.\nDECIMAL"
1011
+ },
1012
+ {
1013
+ "category": "Number",
1014
+ "name": "cos",
1015
+ "syntax": "<variable> = <number>.cos();\n(OR)\n<variable> = cos( <number> );",
1016
+ "returns": "Decimal",
1017
+ "overview": "The cos() function takes a number as an argument, and returns the trigonometric cosine of that number (angle measured in radians).",
1018
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose cosine value will be returned.\nNUMBER or DECIMAL"
1019
+ },
1020
+ {
1021
+ "category": "Number",
1022
+ "name": "cosh",
1023
+ "syntax": "<variable> = <number>.cosh();\n(OR)\n<variable> = cosh(<number>);",
1024
+ "returns": "NUMBER",
1025
+ "overview": "The cosh() function returns the hyperbolic cosine of the specified angle (in radians).",
1026
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned value.\n\n<number>\nNUMBER\nThe number whose hyperbolic cosine value will be returned."
1027
+ },
1028
+ {
1029
+ "category": "Number",
1030
+ "name": "exp",
1031
+ "syntax": "<variable> = <number>.exp();\n(OR)\n<variable> = exp(<number> );",
1032
+ "returns": "Decimal",
1033
+ "overview": "The exp() function takes a number as an argument, and returns the exponential value, of that number.",
1034
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nNUMBER\n\n<number>\nThe number whose exponential value will be returned.\nNUMBER or DECIMAL"
1035
+ },
1036
+ {
1037
+ "category": "Number",
1038
+ "name": "floor",
1039
+ "syntax": "<variable> = <decimalValue>.floor();\n(OR)\n<variable> = floor(<decimalValue> );",
1040
+ "returns": "Number",
1041
+ "overview": "The floor() function takes a decimalValue as an argument, and returns the nearest smallest integer to the given decimal value.",
1042
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nNUMBER\n\n<decimalValue>\nThe nearest smallest integer to this value will be returned.\nDECIMAL"
1043
+ },
1044
+ {
1045
+ "category": "Number",
1046
+ "name": "frac",
1047
+ "syntax": "<variable> = <inputNumber>.frac();\n\n(OR)\n<variable> = frac(<inputNumber>);",
1048
+ "returns": "Number",
1049
+ "overview": "The frac() function takes a decimalValue as an argument, and returns only the fraction part of the value.",
1050
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable that will contain the returned value.\n\n<inputNumber>\nNUMBER\nThe input number whose fraction part is required."
1051
+ },
1052
+ {
1053
+ "category": "Number",
1054
+ "name": "isEven",
1055
+ "syntax": "<variable> = <number>.isEven();\n\n(OR)\n\n<variable> = isEven(<number>);",
1056
+ "returns": "BOOLEAN",
1057
+ "overview": "The isEven function takes a number as argument and returns a true/false based on the parity of the number passed to it.",
1058
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which contains the result of the odd parity check (true/false)\n\n<number>\nNUMBER\nThe number value on which the odd parity check is performed."
1059
+ },
1060
+ {
1061
+ "category": "Number",
1062
+ "name": "isOdd",
1063
+ "syntax": "<variable> = <number>.isOdd();\n\n(OR)\n\n<variable> = isOdd(<number>);",
1064
+ "returns": "BOOLEAN",
1065
+ "overview": "The isOdd function takes a number as argument and returns a true/false based on the parity of the number passed to it.",
1066
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which contains the result of the odd parity check (true/false)\n\n<number>\nNUMBER\nThe number value on which the odd parity check is performed."
1067
+ },
1068
+ {
1069
+ "category": "Number",
1070
+ "name": "largest",
1071
+ "syntax": "<variable> = <numberList>.largest();\n(OR)\n<variable> = largest(<numberList> );",
1072
+ "returns": "Decimal",
1073
+ "overview": "The largest() function takes numberList as an argument, and returns the largest number from the list.",
1074
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<numberList>\nThe list from which the largest value will be returned.\nNumerical values can be specified in double quotes.\n\nNUMBER LIST or DECIMAL LIST"
1075
+ },
1076
+ {
1077
+ "category": "Number",
1078
+ "name": "log",
1079
+ "syntax": "<variable> = <number>.log();\n(OR)\n<variable> = log(<number> );",
1080
+ "returns": "Decimal",
1081
+ "overview": "The log() function takes a number as an argument, and returns the natural logarithm of that number.",
1082
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose natural logarithm value will be returned.\nValue which is equal to, or below 0, will return null.\n\nNUMBER or DECIMAL"
1083
+ },
1084
+ {
1085
+ "category": "Number",
1086
+ "name": "log10",
1087
+ "syntax": "<variable> = <number>.log10();\n\n(OR)\n\n<variable> = log10(<number>);",
1088
+ "returns": "DECIMAL",
1089
+ "overview": "The log10 function takes a number or decimal value as an argument, and returns the base 10 logarithmic value (log10) of that number.",
1090
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDECIMAL\nVariable which will contain the returned value\n\n<number>\nDECIMAL/NUMBER\nThe number whose log10 value needs to be determined.\nThis value has to be greater than 0."
1091
+ },
1092
+ {
1093
+ "category": "Number",
1094
+ "name": "max",
1095
+ "syntax": "<variable> = <numberOne>.max( <numberTwo> );\n(OR)\n<variable> = max(<numberOne>, <numberTwo> );",
1096
+ "returns": "Decimal",
1097
+ "overview": "The max() function takes numberOne and numberTwo as arguments, and returns the bigger number of the two.",
1098
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<numberOne>\nThe number which has to compared with numberTwo\nNUMBER or DECIMAL\n\n<numberTwo>\nThe number which has to compared with numberOne\nNUMBER or DECIMAL"
1099
+ },
1100
+ {
1101
+ "category": "Number",
1102
+ "name": "median",
1103
+ "syntax": "<variable> = <numberList>.median();\n(OR)\n<variable> = median(<numberList> );",
1104
+ "returns": "Decimal",
1105
+ "overview": "The median() function takes numberList as an argument, sorts it in ascending order, and returns the median (lying in the middle) value in the list.",
1106
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<numbeList>\nThe list from which the median value will be returned.\nNumerical values can be specified in double quotes.\n\nNUMBER LIST or DECIMAL LIST"
1107
+ },
1108
+ {
1109
+ "category": "Number",
1110
+ "name": "min",
1111
+ "syntax": "<variable> = <numberOne>.min(<numberTwo> );\n(OR)\n<variable> = min( <numberOne>, <numberTwo> );",
1112
+ "returns": "Decimal",
1113
+ "overview": "The min() function takes numberOne and numberTwo as arguments, and returns the smaller number of the two.",
1114
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<numberOne>\nThe number which has be compared with numberTwo.\nNUMBER or DECIMAL\n\n<numberTwo>\nThe number which has be compared with numberOne.\nNUMBER or DECIMAL"
1115
+ },
1116
+ {
1117
+ "category": "Number",
1118
+ "name": "nextWeekDay",
1119
+ "syntax": "<variable> = <inputDate>.nextWeekDay(<inputDay>);\n\n(OR)\n\n<variable> = nextWeekDay(<inputDate>, <inputDay>);",
1120
+ "returns": "TEXT",
1121
+ "overview": "The nextWeekDay() function takes an inputDate and returns the next immediate date that falls on the specified inputDay.",
1122
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nDATE-TIME\nVariable which will contain the returned date.\n\n<inputDate>\nDATE-TIME\nThe input start date.\n\n<inputDay>\nTEXT\nThe text that represents the day on which the required date will fall.\nAllowed Values:\nSunday\nMonday\nTuesday\nWednesday\nThursday\nFriday \nSaturday\nNote: This function is not related to business days. inputDay param can take any day including weekends and return the next immediate date that falls on the specified day."
1123
+ },
1124
+ {
1125
+ "category": "Number",
1126
+ "name": "nthLargest",
1127
+ "syntax": "<variable> = <numberCollection>.nthLargest(<number>);",
1128
+ "returns": "NUMBER / DECIMAL",
1129
+ "overview": "The nthLargest function operates on a collection of numerical values.",
1130
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which contains the nth largest value from the collection.\n\n<numberCollection>\nCOLLECTION\nThe collection of numerical values (includes NUMBER and DECIMAL).\n\n<number>\nNUMBER\nThe rank of the numerical value which needs to be retrieved from the collection."
1131
+ },
1132
+ {
1133
+ "category": "Number",
1134
+ "name": "nthSmallest",
1135
+ "syntax": "<variable> = <numberCollection>.nthSmallest(<number>);",
1136
+ "returns": "NUMBER / DECIMAL",
1137
+ "overview": "The nthSmallest function operates on a collection of numerical values.",
1138
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which contains the nth smallest value from the collection.\n\n<numberCollection>\nCOLLECTION\nThe collection of numerical values (includes NUMBER and DECIMAL).\n\n<number>\nNUMBER / DECIMAL\nThe rank of the numerical value which needs to be retrieved from the collection."
1139
+ },
1140
+ {
1141
+ "category": "Number",
1142
+ "name": "power",
1143
+ "syntax": "<variable> = <baseNumber>.power( <powerNumber> );\n(OR)\n<variable> = power(<baseNumber>, <powerNumber>);",
1144
+ "returns": "Decimal",
1145
+ "overview": "The power() function takes baseNumber and powerNumber as arguments.",
1146
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<baseNumber>\nValue to be raised to powerNumber.\nNUMBER or DECIMAL\n\n<powerNumber>\nThe power to which the baseNumber will be raised.\nNUMBER or DECIMAL"
1147
+ },
1148
+ {
1149
+ "category": "Number",
1150
+ "name": "range",
1151
+ "syntax": "To generate a random number which falls in a specified range (inclusive of both values):\n<variable> = randomNumber(<start_limit>, <end_limit>);",
1152
+ "returns": "NUMBER",
1153
+ "overview": "The randomNumber function generates a random number from the specified range.",
1154
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER/DECIMAL\nVariable that will contain a random number between the specified limits.\n\n<start_limit>\nNUMBER/DECIMAL\nThe starting value of the range between which the random number needs to be generated.\nNote: When the start limit, end limit, or both are decimals, the function returns a decimal. If both the arguments are whole numbers, the function returns a whole number.\n\n<end_limit>\nNUMBER/DECIMAL\nThe ending value of the range between which the random number needs to generated.\nNote: When the start limit, end limit, or both are decimals, the function returns a decimal. If both the arguments are whole numbers, the function returns a whole number."
1155
+ },
1156
+ {
1157
+ "category": "Number",
1158
+ "name": "round",
1159
+ "syntax": "<variable> = <numericalExpression>.round(<roundingPrecision>);",
1160
+ "returns": "DECIMAL",
1161
+ "overview": "The round function takes a numerical expression and rounding precision as arguments and returns the rounded off value.",
1162
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nDECIMAL\nThe variable that will contain the rounded off value.\n\n<numericalExpression>\nDECIMAL/NUMBER\nThe value to be rounded off to the given precision.\n\n<roundingPrecision>\nNUMBER\n\nThe precision(number of rounding digits) to which the number is to be rounded.When the value is positive:\nA positive value will round off the number to the specified number of positions to the right of the decimal point.\nIf the value to the right of the rounding digit is greater than or equal to 5, the function will add 1 to the rounding digit, and all the digits after the rounding digit will be dropped.\nIf the value to the right of the rounding digit is lesser th"
1163
+ },
1164
+ {
1165
+ "category": "Number",
1166
+ "name": "sin",
1167
+ "syntax": "<variable> = <number>.sin();\n(OR)\n<variable> = sin(<number> );",
1168
+ "returns": "Decimal",
1169
+ "overview": "The sin() function takes a number as an argument, and returns the trigonometric sine of that number (angle measured in radians).",
1170
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose sine value will be returned.\nNUMBER or DECIMAL"
1171
+ },
1172
+ {
1173
+ "category": "Number",
1174
+ "name": "sinh",
1175
+ "syntax": "<variable> = <number>.sinh();\n(OR)\n<variable> = sinh(<number>);",
1176
+ "returns": "NUMBER",
1177
+ "overview": "The sinh() function returns the hyperbolic sine of the specified angle (in radians).",
1178
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned value.\n\n<number>\nNUMBER\nThe number whose hyperbolic sine value will be returned."
1179
+ },
1180
+ {
1181
+ "category": "Number",
1182
+ "name": "smallest",
1183
+ "syntax": "<variable> = <numberList>.smallest();\n(OR)\n<variable> = smallest(<numberList> );",
1184
+ "returns": "Decimal",
1185
+ "overview": "The smallest() function takes numberList as an argument, and returns the smallest number from the list",
1186
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<numberList>\nThe list from which the smallest value will be returned.\nNumerical values can be specified in double quotes.\n\nNUMBER LIST or DECIMAL LIST"
1187
+ },
1188
+ {
1189
+ "category": "Number",
1190
+ "name": "sqrt",
1191
+ "syntax": "<variable> = <number>.sqrt();\n(OR)\n<variable> = sqrt(<number> );",
1192
+ "returns": "Decimal",
1193
+ "overview": "The sqrt() function takes a number as an argument, and returns the square root of that number.",
1194
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose square root will be returned.\nValues below 0 will return null.\n\nNUMBER or DECIMAL"
1195
+ },
1196
+ {
1197
+ "category": "Number",
1198
+ "name": "tan",
1199
+ "syntax": "<variable> = <number>.tan();\n(OR)\n<variable> = tan(<number> );",
1200
+ "returns": "Decimal",
1201
+ "overview": "The tan() function takes a number as an argument, and returns the trigonometric tangent of that number (angle measured in radians).",
1202
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nDECIMAL\n\n<number>\nThe number whose tangent value will be returned.\nNUMBER or DECIMAL"
1203
+ },
1204
+ {
1205
+ "category": "Number",
1206
+ "name": "tanh",
1207
+ "syntax": "<variable> = <number>.tanh();\n(OR)\n<variable> = tanh(<number>);",
1208
+ "returns": "NUMBER",
1209
+ "overview": "The tanh() function returns the number equivalent to the hyperbolic tangent of the specified angle (in radians).",
1210
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nNUMBER\nVariable which will contain the returned value.\n\n<number>\nNUMBER\nThe number whose hyperbolic tangent value will be returned."
1211
+ },
1212
+ {
1213
+ "category": "Number",
1214
+ "name": "toText",
1215
+ "syntax": "<variable> = <expression>.toText(<formatText>);",
1216
+ "returns": "TEXT",
1217
+ "overview": "The text function takes a numerical expression and returns it in the desired format.",
1218
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<expression>\nDATE-TIME / DECIMAL / NUMBER\nThe expression which needs to be formatted.\n\n<formatText>\n\nTEXT\nThe text expression with which the desired expression needs to be formatted.\nNote:\nWhen date-time values are to be formatted, the date-time literals provided can be used.\nIf this param is not specified, a runtime error is thrown."
1219
+ },
1220
+ {
1221
+ "category": "Number",
1222
+ "name": "toHex",
1223
+ "syntax": "<variable> = <number>.toHex();\n(OR)\nvariable = toHex(<number> );",
1224
+ "returns": "Text",
1225
+ "overview": "The toHex() function takes a number as an argument, and returns a string representing the hexadecimal value of that number.",
1226
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned value.\nTEXT\n\n<number>\nThe number whose hexadecimal value will be returned.\nNUMBER"
1227
+ },
1228
+ {
1229
+ "category": "Number",
1230
+ "name": "toWords",
1231
+ "syntax": "<variable> = <number>.toWords(<language>);\n\n(OR)\n<variable> = toWords(<number>, <language>);",
1232
+ "returns": "TEXT",
1233
+ "overview": "The toWords() function converts the input number into words.",
1234
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nThe variable that will contain the converted into words.\n\n<number>\nNUMBER/ DECIMAL\nThe input number that will be converted into words.\nNote:\nA number input value can contain up to 18 digits.\nThe whole and decimal parts of a decimal input value can collectively be up to 15 digits.\n\n<language>\nNUMBER/ TEXT\nThe language in which the input number will be converted into words.\nSupported Languages:\nEnglish UK: en-gb\nArabic: ar\nChinese: zh\nEnglish Indian: en-in\nEnglish UK: en-gb\nEnglish US: en-us\nFrench: fr\nGerman: de\nItalian: it\nJapanese: ja\nKorean: ko\nPortuguese: pt\nSpanish: es"
1235
+ },
1236
+ {
1237
+ "category": "Text",
1238
+ "name": "concat",
1239
+ "syntax": "<variable> = <text1>.concat(<text2>);\n\n(OR)\n\n<variable> = concat(<text1>, <text2>);",
1240
+ "returns": "TEXT",
1241
+ "overview": "The concat function takes a sourceText and an appendText as arguments and returns the concatenated value.",
1242
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which holds the concatenated value\n\n<text1>\nTEXT\nPiece of text to be concatenated\n\n<text2>\nTEXT\nPiece of text to be concatenated"
1243
+ },
1244
+ {
1245
+ "category": "Text",
1246
+ "name": "contains",
1247
+ "syntax": "<variable> = <string>.contains( <searchString> );\n(OR)\nvariable = contains( <string>, <searchString> );",
1248
+ "returns": "Boolean",
1249
+ "overview": "The contains() function takes string and searchString as arguments.",
1250
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string>\nThe string which may contain the searchString.\n\nTEXT\n\n<searchString>\nThe string to be searched for, in the main string.\n\nTEXT"
1251
+ },
1252
+ {
1253
+ "category": "Text",
1254
+ "name": "containsIgnoreCase",
1255
+ "syntax": "<variable> = <string>.containsIgnoreCase( <searchString> );\n(OR)\n<variable> = containsIgnoreCase(<string>, <searchString>);",
1256
+ "returns": "Boolean",
1257
+ "overview": "The containsIgnoreCase() function takes string and searchString as arguments.",
1258
+ "params": "Parameter\nDescription\nData type\n\n<variable>\n Variable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string>\nThe string which may contain the searchString.\nTEXT\n\n<searchString>\nThe string to be searched for, in the main string.\nTEXT"
1259
+ },
1260
+ {
1261
+ "category": "Text",
1262
+ "name": "endsWith",
1263
+ "syntax": "<variable> = <string>.endsWith( <searchString> );\n(OR)\n<variable> = endsWith( <string>, <searchString> );",
1264
+ "returns": "Boolean",
1265
+ "overview": "The endsWith() function takes a string and a searchString as arguments.",
1266
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string>\nThe string which may end with the searchString.\n\nTEXT\n\n<searchString>\nThe searchString with which the main string may end.\n\nTEXT"
1267
+ },
1268
+ {
1269
+ "category": "Text",
1270
+ "name": "endsWithIgnoreCase",
1271
+ "syntax": "<variable> = <string>.endsWithIgnoreCase( <searchString> );\n(OR)\n<variable> = endsWithIgnoreCase(<string>, <searchString>);",
1272
+ "returns": "Boolean",
1273
+ "overview": "The endsWithIgnoreCase() function takes string and searchString as arguments.",
1274
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string>\nThe string which may end with the searchString.\nTEXT\n\n<searchString>\nThe searchString with which the main string may end.\nTEXT"
1275
+ },
1276
+ {
1277
+ "category": "Text",
1278
+ "name": "equalsIgnoreCase",
1279
+ "syntax": "<variable> = <string1>.equalsIgnoreCase(<string2>);\n(OR)\n<variable> = equalsIgnoreCase( <string1>, <string2> );",
1280
+ "returns": "Boolean",
1281
+ "overview": "The equalsIgnoreCase() function takes two strings as arguments.",
1282
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string1>\nThe string to be compared with string2.\n\nTEXT\n\n<string2>\nThe string to be compared with string1.\n\nTEXT"
1283
+ },
1284
+ {
1285
+ "category": "Text",
1286
+ "name": "find",
1287
+ "syntax": "<variable> = <string>.find( );\n(OR)\n<variable> = find( <string>, <searchString>);\n(OR)\n<variable> = <string>.indexOf(<searchString>);\n(OR)\n<variable> = indexOf(<string>,<searchString>);",
1288
+ "returns": "Number",
1289
+ "overview": "The find() function takes string and searchString as arguments.",
1290
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned index number.\nNUMBER\n\n<string>\nThe string from which the index number will be returned.\nTEXT\n\n<searchString>\nThis string's first character's first occurrence will be checked in the string.\nTEXT"
1291
+ },
1292
+ {
1293
+ "category": "Text",
1294
+ "name": "getAlpha",
1295
+ "syntax": "<variable> = <string>.getAlpha();\n(OR)\n<variable> = getAlpha(<string>);",
1296
+ "returns": "Text",
1297
+ "overview": "The getAlpha() function takes a string as an argument, and returns all the letters from that string.",
1298
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned letters.\nTEXT\n\n<string>\nThe string from which the letters will be returned.\nTEXT"
1299
+ },
1300
+ {
1301
+ "category": "Text",
1302
+ "name": "getAlphaNumeric",
1303
+ "syntax": "<variable> = <string>.getAlphaNumeric();\n(OR)\n<variable> = getAlphaNumeric(<string>);",
1304
+ "returns": "Text",
1305
+ "overview": "The getAlphaNumeric() function takes a string as an argument, and returns only the alphanumeric characters from that string.",
1306
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned alphanumeric characters.\nTEXT\n\n<string>\nThe string from which the alphanumeric characters will be returned.\nTEXT"
1307
+ },
1308
+ {
1309
+ "category": "Text",
1310
+ "name": "getOccurenceCount",
1311
+ "syntax": "<variable> = <string>.getOccurenceCount( <searchString> );\n(OR)\n<variable> = getOccurenceCount( <string>, <searchString> );",
1312
+ "returns": "NUMBER",
1313
+ "overview": "The getOccurenceCount() function takes string and searchString as arguments.",
1314
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned count.\nNUMBER\n\n<string>\nThe string in which the count of searchString will be calculated.\nTEXT\n\n<searchString>\n\nThe searchString whose count will be calculated in the string.\n\nTEXT"
1315
+ },
1316
+ {
1317
+ "category": "Text",
1318
+ "name": "getPrefix",
1319
+ "syntax": "<variable> = <string>.getPrefix( <searchString> );\n(OR)\n<variable> = getPrefix( <string>, <searchString>);",
1320
+ "returns": "TEXT",
1321
+ "overview": "The getPrefix() function takes string and searchString as arguments.",
1322
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned characters.\nTEXT\n\n<string>\nThe string from which all the characters preceding the searchString will be returned.\nTEXT\n\n<searchString>\n\nThe searchString whose occurrence will be checked in the string.\n\nTEXT"
1323
+ },
1324
+ {
1325
+ "category": "Text",
1326
+ "name": "getSuffix",
1327
+ "syntax": "<variable> = <string>.getSuffix( <searchString> );\n(OR)\n<variable> = getSuffix( <string>, <searchString>);",
1328
+ "returns": "Text",
1329
+ "overview": "The getSuffix() function takes string and searchString as arguments.",
1330
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned characters.\nTEXT\n\n<string>\nThe string from which all the characters following the searchString will be returned.\nTEXT\n\n<searchString>\n\nThe searchString whose occurrence will be checked in the string.\n\nTEXT"
1331
+ },
1332
+ {
1333
+ "category": "Text",
1334
+ "name": "hexToText",
1335
+ "syntax": "<variable> = <text>.hexToText();\n\n(OR)\n\n<variable> = hexToText(<text>);",
1336
+ "returns": "Text",
1337
+ "overview": "The hextoText() function takes a hexadecimal text as an argument and returns the text equivalent of the input.",
1338
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<text>\nTEXT\nThe hexadecimal text whose equivalent text value will be returned."
1339
+ },
1340
+ {
1341
+ "category": "Text",
1342
+ "name": "indexOf",
1343
+ "syntax": "<variable> = <string>.indexOf( <searchString> );\n(OR)\n<variable> = indexOf( <string>, <searchString>);\n(OR)\n<variable> = <string>.find(<searchString>);\n(OR)\n<variable> = find(<string>,<searchString>);",
1344
+ "returns": "Number",
1345
+ "overview": "The indexOf() function takes string and searchString as arguments.",
1346
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned index number.\nNUMBER\n\n<string>\nThe string from which the index number will be returned.\nTEXT\n\n<searchString>\nThis string's first character's first occurrence will be checked in the string.\nTEXT"
1347
+ },
1348
+ {
1349
+ "category": "Text",
1350
+ "name": "lastIndexOf",
1351
+ "syntax": "<variable> = <string>.lastIndexOf(<searchString>);\n(OR)\n<variable> = lastIndexOf( <string>, <searchString> );",
1352
+ "returns": "Number",
1353
+ "overview": "The lastIndexOf() function takes string and searchString as arguments.",
1354
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned index number.\nNUMBER\n\n<string>\nThe string from which the index number will be returned.\nTEXT\n\n<searchString>\n\nThis string's first character's last occurrence will be checked in the string.\n\nTEXT"
1355
+ },
1356
+ {
1357
+ "category": "Text",
1358
+ "name": "left",
1359
+ "syntax": "<variable> = <string>.left(<number>);",
1360
+ "returns": "Text",
1361
+ "overview": "The left() function takes a string and a number as arguments.",
1362
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string value.\nTEXT\n\n<string>\nThe string from which the characters will be returned.\nTEXT\n\n<number>\nThe number of characters which will be returned.\nIf the number exceeds the count of characters in the string, an error will be encountered during runtime.\nNegative values will return the full string.\n\nNUMBER"
1363
+ },
1364
+ {
1365
+ "category": "Text",
1366
+ "name": "leftpad",
1367
+ "syntax": "<variable> = <text>.leftpad( <whitespaces>);\n(OR)\n<variable> = leftpad(<text>, <whitspaces> );",
1368
+ "returns": "Text",
1369
+ "overview": "The leftpad() function takes text and whitespaces as arguments.",
1370
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable that will contain the returned text.\n\n<text>\nTEXT\nThe text that will be left-padded with white spaces.\n\n<whitespaces>\nNUMBER\nTotal number of whitespaces that need to be padded.\nNote: A negative value will return the string without any changes.\nMaximum value: 100,00"
1371
+ },
1372
+ {
1373
+ "category": "Text",
1374
+ "name": "len",
1375
+ "syntax": "<variable> = <string>.len();\n(OR)\n<variable> = len(<string>);\n(OR)\n<variable> = <string>.length();\n(OR)\n<variable> = length(<string>);",
1376
+ "returns": "Number",
1377
+ "overview": "The len() function takes a string as an argument.",
1378
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the count of characters\nNUMBER\n\n<string>\nThe string whose number of characters will be returned\nTEXT"
1379
+ },
1380
+ {
1381
+ "category": "Text",
1382
+ "name": "length",
1383
+ "syntax": "<variable> = <string>.length();\n(OR)\n<variable> = length( <string> );\n(OR)\n<variable> = <string>.len();\n(OR)\n<variable> = len(<string>);",
1384
+ "returns": "Number",
1385
+ "overview": "The length() function takes a string as an argument.",
1386
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the count of characters.\nNUMBER\n\n<string>\nThe string whose number of characters will be returned.\nTEXT"
1387
+ },
1388
+ {
1389
+ "category": "Text",
1390
+ "name": "ltrim",
1391
+ "syntax": "<variable> = <input_text>.ltrim();\n\n(OR)\n\n<variable> = ltrim(<input_text>);",
1392
+ "returns": "TEXT",
1393
+ "overview": "The ltrim function removes all the extra white spaces (if any) inserted before the text and returns the trimmed text.",
1394
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable that will hold the trimmed text\n\n<text1>\nTEXT\nThe input text whose leading white spaces need to be removed"
1395
+ },
1396
+ {
1397
+ "category": "Text",
1398
+ "name": "matches",
1399
+ "syntax": "<variable> = <string>.matches(<regexString>);\n(OR)\n<variable> = matches( <string>, <regexString> );",
1400
+ "returns": "Boolean",
1401
+ "overview": "The matches() function takes string and regexString (regular expression) as arguments.",
1402
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the boolean value, true or false.\nBOOLEAN\n\n<string>\nThe string to be compared with the regular expression\nTEXT\n\n<regexString>\nThe regular expression to be compared with the string.\nTEXT"
1403
+ },
1404
+ {
1405
+ "category": "Text",
1406
+ "name": "mid",
1407
+ "syntax": "<variable> = <source_text>.mid(<start_index>, [<end_index>]);\n\n(OR)\n\n<variable> = mid(<source_text>, <start_index>, [<end_index>]);",
1408
+ "returns": "TEXT",
1409
+ "overview": "The mid function takes source_text, start_index, and end_index as arguments.",
1410
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which contains the returned text.\n\n<source_text>\nTEXT\nThe source of text on which mid function is effected.\n\n<start_index>\nNUMBER\nThe index starting from which the characters in the source text will be returned.\n\n<end_index>\n (optional)\n\nNUMBER\nThe index until which the characters in the source text will be returned. If omitted, the rest of the text (from the start index) will be returned.\nIf a negative value is specified, this param will be ignored and rest of the text (from the start index) will be returned."
1411
+ },
1412
+ {
1413
+ "category": "Text",
1414
+ "name": "notContains",
1415
+ "syntax": "<variable> = <inputValue>.notContains( <searchValue> );",
1416
+ "returns": "Boolean",
1417
+ "overview": "The notContains() function takes inputValue and searchValue as arguments.",
1418
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the boolean value, true or false\n\n<inputValue>\nTEXT/ LIST/ MAP/ COLLECTION\nThe value which may contain the searchValue.\n\n<searchValue>\nAny datatype\nThe value to be searched for, in the input value."
1419
+ },
1420
+ {
1421
+ "category": "Text",
1422
+ "name": "proper",
1423
+ "syntax": "<variable> = <string>.proper();",
1424
+ "returns": "Text",
1425
+ "overview": "The proper() function takes a string as an argument.",
1426
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string value.\nTEXT\n\n<string>\nThe string which will be returned in start case.\nTEXT"
1427
+ },
1428
+ {
1429
+ "category": "Text",
1430
+ "name": "remove",
1431
+ "syntax": "<variable> = <string>.remove( <searchString> );\n(OR)\n<variable> = remove( <string>, <searchString> );",
1432
+ "returns": "Text",
1433
+ "overview": "The remove() function takes string and searchString as arguments.",
1434
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which the searchString will be removed.\nTEXT\n\n<searchString>\nThe searchString which will be removed from the string.\nTEXT"
1435
+ },
1436
+ {
1437
+ "category": "Text",
1438
+ "name": "removeAllAlpha",
1439
+ "syntax": "<variable> = <string>.removeAllAlpha();\n(OR)\n<variable> = removeAllAlpha(< string> );",
1440
+ "returns": "Text",
1441
+ "overview": "The removeAllAlpha() function takes a string as an argument.",
1442
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which all the characters except letters will be returned.\nTEXT"
1443
+ },
1444
+ {
1445
+ "category": "Text",
1446
+ "name": "removeAllAlphaNumeric",
1447
+ "syntax": "<variable> = <string>.removeAllAlphaNumeric();\n(OR)\n<variable> = removeAllAlphaNumeric( <string> );",
1448
+ "returns": "Text",
1449
+ "overview": "The removeAllAlphaNumeric() function takes a string as an argument.",
1450
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which all the characters except alphanumeric will be returned.\nTEXT"
1451
+ },
1452
+ {
1453
+ "category": "Text",
1454
+ "name": "removeFirstOccurence",
1455
+ "syntax": "<variable> = <string>.removeFirstOccurence(<searchString>);\n(OR)\n<variable> = removeFirstOccurence(<string>, <searchString>);",
1456
+ "returns": "Text",
1457
+ "overview": "The removeFirstOccurence() function takes string and searchString as arguments.",
1458
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which the first occurrence of the searchString will be removed\nTEXT\n\n<searchString>\n\nThe searchString whose first occurrence will be removed from the string.\n\nTEXT"
1459
+ },
1460
+ {
1461
+ "category": "Text",
1462
+ "name": "removeLastOccurence",
1463
+ "syntax": "<variable> = <string>.removeLastOccurence(<searchString>);\n(OR)\n<variable> = removeLastOccurence( <string>, <searchString>);",
1464
+ "returns": "Text",
1465
+ "overview": "The removeLastOccurence() function takes string and searchString as arguments.",
1466
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which the searchString's last occurrence will be removed.\nTEXT\n\n<searchString>\n\nThe searchString whose last occurrence will be removed from the string.\n\nTEXT"
1467
+ },
1468
+ {
1469
+ "category": "Text",
1470
+ "name": "repeat",
1471
+ "syntax": "<variable> = <inputText>.repeat(<repeatCount>);\n\n(OR)\n<variable> = repeat(<inputText>, <repeatCount>);",
1472
+ "returns": "TEXT",
1473
+ "overview": "The repeat() function returns a text with the input text repeated for the specified number of times.",
1474
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned text.\n\n<inputText>\nTEXT\nThe text that will be repeated for the specified number of times\n\n<repeatCount>\nNUMBER\n\nThe number of times the inputText will be repeated."
1475
+ },
1476
+ {
1477
+ "category": "Text",
1478
+ "name": "replaceFirstIgnoreCase",
1479
+ "syntax": "<variable> = <inputText>.replaceFirstIgnoreCase(<searchText>, <replacementText>, <boolean>);\n\n(OR)\n\n<variable> = replaceFirstIgnoreCase(<inputText>, <searchText>, <replacementText>, <boolean>);",
1480
+ "returns": "TEXT",
1481
+ "overview": "The replaceFirstIgnoreCase() function searches for searchText in the inputText and replaces its first occurrence with the replacementText.",
1482
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned text.\n\n<inputText>\nTEXT\nThe text in which the first occurrence of searchText will be replaced with replacementText. \n\n<searchText>\nTEXT\n\nThe first occurrence of this searchText in the inputText will be replaced with replacementText.\n\n<replacementText>\nTEXT\nThis replacementText will replace the first occurrence of searchText in the inputText.\n\n<boolean>\nTEXT\nApplicable values: true or false.\nBy default, the replaceFirstIgnoreCase() function supports regular expression (i.e) it will not find and replace the special characters like $ in the input text.\nThis parameter can be used to specify if the regular e"
1483
+ },
1484
+ {
1485
+ "category": "Text",
1486
+ "name": "replaceAll",
1487
+ "syntax": "<variable> = <string>.replaceAll( <searchString>, <replacementString>, <boolean> );\n(OR)\n<variable> = replaceAll( <string>, <searchString>, <replacementString>, <boolean> );",
1488
+ "returns": "Text",
1489
+ "overview": "The replaceAll() function takes string , searchString , and replacementString as arguments.",
1490
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\n The string in which all occurrences of searchString will be replaced with replacementString.\nTEXT\n\n<searchString>\n\nAll occurrences of this searchString will be replaced with replacementString, in the string.\n\nTEXT\n\n<replacementString>\n\nThis replacementString will replace all occurrences of searchString in the string.\n\nTEXT\n\n<boolean>\n\nApplicable values: true or false.\nBy default, the replaceAll() function supports regular expression (i.e) it will not find and replace the special characters like $ in the source string.\nThis parameter can be used to specify if the regular expression is "
1491
+ },
1492
+ {
1493
+ "category": "Text",
1494
+ "name": "replaceFirst",
1495
+ "syntax": "<variable> = <string>.replaceFirst( <searchString>, <replacementString>, <boolean>);\n(OR)\n<variable> = replaceFirst( <string>, <searchString>, <replacementString>, <boolean>);",
1496
+ "returns": "Text",
1497
+ "overview": "The replaceFirst() function takes string, searchString, and replacementString as arguments.",
1498
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string in which the first occurrence of searchString will be replaced with replacementString.\nTEXT\n\n<searchString>\nThe first occurrence of this searchString will be replaced with replacementString, in the string.\nNote: searchString can also be in the form of regular expression.\n\nTEXT\n\n<replacementString>\nThis replacementString will replace the first occurrence of searchString in the string.\nTEXT\n\n<boolean>\nApplicable values: true or false.\nBy default, the replaceFirst() function supports regular expression (i.e) it will not find and replace the special characters like $ in the sour"
1499
+ },
1500
+ {
1501
+ "category": "Text",
1502
+ "name": "reverse",
1503
+ "syntax": "<variable> = <inputText>.reverse();\n\n(OR)\n\n<variable> = reverse(<inputText>);",
1504
+ "returns": "TEXT",
1505
+ "overview": "The reverse() function takes an inputText and returns a text whose characters are in reverse order.",
1506
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned text.\n\n<inputText>\nTEXT\nThe input text whose characters will be returned in reverse order."
1507
+ },
1508
+ {
1509
+ "category": "Text",
1510
+ "name": "right",
1511
+ "syntax": "<variable> = <string>.right( <number> );",
1512
+ "returns": "Text",
1513
+ "overview": "The right() function takes a string and a number as arguments.",
1514
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string value.\nTEXT\n\n<string>\nThe string from which the characters will be returned.\nTEXT\n\n<number>\nThe number of characters which will be returned.\nIf the number exceeds the count of characters in the string, or a negative value is specified, an error will be encountered during runtime\n\nNUMBER"
1515
+ },
1516
+ {
1517
+ "category": "Text",
1518
+ "name": "rightpad",
1519
+ "syntax": "<variable> = <text>.rightpad( <whitespaces> );\n(OR)\n<variable> = rightpad(<text>, <whitespaces> );",
1520
+ "returns": "Text",
1521
+ "overview": "The rightpad() function takes text and whitespaces as arguments.",
1522
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned text.\n\n<text>\nTEXT\nThe text which will be right-padded with white spaces.\n\n<whitespaces>\nNUMBER\nTotal number of whitespaces that need to be padded.\nNote: A negative value will return the string without any changes.\nMaximum value: 100,00"
1523
+ },
1524
+ {
1525
+ "category": "Text",
1526
+ "name": "rtrim",
1527
+ "syntax": "<variable> = <input_text>.rtrim();\n\n(OR)\n\n<variable> = rtrim(<input_text>);",
1528
+ "returns": "TEXT",
1529
+ "overview": "The rtrim function removes all the extra white spaces (if any) inserted after the input text and returns the trimmed text.",
1530
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable that will hold the trimmed text\n\n<text1>\nTEXT\nThe input text whose trailing white spaces need to be removed"
1531
+ },
1532
+ {
1533
+ "category": "Text",
1534
+ "name": "startsWith",
1535
+ "syntax": "<variable> = <string>.startsWith( <searchString> );\n(OR)\n<variable> = startsWith( <string>, <searchString> );",
1536
+ "returns": "Boolean",
1537
+ "overview": "The startsWith() function takes a string and a searchString as arguments.",
1538
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned boolean value.\nBOOLEAN\n\n<string>\nThe main string which may start with the searchString.\n\nTEXT\n\n<searchString>\nThe searchString with which the main string may start.\n\nTEXT"
1539
+ },
1540
+ {
1541
+ "category": "Text",
1542
+ "name": "startsWithIgnoreCase",
1543
+ "syntax": "<variable> = <string>.startsWithIgnoreCase( <searchString>);\n(OR)\n<variable>= startsWithIgnoreCase(<string>, <searchString>);",
1544
+ "returns": "Boolean",
1545
+ "overview": "The startsWithIgnoreCase() function takes string and searchString as arguments.",
1546
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned boolean value.\nBOOLEAN\n\n<string>\nThe main string which may start with the searchString.\nTEXT\n\n<searchString>\nThe searchString with which the main string may start.\nTEXT"
1547
+ },
1548
+ {
1549
+ "category": "Text",
1550
+ "name": "subString",
1551
+ "syntax": "<variable> = <source_text>.subString(<start_index>, [<end_index>]);\n\n(OR)\n\n<variable> = subString(<source_text>, <start_index>, [<end_index>]);",
1552
+ "returns": "TEXT",
1553
+ "overview": "The subString function takes source_text, start_index, and end_index as arguments.",
1554
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which contains the returned text.\n\n<source_text>\nTEXT\nThe source of text on which subString function is effected.\n\n<start_index>\nNUMBER\nThe index starting from which the characters in the source text will be returned.\n\n<end_index>\n (optional)\n\nNUMBER\nThe index until which the characters in the source text will be returned. If omitted, the rest of the text (from the start index) will be returned.\nIf a negative value is specified, this param will be ignored and rest of the text (from the start index) will be returned."
1555
+ },
1556
+ {
1557
+ "category": "Text",
1558
+ "name": "subText",
1559
+ "syntax": "<variable> = <source_text>.subText(<start_index>, [<end_index>]);\n\n(OR)\n\n<variable> = subText(<source_text>, <start_index>, [<end_index>]);",
1560
+ "returns": "TEXT",
1561
+ "overview": "The subText function takes source_text, start_index, and end_index as arguments.",
1562
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which contains the returned text.\n\n<source_text>\nTEXT\nThe source of text on which subText function is effected.\n\n<start_index>\nNUMBER\nThe index starting from which the characters in the source text will be returned.\n\n<end_index>\n (optional)\n\nNUMBER\nThe index until which the characters in the source text will be returned. If omitted, the rest of the text (from the start index) will be returned.\nIf a negative value is specified, this param will be ignored and rest of the text (from the start index) will be returned."
1563
+ },
1564
+ {
1565
+ "category": "Text",
1566
+ "name": "textToHex",
1567
+ "syntax": "<variable> = <text>.textToHex();\n\n(OR)\n\n<variable> = textToHex(<text>);",
1568
+ "returns": "Text",
1569
+ "overview": "The textToHex() function takes a text as an argument and returns the equivalent hexadecimal value.",
1570
+ "params": "Parameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the returned value.\n\n<text>\nTEXT\nThe hexadecimal text whose equivalent text value will be returned."
1571
+ },
1572
+ {
1573
+ "category": "Text",
1574
+ "name": "toList",
1575
+ "syntax": "<variable> = <source_text>.toList(<separator>);",
1576
+ "returns": "LIST",
1577
+ "overview": "The toList function takes source text and a separator as arguments.",
1578
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will contain the returned List.\n\n<source_text>\nTEXT\nThe piece of text with separators that needs to converted to a list.\n\n<separator>\nTEXT\nThe separator literal which would punctuate the different elements in the source text."
1579
+ },
1580
+ {
1581
+ "category": "Text",
1582
+ "name": "toLowerCase",
1583
+ "syntax": "<variable> = <string>.toLowerCase();\n(OR)\n<variable> = toLowerCase( <string >);\n(OR)\n<variable> = <string>.lower();\n(OR)\n<variable> = lower( <string> );",
1584
+ "returns": "Text",
1585
+ "overview": "The toLowerCase() function takes a string as an argument.",
1586
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nAll letters in this string will be converted to lower case.\nTEXT"
1587
+ },
1588
+ {
1589
+ "category": "Text",
1590
+ "name": "toMap",
1591
+ "syntax": "<variable> = <json_text>.toMap();",
1592
+ "returns": "KEY-VALUE",
1593
+ "overview": "The toMap function takes a JSON formatted text as an argument, and returns a key-value pair.",
1594
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nKEY-VALUE\nThe variable which will contain the converted key-value pairs.\n\n<json_text>\nTEXT\nThe JSON formatted text that needs to be converted to key-value pairs.Note:\nIf the text is not in JSON format, a runtime error will be thrown.\nThe size of the text should be lesser than 5 MB."
1595
+ },
1596
+ {
1597
+ "category": "Text",
1598
+ "name": "toUpperCase",
1599
+ "syntax": "<variable> = <string>.toUpperCase();\n(OR)\n<variable> = toUpperCase( <string> );\n(OR)\n<variable> = <string>.upper();\n(OR)\n<variable> = upper( <string> );",
1600
+ "returns": "Text",
1601
+ "overview": "The toUpperCase() function takes a string as an argument.",
1602
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nAll letters in this string will be converted to upper case.\nTEXT"
1603
+ },
1604
+ {
1605
+ "category": "Text",
1606
+ "name": "trim",
1607
+ "syntax": "<variable> = <string>.trim();\n(OR)\n<variable> = trim( <string> );",
1608
+ "returns": "Text",
1609
+ "overview": "The trim() function takes a string as an argument.",
1610
+ "params": "Parameter\nDescription\nData type\n\n<variable>\nVariable which will contain the returned string.\nTEXT\n\n<string>\nThe string from which the leading and trailing spaces will be removed.\nTEXT"
1611
+ },
1612
+ {
1613
+ "category": "Text",
1614
+ "name": "isEmpty",
1615
+ "syntax": "<variable> = <expression>.isEmpty();",
1616
+ "returns": "BOOLEAN",
1617
+ "overview": "The isEmpty function takes an expression as argument.",
1618
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nBOOLEAN\nVariable which will contain the returned boolean value.\n\n<expression>\nTEXT/LIST/MAP/COLLECTION\nVariable which will hold the expression awaiting the empty validation."
1619
+ },
1620
+ {
1621
+ "category": "XML",
1622
+ "name": "toXml",
1623
+ "syntax": "<text>.toXml();",
1624
+ "returns": "TEXT",
1625
+ "overview": "The toXml function takes a JSON/MAP formatted text as an argument, and returns it as an XML.",
1626
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nTEXT\nVariable which will contain the converted XML.\n\n<text>\nTEXT\nThe JSON formatted text which needs to be converted to XML."
1627
+ },
1628
+ {
1629
+ "category": "XML",
1630
+ "name": "toXmlList",
1631
+ "syntax": "<variable> = <text>.toXmlList();",
1632
+ "returns": "LIST",
1633
+ "overview": "The toXmlList function takes an XML text, and returns the elements of the specified key or the specified xPath (using executeXpath) as a list.",
1634
+ "params": "where,\nParameter\nData type\nDescription\n\n<variable>\nLIST\nVariable which will contain the converted list.\n\n<string>\nTEXT\nThe XML text whose elements will be returned as a list."
1635
+ },
1636
+ {
1637
+ "category": "Text",
1638
+ "name": "getPrefixIgnoreCase",
1639
+ "syntax": "<variable> = <text>.getPrefixIgnoreCase(<search_text>);",
1640
+ "returns": "",
1641
+ "overview": "Gets the prefix of the specified search text in the input text, performing a case-insensitive search.",
1642
+ "params": ""
1643
+ },
1644
+ {
1645
+ "category": "Text",
1646
+ "name": "getSuffixIgnoreCase",
1647
+ "syntax": "<variable> = <text>.getSuffixIgnoreCase(<search_text>);",
1648
+ "returns": "",
1649
+ "overview": "Gets the suffix of the specified search text in the input text, performing a case-insensitive search.",
1650
+ "params": ""
1651
+ },
1652
+ {
1653
+ "category": "Text",
1654
+ "name": "replaceAllIgnoreCase",
1655
+ "syntax": "<variable> = <text>.replaceAllIgnoreCase(<search_text>, <new_text>);",
1656
+ "returns": "",
1657
+ "overview": "Replaces all occurrences of the search text with the new text, performing a case-insensitive search.",
1658
+ "params": ""
1659
+ },
1660
+ {
1661
+ "category": "Text",
1662
+ "name": "isAscii",
1663
+ "syntax": "<variable> = <text>.isAscii();",
1664
+ "returns": "",
1665
+ "overview": "Returns true if every character of the text is ASCII.",
1666
+ "params": ""
1667
+ },
1668
+ {
1669
+ "category": "Date-time",
1670
+ "name": "previousWeekDay",
1671
+ "syntax": "<variable> = <date>.previousWeekDay();",
1672
+ "returns": "",
1673
+ "overview": "Returns the previous weekday (Monday to Friday) before the given date.",
1674
+ "params": ""
1675
+ }
1676
+ ],
1677
+ "tasks": [
1678
+ {
1679
+ "product": "analytics",
1680
+ "name": "zoho.reports.createRow",
1681
+ "syntax": "<variable> = zoho.reports.createRow(<database_name>, <table_name>, <data_map>, <connection>);",
1682
+ "overview": "This task is used to create a row in a table in Zoho Analytics."
1683
+ },
1684
+ {
1685
+ "product": "analytics",
1686
+ "name": "zoho.reports.deleteRow",
1687
+ "syntax": "<variable> = zoho.reports.deleteRow(<database_name>, <table_name>, <criteria>, <connection>);",
1688
+ "overview": "This task is used to delete rows in a table in Zoho Analytics."
1689
+ },
1690
+ {
1691
+ "product": "analytics",
1692
+ "name": "zoho.reports.updateData",
1693
+ "syntax": "<variable> = zoho.reports.updateData(<database_name>, <table_name>, <data_map>, <criteria>, <connection>);",
1694
+ "overview": "This task is used to update rows in a table in Zoho Analytics."
1695
+ },
1696
+ {
1697
+ "product": "bookings",
1698
+ "name": "zoho.bookings.createAppointment",
1699
+ "syntax": "<response> = zoho.bookings.createAppointment(<service_id>, <appointment_date_time>, <customer_details>, <staff_id/resource_id>, <time_zone>, <is_staff>, <connection>);",
1700
+ "overview": "This task is used to book an appointment with the given details."
1701
+ },
1702
+ {
1703
+ "product": "bookings",
1704
+ "name": "zoho.bookings.getAvailableSlots",
1705
+ "syntax": "<response> = zoho.bookings.getAvailableSlots(<service_id>, <staff_id>, <date>, <connection>);",
1706
+ "overview": "This task is used to fetch a list of available slots for the given service and staff on the specified date."
1707
+ },
1708
+ {
1709
+ "product": "bookings",
1710
+ "name": "zoho.bookings.getRecordById",
1711
+ "syntax": "<response> = zoho.bookings.getRecordById(<module>, <record_id>, <connection>);",
1712
+ "overview": "This task is used to fetch a record from the specified module using its ID."
1713
+ },
1714
+ {
1715
+ "product": "bookings",
1716
+ "name": "zoho.bookings.getRelatedRecords",
1717
+ "syntax": "<response> = zoho.bookings.getRelatedRecords(<module>, <parent_module>, <record_id>, <connection>);",
1718
+ "overview": "This task is used to fetch records from a submodule related to a specified record in a parent module."
1719
+ },
1720
+ {
1721
+ "product": "bookings",
1722
+ "name": "zoho.bookings.getWorkspaces",
1723
+ "syntax": "<response> = zoho.bookings.getWorkspaces(<connection>);",
1724
+ "overview": "This task is used to fetch all the workspaces from your Zoho Bookings account."
1725
+ },
1726
+ {
1727
+ "product": "bookings",
1728
+ "name": "zoho.bookings.updateRecord",
1729
+ "syntax": "<response> = zoho.bookings.updateRecord(<module>, <record_id>, <new_values>, <connection>);",
1730
+ "overview": "This task is used to update a record with the specified values using its ID."
1731
+ },
1732
+ {
1733
+ "product": "books",
1734
+ "name": "zoho.books.createRecord",
1735
+ "syntax": "<variable> = zoho.books.createRecord(<module_name>, <org_ID>, <data_map>,<connection>);",
1736
+ "overview": "This task is used to create a record in Zoho Books."
1737
+ },
1738
+ {
1739
+ "product": "books",
1740
+ "name": "zoho.books.getRecordsByID",
1741
+ "syntax": "<variable> = zoho.books.getRecordsByID(<module_name>, <org_ID>, <record_id>, <connection>);",
1742
+ "overview": "This task is used to fetch a record from Zoho Books using the record ID."
1743
+ },
1744
+ {
1745
+ "product": "books",
1746
+ "name": "zoho.books.getRecords",
1747
+ "syntax": "<variable> = zoho.books.getRecords(<module_name>, <org_ID>, <search>, <connection>);",
1748
+ "overview": "This task is used to fetch records from a specified module in Zoho Books."
1749
+ },
1750
+ {
1751
+ "product": "books",
1752
+ "name": "zoho.books.getOrganizations",
1753
+ "syntax": "<variable> = zoho.books.getOrganizations(<connection>);",
1754
+ "overview": "This task is used to fetch all the organizations that a user is associated with in Zoho Books."
1755
+ },
1756
+ {
1757
+ "product": "books",
1758
+ "name": "zoho.books.getTemplates",
1759
+ "syntax": "<variable> = zoho.books.getTemplates(<module_name>, <org_ID>, <connection>);",
1760
+ "overview": "This task is used to fetch all the templates from the specified Zoho Books module."
1761
+ },
1762
+ {
1763
+ "product": "books",
1764
+ "name": "zoho.books.markStatus",
1765
+ "syntax": "<variable> = zoho.books.markStatus(<module_name>, <org_ID>, <record_ID>, <status>, <connection>);",
1766
+ "overview": "This task is used to change the status field with one of the allowed values in the specified Zoho Books module."
1767
+ },
1768
+ {
1769
+ "product": "books",
1770
+ "name": "zoho.books.updateRecord",
1771
+ "syntax": "<variable> = zoho.books.updateRecord(<module_name>, <org_ID>, <record_ID>, <data_map>, <books_connection>);",
1772
+ "overview": "This task is used to update a record in Zoho Books using the record ID."
1773
+ },
1774
+ {
1775
+ "product": "calendar",
1776
+ "name": "zoho.calendar.createEvent",
1777
+ "syntax": "<variable> = zoho.calendar.createEvent(<calendar_uid>, <event_details_map>, <connection>);",
1778
+ "overview": "This task is used to create an event in Zoho Calendar."
1779
+ },
1780
+ {
1781
+ "product": "cliq",
1782
+ "name": "zoho.cliq.createRecord",
1783
+ "syntax": "<variable> = zoho.cliq.createRecord(<database_name>, <data_map>, <connection>);",
1784
+ "overview": "This task is used to add a new record with the specified values into a Zoho Cliq database."
1785
+ },
1786
+ {
1787
+ "product": "cliq",
1788
+ "name": "zoho.cliq.deleteRecord",
1789
+ "syntax": "<variable> = zoho.cliq.deleteRecord(<database_name>, <record_ID>, <connection>);",
1790
+ "overview": "This task is used to delete a record using its ID from a Zoho Cliq database."
1791
+ },
1792
+ {
1793
+ "product": "cliq",
1794
+ "name": "zoho.cliq.deleteRecords",
1795
+ "syntax": "<variable> = zoho.cliq.deleteRecords(<database_name>, <query_text>, <connection>);",
1796
+ "overview": "This task is used to delete records from a Zoho Cliq database based on a specified criteria."
1797
+ },
1798
+ {
1799
+ "product": "cliq",
1800
+ "name": "zoho.cliq.getRecordById",
1801
+ "syntax": "<variable> = zoho.cliq.getRecordById(<database_name>, <record_ID>, <connection>);",
1802
+ "overview": "This task is used to fetch a record using its ID from a Zoho Cliq database."
1803
+ },
1804
+ {
1805
+ "product": "cliq",
1806
+ "name": "zoho.cliq.getRecords",
1807
+ "syntax": "<variable> = zoho.cliq.getRecords(<database_name>, <query_map>, <connection>);",
1808
+ "overview": "This task is used to fetch a list of records from a Zoho Cliq database, based on a given criteria."
1809
+ },
1810
+ {
1811
+ "product": "cliq",
1812
+ "name": "zoho.cliq.postToBot",
1813
+ "syntax": "<variable> = zoho.cliq.postToBot(<bot_name>, <message>, <connection>);",
1814
+ "overview": "This task is used to post a message to any of the bots that you have subscribed, using the bot name in Zoho Cliq."
1815
+ },
1816
+ {
1817
+ "product": "cliq",
1818
+ "name": "zoho.cliq.postToChannel",
1819
+ "syntax": "<variable> = zoho.cliq.postToChannel(<channel_name>, <message>, <connection>);",
1820
+ "overview": "This task is used to post a message to any of the channels that you are a part of, using the channel name in Zoho Cliq."
1821
+ },
1822
+ {
1823
+ "product": "cliq",
1824
+ "name": "zoho.cliq.postToChat",
1825
+ "syntax": "<variable> = zoho.cliq.postToChat(<chat_ID>, <message>, <connection>);",
1826
+ "overview": "This task is used to post a message to any member in your organization, using the recipient's chat ID in Zoho Cliq."
1827
+ },
1828
+ {
1829
+ "product": "cliq",
1830
+ "name": "zoho.cliq.postToUser",
1831
+ "syntax": "<variable> = zoho.cliq.postToUser(<email_ID / ZUID>, <message>, <connection>);",
1832
+ "overview": "The zoho.cliq.postToUser DELUGE task is used to post a message to any member in your organization using their email ID or ZUID."
1833
+ },
1834
+ {
1835
+ "product": "cliq",
1836
+ "name": "zoho.cliq.updateRecord",
1837
+ "syntax": "<variable> = zoho.cliq.updateRecord(<database_name>, <record_ID>, <values_map>, <connection>);",
1838
+ "overview": "This task is used to update values of a particular record using its ID in a Zoho Cliq database."
1839
+ },
1840
+ {
1841
+ "product": "creator",
1842
+ "name": "zoho.creator.createRecord",
1843
+ "syntax": "<variable> = zoho.creator.createRecord(<owner_name>, <app_link_name>, <form_link_name>, <input_values>, <other_params>, <connection>);",
1844
+ "overview": "The zoho.creator.createRecord task adds one or more records to the specified Zoho Creator form with the given input field values."
1845
+ },
1846
+ {
1847
+ "product": "creator",
1848
+ "name": "zoho.creator.getRecordById",
1849
+ "syntax": "<variable> = zoho.creator.getRecordById(<owner_name>, <app_link_name>, <report_link_name>, <record_id>, <connection_link_name>);",
1850
+ "overview": "The zoho.creator.getRecordById task is used to fetch a record using its ID from the specified Zoho Creator application."
1851
+ },
1852
+ {
1853
+ "product": "creator",
1854
+ "name": "zoho.creator.getRecords",
1855
+ "syntax": "<variable> = zoho.creator.getRecords(<owner_name>, <app_link_name>, <report_link_name>, <criteria>, <from_index>, <limit>, <connection_link_name>);",
1856
+ "overview": "The zoho.creator.getRecords task is used to fetch records from the specified report of the Zoho Creator application."
1857
+ },
1858
+ {
1859
+ "product": "creator",
1860
+ "name": "zoho.creator.updateRecord",
1861
+ "syntax": "<variable> = zoho.creator.updateRecord(<owner_name>, <app_link_name>, <report_link_name>, <record_id>, <new_input_values>, <other_api_params>, <connection_link_name>);",
1862
+ "overview": "The zoho.creator.updateRecord task is used to update a record using its ID in the specified Zoho Creator application."
1863
+ },
1864
+ {
1865
+ "product": "creator",
1866
+ "name": "zoho.creator.updateRecords",
1867
+ "syntax": "<variable> = zoho.creator.updateRecords(<owner_name>, <app_link_name>, <report_link_name>, <criteria>, <new_input_values>, <other_api_params>, <connection_link_name>);",
1868
+ "overview": "The zoho.creator.updateRecords task is used to update all records that satisfy criteria in the specified Zoho Creator application."
1869
+ },
1870
+ {
1871
+ "product": "crm",
1872
+ "name": "zoho.crm.v8.bulkCreate",
1873
+ "syntax": "<variable>=zoho.crm.v8.bulkCreate(<module_name>,<records_value>, <options_map>, <connection>);",
1874
+ "overview": "The zoho.crm.v8.bulkCreate task allows you to create multiple records simultaneously under the specified module."
1875
+ },
1876
+ {
1877
+ "product": "crm",
1878
+ "name": "zoho.crm.v8.bulkUpdate",
1879
+ "syntax": "<variable>=zoho.crm.v8.bulkUpdate(<module_name>,<records_value>, <options_map>, <connection>);",
1880
+ "overview": "The zoho.crm.v8.bulkUpdate task updates multiple records in the specified module of Zoho CRM."
1881
+ },
1882
+ {
1883
+ "product": "crm",
1884
+ "name": "zoho.crm.v8.convertLead",
1885
+ "syntax": "<variable>=zoho.crm.v8.convertLead(<lead_id>,<values>, <connection>);",
1886
+ "overview": "This task is used to convert a lead into a contact, deal, and account in Zoho CRM."
1887
+ },
1888
+ {
1889
+ "product": "crm",
1890
+ "name": "zoho.crm.v8.createRecord",
1891
+ "syntax": "<variable>=zoho.crm.v8.createRecord(<module_name>,<record_details>, <options_map>, <connection>);",
1892
+ "overview": "Learn how to create a record in the specified module of Zoho CRM with zoho.crm.v8.createRecord task."
1893
+ },
1894
+ {
1895
+ "product": "crm",
1896
+ "name": "zoho.crm.getAllMeta (via invokeConnector)",
1897
+ "syntax": "<Response>=zoho.crm.invokeConnector(\"crm.modulemetadata\",<parameterMap>);",
1898
+ "overview": "Get the metadata of all the modules using the zoho.crm.invokeConnector() function."
1899
+ },
1900
+ {
1901
+ "product": "crm",
1902
+ "name": "zoho.crm.v8.getFields",
1903
+ "syntax": "<variable>=zoho.crm.v8.getFields(<module_name>,<connection>);",
1904
+ "overview": "This task is used to fetch metadata of all fields from the specified Zoho CRM module."
1905
+ },
1906
+ {
1907
+ "product": "crm",
1908
+ "name": "zoho.crm.getModMeta (via invokeConnector)",
1909
+ "syntax": "<Response>=zoho.crm.invokeConnector(\"crm.modulemetadata\",<moduleMap>);",
1910
+ "overview": "Get a particular module's metadata using the zoho.crm.invokeConnector() function."
1911
+ },
1912
+ {
1913
+ "product": "crm",
1914
+ "name": "zoho.crm.getOrgInfo (via invokeConnector)",
1915
+ "syntax": "<Response>=zoho.crm.invokeConnector(\"crm.getorg\",<parameterMap>);",
1916
+ "overview": "Get the details about the organization associated with your account using the zoho.crm.invokeConnector() function."
1917
+ },
1918
+ {
1919
+ "product": "crm",
1920
+ "name": "zoho.crm.getOrgVariable",
1921
+ "syntax": "<Response>=zoho.crm.getOrgVariable(\"<customVariableName>\");",
1922
+ "overview": "Set the value of a custom variable (Custom Properties in Extension and Org Settings in Vertical Solution) using the zoho.crm.getOrgVariable()."
1923
+ },
1924
+ {
1925
+ "product": "crm",
1926
+ "name": "zoho.crm.v8.getRecordById",
1927
+ "syntax": "<variable>=zoho.crm.v8.getRecordById(<module_name>,<record_ID>, <query_value>, <connection>);",
1928
+ "overview": "This task is used to fetch a record from Zoho CRM module using the record ID."
1929
+ },
1930
+ {
1931
+ "product": "crm",
1932
+ "name": "zoho.crm.v8.getRecords",
1933
+ "syntax": "<variable>=zoho.crm.v8.getRecords(<module_name>,<query_value>,<page>, <per_page>, <connection>);",
1934
+ "overview": "This task is used to fetch records from the specified Zoho CRM module."
1935
+ },
1936
+ {
1937
+ "product": "crm",
1938
+ "name": "zoho.crm.v8.getRelatedRecords",
1939
+ "syntax": "<response>=zoho.crm.v8.getRelatedRecords(<relation_name>,<parent_module_name>, <record_id>,<query_value>,<page>, <per_page>, <connection>);",
1940
+ "overview": "This task is used to fetch records from a submodule(related list) related with a specific record in a parent module in Zoho CRM."
1941
+ },
1942
+ {
1943
+ "product": "crm",
1944
+ "name": "zoho.crm.getRecords",
1945
+ "syntax": "<Response>=zoho.crm.getRecords(\"users\",<pageLong>,<perPageLong>,<userTypeMapmap>);",
1946
+ "overview": "Fetching the details about the users of an extension or vertical solution using the zoho.crm.getRecords() deluge task."
1947
+ },
1948
+ {
1949
+ "product": "crm",
1950
+ "name": "zoho.crm.v8.searchRecords",
1951
+ "syntax": "<variable>=zoho.crm.v8.searchRecords(<module_name>,<criteria>, <page>, <per_page>, <search_value>, <connection>);",
1952
+ "overview": "The search task retrieves records from the specified Zoho CRM module that match the provided search criteria, with support for optional parameters to refine and narrow down the results."
1953
+ },
1954
+ {
1955
+ "product": "crm",
1956
+ "name": "zoho.crm.setOrganizationVariable (via invokeConnector)",
1957
+ "syntax": "<Response>=zoho.crm.invokeConnector(\"crm.set\",<valueMapMap>);",
1958
+ "overview": "Set the value of a custom variable (Custom Properties in Extension and Org Settings in Vertical Solution) using the zoho.crm.invokeConnector()."
1959
+ },
1960
+ {
1961
+ "product": "crm",
1962
+ "name": "zoho.crm.v8.updateRecord",
1963
+ "syntax": "<variable>=zoho.crm.v8.updateRecord(<module_name>,<record_ID>, <record_value>, <options_map>, <connection>);",
1964
+ "overview": "This task updates the values of a particular record using its ID in the specified module of Zoho CRM."
1965
+ },
1966
+ {
1967
+ "product": "crm",
1968
+ "name": "zoho.crm.v8.updateRelatedRecord",
1969
+ "syntax": "<variable>=zoho.crm.v8.updateRelatedRecord(<sub_module>,<sub_module_record_id>, <parent_module>, <parent_module_record_id>, <values>, <connection>);",
1970
+ "overview": "This task is used to update a record in a submodule related to a record in a parent module in Zoho CRM."
1971
+ },
1972
+ {
1973
+ "product": "crm",
1974
+ "name": "zoho.crm.v8.upsert",
1975
+ "syntax": "<variable>=zoho.crm.v8.upsert(<module>,<values>,<duplicate_check>,<connection>);",
1976
+ "overview": "The zoho.crm.v8.upsert task checks whether a record already exists in the specified Zoho CRM module by using a unique \nidentifier field value provided in the request."
1977
+ },
1978
+ {
1979
+ "product": "desk",
1980
+ "name": "zoho.desk.create",
1981
+ "syntax": "<variable>=zoho.desk.create(<orgId>, <module_name>, <record_value>, <connection>);",
1982
+ "overview": "This task is used to create a record in the specified Zoho Desk module."
1983
+ },
1984
+ {
1985
+ "product": "desk",
1986
+ "name": "zoho.desk.createRelatedRecord",
1987
+ "syntax": "<variable>=zoho.desk.createRelatedRecord(<orgId>, <sub_module>, <parent_module>, <record_id>, <record_value>, <connection>);",
1988
+ "overview": "This task is used to create a record in a sub module belonging to a record in a parent module in Zoho Desk."
1989
+ },
1990
+ {
1991
+ "product": "desk",
1992
+ "name": "zoho.desk.getRecordById",
1993
+ "syntax": "<variable>=zoho.desk.getRecordById(<orgId>, <module_name>, <record_id>, <connection>);",
1994
+ "overview": "This task is used to fetch record using its ID from the specified Zoho Desk module."
1995
+ },
1996
+ {
1997
+ "product": "desk",
1998
+ "name": "zoho.desk.getRelatedRecordById",
1999
+ "syntax": "<variable>=zoho.desk.getRelatedRecordById(<orgID>, <sub_module>, <sub_recordID>, <parent_module>, <parent_recordID>, <connection>);",
2000
+ "overview": "This task is used to fetch a related record using its ID, from a parent record in Zoho Desk."
2001
+ },
2002
+ {
2003
+ "product": "desk",
2004
+ "name": "zoho.desk.getRelatedRecords",
2005
+ "syntax": "<variable> = zoho.desk.getRelatedRecords(<orgID>, <sub_module>, <parent_module>, <record_ID>, <fromIndex>, <limit>, <query_value>, <connection>);",
2006
+ "overview": "This task is used to fetch records from a submodule related to a record in a parent module in Zoho Desk."
2007
+ },
2008
+ {
2009
+ "product": "desk",
2010
+ "name": "zoho.desk.getRecords",
2011
+ "syntax": "<variable>=zoho.desk.getRecords(<orgId>, <module_name>,<fromIndex>,<limit>, <query_value>, <connection>);",
2012
+ "overview": "This task is used to fetch records from the specified Zoho Desk module."
2013
+ },
2014
+ {
2015
+ "product": "desk",
2016
+ "name": "zoho.desk.ticket.merge",
2017
+ "syntax": "<variable> = zoho.desk.ticket.merge(<orgID>, <ticket_ID>, <param_value>, <connection>);",
2018
+ "overview": "This task is used to merge two or more records in the Zoho Desk module - Tickets."
2019
+ },
2020
+ {
2021
+ "product": "desk",
2022
+ "name": "zoho.desk.ticket.move",
2023
+ "syntax": "<variable> = zoho.desk.ticket.move(<orgID>, <ticket_ID>, <department_ID>, <connection>);",
2024
+ "overview": "This task is used to move a ticket to a specified department."
2025
+ },
2026
+ {
2027
+ "product": "desk",
2028
+ "name": "zoho.desk.searchRecords",
2029
+ "syntax": "<variable> =zoho.desk.searchRecords(<orgID>, <module_name>,<query>, <fromIndex>, <limit>, <connection>);",
2030
+ "overview": "Learn about the Search records task that is used to fetch records that match a specified criteria."
2031
+ },
2032
+ {
2033
+ "product": "desk",
2034
+ "name": "zoho.desk.ticket.split",
2035
+ "syntax": "<variable> = zoho.desk.ticket.split(<orgID>, <ticket_ID>, <thread_ID>, <connection>);",
2036
+ "overview": "This task is used to split a reply from an existing ticket as a new ticket."
2037
+ },
2038
+ {
2039
+ "product": "desk",
2040
+ "name": "zoho.desk.update",
2041
+ "syntax": "<variable> =zoho.desk.update(<orgId>, <module_name>,<record_id>, <record_value>, <connection>);",
2042
+ "overview": "This task is used to update a record using its ID in the specified Zoho Desk module."
2043
+ },
2044
+ {
2045
+ "product": "desk",
2046
+ "name": "zoho.desk.updateRelatedRecord",
2047
+ "syntax": "<variable>=zoho.desk.updateRelatedRecord(<orgID>, <sub_module>, <sub_recordID>, <parent_module>, <parent_recordID>, <record_value>, <connection>);",
2048
+ "overview": "This task is used to update a related record in a submodule belonging to a record in a parent module in Zoho Desk."
2049
+ },
2050
+ {
2051
+ "product": "inventory",
2052
+ "name": "zoho.inventory.createRecord",
2053
+ "syntax": "<response> = zoho.inventory.createRecord(<module>, <org_id>, <data_map>, [<connection>]);",
2054
+ "overview": "Learn how to create a record in the specified module of Zoho Inventory using deluge"
2055
+ },
2056
+ {
2057
+ "product": "inventory",
2058
+ "name": "zoho.inventory.getOrganizations",
2059
+ "syntax": "<response> = zoho.inventory.getOrganizations([<connection>]);",
2060
+ "overview": "The zoho.inventory.getOrganizations task is used to fetch all the organizations associated with your Zoho Inventory account."
2061
+ },
2062
+ {
2063
+ "product": "inventory",
2064
+ "name": "zoho.inventory.getRecordsByID",
2065
+ "syntax": "<response> = zoho.inventory.getRecordsByID(<module>, <org_id>, <record_id>, [<connection>]);",
2066
+ "overview": "Learn how to fetch records from a specified module of Zoho Inventory with record ID using deluge"
2067
+ },
2068
+ {
2069
+ "product": "inventory",
2070
+ "name": "zoho.inventory.getRecords",
2071
+ "syntax": "<response> = zoho.inventory.getRecords(<module>, <org_id>, [<criteria_map>], [<connection>]);",
2072
+ "overview": "Learn how to get records from the specified module of Zoho Inventory using deluge"
2073
+ },
2074
+ {
2075
+ "product": "inventory",
2076
+ "name": "zoho.inventory.markStatus",
2077
+ "syntax": "<response> = zoho.inventory.markStatus(<module>, <org_id>, <record_id>, <status>, [<connection>]);",
2078
+ "overview": "The zoho.inventory.markStatus task is used to change the status field with one of the allowed values in the specified Zoho Inventory module."
2079
+ },
2080
+ {
2081
+ "product": "inventory",
2082
+ "name": "zoho.inventory.updateRecord",
2083
+ "syntax": "<response> = zoho.inventory.updateRecord(<module>, <org_id>, <record_id>, <values_map>, [<connection>]);",
2084
+ "overview": "Learn how to update record in the specified module of Zoho Inventory using deluge"
2085
+ },
2086
+ {
2087
+ "product": "invoice",
2088
+ "name": "zoho.invoice.create",
2089
+ "syntax": "<variable> = zoho.invoice.create(<module_name>, <org_ID>, <data_map>, <connection>);",
2090
+ "overview": "This task is used to create a record in Zoho Invoice."
2091
+ },
2092
+ {
2093
+ "product": "invoice",
2094
+ "name": "zoho.invoice.getRecordById",
2095
+ "syntax": "<variable> = zoho.invoice.getRecordById(<module_name>,<org_ID>,<record_ID>);",
2096
+ "overview": "This task is used to fetch a record from Zoho Invoice using the record ID."
2097
+ },
2098
+ {
2099
+ "product": "invoice",
2100
+ "name": "zoho.invoice.getRecords",
2101
+ "syntax": "<variable> = zoho.invoice.getRecords(<module_name>, <org_ID>, <search_map>, <searchText>, <sortColumn>, <connection>);",
2102
+ "overview": "This task is used to fetch records from Zoho Invoice."
2103
+ },
2104
+ {
2105
+ "product": "invoice",
2106
+ "name": "zoho.invoice.update",
2107
+ "syntax": "<variable> = zoho.invoice.update(<module_name>, <org_ID>, <record_ID>, <data_map>);",
2108
+ "overview": "This task is used to update a record in Zoho Invoice using the record ID."
2109
+ },
2110
+ {
2111
+ "product": "mail",
2112
+ "name": "zoho.mail.createFolder",
2113
+ "syntax": "<response> = zoho.mail.createFolder(<folderName>, <parent_folder_id>, <connection>);",
2114
+ "overview": "The zoho.mail.createFolder task is used to create a new folder in Zoho Mail."
2115
+ },
2116
+ {
2117
+ "product": "mail",
2118
+ "name": "zoho.mail.createTag",
2119
+ "syntax": "<response> = zoho.mail.createTag(<tag_name>, <color>, <connection>);",
2120
+ "overview": "The zoho.mail.createTag task is used to create a tag with the specified color in Zoho Mail."
2121
+ },
2122
+ {
2123
+ "product": "mail",
2124
+ "name": "zoho.mail.getFolders",
2125
+ "syntax": "<response>=zoho.mail.getFolders(<connection>);",
2126
+ "overview": "The zoho.mail.getFolders task fetches the list of all the folders from Zoho Mail."
2127
+ },
2128
+ {
2129
+ "product": "mail",
2130
+ "name": "zoho.mail.getLabels",
2131
+ "syntax": "<response> = zoho.mail.getLabels(<connection>);",
2132
+ "overview": "The zoho.mail.getLabels task is used to retrieve all the label names from your Zoho Mail account."
2133
+ },
2134
+ {
2135
+ "product": "mail",
2136
+ "name": "zoho.mail.getMessage",
2137
+ "syntax": "<response> = zoho.mail.getMessage(<message_id>, <connection>);",
2138
+ "overview": "The zoho.mail.getMessage task is used to retrieve details of an email from Zoho Mail."
2139
+ },
2140
+ {
2141
+ "product": "mail",
2142
+ "name": "zoho.mail.markAsRead",
2143
+ "syntax": "<response> = zoho.mail.markAsRead(<message_id>, <connection>);",
2144
+ "overview": "The zoho.mail.markAsRead task is used to mark an email as read in Zoho Mail."
2145
+ },
2146
+ {
2147
+ "product": "mail",
2148
+ "name": "zoho.mail.markAsUnread",
2149
+ "syntax": "<response> = zoho.mail.markAsUnread(<message_id>, <connection>);",
2150
+ "overview": "The zoho.mail.markAsUnread task is used to mark an email as unread in Zoho Mail."
2151
+ },
2152
+ {
2153
+ "product": "mail",
2154
+ "name": "zoho.mail.moveToFolder",
2155
+ "syntax": "<response> = zoho.mail.moveToFolder(<message_id>, <folder_id>/<folder_path>, <connection>);",
2156
+ "overview": "The zoho.mail.moveToFolder task is used to move an email from one folder to another in Zoho Mail."
2157
+ },
2158
+ {
2159
+ "product": "mail",
2160
+ "name": "zoho.mail.removeFlag",
2161
+ "syntax": "<response> = zoho.mail.removeFlag(<message_id>, <connection>);",
2162
+ "overview": "The zoho.mail.removeFlag task is used to remove flag from previously flagged emails in Zoho Mail."
2163
+ },
2164
+ {
2165
+ "product": "mail",
2166
+ "name": "zoho.mail.setFlag",
2167
+ "syntax": "<response> = zoho.mail.setFlag(<message_id>, <flag_name>, <connection>);",
2168
+ "overview": "The zoho.mail.setFlag task is used to flag an email in Zoho Mail."
2169
+ },
2170
+ {
2171
+ "product": "mail",
2172
+ "name": "zoho.mail.setTag",
2173
+ "syntax": "<response> = zoho.mail.setTag(<message_id>, <tag>, <connection>);",
2174
+ "overview": "The zoho.mail.setTag task is used to set tags to the specified email in Zoho Mail."
2175
+ },
2176
+ {
2177
+ "product": "people",
2178
+ "name": "zoho.people.create",
2179
+ "syntax": "<response> = zoho.people.create(<form_name>, <record_values>, [<connection>]);",
2180
+ "overview": "The zoho.people.create task is used to create a record in the specified Zoho People form."
2181
+ },
2182
+ {
2183
+ "product": "people",
2184
+ "name": "zoho.people.getRecordById",
2185
+ "syntax": "<response> = zoho.people.getRecordById(<form_name>, <record_id>, [<connection>]);",
2186
+ "overview": "The zoho.people.getRecordById task is used to fetch a record from the specified Zoho People form using its ID."
2187
+ },
2188
+ {
2189
+ "product": "people",
2190
+ "name": "zoho.people.getRecords",
2191
+ "syntax": "<response> = zoho.people.getRecords(<form_name>, [<from_index>],[<count>], [<search_criteria>], [<connection>]);",
2192
+ "overview": "The zoho.people.getRecords task is used to fetch records from the specified Zoho People form."
2193
+ },
2194
+ {
2195
+ "product": "people",
2196
+ "name": "zoho.people.update",
2197
+ "syntax": "<response> = zoho.people.update(<form_name>, <new_values>, [<connection>]);",
2198
+ "overview": "The zoho.people.update task is used to update a record in the specified Zoho People form."
2199
+ },
2200
+ {
2201
+ "product": "projects",
2202
+ "name": "zoho.projects.associateLogs",
2203
+ "syntax": "<response> = zoho.projects.associateLogs(<portal>, <project_id>, <module>, <record_id>, <values>, [<connection>]);",
2204
+ "overview": "Learn how to create a time log and associates it with the specified record in Zoho Projects using deluge"
2205
+ },
2206
+ {
2207
+ "product": "projects",
2208
+ "name": "zoho.projects.createProject",
2209
+ "syntax": "<response>=zoho.projects.createProject(<portal>, [<values>], [<connection>]);",
2210
+ "overview": "Learn how to create a Zoho project in a specified portal using deluge"
2211
+ },
2212
+ {
2213
+ "product": "projects",
2214
+ "name": "zoho.projects.create",
2215
+ "syntax": "<response> = zoho.projects.create(<portal>, <project_id>, <module>, <data_map>, [<connection>]);",
2216
+ "overview": "Learn how to create a new record in the specified Zoho Projects module using deluge"
2217
+ },
2218
+ {
2219
+ "product": "projects",
2220
+ "name": "zoho.projects.getPortals",
2221
+ "syntax": "<response>=zoho.projects.getPortals([<connection>]);",
2222
+ "overview": "Learn how to fetch the details of all your portals in Zoho Projects using deluge"
2223
+ },
2224
+ {
2225
+ "product": "projects",
2226
+ "name": "zoho.projects.getProjectDetails",
2227
+ "syntax": "<response>=zoho.projects.getProjectDetails(<portal>, [<status>], [<connection>]);",
2228
+ "overview": "Learn how to fetch all the projects from the specified portal in Zoho Projects using deluge"
2229
+ },
2230
+ {
2231
+ "product": "projects",
2232
+ "name": "zoho.projects.getRecordById",
2233
+ "syntax": "<response> = zoho.projects.getRecordById(<portal>, <project_id>, <module>, [<record_id>], [<connection>]);",
2234
+ "overview": "Learn how to fetch a record from the specified Zoho Projects module with record ID using deluge"
2235
+ },
2236
+ {
2237
+ "product": "projects",
2238
+ "name": "zoho.projects.getRecords",
2239
+ "syntax": "<response> = zoho.projects.getRecords(<portal>, <project_id>, <module>, <dataMap/index>, <range>, <connection>);",
2240
+ "overview": "The zoho.projects.getRecords task fetched all the records from the specified module in Zoho Projects."
2241
+ },
2242
+ {
2243
+ "product": "projects",
2244
+ "name": "zoho.projects.updateAssociateLogs",
2245
+ "syntax": "<response> = zoho.projects.updateAssociateLogs(<portal>, <project_id>, <log_record_id>, <module>, <record_id>, <values>, [<connection>]);",
2246
+ "overview": "Learn how to update the time log associated with the specified record in Zoho Projects using deluge"
2247
+ },
2248
+ {
2249
+ "product": "projects",
2250
+ "name": "zoho.projects.update",
2251
+ "syntax": "<response> = zoho.projects.update(<portal>, <project_id>, <module>, <record_id>, <data_map>, [<connection>]);",
2252
+ "overview": "Learn how to update records in a specified Zoho Projects module using deluge"
2253
+ },
2254
+ {
2255
+ "product": "recruit",
2256
+ "name": "zoho.recruit.addRecord",
2257
+ "syntax": "<variable> = zoho.recruit.addRecord(<module_name>, <data_map>, <duplicate_check>, <workflow_trigger>, <connection>);",
2258
+ "overview": "The zoho.recruit.addRecord task is used to create records in Zoho Recruit."
2259
+ },
2260
+ {
2261
+ "product": "recruit",
2262
+ "name": "zoho.recruit.getRecordbyId",
2263
+ "syntax": "<variable> = zoho.recruit.getRecordbyId(<module_name>, <recordID>, <connection>);",
2264
+ "overview": "The zoho.recruit.getRecordbyId task is used to fetch records from Zoho Recruit, based on the specified record ID."
2265
+ },
2266
+ {
2267
+ "product": "recruit",
2268
+ "name": "zoho.recruit.getRecords",
2269
+ "syntax": "<variable> = zoho.recruit.getRecords(<module_name>, <fromIndex>, <toIndex>, <(selectColumns)>, <sortColumnString>, <sortOrderString>, <connection>);",
2270
+ "overview": "The zoho.recruit.getRecords task is used to fetch records from Zoho Recruit."
2271
+ },
2272
+ {
2273
+ "product": "recruit",
2274
+ "name": "zoho.recruit.searchRecords",
2275
+ "syntax": "<variable> = zoho.recruit.searchRecords(<module_name>, <searchCondition>, <fromIndex>, <toIndex>, <selectColumns>, <connection>);",
2276
+ "overview": "The zoho.recruit.searchRecords task is used to search and fetch required records from Zoho Recruit."
2277
+ },
2278
+ {
2279
+ "product": "recruit",
2280
+ "name": "zoho.recruit.updateRecord",
2281
+ "syntax": "<variable> = zoho.recruit.updateRecord(<module_name>, <record_ID>, <data_map>, <workflow_trigger>, <connection>);",
2282
+ "overview": "The zoho.recruit.updateRecord is used to update a record in Zoho Recruit."
2283
+ },
2284
+ {
2285
+ "product": "salesiq",
2286
+ "name": "zoho.salesiq.visitorsession.get",
2287
+ "syntax": "<response> = zoho.salesiq.visitorsession.get(<portal_name>, <key>,<connection>);",
2288
+ "overview": "The zoho.salesiq.visitorsession.get task fetches the value temporarily stored by the zoho.salesiq.visitorsession.set task."
2289
+ },
2290
+ {
2291
+ "product": "salesiq",
2292
+ "name": "zoho.salesiq.visitorsession.set",
2293
+ "syntax": "<response> = zoho.salesiq.visitorsession.set(<portal_name>, <session_data>,<connection>);",
2294
+ "overview": "The zoho.salesiq.visitorsession.set task temporarily stores values during a chat conversation with your website visitors."
2295
+ },
2296
+ {
2297
+ "product": "sheet",
2298
+ "name": "zoho.sheet.createRecords",
2299
+ "syntax": "<response> = zoho.sheet.createRecords(<resource_id>, <worksheet_name>, <row_data>, <query_map>, <connection>);",
2300
+ "overview": "Learn how to insert data into the specified worksheet of a Zoho Sheet file using deluge"
2301
+ },
2302
+ {
2303
+ "product": "sheet",
2304
+ "name": "zoho.sheet.find",
2305
+ "syntax": "<response> = zoho.sheet.find(<resource_id>, <scope>, <search_text>, <worksheet_name>, <row_index/column_index>, <connection>);",
2306
+ "overview": "Learn how to find the specified text in a row, column, worksheet, or workbook of Zoho Sheet file using deluge"
2307
+ },
2308
+ {
2309
+ "product": "sheet",
2310
+ "name": "zoho.sheet.getRecords",
2311
+ "syntax": "<response> = zoho.sheet.getRecords(<resource_id>,<worksheet_name>, <query_map>, <connection>);",
2312
+ "overview": "Learn how to fetch data from a specified worksheet of a Zoho Sheets file using zoho.sheet.getRecords task."
2313
+ },
2314
+ {
2315
+ "product": "sheet",
2316
+ "name": "zoho.sheet.getSheets",
2317
+ "syntax": "<response> = zoho.sheet.getSheets(<resource_id>, <connection>);",
2318
+ "overview": "Learn how to fetch a list of all the worksheets from the specified Zoho Sheet file using deluge"
2319
+ },
2320
+ {
2321
+ "product": "sheet",
2322
+ "name": "zoho.sheet.insertCSV",
2323
+ "syntax": "<response> = zoho.sheet.insertCSV(<resource_id>, <worksheet_name>, <csv_data>, <row>, <column>, <connection>);",
2324
+ "overview": "Learn to insert comma-separated values (CSV) into the specified worksheet of the Zoho Sheet file using zoho.sheet.insertCSV task."
2325
+ },
2326
+ {
2327
+ "product": "sheet",
2328
+ "name": "zoho.sheet.replace",
2329
+ "syntax": "<response> = zoho.sheet.replace(<resource_id>, <scope>, <search_text>, <replace_with>, <worksheet_name>, <row_index/column_index>,[<connection>]);",
2330
+ "overview": "Learn how to find the specified text in a row, column, worksheet, or workbook of Zoho Sheet file, and replace all its occurrences with a new text using deluge"
2331
+ },
2332
+ {
2333
+ "product": "sheet",
2334
+ "name": "zoho.sheet.updateRecords",
2335
+ "syntax": "<response> = zoho.sheet.updateRecords(<resource_id>, <worksheet_name>, <criteria>, <data_map>, <optional_map>, <connection>);",
2336
+ "overview": "Learn how to update rows that satisfy the specified criteria with new values in Zoho Sheet using deluge"
2337
+ },
2338
+ {
2339
+ "product": "subscription",
2340
+ "name": "zoho.billing.getList",
2341
+ "syntax": "<variable> = zoho.billing.getList(<moduleName>, <organization_ID>, <per_page>, <page>, <connection>);",
2342
+ "overview": "This task is used to fetch records from Zoho Billing."
2343
+ },
2344
+ {
2345
+ "product": "subscriptions",
2346
+ "name": "zoho.billing.create",
2347
+ "syntax": "<variable> = zoho.billing.create(<module_name>, <org_id>, <data_map>, <connection>);",
2348
+ "overview": "This task is used to create a record in Zoho Billing."
2349
+ },
2350
+ {
2351
+ "product": "subscriptions",
2352
+ "name": "zoho.billing.retrieve",
2353
+ "syntax": "<variable> = zoho.billing.retrieve(<module_name>, <org_ID>,<record_ID>, <connection>);",
2354
+ "overview": "This task is used to fetch a record from Zoho Billing by specifying the record ID."
2355
+ },
2356
+ {
2357
+ "product": "subscriptions",
2358
+ "name": "zoho.billing.update",
2359
+ "syntax": "<variable> = zoho.billing.update(<moduleName>, <organization_id>, <record_ID>, <data_map>, <connection>);",
2360
+ "overview": "This task is used to update a record in Zoho Billing using the record ID."
2361
+ },
2362
+ {
2363
+ "product": "workdrive",
2364
+ "name": "zoho.workdrive.createFolder",
2365
+ "syntax": "<response> = zoho.workdrive.createFolder(<folder_name>, <parent_id>, <connection>);",
2366
+ "overview": "The zoho.workdrive.createFolder task creates a folder within the specified folder under my folders."
2367
+ },
2368
+ {
2369
+ "product": "workdrive",
2370
+ "name": "zoho.workdrive.createTeamFolder",
2371
+ "syntax": "<response> = zoho.workdrive.createTeamFolder(<folder_name>, <parent_id>, <description>, <is_public_within_team>, <connection>);",
2372
+ "overview": "Learn how to create a team folder for the specified team in Zoho WorkDrive using deluge"
2373
+ },
2374
+ {
2375
+ "product": "workdrive",
2376
+ "name": "zoho.workdrive.uploadFile",
2377
+ "syntax": "<response> = zoho.workdrive.uploadFile(<file>, <folder_id>, <file_name>, <override_name_exist>, <connection>);",
2378
+ "overview": "Learn how zoho.workdrive.uploadFile task uploads a file to the specified folder in Zoho WorkDrive."
2379
+ },
2380
+ {
2381
+ "product": "writer",
2382
+ "name": "zoho.writer.generateFillableLink",
2383
+ "syntax": "<response>=zoho.writer.generateFillableLink(<document_id>,<merge_detail>,<optional_settings>,<connection>)\n\nParameters\nData type\nDescription\n\n<response>\nKEY-VALUE\nThe response returned by Zoho Writer. It provides the merged document's details, fillable link for each record, and the merge status.\n\n<document_id>\nTEXT\nThe document ID can be obtained from the URL of the document from which fillable li",
2384
+ "overview": "The zoho.writer.generateFillableLink task merges your document and generates prefilled fillable links to collect data."
2385
+ },
2386
+ {
2387
+ "product": "writer",
2388
+ "name": "zoho.writer.v2.mergeAndSend",
2389
+ "syntax": "<response> = zoho.writer.v2.mergeAndSend(<document_id>, <merge_detail>, <output_settings>, <optional_settings>, <connection>)",
2390
+ "overview": "The zoho.writer.v2.mergeAndSend task merges your document and sends it via email."
2391
+ },
2392
+ {
2393
+ "product": "writer",
2394
+ "name": "zoho.writer.documents.setDescription",
2395
+ "syntax": "<response>=zoho.writer.documents.setDescription(<document_id>,<Description>,<connection>);",
2396
+ "overview": "The zoho.writer.documents.setDescription adds or updates the document description with the given description."
2397
+ },
2398
+ {
2399
+ "product": "writer",
2400
+ "name": "zoho.writer.documents.trackchanges",
2401
+ "syntax": "<response>=zoho.writer.documents.trackchanges(<document_id>,<enableTC>,<connection>);",
2402
+ "overview": "The zoho.writer.documents.trackchanges enables or disables track changes option in the given document."
2403
+ },
2404
+ {
2405
+ "product": "writer",
2406
+ "name": "zoho.writer.getAllFields",
2407
+ "syntax": "<response>=zoho.writer.getAllFields(<document_id>,<connection>);",
2408
+ "overview": "The zoho.writer.getAllFields task is used to fetch all the fields present in the document in Zoho Writer."
2409
+ },
2410
+ {
2411
+ "product": "writer",
2412
+ "name": "zoho.writer.getDocuments",
2413
+ "syntax": "<response> = zoho.writer.getDocuments(<category>, <offset>, <limit>, <sort_by>, <connection>);",
2414
+ "overview": "Learn how to fetch a list of all the documents from Zoho Writer using deluge"
2415
+ },
2416
+ {
2417
+ "product": "writer",
2418
+ "name": "zoho.writer.getMergeFields",
2419
+ "syntax": "<response> = zoho.writer.getMergeFields(<document_id>, <connection>);",
2420
+ "overview": "Learn how to list all the merge fields inserted into a Zoho Writer document."
2421
+ },
2422
+ {
2423
+ "product": "writer",
2424
+ "name": "zoho.writer.getMergeTemplates",
2425
+ "syntax": "<response>=zoho.writer.getMergeTemplates(<optional_settings>,<connection>);",
2426
+ "overview": "The zoho.writer.getMergeTemplates lists all the merge templates created by the user."
2427
+ },
2428
+ {
2429
+ "product": "writer",
2430
+ "name": "zoho.writer.getSignTemplates",
2431
+ "syntax": "<response>=zoho.writer.getSignTemplates(<optional_settings>,<connection>);",
2432
+ "overview": "The zoho.writer.getSignTemplates lists all the sign templates created by the user."
2433
+ },
2434
+ {
2435
+ "product": "writer",
2436
+ "name": "zoho.writer.documents.lock",
2437
+ "syntax": "<response>=zoho.writer.documents.lock(<document_id>,<enableLock>,<connection>);",
2438
+ "overview": "The zoho.writer.documents.lock locks or unlocks the specified document."
2439
+ },
2440
+ {
2441
+ "product": "writer",
2442
+ "name": "zoho.writer.documents.markAsReady",
2443
+ "syntax": "<response>=zoho.writer.documents.markAsReady(<document_id>,<connection>);",
2444
+ "overview": "The zoho.writer.documents.markAsReady marks the document as ready."
2445
+ },
2446
+ {
2447
+ "product": "writer",
2448
+ "name": "zoho.writer.documents.MarkAsFinal",
2449
+ "syntax": "<response>=zoho.writer.documents.MarkAsFinal(<document_id>,<markAsFinal>,<connection>);",
2450
+ "overview": "The zoho.writer.documents.MarkAsFinal enables or disables editing in the document."
2451
+ },
2452
+ {
2453
+ "product": "writer",
2454
+ "name": "zoho.writer.documents.favorite",
2455
+ "syntax": "<response>=zoho.writer.documents.favorite(<document_id>,<operation_type>,<connection>)",
2456
+ "overview": "The zoho.writer.documents.favorite marks or unmarks the document as favorite."
2457
+ },
2458
+ {
2459
+ "product": "writer",
2460
+ "name": "zoho.writer.mergeAndInvoke",
2461
+ "syntax": "<response>=zoho.writer.mergeAndInvoke(<document_id>,<merge_detail>,<optional_settings>,<connection>)",
2462
+ "overview": "The zoho.writer.mergeAndInvoke task merges the document and invokes a custom funciton to perform further operations on it."
2463
+ },
2464
+ {
2465
+ "product": "writer",
2466
+ "name": "zoho.writer.mergeAndSend",
2467
+ "syntax": "<response> = zoho.writer.mergeAndSend(<document_id>, <output_format>, <email_id>, <values_map>, <connection>);",
2468
+ "overview": "Learn about zoho.writer.mergeAndSend task which supplies values to the merge fields inserted to a document, and sends the new merged documents individually."
2469
+ },
2470
+ {
2471
+ "product": "writer",
2472
+ "name": "zoho.writer.mergeAndSign",
2473
+ "syntax": "<response>=zoho.writer.mergeAndSign(<document_id>,<merge_detail>,<filename>,<signerList>,<option_settings>,<connection>)",
2474
+ "overview": "The zoho.writer.mergeAndSign task merges the document and sends it for signature collection to its recipients."
2475
+ },
2476
+ {
2477
+ "product": "writer",
2478
+ "name": "zoho.writer.v2.mergeAndStore",
2479
+ "syntax": "<response>=zoho.writer.v2.mergeAndStore(<document_id>,<merge_detail>,<output_settings>,<optional_settings>,<connection>)",
2480
+ "overview": "The zoho.writer.v2.mergeAndStore task merges the document and stores it in a specific location in Zoho WorkDrive."
2481
+ },
2482
+ {
2483
+ "product": "writer",
2484
+ "name": "zoho.writer.documents.setName",
2485
+ "syntax": "<response>=zoho.writer.documents.setName(<document_id>,<name>,<connection>)",
2486
+ "overview": "The zoho.writer.documents.setName renames the document with the given name."
2487
+ },
2488
+ {
2489
+ "product": "writer",
2490
+ "name": "zoho.writer.shareDocument",
2491
+ "syntax": "<response> = zoho.writer.shareDocument(<document_id>, <email_id>, <role>, <type>, <connection>);",
2492
+ "overview": "Learn how to share a Zoho Writer document owned or co-owned by you with other users using deluge"
2493
+ },
2494
+ {
2495
+ "product": "writer",
2496
+ "name": "zoho.writer.signDocument",
2497
+ "syntax": "<response> = zoho.writer.signDocument(<document_id>, <service>, <recipients>, <signed_document_name>, <input_map>, <connection>);",
2498
+ "overview": "The zoho.writer.signDocument task sends an email to get a document signed by the specified recipients."
2499
+ },
2500
+ {
2501
+ "product": "writer",
2502
+ "name": "zoho.writer.uploadDocument",
2503
+ "syntax": "<response> = zoho.writer.uploadDocument(<content>, <file_name>, <folder_id>, <password>, <connection>);",
2504
+ "overview": "Learn how to upload a document to Zoho Writer using deluge"
2505
+ },
2506
+ {
2507
+ "product": "writer",
2508
+ "name": "zoho.writer.v2.signDocument",
2509
+ "syntax": "<response>=zoho.writer.v2.signDocument(<document_id>,<recipients_list>,<signed_document_name>,<optional_settings>,<connection>);",
2510
+ "overview": "The zoho.writer.v2.signDocument task sends a document for signature and tracks its status."
2511
+ }
2512
+ ],
2513
+ "statements": [
2514
+ {
2515
+ "name": "if / else if / else / conditional if / ifNull",
2516
+ "syntax": "if statement:\nif (<criteria>)\n{\n<actions>\n}\nelse if statement:\nif (criteria)\n{\n<actions>\n}\nelse if (criteria)\n{\n<actions>\n}\nelse statement:\nif (criteria)\n{\n<actions>\n}\nelse\n{\n<actions>\n}\nconditional if statement:\n<variable> = if (<criteria> , <success_value>, <failure_value>); \nifNull statement:\n<variable> = ifNull (<expression1> , <expression2>); \n\nParam\nExplanation\n\n<criteria>\nCriteria based on which the actions will be executed.\n\n<actions>\nAction(s) to be executed when specified criteria are met. \nYou can also use deluge tasks here.\n\n<variable>\nVariable holding the returned value.\n\n<success_value>\nThe value specified here will be returned if the criterion is met.\nYou can directly specify a value, or you can also specify an expression, i.e. a combination of values, constants, variables, operators, functions and so on, which evaluates to a value.\nYou can also specify any statements that",
2517
+ "overview": "Conditional statements examine specified criteria, and act in one way if the criteria are met, or in another way if the criteria are not met."
2518
+ },
2519
+ {
2520
+ "name": "for each",
2521
+ "syntax": "for each <elementVariable> in <variable>\n {\n }",
2522
+ "overview": "The for each element deluge task iterates through all the elements present in a list, comma-separated text, or a CSV file."
2523
+ },
2524
+ {
2525
+ "name": "break",
2526
+ "syntax": "break;\n\nThe syntax can be placed within a conditional block. When the condition is met, the current loop is terminated and the immediate next statement after the loop takes the control.",
2527
+ "overview": "The break statement when executed terminates the execution of the current loop and resumes execution of the first statement after the loop."
2528
+ },
2529
+ {
2530
+ "name": "continue",
2531
+ "syntax": "continue;\n\nThe syntax can be placed within the loop after a conditional statement. When the condition is met, the current iteration is skipped while the loop continues.",
2532
+ "overview": "The continue statement skips a particular iteration within a loop based on specified condition and continues with the iteration process."
2533
+ },
2534
+ {
2535
+ "name": "try / catch",
2536
+ "syntax": "try \n{ \n <script>// Enclose Deluge script that might raise an exception. \n // You may also use the throw statement here to raise \n // an exception explicitly. \n} \ncatch(<exception_variable>) \n{ \n <script>// Handle the exception here. \n // You can inspect, log, or re-throw the exception. \n} \n\nThe throw statement can be used inside the try block to explicitly raise an exception. See the throw statement page for full details.",
2537
+ "overview": "The try-catch The try-catch statement is used to handle exceptions in a Deluge script."
2538
+ },
2539
+ {
2540
+ "name": "throw",
2541
+ "syntax": "throw<expression>;\n\nThe throw statement accepts an expression that describes the exception to be thrown. The expression can be of the following types:\nExpression Type\nPurpose\nExample\n\nText\nRaises an exception using a text value as the exception message. The value can be specified directly or supplied through a Text variable.\n\"Email address is required.\" \n\n(or) \n\nerrorMessage \n\nwhere errorMessage = \"Email address is required.\";\n\nMap\nRaises an exception using a map containing the mandatory message key and optional data key. The map can be specified directly or supplied through a Map variable. \n\nNote: The message key is mandatory. The data key is optional, and can contain any Deluge data type.\n{\n \"message\":\"Validation failed.\",\n \"data\":\n {\n \"field\":\"Email\",\n \"value\":input.Email\n }\n}\n\nException variable\nRe-throws a previously caught exception.\ne\n\nOnce the exception has been raised, Deluge sk",
2542
+ "overview": ""
2543
+ },
2544
+ {
2545
+ "name": "sendmail",
2546
+ "syntax": "sendmail[from: <from_address>to: <to_address>cc: <cc>bcc: <bcc>reply to: <reply_to_address>subject: <subject>message: <message>content type: <content_type>attachments: <attachment>]\n\nParameter\nData type\nDescription\n\n<from_address>\n\nTEXT\nThe value you provide here will be displayed as the sender's email address.\nAllowed Values:\nYou can hardcode the sender's email address.\nYou can specify the system variable zoho.adminuserid.\nYou can specify the system variable zoho.loginuserid as long as the user is not a customer portal user. If the user is a portal user, the email address has to be verified before it can be used as the FROM address.\nThe address can be specified in the format \"John <john@zylker.com>\" to display the sender name in the recipient's inbox.\nIn Zoho Creator, you can specify the value entered in email address field type in your form in the format: input.<email_field_link_name>.",
2547
+ "overview": "To improve email deliverability, we will be following Gmail's updated sender email policy starting from February 1, 2024."
2548
+ }
2549
+ ],
2550
+ "invokeurl": {
2551
+ "syntax": "response =invokeUrl \n[ \nurl: <url_value> \ntype: <type_value>headers: <headers_value>\nbody: <body_value>\nparameters: <parameters_value>\nfiles: <files_value>\nconnection: <connection_name>\ndetailed: <detailed_value> \nresponse-format: <response_format_value>\nresponse-decoding: <encoding_format_value>];",
2552
+ "params": "Parameter\nData type\nDescription\n\n<response>\nKEY-VALUE/ FILE/ TEXT/ LIST\nThe variable that will contain the response returned.\n\n<url_value>\n\nTEXT\nThe request URL whose resources need to be accessed.\nNote: URL domains with user-created SSL certificates cannot be invoked using this task.\n\n<type_value>\n(optional)\n\nConstant\nThe HTTP request method.\nAllowed values:\nGET\nPOST\nPUT\nPATCH\nDELETE\nOPTIONS\nDefault value: GET\nNote:\nOPTIONS is used to check what actions a server allows before making the real request. It doesn’t send or change any data, it only asks the server what is allowed.\n\n<headers_value>\n(optional)\n\nKEY-VALUE\nThe attributes or the header values.\n\n<body_value>\nTEXT/ FILE/ KEY-VALUE\nThe optimal way to specify the data sent in an API request body.\n\nNote: \nIn order to add query parameters to the request, append the required value to the URL. For example, you can add the query param followed by the question mark(?) as part of the URL in the response,\nurl: \"http://www.thenonlinearpath.com/wp-content/uploads/2016/05/AddImage?page=2\"\nThe content-type specified in the header must match the data format of the body_value. For example,\nheaders: {\"Content-Type\": \"application/json\"}\nbody: {\"name\":\"John Doe\", \"email\":\"john.doe@example.com\"}\nThe default content-type for each body format is listed below. However, if the header explicitly specifies a content-type value, it will override the default setting.\n\nRequest body formats in invokeUrl:\nRaw: If the input value is of TEXT data, the body is considered to be in Raw format. Default content-type: text/plain. Alternatively, you can use application/json, text/html, application/xml, application/javascript, etc. by overriding content type using header.\nFormdata: If the input value is of Key-value data, by default the content-type will be sent as multipart/form-data. Alternatively, you can use application/x-www-form-urlencoded by overriding content type using header.\nBinary: If the input value is file data, the body is considered t",
2553
+ "overview": "The invokeUrl task is an HTTP client that allows you to access and modify:\nweb resources using HTTP calls."
2554
+ },
2555
+ "datatypes": [
2556
+ {
2557
+ "name": "boolean",
2558
+ "overview": "",
2559
+ "notes": " Example Overview The boolean datatype represents the boolean values - true and false. Note: Boolean values must not be enclosed in quotes Boolean values are case-insensitive Example job_experience = false; Salary_negotiable = true; Note: See this page to know the built-in functions that return a value of Boolean data type. See this page to know which Zoho Creator field types are of boolean data type. Get Started Now Execute ",
2560
+ "example": "Overview\nThe boolean datatype represents the boolean values - true and false."
2561
+ },
2562
+ {
2563
+ "name": "collection",
2564
+ "overview": "",
2565
+ "notes": " Types Create a collection Insert data into a collection Retrieve data from a collection Iterate through a collection List/Map vs Collection Related Links Note: Collection data type is not to be confused with a collection variable. To learn about a collection variable, which is used to hold a collection of records in Zoho Creator, refer to this page. Overview Collection allows you to store, insert, retrieve, delete, and manipulate a group of data. The values in a collection can be of any basic data type. Or, the values themselves could be collections. Types The following two types are the broad classification of collection. Index-value collection The index-value collection holds the data i",
2566
+ "example": "The following collection has 3 values. Therefore, the index starts from 0 and extends up to 2.\nIndex\n0\n1\n2\n\nValue\nShawn\nAlan\nKate\n\nThe index of Shawn, Alan, and Kate are 0, 1, and 2 respectively.\n\nKey-value collection\nThe key-value collection does not hold values in an ordered"
2567
+ },
2568
+ {
2569
+ "name": "date-time",
2570
+ "overview": "",
2571
+ "notes": " Example Overview The date-time datatype represents date and time values in a variety of supported formats. Note: Date-time values must be enclosed within single quotes. A date can be declared without time, in which case 00:00:00 is taken as the default. Example date = '15-Aug-1947'; appointment_time = '15-Aug-1947 19:00:00'; Supported Date formats dd-MMM-yy (15-Aug-47) dd-MMM-yyyy (15-Aug-1947) dd-MMMM-yy (15-August-47) dd-MMMM-yyyy (15-August-1947) MM-dd-yy (08-15-47) yy-MM-dd (47-08-15) dd-MM-yy (15-08-47) dd-MM-yyyy (15-08-1947) MM-dd-yyyy (08-15-1947) yyyy-MM-dd (1947-08-15) yy/MM/dd (47/08/15) dd/MM/yy (15/08/47) MM/dd/yy (08/15/47) yyyy/MM/dd (1947/08/15) MM/dd/yyyy (08/15/1947",
2572
+ "example": "Overview\nThe date-time datatype represents date and time values in a variety of supported formats."
2573
+ },
2574
+ {
2575
+ "name": "decimal",
2576
+ "overview": "",
2577
+ "notes": " Example Overview The decimal datatype represents decimal values, commonly used to represent values such as currency, percentage, etc. Example planPrice = 0.99; Note: See this page to find the built-in functions applicable to decimal data type. See this page to know which Zoho Creator field types are of decimal data type. Get Started Now Execute ",
2578
+ "example": "Overview\nThe decimal datatype represents decimal values, commonly used to represent values such as currency, percentage, etc.\nExample\nplanPrice = 0.99;\n Note: See this page to find the built-in functions applicable to decimal data type.\nSee this page to know which Zoho Creator field types are of dec"
2579
+ },
2580
+ {
2581
+ "name": "key-value",
2582
+ "overview": "",
2583
+ "notes": " Example Overview Key-Value is a data-type which holds values based on keys. The keys can be used to retrieve the corresponding values. Keys must be unique. If the same key is specified again, its value will overwrite the first value. Both, keys and values can be of any data type. Example ZohoProduct = {\"Product\" : \"Creator\", \"Version\" : 5}; The key value pairs can be subject to various operations such as: Key-value pair operations - Perform actions based on the key-value pair. For example, functions such as put(), get() and putAll() Search - Search for key or value return a boolean value. For example, functions such as containKey() and containValue(). Range - Perform range operations to re",
2584
+ "example": "Overview\nKey-Value is a data-type which holds values based on keys. The keys can be used to retrieve the corresponding values.\nKeys must be unique. If the same key is specified again, its value will overwrite the first value.\nBoth, keys and values can be of any data type.\nExample\nZohoProduct = {\"Pro"
2585
+ },
2586
+ {
2587
+ "name": "list",
2588
+ "overview": "",
2589
+ "notes": " Example Overview List is a data-type which can hold a collection of values. Each value present in the list is called an element. A list can contain elements of different types say number, text, date etc. grouped together. You can also restrict the list to only accept values of a specific data-type using special qualifiers. In general, a list provides methods to store, retrieve and manipulate an aggregate of elements. The limit to the number of elements that can be added depends on the method of addition: Assigning the elements directly - No limit Using the add builtin function - No limit (they need to be added one by one) Using the addAll builtin function - 25,000 elements Note: The index ",
2590
+ "example": "Overview\nList is a data-type which can hold a collection of values. Each value present in the list is called an element.\nA list can contain elements of different types say number, text, date etc. grouped together. You can also restrict the list to only accept values of a specific data-type using spe"
2591
+ },
2592
+ {
2593
+ "name": "number",
2594
+ "overview": "",
2595
+ "notes": " Example Overview The Number datatype represents integer values. These integer values can range from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,808. Number datatype does not include decimal values. However, Number datatype can be used to perform operations with decimal values, in which case the end result becomes a decimal datatype. Example Version = 5; Note: See this page to find the built-in functions applicable to Number data type. See this page to know which Zoho Creator field types are of Number data type. Get Started Now Execute ",
2596
+ "example": "Overview\nThe Number datatype represents integer values. These integer values can range from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,808.\nNumber datatype does not include decimal values. However, Number datatype can be used to perform operations with decimal values, in which case the end "
2597
+ },
2598
+ {
2599
+ "name": "text",
2600
+ "overview": "",
2601
+ "notes": " Example Overview The text, or string, datatype represents a sequence of characters. These characters can be text characters, special characters, numeric characters, or other valid input, and must be enclosed in double quotes. Note:The backslash ( \\ ) can be used to escape double quotes within a string Example Name = \"John\"; Address = \"Zoho Corporation, 4141 Hacienda Drive, Pleasanton, California 94588, USA\"; Num = \"1234567890\"; Note: See this page to find the built-in functions applicable to text data type. See this page to know which Zoho Creator field types are of text data type. Get Started Now Execute ",
2602
+ "example": "Overview\nThe text, or string, datatype represents a sequence of characters. These characters can be text characters, special characters, numeric characters, or other valid input, and must be enclosed in double quotes."
2603
+ },
2604
+ {
2605
+ "name": "time",
2606
+ "overview": "",
2607
+ "notes": " Example Overview The time datatype represents time values in both 12-hour and 24-hour formats. This data type works independently of a date value. Note: Time data type is currently supported only in Zoho Creator. Time values must be enclosed within single quotes. Time values range between '12:00:00 AM' to '11:59:59 PM' for 12-hour format. Time values range between '00:00:00' to '23:59:59' for 24-hour format. A time value should be defined with all the three components - hours, minutes and seconds in place (AM/PM in case of 12-hour format). Example available_from = '19:00:00'; closing_at = '06:00:00 PM'; Supported Time formats hh:mm:ss a (12-hour format) HH:mm:ss (24-hour format) Note:",
2608
+ "example": "Overview\nThe time datatype represents time values in both 12-hour and 24-hour formats. This data type works independently of a date value."
2609
+ },
2610
+ {
2611
+ "name": "typed list",
2612
+ "overview": "",
2613
+ "notes": " Syntax Examples Overview Create list variables which hold elements of a particular data type only. Syntax To declare a string list variable <variable> = List:String(); To declare a Bigint list variable <variable> = List:Int(); To declare a Decimal list variable <variable> = List:Float(); To declare a Timestamp list variable <variable> = List:date(); To declare a Boolean list variable <variable> = List:Bool(); Parameter Description <variable> Variable which will hold the list elements. Points to keep in mind for each type of list Data type of the list Points to keep in mind Text Text elements must be enclosed in single or double quotes. Number and Decimal elements can be specified with",
2614
+ "example": ""
2615
+ }
2616
+ ],
2617
+ "limits": "Statement Limitation\nThe maximum number of statements that can be executed in one function is 5000.\nNote: The number of statements executed need not always be equal to the number of statements present in a function.\n\nCase 1: for each task\nConsider the following script,\n\n for each element in list_var \n {\n //Statement 1\n //Statement 2\n }\n\n Let us assume, the list variable - list_var has 5 elements. This conveys that the for each loop runs 5 times. So,\nThe total number of statements present is 3 (includes the for each task and the two statements within).\n\nThe total number of statements executed is 15 (3 statements are executed 5 times).\n\nThe statement limitation imposed, accounts only the number of statements executed.\nCase 2: sendmail and invokeUrl tasks\nThe sendmail and invokeUrl tasks require more than one line of script to perform their respective functions. However, on execution, the task as a whole is treated as one statement.\nConsider the following example,\n\n sendmail \n [\n From: zoho.adminuserid\n To: \"john@zylker.com\"\n Subject: \"Reminder\"\n Message: \"Hello, this is to remind you that your invoice is due next week. Please let me know if you have any questions. Thank you.\"\n ]\n\n In the above script, the total number of statements executed is 1.\nRecursive Function Limitation\nThe maximum number of function calls that can be executed within one function is 75.\nTask Limitations\nTask\nLimit (per day)\n\nEmail\n\nThe maximum number of emails that a user can send using sendmail task is 500.\n\nWebhook\n\nThe maximum number of webhook tasks (invokeUrl, getUrl, and postUrl) that a user can execute is 2000.\n\nIntegration tasks\n\nThe maximum number of integration tasks that a user can execute is 2000.\n\nSendmail Task Limitation\nThe following restrictions are imposed on the sendmail task to avoid spam emails.\nIn services other than Zoho Cliq, the From: address should only be specified as zoho.adminuserid, or zoho.loginuserid*, or a verified email address. Otherwise, the sendmail task will fail.\nFrom\nTo\nResult\n\nzoho.adminuserid, zoho.loginuserid (*only when the logged in user is not a customer portal user), or verified email address\n(or)\nvariable that contains any of these\nAny email address\nMail will be sent\n\nemail address other than zoho.adminuserid, zoho.loginuserid, or verified email address\nAny email address\nError while saving\n\nvariable that contains email address other than zoho.adminuserid, zoho.loginuserid, or verified email address\nAny email address\nError during run time\n\nIn Zoho Cliq, the From: address should only be specified as zoho.loginuserid, or a verified email address. Otherwise, the sendmail task will fail.\nFrom\nTo\nResult\n\nzoho.loginuserid or verified email address\n(or)\nvariable that contains any of these\nAny email address\nMail will be sent\n\nemail address other than zoho.loginuserid or verified email address\nAny email address\nError while saving\n\nvariable that contains email address other than zoho.adminuserid, zoho.loginuserid, or verified email address\nAny email address\nError during run time\n\nThe maximum size of attachments that can be sent using a sendmail task is 15 MB.\n\nInvokeUrl Task Limitation\nThe maximum content length of the response that can",
2618
+ "systemVariables": "Date Variables\nThe table given below lists the Zoho variables and value returned by the variables.\nVariable\nReturns\n\nzoho.currentdate\nCurrent date in the format specified in Application settings.\n\nzoho.currenttime\nCurrent date and time in the format specified in Application settings.\n\nText Variables\nTo improve email deliverability, we will be following Gmail's updated sender email policy starting from February 1, 2024. This means that Gmail addresses cannot be used as a sender address in the send mail tasks. Learn More\nThe table given below lists the Zoho variables and value returned by the variables in a private and public application.\nVariable\nPrivate app / Logged-in user\nPublic app / Logged-in user\nPublic app / Public user\n\nzoho.loginuser\nUsername of the currently logged-in user\nPublic\nPublic\n\nzoho.loginuser.name\n(applicable only to Zoho Creator)\n\nName of the currently logged-in user\nPublic\nPublic\n\nzoho.loginuserid\nEmail address of the currently logged-in user\nNull\nNull\n\nOther Variables\nVariable\nReturns\n\nzoho.adminuser\nUsername of the Application owner\n\nzoho.adminuserid\nEmail address of the Application owner\n\nzoho.appname\n(applicable only to Zoho Creator)\n\nApplication link name of the current application\n\nzoho.ipaddress\nPublic IP address of the current user \nThe value is displayed as null when the user is not in session.\n\nzoho.appuri\n(applicable only to Zoho Creator)\n\nApplication details in the format:\n/<admin_username>/<application_link_name>/\n\nzoho.device.type\nType of device used to access the application. Returns a text \"web\", \"phone\", or \"tablet\"\n\nNote: \nThe variable zoho.device.type is currently supported only in Zoho Creator.\nIt's also currently not supported for field rules events in forms.\nThe default value will be web for workflows where it's not possible to return the exact device type. For example, when used in Schedule workflows.\n\nThe zoho variable zoho.device.type is used to get the information of the end device type. The variable will return the device types web, phone, or tablet.\nFor example, in the development of a shopping application, you can make use of this zoho variable to fetch the device type and then adjust the interface elements, styling, and layout based on the user's preferred device type. This ensures an optimized journey for users accessing their Creator application platform across web, tablets, or mobile devices. The super admins and admins who manage the application's dashboard and review analytics, or the users shopping, can each experience the application tailored to their device, thereby enhancing user engagement.\nNot",
2619
+ "operators": "Types of Operators\nArithmetic Operators: Arithmetic operators are used to perform calculations on numerical values, as well as to concatenate two or more string values. \n\nAssignment Operators: Assignment Operators are of two types -- Simple assignment operator and Compound assignment operator. The simple assignment operator assigns the value of the right operand to the variable (or the field) specified in the left operand. Compound assignment operators consist of a binary operator and the simple assignment operator. They perform the operation of the binary operator on both operands and store the result of that operation into the left operand.\n\nLogical Operators: Logical operators are typically used with multiple conditions in a criteria. Each condition returns a boolean value, and the logical operators used to connect the conditions determine the overall boolean value of the criteria.\n\nRelational Operators: Relational operators compare two given values and return a boolean value, most commonly used in conditional statements.\n\nGet Started Now\nExecute\n\n ",
2620
+ "keywords": [
2621
+ "bool",
2622
+ "collection",
2623
+ "date",
2624
+ "false",
2625
+ "for-each",
2626
+ "else",
2627
+ "else-if",
2628
+ "float",
2629
+ "from",
2630
+ "if",
2631
+ "ifnull",
2632
+ "in",
2633
+ "int",
2634
+ "is",
2635
+ "list",
2636
+ "map",
2637
+ "null",
2638
+ "permissions",
2639
+ "portal",
2640
+ "reload",
2641
+ "return",
2642
+ "string",
2643
+ "thisapp",
2644
+ "true",
2645
+ "void",
2646
+ "zoho"
2647
+ ]
2648
+ }