Zoho: Get field dependencies for a layout

← Map dependency operations · Get started

Operation zoho.getmapdependency

Provider route: GET /crm/v8/settings/layouts/{layoutId}/map_dependency. 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"]["getMapDependency"]>[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.getMapDependency(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(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]+$
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_]*$
query.page	integer	Optional	Format: int32
query.per_page	integer	Optional	Format: int32 Maximum: 200
query.filters	string	Optional	Maximum length: 100

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 successful response containing the list of field dependencies and pagination details for the specified layout. Additional keys: not allowed
$ (anyOf 1).info	object	Required within parent	Contains the pagination details for the response. Additional keys: not allowed
$ (anyOf 1).info.count	JSON	Required within parent
$ (anyOf 1).info.count (anyOf 1)	integer	Alternative	Represents the number of records returned on the current page. 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	Indicates whether additional pages of records are available. Possible values: true, false.
$ (anyOf 1).info.page	JSON	Required within parent
$ (anyOf 1).info.page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. 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	Represents the maximum number of records included on each page. Format: int32
$ (anyOf 1).info.per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).map_dependency	array	Required within parent	Contains the list of field dependency objects for the specified layout. Maximum items: 200
$ (anyOf 1).map_dependency[]	object	Each item	Represents a field dependency object, including the parent and child field references, dependency metadata, and activity status. 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 Details of the parent field.
$ (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 1).map_dependency[].sub_module	JSON	Required within parent	The API name and ID of the field that is mapped as the parent in the subform of the module. For non-subforms, this value is null. This key is present only when you fetch all the mapped dependencies in a module.
$ (anyOf 1).map_dependency[].sub_module (anyOf 1)	null	Alternative	Indicates that the dependency applies to the main module fields and is not associated with any subform.
$ (anyOf 1).map_dependency[].sub_module (anyOf 2)	object	Alternative	Represents the details of the subform module when the dependency applies to a subform field. Additional keys: not allowed
$ (anyOf 1).map_dependency[].sub_module (anyOf 2).api_name	string	Required within parent	Represents the API name of the subform module. Maximum length: 50
$ (anyOf 1).map_dependency[].sub_module (anyOf 2).id	string	Required within parent	Represents the unique identifier of the subform module. Make a [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the details of the subform module. Format: int64
$ (anyOf 2)	null	Alternative

Referenced models: Update an existing field dependency — request body — body map dependency item child

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

Policy, approvals and errors

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