Zoho: Get record locking configuration

← Record locking configurations operations · Get started

Operation zoho.getrecordlockingconfiguration

Provider route: GET /crm/v8/settings/record_locking_configurations. 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["recordLockingConfigurations"]["getRecordLockingConfiguration"]>[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.recordLockingConfigurations.getRecordLockingConfiguration(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.record_locking_configurations.get_record_locking_configuration(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Module API name Maximum length: 256

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)	Model	Alternative	Expand Get record locking configuration — response body — record locking configurations
$ (anyOf 2)	null	Alternative

Referenced models: Get record locking configuration — response body — record locking configurations

Schemas

Get record locking configuration — response body — record locking configurations

Field	Type	Presence	Description and constraints
$	object	Root	Response object containing the record locking configuration details. Additional keys: not allowed
record_locking_configurations	array	Required within parent	Array containing the record locking configuration details. Maximum items: 1
record_locking_configurations[]	Model	Each item	Expand Get record locking configuration — response body — record locking configurations record locking configurations item

Referenced models: Get record locking configuration — response body — record locking configurations record locking configurations item

Get record locking configuration — response body — record locking configurations record locking configurations item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the record locking configuration. Additional keys: not allowed
created_by	object	Required within parent	User who created the configuration. Additional keys: not allowed
created_by.id	string	Required within parent	Unique identifier of the user. Maximum length: 32
created_by.name	string	Required within parent	Name of the user. Maximum length: 256
created_time	string	Required within parent	Timestamp when the configuration was created. Format: date-time
excluded_fields	array	Required within parent	Fields that are exempt from locking. Maximum items: 15
excluded_fields[]	object	Each item	Minimal details of an excluded field. Additional keys: not allowed
excluded_fields[].api_name	string	Required within parent	API name of the excluded field. Maximum length: 256
excluded_fields[].id	string	Required within parent	Unique identifier of the excluded field. Maximum length: 32
feature_type	string	Required within parent	Feature type identifier (always `record_locking`). Known values: record_locking Default: record_locking
id	string	Required within parent	Unique identifier of the configuration. Maximum length: 32
lock_excluded_profiles	array	Required within parent	Profiles that are excluded from locking. Maximum items: 15
lock_excluded_profiles[]	object	Each item	Minimal details of an excluded profile. Additional keys: not allowed
lock_excluded_profiles[].id	string	Required within parent	Unique identifier of the profile. Maximum length: 32
lock_excluded_profiles[].name	string	Required within parent	Name of the profile. Maximum length: 256
lock_for_portal_users	boolean	Required within parent	Indicates whether portal users are subject to locking. Default: true
lock_type	string	Required within parent	The locking mode used for this configuration. Known values: automatic, manual, both
locked_for	string	Required within parent	Indicates which profiles the lock applies to. Known values: all_profiles, all_profiles_except_excluded_profiles
locking_rules	array	Required within parent	List of locking rules defined in the configuration. Maximum items: 5
locking_rules[]	Model	Each item	Expand Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item
modified_by	object	Required within parent	User who last modified the configuration. Additional keys: not allowed
modified_by.id	string	Required within parent	Unique identifier of the user. Maximum length: 32
modified_by.name	string	Required within parent	Name of the user. Maximum length: 256
modified_time	string	Required within parent	Timestamp when the configuration was last modified. Format: date-time
restricted_actions	array	Required within parent	List of actions that are restricted on locked records. Maximum items: 5
restricted_actions[]	string	Each item	A restricted action. Known values: change_owner, update, delete, tags, convert
restricted_communications	array	Required within parent	List of communication actions restricted on locked records. Maximum items: 1
restricted_communications[]	string	Each item	A restricted communication action. Known values: send_mail
restricted_custom_buttons	JSON	Required within parent
restricted_custom_buttons (anyOf 1)	array	Alternative	List of custom buttons restricted on locked records (may be null).
restricted_custom_buttons (anyOf 1)[]	object	Each item	Minimal details of a restricted custom button. Additional keys: not allowed
restricted_custom_buttons (anyOf 1)[].id	string	Required within parent	Unique identifier of the custom button. Maximum length: 32
restricted_custom_buttons (anyOf 1)[].name	string	Optional	Name of the custom button. Maximum length: 256
restricted_custom_buttons (anyOf 2)	null	Alternative	List of custom buttons restricted on locked records (may be null).
restricted_custom_buttons (anyOf 2)[]	object	Each item	Minimal details of a restricted custom button. Additional keys: not allowed
restricted_custom_buttons (anyOf 2)[].id	string	Required within parent	Unique identifier of the custom button. Maximum length: 32
restricted_custom_buttons (anyOf 2)[].name	string	Optional	Name of the custom button. Maximum length: 256
system_defined	boolean	Required within parent	Indicates whether the configuration is system-defined.

Referenced models: Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item

Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a locking rule. Additional keys: not allowed
criteria	Model	Optional	Expand Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item criteria
id	string	Required within parent	Unique identifier of the locking rule. Maximum length: 32
lock_existing_records	boolean	Required within parent	Indicates whether existing records are locked when the rule is applied. Default: false
name	string	Required within parent	Name of the locking rule. Maximum length: 256

Referenced models: Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item criteria

Get record locking configuration — response body — record locking configurations record locking configurations item locking rules item criteria

Field	Type	Presence	Description and constraints
$	object	Root	Criteria that records must match for the rule to apply. Additional keys: not allowed
comparator	string	Required within parent	The comparator used in the criteria. Maximum length: 256
field	object	Required within parent	Details of the field used in the criteria. Additional keys: not allowed
field.api_name	string	Required within parent	API name of the field. Maximum length: 256
field.id	string	Required within parent	Unique identifier of the field. Maximum length: 32
type	string	Required within parent	Type of the criteria. Maximum length: 256
value	JSON	Optional

Policy, approvals and errors

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