Zoho: Get Field Associations

← Global picklists operations · Get started

Operation zoho.getglobalpicklistfieldassociations

Provider route: GET /crm/v8/settings/global_picklists/{id}/actions/associations. 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["globalPicklists"]["getGlobalPickListFieldAssociations"]>[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.globalPicklists.getGlobalPickListFieldAssociations(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.global_picklists.get_global_pick_list_field_associations(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.id	string	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Default: 1 Format: int32 Minimum: 1
query.per_page	integer	Optional	Default: 200 Format: int64 Maximum: 200 Minimum: 1
query.include_inner_details	array	Optional	Maximum items: 3
query.include_inner_details[]	string	Each item	Allowed values for including nested details in the response. One of: module.plural_label, module.module_name, layouts.status

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	Response object containing associations of global picklist fields and modules. Additional keys: not allowed
$ (anyOf 1).associations	array	Required within parent	List of associations between global picklist and fields/modules/layouts. Maximum items: 1000
$ (anyOf 1).associations[]	object	Each item	Association object for a global picklist field. Additional keys: not allowed
$ (anyOf 1).associations[].field	object	Required within parent	Field details associated with the global picklist. Additional keys: not allowed
$ (anyOf 1).associations[].field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).associations[].field.field_label	string	Optional	Name of the field label. Maximum length: 100
$ (anyOf 1).associations[].field.id	string	Required within parent	Id of the resource. Format: int64
$ (anyOf 1).associations[].layouts	array	Required within parent	List of layouts associated with the field. Maximum items: 100
$ (anyOf 1).associations[].layouts[]	object	Each item	Layout details. Additional keys: not allowed
$ (anyOf 1).associations[].layouts[].id	string	Required within parent	Id of the resource. Format: int64
$ (anyOf 1).associations[].layouts[].name	string	Required within parent	Name of the layout Maximum length: 50
$ (anyOf 1).associations[].layouts[].status	string	Optional	Layout status. Maximum length: 20
$ (anyOf 1).associations[].module	object	Required within parent	Module details associated with the field. Additional keys: not allowed
$ (anyOf 1).associations[].module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).associations[].module.id	string	Required within parent	Id of the resource. Format: int64
$ (anyOf 1).associations[].module.module_name	string	Optional	Name of the module Maximum length: 100
$ (anyOf 1).associations[].module.plural_label	string	Optional	Plural label of the module. Maximum length: 25
$ (anyOf 1).info	object	Required within parent	Pagination and record info for associations response. Additional keys: not allowed
$ (anyOf 1).info.count	JSON	Required within parent
$ (anyOf 1).info.count (anyOf 1)	integer	Alternative	Number of records returned. Format: int32
$ (anyOf 1).info.count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.more_records	boolean	Required within parent	Whether more records are available.
$ (anyOf 1).info.page	JSON	Required within parent
$ (anyOf 1).info.page (anyOf 1)	integer	Alternative	Current page number. Format: int32
$ (anyOf 1).info.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).info.per_page	JSON	Required within parent
$ (anyOf 1).info.per_page (anyOf 1)	integer	Alternative	Number of records per page. Format: int32
$ (anyOf 1).info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getglobalpicklistfieldassociations. Catalog operation: getGlobalPickListFieldAssociations. 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