Docs
ZEST
Component Help
ZEST Specification File
Resource Config
Path Config

Path Config

Path config will have the path details from where the data and primary keys of the resource should be fetched.

Possible Locations

Child Elements

Primary recurrent

Attributes

Name	Type	Description

data-extraction-path required	JSON path	Data path to locate the data of resource.

Note:

The path config at the <content> level takes precedence, enabling the configuration of distinct data extraction paths for various content. Conversely, the path config declared at the <resource-config> level applies to all content but has the lowest priority.
If the <primary> is not provided at the content level, the primary key(s) specified at the <resource-config> level will be used.

Example

Following are the structures in the trips resource.

copy


<components>
&lt;!-- primary structure of the trips resource --&gt;

&lt;structure ref-name="trips" name="primary_structure"&gt;
    &lt;property name="trip_name" type="string"/&gt;
    &lt;property name="trip_id" type="long_string"/&gt;
    &lt;property name="destination" type="string"/&gt;
    &lt;property name="start_time" type="datetime"/&gt;
    &lt;property name="end_time" type="datetime"/&gt;
    &lt;property name="no_of_days" type="string"/&gt;
&lt;/structure&gt;

&lt;!-- wrapper of the primary structure --&gt;

&lt;structure ref-name="data" name="wrapper"&gt;
    &lt;property name="trips" type="collections"&gt;
        &lt;structure-ref name="trips" /&gt;
    &lt;/property&gt;
&lt;/structure&gt;

</components>

Here, the trips key will be used for extracting the resource’s data.

Thus, the path config of trips resource should look like this.

copy

<path-config data-extraction-path="$.trips"/>

Last Updated 2025-05-30 16:54:59 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit