REST API - View Records
Table of Contents
URL
where,
| <applicationName> and <viewLinkName> | These are the link name of your application and view/report, respectively. These can be be referred from here. |
| <format> | This is the type of response format, as listed below. |
Formats
- XML
- JSON
HTTP Method
GET
Parameters
| Parameter Name | Usage | Description |
| authtoken | Required | A valid API authtoken. Refer this page to generate authtoken. |
| scope | Required | Specify the value as creatorapi |
| <application link name> | Required | The link name of the application that contains the form. |
| <view link name> | Required | The link name of the view/report to display the records from. |
| zc_ownername | Required | The owner of the application. |
| raw | Optional | If response format is specified as json set this parameter to true to get only a json array without a Javascript variable. |
| criteria | Optional | The criteria must be specified in the format <criteria column name> <operator> <value> Example : (Name == "Jean" && DOB == "20-Jul-1981") |
| startindex | Optional | The starting index of the range of records to be viewed (pagination purpose) |
| limit | Optional | The end index of the range of records to be viewed (pagination purpose) |
Refer to this page for the link names used in your applications.
Prerequisites
Notes
- Anyone with a valid auth token can view the records of a public Form.
- Only the owner of the application can view the records of a private Form.
- Any user with a valid auth token and share permission can view the records of a shared Form.
- Lookup related fields are listed as <Lookup Field Name>.<Actual Field Name> (eg: Department.Department_Name)
Sample Request
<input type="hidden" name ="authtoken" value="************">
<input type="hidden" name ="zc_ownername" value="********">
<input type="hidden" name="criteria" value='(PacienteSL=="Abilio Alfredo Finotti")'>
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="submit" value="View Records">
</form>
Sample Response
XML response
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<records>
<record id="8007000006281183">
<column name="Name">
<value>Juliet</value>
</column>
<column name="DOB">
<value>14-Jul-1989</value>
</column>
<column name="Address">
<value>France</value>
</column>
<column name="Hobbies">
<value>[Reading, Swimming]</value>
</column>
<column name="Basic">
<value>33000.0</value>
</column>
</record>
<record>
<column name="Name">
<value>Gary</value>
</column>
<column name="DOB">
<value>12-Jun-1980</value>
</column>
<column name="Address">
<value>India</value>
</column>
<column name="Hobbies">
<value>[Swimming]</value>
</column>
<column name="Basic">
<value>35000.0</value>
</column>
</record>
<record>
<column name="Name">
<value>Jean</value>
</column>
<column name="DOB">
<value>20-Jul-1981</value>
</column>
<column name="Address">
<value>UK</value>
</column>
<column name="Hobbies">
<value>[Running, Swimming]</value>
</column>
<column name="Basic">
<value>32000.0</value>
</column>
<column name="Department.Role">
<value>Finance</value>
</column>
</record>
</records>
</response>
JSON response
CSV response
Error Codes
If there is an error in the request format, the corresponding error code with error message will be displayed. Please refer to the topic Error codes and descriptions to know about them. If the operation is successful, the response message will be displayed with status as "Success".