Data Path

The data saved in the data manager can be retrieved using an expression called data path. This can also be used to retrieve the data of a current API call.

Possible Locations

• path
• Condition

Syntaxes of Data Path

    

        
copy
        

            

        
    
    

         

<resource_name>:<path>  <!-- to access different resources -->

<variable_name>:<path> <!-- to access current API call -->


    

Resource Name and Variable Name

For accessing a different resource, the data path should hold the resource name of whose data you are trying to access. Whereas, to access the current API call, you should provide any of the following two variables depending on your case.

• REQUEST: Contains the request details such as URL, params, headers and body.
• RESPONSE: Contains the response details like headers and body.

Path

This is similar to any JSON or XML path. For accessing the current API call’s data, following are a few path variables that will help you in navigating you to your desired key.

• REQUEST: url, headers, params, body
• RESPONSE: headers, body

Here is the list of path expressions that can be used in the ZSPEC,

Samples

Data Path to access resources

Imagine that you want to use the data of trips resource, in one of your current resources. Following is the GET response of the trips resource,

• Resource name: trips
• Data Extraction Path: $.trips
• Primary Path: $.trip_id

    

        
copy
        

            

        
    
    

         
{
    "trips": [
        {
            "trip_name": "London - Emily Jones",
            "trip_id": "5545984000000006873",
            "no_of_days": 10,
            "travelers": [
                {
                    "traveler_name":[
                        "Ms",
                        "Emily",
                        "Jones"
                    ],
                    "traveler_email": "emily@qke.com"
                }
            ]
        },
        {
            "trip_name": "Sidney - John Smith",
            "trip_id": "5545974000000006871", 
            "no_of_days": 2,
            "travelers": [
                {
                    "traveler_name":[
                        "Mr",
                        "John",
                        "Smith"
                    ],
                    "traveler_email": "johnsmith@abc.com"
                },
                {
                    "traveler_name":[
                        "Mr",
                        "Patrick",
                        "Robinson"
                    ],
                    "traveler_email": "patrobinson@abc.com"
                }
            ]
        }
    ]
}

    

Now let us look at a few data path samples to access this data for your current resource.

[10,2] 

    

        
copy
        

            

        
    
    

         
[
    "emily@qke.com"
    "johnsmith@abc.com",
    "patrobinson@abc.com"
]

    

    

        
copy
        

            

        
    
    

         
[
    "London - Emily Jones",
    "Sidney - John Smith"
]

    

    

        
copy
        

            

        
    
    

         
[
    "5545984000000006873",
    "5545974000000006871"
]

    

Data Path to access variables

Now, consider that you are writing ZSPEC for the trips resource and you need to access the data of trips resource from the current API call.

Request data

The request details of the trips resource’s current API call will be available like this.

REQUEST:

    

        
copy
        

            

        
    
    

         
{
    "url": {
        "module": "trips"
    },
    "params": 
        {
            "ids": "5545974000000006871,5545974000003954574,5545974000000002599"
            
        },
    "headers" : {
        "Authorization":"Zoho-oauthtoken 1000.9b67d20xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0f0f6c9"
    },
    "body" : null
}

    

Let us look at how you have to access the request details of this API call.

Response data

The response details of this API call will be available for us to access as given below.

RESPONSE:

    

        
copy
        

            

        
    
    

         
{
    "headers" : {
        "Content-Language":"en-US",
        "Content-Type":"application/json;charset=UTF-8"
    },
    "body" : {
        "trips": [
            {
                "trip_name": "Bali - John Smith",
                "trip_id": "5545974000000006871", 
                "no_of_days": 2
            },
            {
                "trip_name": "London - Emily Jones",
                "trip_id": "5545974000000006873",
                "no_of_days": 10
            },
            {
                "trip_name": "Sidney - Patrick Robinson",
                "trip_id": "5545974000000006875",
                "no_of_days": 5 
            }
        ]
    }
}

    

Now, let us look at a few data path samples that can be used to retrieve this response data.

    

        
copy
        

            

        
    
    

         
{
    "trip_name": "London - Emily Jones",
    "trip_id": "5545974000000006873",
    "no_of_days": 10
}