Get IDs of fields in Zoho Sign

Table of Contents

Note:

  • Each time the zoho.sign.getFieldIds 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.
  • 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 zoho.sign.getFieldIds integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

The zoho.sign.getFieldIds task is used to retrieve IDs of all the fields in your Zoho Sign account. The retrieved field IDs can be further utilized, like adding fields to a document using the submitRequest task.

Syntax

<response>=zoho.sign.getFieldIds([<connection>]);

where:

ParamsData TypeDescription
<response>KEY-VALUEThe response returned by Zoho Sign which contains the field type, the field ID and whether it is mandatory or not

<connection>

(optional)*

TEXT

The name of the connection.

*Note: This param is not applicable to Zoho Creator and mandatory in Zoho Cliq.

Example

The following script fetches the ids of all the fields stored in Zoho Sign account:

response = zoho.sign.getFieldIds();

where:

response
The KEY-VALUE pair returned from Zoho Sign.

Response Format

Success Response

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

     {
     "field_types":[
     {
     "field_type_id":"10696000000000043",
     "field_category":"checkbox",
     "is_mandatory":false,
     "field_type_name":"Checkbox"
     },
     {
     "field_type_id":"10696000000000045",
     "field_category":"radiogroup",
     "is_mandatory":false,
     "field_type_name":"Radiogroup"
     },
     {
     "field_type_id":"10696000000000047",
     "field_category":"image",
     "is_mandatory":true,
     "field_type_name":"Signature"
     },
     {
     "field_type_id":"10696000000000049",
     "field_category":"image",
     "is_mandatory":true,
     "field_type_name":"Initial"
     },
     {
     "field_type_id":"10696000000000053",
     "field_category":"textfield",
     "is_mandatory":false,
     "field_type_name":"Textfield"
     },
     {
     "field_type_id":"10696000000000055",
     "field_category":"textfield",
     "is_mandatory":true,
     "field_type_name":"Email"
     },
     {
     "field_type_id":"10696000000000057",
     "field_category":"datefield",
     "is_mandatory":true,
     "field_type_name":"Date"
     },
     {
     "field_type_id":"10696000000000059",
     "field_category":"textfield",
     "is_mandatory":true,
     "field_type_name":"Name"
     },
     {
     "field_type_id":"10696000000000061",
     "field_category":"textfield",
     "is_mandatory":true,
     "field_type_name":"Company"
     },
     {
     "field_type_id":"10696000000000063",
     "field_category":"textfield",
     "is_mandatory":true,
     "field_type_name":"Jobtitle"
     },
     {
     "field_type_id":"10696000000005001",
     "field_category":"datefield",
     "is_mandatory":false,
     "field_type_name":"CustomDate"
     },
     {
     "field_type_id":"10696000000005003",
     "field_category":"dropdown",
     "is_mandatory":false,
     "field_type_name":"Dropdown"
     },
     {
     "field_type_id":"10696000000007007",
     "field_category":"filefield",
     "is_mandatory":false,
     "field_type_name":"Attachment"
     }
     ],
     "code":0,
     "message":"Field types retrieved successfully",
     "status":"success"
     }

To get the field type IDs and field type names from the response returned, execute the following script:

 res  = <variable>.getJSON("field_types");
 for each var in res 
 {
 info var.getJSON("field_type_id");
 info var.getJSON("field_type_name");
 }

Related Links