system.util.jsonEncode

This function is used in Python Scripting.

Description

Takes a Python object such as a list or dict and converts into a json string.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.util.jsonEncode(pyObj, [indentFactor])

Parameters

Type	Parameter	Description
PyObject	pyObj	The Python object to encode into JSON such as a Python list or dictionary.
int	indentFactor	Optional parameter. The number of spaces to add to each level of indentation for pretty printing.

Returns

String - The encoded JSON string.

Scope

All

Code Examples

Example #1

# The following example builds a Python dictionary, and converts it to a JSON string
  
# Build the Python dictionary
employeeDict = {"employees":[{"firstName":"John", "lastName":"Doe"},{"firstName":"Anna", "lastName":"Smith"},{"firstName":"Peter", "lastName":"Jones"}]}
  
# Convert the dictionary and store the resulting JSON string in a variable.
jsonString = system.util.jsonEncode(employeeDict)