Choose where you’d like to start

Get Record by ID

Table of Contents

Overview

The zoho.creator.getRecordById task is used to fetch a record using its ID from the specified Zoho Creator application.

Note: This integration task is based on the Get Record - Detailed view  Zoho Creator V2 API.

Syntax

<variable> = zoho.creator.getRecordById(<owner_name>, <app_link_name>, <report_link_name>, <record_id>, <connection_link_name>);

where:

ParameterData TypeDescription

<variable>

KEY-VALUE

Variable that will hold the details of the record fetched.

<owner_name>

TEXT

Name of the owner of the app from which the record needs to be fetched.

Note:

Name of the application owner can be fetched in the following ways:

  • From the URL of the application while editing or accessing it. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/...
  • By using the system variable - zoho.adminuser

<app_link_name>

TEXT

Link name of the application from which the record needs to be fetched.

Note:

Link name of the application can be fetched in the following ways:

  • From the URL of the application while editing or accessing it. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/<application_name>/...
  • By using the system variable -  zoho.appname
  • Link names of applications, reports, and fields in your account can also be viewed on the reference page (listed in brackets).

<report_link_name>

TEXT

Link name of the report from which the record needs to be fetched.

Note:

  • Link names of applications, reports, and fields in your account can be viewed on the reference page (listed in brackets).
  • You can also fetch link names from the URL while accessing the report. The URL is in the format: app.zohocreator.com/appbuilder/<application_owner>/<application_name>/#Report:<report_link_name>

<record_id>

​

NUMBER

ID of the record that needs to be fetched.

Note: You can use the zoho.creator.getRecords integration task to fetch the record ID. Click here for the Deluge script to extract record IDs from the returned response.

<connection_link_name>

TEXT

Link name of the connection created and connected to your Zoho Creator account. 

Note:
  • The connection should be OAuth 2 based. To create OAuth 2 based connection with Zoho services, choose the default service - Zoho OAuth under pick your service in connections page.
  • Make sure to add the scopes mentioned in the Zoho Creator Get Record - Detailed view API document while creating the connection.

Example 1

The following example fetches the record with ID - 60210000000020007 from the report - All_tasks of the Zoho Creator application - Task_Management

response = zoho.creator.getRecordById("Shawn", "Task_Management", "All_Tasks", 60210000000020007, "creator_oauth_connection");

where:

response
The KEY-VALUE variable that holds the response of the task
"Shawn"
The TEXT value that represents the name of the application owner.
"Task_Management"
The TEXT value that represents the link name of the application.
"All_Tasks"
The TEXT value that represents the link name of the application.
60210000000020007
The NUMBER that represents the ID of the record that need to be fetched.
"creator_oauth_connection"
The TEXT value that represents the link name of the Zoho Creator OAuth connection created with required scopes.

Response Format

Success Response

  • The successful response will be returned in the following format:

     {
     "code":3000,
     "data":{
     "Task_Name":"Priority Task",
     "Task_Description":"I need help installing my air conditioner",
     "ID":"60210000000020007",
     }
     }
Failure Response

  • The failure response for incorrect or non-existent application name will be returned in the following format

     {
     "code": 2892,
     "message": "No application named <application_name> found. Please check and try again."
    }

  • The failure response for incorrect owner name will be returned in the following format

     {
     "code": 1110,
     "message": "No workspace named <owner_name> found. Please enter a valid workspace value."
    }

  • The failure response for incorrect or non-existent report name will be returned in the following format

     {
     "code": 2894,
     "message": "No report named <report_link_name> found. Please check and try again."
    }

  • The failure response for incorrect or non-existent record ID will be returned in the following format:

     {
     "code": 3100,
     "message": "No Data Available"
    }

Related Links

Get Started Now

Execute