Zoho: List kiosk executions
Zoho kiosksExecute.getKioskExecutions: arguments, response, policy and SDK examples.
← Kiosks execute operations · Get started
Operation zoho.getkioskexecutions
Provider route: GET /crm/v8/settings/kiosks/{kioskId}/executions. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["kiosksExecute"]["getKioskExecutions"]>[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.getKioskExecutions(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.get_kiosk_executions(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.kioskId | string | Required within parent | Maximum length: 19 |
query | object | Optional | Additional keys: not allowed |
query.page | integer | Optional | Format: int32 |
query.per_page | integer | Optional | Format: int32 |
query.include_inner_details | string | Optional | Maximum length: 500 |
Response
Section titled “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 |
|---|---|---|---|
$ | Model | Root | Expand List kiosk executions — response body |
Referenced models: List kiosk executions — response body
Schemas
Section titled “Schemas”List kiosk executions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a paginated list of kiosk execution records along with pagination metadata. Additional keys: not allowed |
info | Model | Required within parent | Expand List kiosk executions — response body — info |
kiosk_executions | array | Required within parent | Contains the list of kiosk execution records returned for the specified kiosk. Maximum items: 4 |
kiosk_executions[] | Model | Each item | Expand List kiosk executions — response body — kiosk executions item |
Referenced models: List kiosk executions — response body — kiosk executions item, List kiosk executions — response body — info
List kiosk executions — response body — kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an execution instance of a kiosk, including start and end timestamps, owner information, executable state details, and the execution record ID. Additional keys: not allowed |
Kiosk_End_Time | string | Required within parent | The timestamp indicating when the most recently executed state of the Kiosk ended, in ISO 8601 format. The response is sorted in descending order of this field, with the most recent executions listed first. Maximum length: 255 |
Kiosk_Start_Time | string | Required within parent | Represents the date and time at which the kiosk execution record session began. Maximum length: 255 |
Owner | Model | Required within parent | Expand List kiosk executions — response body — kiosk executions item Owner |
executable_info | Model | Required within parent | Expand List kiosk executions — response body — kiosk executions item executable info |
id | string | Required within parent | The unique identifier of the available transition. Maximum length: 255 |
Referenced models: List kiosk executions — response body — kiosk executions item executable info, List kiosk executions — response body — kiosk executions item Owner
List kiosk executions — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents pagination metadata for list responses, including the current page number, records per page, total count, and whether more records are available. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Indicates the number of kiosk execution records returned in the current page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether more execution records are available beyond the current page. Possible values: true - Additional execution records exist beyond the current page. false - No additional execution records exist; the current page is the last. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Indicates the current page number in the paginated list of execution records. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Indicates the maximum number of kiosk execution records returned per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List kiosk executions — response body — kiosk executions item executable info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the current state of the Kiosk execution and the transition that can be executed next. Additional keys: not allowed |
state | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state |
transitions | array | Required within parent | An array of available next transitions from the current state. Each transition object contains the unique identifier of an available transition from the current state. Maximum items: 1 |
transitions[] | Model | Each item | Expand List kiosk executions — response body — kiosk executions item executable info transitions item |
Referenced models: List kiosk executions — response body — kiosk executions item executable info transitions item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
List kiosk executions — response body — kiosk executions item Owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the owner of the record who initiated this kiosk execution. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the record owner in the preview. Maximum length: 255 |
name | string | Required within parent | Represents the full name of the record owner in the preview. Maximum length: 255 |
List kiosk executions — response body — kiosk executions item executable info transitions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a minimal transition reference used in kiosk execution records, containing the transition ID. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the kiosk transition referenced in the execution record. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summary of a kiosk state referenced in the preview, including the state ID and display name. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the kiosk state referenced in the preview. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk state referenced in the preview. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getkioskexecutions. Catalog operation: getKioskExecutions. 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.