About the REST Dictionary

A REST Reference for Everyone

Developing Solutions provides a protocol dictionary for the RESTful APIs used in 3GPP networks. Included in this reference are the OMA APIs that provide CIoT services in 4G core networks and the service-based interfaces in 5G core networks.

Software developers and test designers can use this hierarchical reference to browse through the various services, the paths defined for each request message, and the structures of the associated request and response messages.

The JSON structures described in this documentation are under the copyright of 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

Specification version: R17 June, 2021

Previous Versions

Using the Dictionary

The CONTENTS tab displays the hierarchical view. The dictionary is organized by service and is arranged in alphabetical order.

Service topics briefly describe the service, link to the governing specification, and link to the request message topics for the service.

Message topics describe how and when each message is used and define the required and optional JSON content of that message. Required items are indicated with red asterisks (*).

If you know what you’re looking for, start with the SEARCH tab to quickly locate the topics of interest.

Other Resources

We provide protocol dictionaries and reference guides for 3G, 4G, and 5G core networks in various formats. See our Reference Guides page for more information.