JSONPath

From NovaOrdis Knowledge Base
Revision as of 00:08, 16 March 2021 by Ovidiu (talk | contribs) (→‎$)
Jump to navigation Jump to search

External

Internal

Overview

JSONPath is a query language for JSON similar to XPath for XML. Some documentation describes it as a Java DSL for reading JSON documents, probably to address those cases where the implementation is made in Java.

Concepts

JSONPath Expression

A JSONPath expression specifies a path to an element or a set of elements that are part of a JSON document. An expression can be assembled using a series of syntax elements presented below.

$

$ represents the top-level element (or root) of the JSON document. The "$" is optional, the following are equivalent:

$.metadata
.metadata
metadata

There are two ways to select a specific child element relative to the parent element: .property and [0-based-index]. These two different syntaxes are applied to JSON Objects and Arrays, given the fact that JSON has only these two types of collections.

.property

This is called "the dot notation" where a property of the parent JSON Object is specified following a dot.

.metadata.resourceVersion

[0-based-index]

JSONPath Template