Zoho: Get Picklist Value Associations
Zoho globalPicklists.getPickListValuesAssociations: arguments, response, policy and SDK examples.
← Global picklists operations · Get started
Operation zoho.getpicklistvaluesassociations
Provider route: GET /crm/v8/settings/global_picklists/{id}/actions/pick_list_values_associations. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getPickListValuesAssociations"]>[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.getPickListValuesAssociations(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_pick_list_values_associations(arguments) result = await call.wait() return result.body_json()| 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 | Required within parent | Additional keys: not allowed |
query.picklist_value_id | string | Required within parent | Format: int64 |
Response
Section titled “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 picklist value associations. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations | array | Required within parent | Array of picklist value associations grouped by association type. Maximum items: 100 |
$ (anyOf 1).pick_list_values_associations[] | object | Each item | Association group for a specific type of feature. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources | array | Required within parent | Array of resources associated with the picklist value. Maximum items: 100 |
$ (anyOf 1).pick_list_values_associations[].resources[] | object | Each item | Resource object containing association details. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details | JSON | Required within parent | Details about the resource associations. |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 1) | JSON | Alternative | |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 1) (anyOf 1) | object | Alternative | Blueprint details with module information. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 1) (anyOf 1).module | Model | Required within parent | Expand Get Picklist Value Associations — response body — pick list values associations pick list values associations item resources item details value Blueprint details with module information module |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 1) (anyOf 2) | null | Alternative | Blueprint details with module information. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 1) (anyOf 2).module | Model | Required within parent | Expand Get Picklist Value Associations — response body — pick list values associations pick list values associations item resources item details value Blueprint details with module information module |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2) | object | Alternative | Orchestration or workflow details with actions. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions | array | Required within parent | Array of actions associated with the orchestration or workflow. Maximum items: 100 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[] | object | Each item | Action object with module and optional transition details. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].module | object | Required within parent | Module details for the action. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].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).pick_list_values_associations[].resources[].details (anyOf 2).actions[].module.id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].transition | object | Optional | Transition details for orchestration actions. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].transition.id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].transition.name | string | Required within parent | Name of the transition. Maximum length: 255 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 2).actions[].type | string | Required within parent | Type of action. Maximum length: 100 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3) | array | Alternative | Array of task or field update associations. Maximum items: 100 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[] | object | Each item | Task or field update association object. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].name | string | Required within parent | Name of the task or field update. Maximum length: 255 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].transition | object | Optional | Transition details for orchestration tasks. Additional keys: not allowed |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].transition.id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].transition.name | string | Required within parent | Name of the transition. Maximum length: 255 |
$ (anyOf 1).pick_list_values_associations[].resources[].details (anyOf 3)[].type | string | Required within parent | Type of association (Workflow, Orchestration, etc.). Maximum length: 100 |
$ (anyOf 1).pick_list_values_associations[].resources[].id | string | Required within parent | Id of the resource. Format: int64 |
$ (anyOf 1).pick_list_values_associations[].resources[].name | string | Required within parent | Name of the resource. Maximum length: 255 |
$ (anyOf 1).pick_list_values_associations[].type | string | Required within parent | Type of association (field_update, task, blueprint, orchestration, workflow, etc.). Maximum length: 100 |
$ (anyOf 2) | null | Alternative |
Schemas
Section titled “Schemas”Get Picklist Value Associations — response body — pick list values associations pick list values associations item resources item details value Blueprint details with module information module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module details for blueprint. Additional keys: not allowed |
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_]*$ |
id | string | Required within parent | Id of the resource. Format: int64 |
plural_label | string | Required within parent | Plural label of the module. Maximum length: 25 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getpicklistvaluesassociations. Catalog operation: getPickListValuesAssociations. 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]