Versions Compared

Version Old Version 2 New Version Current
Changes made by

Zoe Baldwin

Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Coming Soon

...

hiddentrue

Function: toJson()

Converts an object, such as an array or JSON string, to JSON.

Syntax

toJson(object)

ArgumentTypeDescription
Object

Array

String

Object to be converted to JSON.

...

Examples

Code Block
toJson(getCo)

Returns JSON from a lookup with an array of company objects.

...


The returned JSON has the following syntax:

  • Objects are enclosed in curly brackets, or braces ( { } )

    • An object's key-value pairs are separated by a comma ( , )

    • The key and value in a pair are separated by a colon ( : ), e.g. key : value

    • Keys in an object are strings, whereas values may be a string, number, object, array, true, false, or null, including another object or an array

    • Objects can contain other objects and/or arrays

  • Arrays are enclosed in square brackets ( [ ] )

    • An array's values are separated by a comma ( , )

    • Each value in an array may be of a different type, including another array or an object

    • Arrays can contain other arrays and/or objects

Examples

The data being converted:

CompanyIDCompanyNameIndustry
108Romaguera IncManufacturing
112Becker and SonsManufacturing
398Larson IncManufacturing

Example 1

Code Block
titleExample 1 Input
//Return the data from the lookup connector, getCo, as JSON
toJson(getCo)

Returns JSON containing an array of objects (each object is contained by curly brackets). Each object contains 3 key-value pairs, where the key and value are separated by a colon ( : ) and each key-value pair is separated by a comma ( , ).

Code Block
titleExample 1 Output
[ {
    "CompanyID" : 108,
    "CompanyName" : "Romaguera Inc",
    "Industry" : "Manufacturing"
  }, {
    "CompanyID" : 112,
    "CompanyName" : "Becker and Sons",
    "Industry" : "Manufacturing"
 }, {
    "CompanyID" : 398,
    "CompanyName" : "Larson Inc",
    "Industry" : "Manufacturing"

...

} ]

...

Example 2
 Code Block
titleExample 2 Input
{

//For each $company object, return the data from the lookup connector, getCo, as JSON
forEach(
    	$company, toJson(getCo)
.getCo, 
, 

//Create a key-value pair of the $company object's CompanyName, paired with the $company object
		$company.CompanyName : $company
)
}
  • Returns JSON from a Lookup
  • Loops over the getCo array to generate a property pair of $company.CompanyName mapped to the company object
  • . Accessed original getCo array in that as a property. Looping over that and generating a property pair of $company.CompanyName mapped to the company object. The foreach returns a list of property pairs. Because their in the curly bracket they get composed into the JSON object 
 Code Block
Returns JSON containing the $company object's CompanyName, e.g. "Romaguera Inc", paired with the $company object, e.g. { "CompanyID" : 108, "CompanyName" : "Romaguera Inc", "Industry" : "Manufacturing" } as a key-value pair.
 Code Block
titleExample 2 Output
{
  "Romaguera Inc" : {
    "CompanyID" : 108,
    "CompanyName" : "Romaguera Inc",
    "Industry" : "Manufacturing"
  },
  "Becker and Sons" : {
    "CompanyID" : 112,
    "CompanyName" : "Becker and Sons",
    "Industry" : "Manufacturing"
 },
  "Larson Inc" : {
    "CompanyID" : 398,
    "CompanyName" : "Larson Inc",
    "Industry" : "Manufacturing"
  }
}
Return JSON from Lookup
Creates a key/value pair of the CompanyName mapped to CompanyID
code
...
Example 3
 Code Block
titleExample 3 Input
{
forEach(

//For each $company object, return the data from the lookup connector, getCo, as JSON
    	$company, toJson(getCo)
.getCo, $company
,

//Create a key-value pair of the $company object's CompanyName, paired with the $company object's CompanyID
		$company.CompanyName : $company.CompanyID
)
}
Returns 
Returns JSON containing a key-value pair of the CompanyName mapped to CompanyID.
 Code Block
titleExample 3 Output
{
  "Romaguera Inc" : 108,
  "Becker and Sons" : 112, 
  "Larson Inc" : 398
}
Return JSON from Lookup
Creates a key/value pair of the CompanyName mapped to CompanyID
code
...
Example 4 
 Code Block
titleExample 4 Input
{
forEach(

//For each $company object, return the data from the lookup connector, getCo, as JSON
    	$company, toJson(getCo)
.getCo, $company
, 

//Create a key-value pair of the CompanyName paired with the $company object, and convert the CompanyName within the $company object to uppercase
		$company.CompanyName : {$company,"CompanyName":toUpper($company.CompanyName)}
)
}
Returns 
 Code Block
Returns JSON containing multiple key-value pairs, where the keys are the $company object's CompanyName, and the values are the $company objects. In each $company object, there are 3 key-value pairs, where the value paired with the key, "CompanyName", is converted to uppercase.
 Code Block
titleExample 4 Output
{
  "Romaguera Inc" : {
    "CompanyID" : 108,
    "CompanyName" : "ROMAGUERA INC",
    "Industry" : "Manufacturing"
  },
  "Becker and Sons" : {
    "CompanyID" : 112,
    "CompanyName" : "BECKER AND SONS",
    "Industry" : "Manufacturing"
  },
 "Larson Inc" : {
    "CompanyID" : 398,
    "CompanyName" : "LARSON INC",
    "Industry" : "Manufacturing"
  }
}
...
Example 5
 Code Block
titleExample 5 Input
do(

//For each $company object, return the data from the lookup connector, getCo, as JSON and prefix the array of $company objects with the string, "CompanyData"
    {"CompanyData":
    forEach($company, toJson(getCo),

        //output the $company object 
        {$company}
    )
    }
)
Returns a key-value pair of the string, "CompanyData" paired with an array of $company objects.
 Code Block
titleExample 5 Output
{
"CompanyData" : [ {
"CompanyID" : 108,
"CompanyName" : "Romaguera Inc",
"Industry" : "Manufacturing"
}, {
"CompanyID" : 112,
"CompanyName" : "Becker and Sons",
"Industry" : "Manufacturing"
}, {
"CompanyID" : 398,
"CompanyName" : "Larson Inc",
"Industry" : "Manufacturing"
} ]
}