Zoho: Rich text field content for multiple records

← Fetch full data operations · Get started

Operation zoho.fetchfulldataformultiplerecords

Provider route: GET /crm/v8/{moduleApiName}/actions/fetch_full_data. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["fetchFullData"]["fetchFullDataForMultipleRecords"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.fetchFullData.fetchFullDataForMultipleRecords(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.fetch_full_data.fetch_full_data_for_multiple_records(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.moduleApiName	string	Required within parent	Maximum length: 50
query	object	Required within parent	Additional keys: not allowed
query.fields	string	Required within parent	Maximum length: 1000
query.ids	string	Required within parent	Format: int64

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Wrapper object for the response. Contains a ‘data’ array of record objects, each holding the record ID and the rich text field values. Additional keys: not allowed
$ (anyOf 1).data	array	Required within parent	An array of record objects, each containing the record ID and the values of the requested rich text fields. Returns up to 200 records matching the specified IDs. Maximum items: 200
$ (anyOf 1).data[]	Model	Each item	Expand Rich text field content for multiple records — response body — data data item
$ (anyOf 2)	null	Alternative

Referenced models: Rich text field content for multiple records — response body — data data item

Schemas

Rich text field content for multiple records — response body — data data item

Field	Type	Presence	Description and constraints
$	object	Root	A record object containing the record's unique ID and the full content of each requested rich text field. The rich text field property names correspond to the API names of the fields in the module. Additional keys: see wildcard field
id	string	Required within parent	The unique identifier of the record whose rich text field data is being returned. Format: int64
$.*	string	Additional keys	The full HTML-formatted content of a rich text field. The property name corresponds to the API name of the rich text field in the module. The value is null if the field has no content. Each rich text field supports up to 50,000 characters. Maximum length: 50000

Policy, approvals and errors

SDK function policy ID: zoho.fetchfulldataformultiplerecords. Catalog operation: fetchFullDataForMultipleRecords. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source