Get Record by ID

Table of Contents

Note:

  • Each time the Get Record by ID integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.

  • The API limits deduction depend on where the request is sent and received.
    When this task is executed to send request,

    • within the same Zoho Creator account - Both the Developer API limit and the External calls limit are deducted from that Creator account.

    • from a different service to a Zoho Creator account - The Developer API limit is deducted from the target Creator account, and the external calls limit is deducted from the service that sends the request.

    • from one Zoho Creator account to another Zoho Creator account - The Developer API limit is deducted from the target Creator account, and the External calls limit is deducted from the Creator account that sends the request.

  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if the Get Record by ID task is placed inside a for each task that iterates five times, five external API calls will be consumed, even though the task appears only once in the script.
     

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-VALUEVariable 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
    • To improve email deliverability, we will be following Gmail's updated sender email policy starting from February 1, 2024. This means that Gmail addresses cannot be used as a sender address in the send mail tasks.Learn More
<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:

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