Purpose

Specifies the embedded object, including the path, that contains the results you want mapped to a dedicated relational table. When specifying an endpoint using the Sample property method, this property allows you to limit the results mapped to the table to only those returned in the specified object, instead of the results from the entire endpoint.

Valid Values

String

where

String is the embedded object and path that contains the results you want mapped to a dedicated relational table. For nested objects, separate the element names with forward slashes.

Example

For example, an endpoint returns the following JSON response that contains multiple objects, total_events and events.

{
  "total_events": 2,
  "events": [
    {
      "attending_count": 164,
      "cost": 6899.00,
      "name": "Smith Family Reunion",
      "location": "San Francisco"
    },
    {
      "attending_count": 87,
      "cost": 5465.00,
      "name": "Brady Wedding",
      "location": "Santa Clara"
    }
  ]
}

If no value is specified for this property, the driver maps the total_events object to a parent table and events object to a child table. However, if your application only needs the information from the events object, you can specify /events with this property to map only that object. In this configuration, the driver maps the events object to a parent table and each element of the array to rows, while the total_events object is ignored.

Notes

  • This property is used only when specifying an endpoint using the Sample property method. When using a Model file, you can use the JSON Root field on the Autonomous REST Composer to specify this value. See "Generating a Model file with the Autonomous REST Composer" for more information.

  • During sampling, the driver specifies a default value for this property when it detects an embedded object that meets the criteria for a JSON root. Depending on the structure of your data model, you might want to add, edit, or remove values for this property.

Data Source Methods

public String getJSONRoot()

public void setJSONRoot(String)

Default Value

No default value

Data Type

String