Zoho: Get a field dependency by ID

← Map dependency operations · Get started

Operation zoho.getmapdependencybyid

Provider route: GET /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}. 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["mapDependency"]["getMapDependencyById"]>[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.mapDependency.getMapDependencyById(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.map_dependency.get_map_dependency_by_id(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.layoutId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
path.dependencyId	string	Required within parent	Format: int64
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$

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	Represents the response containing the complete details of the specified field dependency, including all picklist value mappings. Additional keys: not allowed
$ (anyOf 1).map_dependency	array	Required within parent	Contains the field dependency details for the specified dependency ID. Maximum items: 1
$ (anyOf 1).map_dependency[]	object	Each item	Each object represents the field dependency object with complete parent and child field references, picklist value mappings, and dependency metadata. Additional keys: not allowed
$ (anyOf 1).map_dependency[].active	boolean	Required within parent	Indicates whether the dependency is active in the layout. Possible values: true, false. Known values: True, False
$ (anyOf 1).map_dependency[].category	JSON	Required within parent
$ (anyOf 1).map_dependency[].category (anyOf 1)	integer	Alternative	Represents the category of the dependency. Possible values: 0. 0 represents the default category. Known values: 0 Format: int32
$ (anyOf 1).map_dependency[].category (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).map_dependency[].child	Model	Required within parent	Expand Update an existing field dependency — request body — body map dependency item child Details of the child field
$ (anyOf 1).map_dependency[].id	string	Required within parent	Represents the unique identifier of the field dependency. Format: int64
$ (anyOf 1).map_dependency[].internal	boolean	Required within parent	Indicates whether the dependency was defined by the system or created by the user. Possible values: true, false. Known values: True, False
$ (anyOf 1).map_dependency[].parent	Model	Required within parent	Expand Update an existing field dependency — request body — body map dependency item child Parent field details
$ (anyOf 1).map_dependency[].pick_list_values	array	Required within parent	Contains the complete mapping of parent picklist options to their corresponding child picklist options. Maximum items: 2000
$ (anyOf 1).map_dependency[].pick_list_values[]	Model	Each item	Expand Get a field dependency by ID — response body — map dependency map dependency item pick list values item
$ (anyOf 1).map_dependency[].source	JSON	Required within parent
$ (anyOf 1).map_dependency[].source (anyOf 1)	integer	Alternative	Represents the source of the dependency. Possible values: 1. It indicates Zoho CRM as the source. Known values: 1 Format: int32
$ (anyOf 1).map_dependency[].source (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

Referenced models: Update an existing field dependency — request body — body map dependency item child, Get a field dependency by ID — response body — map dependency map dependency item pick list values item

Schemas

Update an existing field dependency — request body — body map dependency item child

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to a field, identified by its unique ID and API name. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field. Maximum length: 50
id	string	Required within parent	Represents the unique identifier of the field. Format: int64

Get a field dependency by ID — response body — map dependency map dependency item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a parent picklist option with its complete set of mapped child picklist values, as returned in GET responses. Additional keys: not allowed
actual_value	string	Required within parent	Represents the actual stored value of the parent picklist option. Maximum length: 120
display_value	string	Required within parent	Represents the display label of the parent picklist option as shown in the CRM interface. Maximum length: 120
id	string	Required within parent	Represents the unique identifier of the parent picklist option. Format: int64
maps	array	Required within parent	Lists the child picklist options associated with this parent picklist value. Maximum items: 2000
maps[]	Model	Each item	Expand Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item

Referenced models: Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item

Get a field dependency by ID — response body — map dependency map dependency item pick list values item maps item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a picklist option with its unique identifier, actual value, and display label. Additional keys: not allowed
actual_value	string	Required within parent	Represents the actual stored value of the picklist option. Maximum length: 120
display_value	string	Required within parent	Represents the display label of the picklist option as shown in the CRM interface. Maximum length: 120
id	string	Required within parent	Represents the unique identifier of the picklist option. Format: int64

Policy, approvals and errors

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