Force.com Apex Code Developer's Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
Approval Namespace
Auth Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
Address Class
Answers Class
ApexPages Class
Approval Class
Blob Class
Boolean Class
BusinessHours Class
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Double Class
EncodingUtil Class
Enum Methods
Exception Class and Built-In Exceptions
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSON Methods
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
PageReference Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
RemoteObjectController
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
SelectOption Class
Set Class
Site Class
sObject Class
StaticResourceCalloutMock Class
String Class
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

JSON Class

Contains methods for serializing Apex objects into JSON format and deserializing JSON content that was serialized using the serialize method in this class.

Namespace

System

Usage

Use the methods in the System.JSON class to perform round-trip JSON serialization and deserialization of Apex objects.

JSON Methods

The following are methods for JSON. All methods are static.

createGenerator(prettyPrint)

Returns a new JSON generator.

Signature

public static System.JSONGenerator createGenerator(Boolean prettyPrint)

Parameters

prettyPrint
Type: Boolean
Determines whether the JSON generator creates JSON content in pretty-print format with the content indented. Set to true to create indented content.

Return Value

Type: System.JSONGenerator

createParser(jsonString)

Returns a new JSON parser.

Signature

public static System.JSONParser createParser(String jsonString)

Parameters

jsonString
Type: String
The JSON content to parse.

Return Value

Type: System.JSONParser

deserialize(jsonString, apexType)

Deserializes the specified JSON string into an Apex object of the specified type.

Signature

public static Object deserialize(String jsonString, System.Type apexType)

Parameters

jsonString
Type: String
The JSON content to deserialize.
apexType
Type: System.Type
The Apex type of the object that this method creates after deserializing the JSON content.

Return Value

Type: Object

Usage

If the JSON content to parse contains attributes not present in the Apex type specified in the argument, such as a missing field or object, this method ignores these attributes and parses the rest of the JSON content. However, for Apex saved using Salesforce API version 24.0 or earlier, this method throws a run-time exception for missing attributes.

Example

The following example deserializes a Decimal value.

deserializeStrict(jsonString, apexType)

Deserializes the specified JSON string into an Apex object of the specified type.

Signature

public static Object deserializeStrict(String jsonString, System.Type apexType)

Parameters

jsonString
Type: String
The JSON content to deserialize.
apexType
Type: System.Type
The Apex type of the object that this method creates after deserializing the JSON content.

Return Value

Type: Object

Usage

All attributes in the JSON string must be present in the specified type.If the JSON content to parse contains attributes not present in the Apex type specified in the argument, such as a missing field or object, this method throws a run-time exception.

Example

The following example deserializes a JSON string into an object of a user-defined type represented by the Car class, which this example also defines.

deserializeUntyped(jsonString)

Deserializes the specified JSON string into collections of primitive data types.

Signature

public static Object deserializeUntyped(String jsonString)

Parameters

jsonString
Type: String
The JSON content to deserialize.

Return Value

Type: Object

Example

The following example deserializes a JSON representation of an appliance object into a map that contains primitive data types and further collections of primitive types. It then verifies the deserialized values.

serialize(objectToSerialize)

Serializes Apex objects into JSON content.

Signature

public static String serialize(Object objectToSerialize)

Parameters

objectToSerialize
Type: Object
The Apex object to serialize.

Return Value

Type: String

Example

The following example serializes a new Datetime value.

serializePretty(objectToSerialize)

Serializes Apex objects into JSON content and generates indented content using the pretty-print format.

Signature

public static String serializePretty(Object objectToSerialize)

Parameters

objectToSerialize
Type: Object
The Apex object to serialize.

Return Value

Type: String