User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Takes a Python object such as a list or dictionary and converts into a JSON string.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

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

  • Parameters

Any pyObj - The Python object to encode into JSON such as a Python list or dictionary.

Integer indentFactor - The number of spaces to add to each level of indentation for prettyprinting. [optional]

  • Returns

String - The encoded JSON string.

  • Scope

Gateway, Vision Client, Perspective Session

JSON to Python Mapping

The table below lists possible Python types, and how they map to JSON objects. 

Python TypeMapped JSON Type
Boolean (True/False)Boolean (true/false)
StringString
Number (Float, Integer)Numeric
Nonenull
SequenceArray
DictionaryObject
Code Examples
Code Snippet
# 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)
Keywords

system util jsonEncode, util.jsonEncode