Skip to content

Zoho: Initiate a Test Run for a Kiosk

Zoho kiosksExecute.testRunKiosk: arguments, response, policy and SDK examples.

← Kiosks execute operations · Get started

Operation zoho.testrunkiosk

Provider route: POST /crm/v8/settings/kiosks/{kioskId}/actions/test_run. Alter supplies the connection’s credentials and routing.

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["kiosksExecute"]["testRunKiosk"]>[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.kiosksExecute.testRunKiosk(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.kiosks_execute.test_run_kiosk(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.kioskIdstringRequired within parentMaximum length: 19
bodyModelOptionalExpand Initiate a Test Run for a Kiosk — request body — body

Referenced models: Initiate a Test Run for a Kiosk — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Initiate a Test Run for a Kiosk — response body

Referenced models: Initiate a Test Run for a Kiosk — response body

Initiate a Test Run for a Kiosk — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for a kiosk test run, containing one or more test run entries.
Additional keys: not allowed
kiosk_test_runarrayRequired within parentContains one or more test run entries, each providing the data context for initiating a kiosk test run.
Maximum items: 1
kiosk_test_run[]ModelEach itemExpand Initiate a Test Run for a Kiosk — request body — body kiosk test run item

Referenced models: Initiate a Test Run for a Kiosk — request body — body kiosk test run item

Initiate a Test Run for a Kiosk — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response for a successful kiosk test run, including the status, message, and details of the next executable state.
Additional keys: not allowed
kiosk_test_runarrayOptionalContains the result of the test run, including status, message, and details of the next executable state.
Maximum items: 1
kiosk_test_run[]ModelEach itemExpand Initiate a Test Run for a Kiosk — response body — kiosk test run item

Referenced models: Initiate a Test Run for a Kiosk — response body — kiosk test run item

Initiate a Test Run for a Kiosk — request body — body kiosk test run item
FieldTypePresenceDescription and constraints
$objectRootRepresents a test run payload entry that provides the data context needed for executing a kiosk test run.
Additional keys: not allowed
dataModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data
Contains information about the current record module if any

Referenced models: Execute a Kiosk — request body — body kiosk execute item data

Initiate a Test Run for a Kiosk — response body — kiosk test run item
FieldTypePresenceDescription and constraints
$objectRootRepresents the outcome of a test run entry, including the status code, message, and detailed execution data.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the test run entry.
Maximum length: 255
detailsModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details
messagestringOptionalContains the message describing the outcome of the test run entry.
Maximum length: 255
statusstringOptionalIndicates the overall status of the test run entry result.
Maximum length: 255

Referenced models: Execute a Kiosk — response body — kiosk execute item details

Execute a Kiosk — request body — body kiosk execute item data
FieldTypePresenceDescription and constraints
$objectRootRepresents the execution data container, holding the current record reference and the execution instance ID.
Additional keys: not allowed
Current_RecordModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data Current Record
The Current_Record field provides the record context for the Kiosk execution.
idstring or nullOptionalRepresents the unique identifier of the kiosk execution instance.
Maximum length: 18

Referenced models: Execute a Kiosk — request body — body kiosk execute item data Current Record

Execute a Kiosk — response body — kiosk execute item details
FieldTypePresenceDescription and constraints
$objectRootProvides details of a test run execution, including the next executable state, any dependent states that were executed, and the execution record ID.
Additional keys: not allowed
executed_dependent_statesJSONOptional
executed_dependent_states (anyOf 1)arrayAlternativeContains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered.
Maximum items: 10
executed_dependent_states (anyOf 1)[]ModelEach itemExpand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
executed_dependent_states (anyOf 2)nullAlternativeContains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered.
Maximum items: 10
executed_dependent_states (anyOf 2)[]ModelEach itemExpand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
idstringOptionalContains the unique identifier of the test run execution record.
Maximum length: 255
next_executable_stateModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details next executable state

Referenced models: Execute a Kiosk — response body — kiosk execute item details next executable state, Execute a Kiosk — response body — kiosk execute item details executed dependent states null item

Execute a Kiosk — request body — body kiosk execute item data Current Record
FieldTypePresenceDescription and constraints
$objectRootRepresents a reference to the current module record used during kiosk execution, including the record ID.
Additional keys: not allowed
idstring or nullOptionalRepresents the unique identifier of the current module record referenced during execution.

Maximum length: 19
Execute a Kiosk — response body — kiosk execute item details next executable state
FieldTypePresenceDescription and constraints
$objectRootAn array of dependent states that were executed during the test run. Each object contains information about the state and the transition taken.
Additional keys: not allowed
idstringOptionalContains the unique identifier of the next executable kiosk state.
Maximum length: 255
namestringOptionalRepresents the display name of the next executable kiosk state.
Maximum length: 255
Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
FieldTypePresenceDescription and constraints
$objectRootA dependent state executed during kiosk execution
Additional keys: not allowed
detailsobjectOptionalField: details — optional state-specific details
Additional keys: allowed
idstringRequired within parentField: id
Maximum length: 255
namestringRequired within parentField: name
Maximum length: 255
ridstringOptionalField: rid
Format: uuid
Maximum length: 255
transitionobjectRequired within parentField: transition
Additional keys: not allowed
transition.idstringRequired within parentField: id
Maximum length: 255
transition.namestringRequired within parentField: name
Maximum length: 255
transition.ridstringOptionalField: rid
Format: uuid
Maximum length: 255
typestringOptionalField: type
Maximum length: 255

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

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.