GlideJsonPath - Global

  • Release version: Yokohama
  • Updated January 30, 2025
  • 1 minute to read

    • The GlideJsonPath API retrieves values from a JSON document using a query path string.

    This API is available by default.

    GlideJsonPath - GlideJsonPath(String jsonDocument)

    Instantiates a GlideJsonPath scriptable object by parsing a JSON document.

    Table 1. Parameters
    Name Type Description
    jsonDocument String JSON document to parse.

    This example instantiates a GlideJsonPath object by parsing a JSON document.

    var v = new GlideJsonPath('{"lib":{"jsonpath":{"creator":{"name":"DevStudio","developers":["dev1","dev2","dev3"]}}}}');

    GlideJsonPath - read(String jsonPath)

    Retrieves values from a JSON document using a query path string.

    Table 2. Parameters
    Name Type Description
    jsonPath String Path to search for in the JSON document.

    All valid JSONPath expressions are supported. For more information, see JSONPath.
    Table 3. Returns
    Type Description
    Object JavaScript object(s) that match the specified path.

    This example searches a JSON document for all developers listed under the specified path.

    var v = new GlideJsonPath('{"lib":{"jsonpath":{"creator":{"name":"DevStudio","developers":["dev1","dev2","dev3"]}}}}'); 
var l = v.read("$['lib']['jsonpath']['creator']['developers'][*]");

    Output:

    "dev1", "dev2", "dev3"