Get All Fields in Zoho Writer
Table of Contents
Description
The zoho.writer.getAllFields task is used to fetch all the fields present in a Zoho Writer document. This task is based on the Zoho Writer Get All Fields API.
Syntax
<response> = zoho.writer.getAllFields(<document_id>, <connection>);
where:
Params | Data type | Description |
<response> | KEY-VALUE | The response returned by Zoho Writer. It represents the list of all fields inserted into the specified document. |
<document_id> | TEXT | The ID of the document from which the fields need to be fetched. The document ID can be obtained from the URL of the document from which the fields need to be fetched. The URL is in the following format: |
<connection> | TEXT | The connection's link name. Note:
|
Example
The following script fetches all the fields in a given Writer document.
response = zoho.writer.getAllFields("al296XXXXXXXXXXXXXXXXXXXXXXXXXXXa516c", "writer_oauth_connection");
where:
response
"al296XXXXXXXXXXXXXXXXXXXXXXXXXXXa516c"
"writer_oauth_connection"
Response Format
{ merge : [ {'id':'Name','display_name':'Name','type':'text'}, {'id':'Email','display_name':'Email','type':'email'}, {'id':'Products','display_name':'Products','type':'related_list', fields:[ {'id':'Products.Products_name','display_name':'Products.Products Name','type':'text'}, {'id':'Products.Products_code','display_name':'Products.Products Code','type':'number'}, {'id':'Products.Products_category','display_name':'Products.Products Category','type':'text'} ] }, {'id':'Mobile','display_name':'Mobile','type':'number'}, ..... ], sign: { "Recipient1": { "job_title": "" "Agree_term_and_conditions": "" } "Recipient2": { "company_name": "", "Address": "" } } }