Zoho: Get record locking information

Zoho lockingInformations.getRecordLockingInformationOfTheRecord: arguments, response, policy and SDK examples.

← Locking informations operations · Get started

Operation zoho.getrecordlockinginformationoftherecord

Provider route: GET /crm/v8/{moduleName}/{recordId}/Locking_Information__s. 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["lockingInformations"]["getRecordLockingInformationOfTheRecord"]>[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.lockingInformations.getRecordLockingInformationOfTheRecord(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.locking_informations.get_record_locking_information_of_the_record(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.moduleName`	string	Required within parent	Maximum length: 256
`path.recordId`	string	Required within parent	Maximum length: 32
`query`	object	Optional	Additional keys: not allowed
`query.fields`	string	Optional	Maximum length: 2048

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	Contains the locking information details and pagination metadata for the locked record. Additional keys: not allowed
`$ (anyOf 1).data`	array	Required within parent	Contains the locking information details of the locked record. Maximum items: 1
`$ (anyOf 1).data[]`	object	Each item	Represents the locking information details of a locked record. Additional keys: not allowed
`$ (anyOf 1).data[].$editable`	boolean	Optional	Indicates whether the locked record is editable by the current user. Possible values: true - The record is editable. false - The record is not editable.
`$ (anyOf 1).data[].$field_states`	JSON	Optional	Represents the field-level lock states of the record. Returns null when no field-level locking is applied.
`$ (anyOf 1).data[].$field_states (anyOf 1)`	string	Alternative	Contains the locking information details and pagination metadata for the locked record. Maximum length: 255
`$ (anyOf 1).data[].$field_states (anyOf 2)`	null	Alternative	Contains the locking information details and pagination metadata for the locked record.
`$ (anyOf 1).data[].$sharing_permission`	string	Optional	Represents the sharing permission level of the current user on the locked record. Maximum length: 10000
`$ (anyOf 1).data[].$zia_visions`	JSON	Optional	Represents Zia Visions data associated with the record. Returns null when Zia Visions data is not available.
`$ (anyOf 1).data[].$zia_visions (anyOf 1)`	string	Alternative	Contains the Zia Visions related information. Maximum length: 255
`$ (anyOf 1).data[].$zia_visions (anyOf 2)`	null	Alternative	Null when Zia Visions data is not available.
`$ (anyOf 1).data[].Feature_Type__s`	string	Optional	Represents the feature type associated with the locking information. Maximum length: 255
`$ (anyOf 1).data[].Lock_Source__s`	string	Optional	Indicates the source of the record lock. Possible values: Manual - The record was locked manually by a user. Automatic - The record was locked automatically by a rule. Both - The record has both manual and automatic locks. Known values: Manual, Both, Automatic Maximum length: 255
`$ (anyOf 1).data[].Locked_By__s`	JSON	Optional
`$ (anyOf 1).data[].Locked_By__s (anyOf 1)`	Model	Alternative	Expand Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_12d8bbec7e67
`$ (anyOf 1).data[].Locked_By__s (anyOf 2)`	Model	Alternative	Expand Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_1d244b825e98
`$ (anyOf 1).data[].Locked_For__s`	Model	Optional	Expand Get record locking information by ID — response body — data data item Locked For s
`$ (anyOf 1).data[].Locked_Reason__s`	JSON	Optional
`$ (anyOf 1).data[].Locked_Reason__s (anyOf 1)`	string	Alternative	Represents the reason for locking the record. Returns null for automatically locked records. Maximum length: 3000
`$ (anyOf 1).data[].Locked_Reason__s (anyOf 2)`	null	Alternative	Represents the reason for locking the record. Returns null for automatically locked records. Maximum length: 3000
`$ (anyOf 1).data[].Locked_Time__s`	string	Optional	Represents the timestamp when the record was locked. Format: date-time
`$ (anyOf 1).data[].Record_Locking_Configuration_Id__s`	string	Optional	Represents the unique identifier of the record locking configuration applied to this record. Maximum length: 255
`$ (anyOf 1).data[].Record_Locking_Rule_Id__s`	JSON	Optional
`$ (anyOf 1).data[].Record_Locking_Rule_Id__s (anyOf 1)`	string	Alternative	Represents the unique identifier of the record locking rule. Returns null for manually locked records. Maximum length: 255
`$ (anyOf 1).data[].Record_Locking_Rule_Id__s (anyOf 2)`	null	Alternative	Represents the unique identifier of the record locking rule. Returns null for manually locked records. Maximum length: 255
`$ (anyOf 1).data[].id`	string	Required within parent	Represents the unique identifier of the locking information record. Maximum length: 255
`$ (anyOf 1).info`	object	Required within parent	An object containing the pagination details. Additional keys: not allowed
`$ (anyOf 1).info.count`	JSON	Required within parent
`$ (anyOf 1).info.count (anyOf 1)`	integer	Alternative	Represents the total number of locking information records returned in the response. 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 more locking information records are available beyond the current page. Possible values: true - More records are available. false - No more records are available.
`$ (anyOf 1).info.next_page_token`	JSON	Optional
`$ (anyOf 1).info.next_page_token (anyOf 1)`	string	Alternative	Represents the token used to fetch the next page of records. Returns null when token-based pagination is not in use or no next page exists. Maximum length: 255
`$ (anyOf 1).info.next_page_token (anyOf 2)`	null	Alternative	Represents the token used to fetch the next page of records. Returns null when token-based pagination is not in use or no next page exists. Maximum length: 255
`$ (anyOf 1).info.page`	JSON	Required within parent
`$ (anyOf 1).info.page (anyOf 1)`	integer	Alternative	Represents the current page number of the response. Format: int32
`$ (anyOf 1).info.page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.page_token_expiry`	JSON	Optional
`$ (anyOf 1).info.page_token_expiry (anyOf 1)`	string	Alternative	Represents the expiry timestamp of the page token. Returns null when token-based pagination is not in use. Maximum length: 255
`$ (anyOf 1).info.page_token_expiry (anyOf 2)`	null	Alternative	Represents the expiry timestamp of the page token. Returns null when token-based pagination is not in use. Maximum length: 255
`$ (anyOf 1).info.per_page`	JSON	Required within parent
`$ (anyOf 1).info.per_page (anyOf 1)`	integer	Alternative	Represents the number of records displayed per page. Format: int32
`$ (anyOf 1).info.per_page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.previous_page_token`	JSON	Optional
`$ (anyOf 1).info.previous_page_token (anyOf 1)`	string	Alternative	Represents the token used to fetch the previous page of records. Returns null when token-based pagination is not in use or no previous page exists. Maximum length: 255
`$ (anyOf 1).info.previous_page_token (anyOf 2)`	null	Alternative	Represents the token used to fetch the previous page of records. Returns null when token-based pagination is not in use or no previous page exists. Maximum length: 255
`$ (anyOf 2)`	null	Alternative

Referenced models: Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_12d8bbec7e67, Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_1d244b825e98, Get record locking information by ID — response body — data data item Locked For s

Schemas

Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_12d8bbec7e67

Field	Type	Presence	Description and constraints
`$`	object	Root	An object containing the details of the user who locked the record. Returns null for automatically locked records where no specific user performed the lock. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique identifier of the user who locked the record. Maximum length: 255
`module`	string	Optional	Represents the module to which the user who locked the record belongs. Maximum length: 255
`name`	string	Required within parent	Represents the name of the user who locked the record. Maximum length: 255

Get record locking information by ID — response body — data data item Locked By s id, module, name — shared_locked-by-s_1d244b825e98

Field	Type	Presence	Description and constraints
`$`	null	Root	An object containing the details of the user who locked the record. Returns null for automatically locked records where no specific user performed the lock. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique identifier of the user who locked the record. Maximum length: 255
`module`	string	Optional	Represents the module to which the user who locked the record belongs. Maximum length: 255
`name`	string	Required within parent	Represents the name of the user who locked the record. Maximum length: 255

Get record locking information by ID — response body — data data item Locked For s

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the details of the record that is locked. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique identifier of the locked record. Maximum length: 255
`module`	object	Required within parent	Represents the details of the module to which the locked record belongs. Additional keys: not allowed
`module.api_name`	string	Required within parent	Represents the API name of the module of the locked record. Maximum length: 255
`module.id`	string	Required within parent	Represents the unique identifier of the module of the locked record. Maximum length: 255
`name`	string	Required within parent	Represents the name of the locked record. Maximum length: 255

Policy, approvals and errors

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

Report an issue with this page