Zoho: Kiosks execute schemas
46 Zoho schemas with complete fields and constraints.
← Kiosks execute operations · All schemas
Execute a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for executing a kiosk, containing one or more execute action entries. Additional keys: not allowed |
kiosk_execute | array | Required within parent | The request body must be a JSON object containing the kiosk_execute array. The array contains the data required to execute the Kiosk. Maximum items: 1 |
kiosk_execute[] | Model | Each item | Expand Execute a Kiosk — request body — body kiosk execute item |
Referenced models: Execute a Kiosk — request body — body kiosk execute item
Execute a Kiosk — request body — body kiosk execute item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an execute action entry used to process a kiosk state with the provided data context. Additional keys: not allowed |
data | Model | Optional | Expand Execute a Kiosk — request body — body kiosk execute item data Specify the data context for the Kiosk execution. If not provided, the Kiosk will execute without a record context. |
Referenced models: Execute a Kiosk — request body — body kiosk execute item data
Execute a Kiosk — request body — body kiosk execute item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the execution data container, holding the current record reference and the execution instance ID. Additional keys: not allowed |
Current_Record | Model | Optional | Expand Execute a Kiosk — request body — body kiosk execute item data Current Record The Current_Record field provides the record context for the Kiosk execution. |
id | string or null | Optional | Represents 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 — request body — body kiosk execute item data Current Record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the current module record used during kiosk execution, including the record ID. Additional keys: not allowed |
id | string or null | Optional | Represents the unique identifier of the current module record referenced during execution. Maximum length: 19 |
Execute a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates a successful execute action and provides details about the next executable kiosk state. Additional keys: not allowed |
kiosk_execute | array | Optional | Contains the result of the execute action, including the status, message, and details of the next executable state. Maximum items: 1 |
kiosk_execute[] | Model | Each item | Expand Execute a Kiosk — response body — kiosk execute item |
Referenced models: Execute a Kiosk — response body — kiosk execute item
Execute a Kiosk — response body — kiosk execute item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of an execute action, including the status code, message, and details of the next executable state. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the execute action result. Maximum length: 255 |
details | Model | Optional | Expand Execute a Kiosk — response body — kiosk execute item details |
message | string | Optional | Represents the message describing the outcome of the execute action. Maximum length: 255 |
status | string | Optional | Represents the response status indicating whether the execute action succeeded or encountered an error. Maximum length: 255 |
Referenced models: Execute a Kiosk — response body — kiosk execute item details
Execute a Kiosk — response body — kiosk execute item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides 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_states | JSON | Optional | |
executed_dependent_states (anyOf 1) | array | Alternative | Contains 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)[] | Model | Each item | Expand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item |
executed_dependent_states (anyOf 2) | null | Alternative | Contains 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)[] | Model | Each item | Expand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item |
id | string | Optional | Contains the unique identifier of the test run execution record. Maximum length: 255 |
next_executable_state | Model | Optional | Expand 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 — response body — kiosk execute item details executed dependent states null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A dependent state executed during kiosk execution Additional keys: not allowed |
details | object | Optional | Field: details — optional state-specific details Additional keys: allowed |
id | string | Required within parent | Field: id Maximum length: 255 |
name | string | Required within parent | Field: name Maximum length: 255 |
rid | string | Optional | Field: rid Format: uuid Maximum length: 255 |
transition | object | Required within parent | Field: transition Additional keys: not allowed |
transition.id | string | Required within parent | Field: id Maximum length: 255 |
transition.name | string | Required within parent | Field: name Maximum length: 255 |
transition.rid | string | Optional | Field: rid Format: uuid Maximum length: 255 |
type | string | Optional | Field: type Maximum length: 255 |
Execute a Kiosk — response body — kiosk execute item details next executable state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An 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 |
id | string | Optional | Contains the unique identifier of the next executable kiosk state. Maximum length: 255 |
name | string | Optional | Represents the display name of the next executable kiosk state. Maximum length: 255 |
Initiate a Test Run for a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for a kiosk test run, containing one or more test run entries. Additional keys: not allowed |
kiosk_test_run | array | Required within parent | Contains one or more test run entries, each providing the data context for initiating a kiosk test run. Maximum items: 1 |
kiosk_test_run[] | Model | Each item | Expand 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 — request body — body kiosk test run item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a test run payload entry that provides the data context needed for executing a kiosk test run. Additional keys: not allowed |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_run | array | Optional | Contains the result of the test run, including status, message, and details of the next executable state. Maximum items: 1 |
kiosk_test_run[] | Model | Each item | Expand 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 — response body — kiosk test run item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the outcome of a test run entry, including the status code, message, and detailed execution data. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the test run entry. Maximum length: 255 |
details | Model | Optional | Expand Execute a Kiosk — response body — kiosk execute item details |
message | string | Optional | Contains the message describing the outcome of the test run entry. Maximum length: 255 |
status | string | Optional | Indicates the overall status of the test run entry result. Maximum length: 255 |
Referenced models: Execute a Kiosk — response body — kiosk execute item details
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 — 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
| 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 — 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
| 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 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 a kiosk execution record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a specific kiosk execution state view, containing the elements and metadata for the state being executed. Additional keys: not allowed |
kiosk_executions | array | Required within parent | Contains the details of the execution state being rendered, including elements, layout, and data. Maximum items: 1 |
kiosk_executions[] | Model | Each item | Expand Retrieve a kiosk execution record — response body — kiosk executions item |
Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item
Retrieve a kiosk execution record — response body — kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the screen and data for a specific execution state, including elements, layout dimensions, screen title, kiosk details, and executable information. Additional keys: not allowed |
button_align | JSON | Required within parent | |
button_align (anyOf 1) | string | Alternative | The alignment of action buttons. Possible values: right_to_left - Buttons are aligned from right to left. left_to_right - Buttons are aligned from left to right. center - Buttons are aligned to the center. Known values: right_to_left, left_to_right, center Maximum length: 255 |
button_align (anyOf 2) | null | Alternative | The alignment of action buttons. Possible values: right_to_left - Buttons are aligned from right to left. left_to_right - Buttons are aligned from left to right. center - Buttons are aligned to the center. Known values: right_to_left, left_to_right, center Maximum length: 255 |
data | Model | Required within parent | Expand Retrieve a kiosk execution record — response body — kiosk executions item data |
elements | array | Required within parent | An array of UI elements and data sources configured in the Kiosk. Each element has a type field that determines its structure. Maximum items: 1 |
elements[] | Model | Each item | Expand Retrieve a kiosk execution record — response body — kiosk executions item elements item |
executable_info | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info |
id | string | Required within parent | Contains the unique identifier of the kiosk execution view record. Maximum length: 255 |
kiosk | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk |
title | string | Required within parent | Represents the display title of the kiosk execution state screen. Maximum length: 255 |
width | JSON | Required within parent | |
width (anyOf 1) | string | Alternative | Indicates the display width of the kiosk execution state screen. Known values: 670px, 1000px Maximum length: 255 |
width (anyOf 2) | null | Alternative | Indicates the display width of the kiosk execution state screen. Known values: 670px, 1000px Maximum length: 255 |
Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data, Retrieve a kiosk execution record — response body — kiosk executions item elements item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
Retrieve a kiosk execution record — response body — kiosk executions item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the runtime data available during the Kiosk execution. This object includes system-generated values (such as execution details, owner information, and record references) along with dynamically generated key-value pairs. The dynamic keys correspond to the API names of the configured Kiosk fields, GetRecords elements, and other runtime values available in the current execution. The fields returned vary depending on the Kiosk configuration and the execution context. Additional keys: not allowed |
Kiosk_End_Time | string | Required within parent | Represents the date and time at which the kiosk execution session ended. Maximum length: 255 |
Kiosk_Start_Time | string | Required within parent | Represents the date and time at which the kiosk execution session began. Maximum length: 255 |
Owner | Model | Required within parent | Expand Retrieve a kiosk execution record — response body — kiosk executions item data Owner |
id | string | Required within parent | Contains the unique identifier for the kiosk execution instance. Maximum length: 255 |
Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data Owner
Retrieve a kiosk execution record — response body — kiosk executions item data Owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents detailed owner information for a kiosk execution, including name, ID, and email address. Additional keys: not allowed |
email | string | Required within parent | Represents the email address of the owner associated with the kiosk execution. Maximum length: 255 |
id | string | Required within parent | Contains the unique identifier of the owner associated with the kiosk execution. Maximum length: 255 |
name | string | Required within parent | Represents the full name of the owner associated with the kiosk execution. Maximum length: 255 |
Retrieve a kiosk execution record — response body — kiosk executions item elements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a simple element associated with a kiosk execution, including its type classification and associated value. Additional keys: not allowed |
type | string | Required within parent | Indicates the type classification of the execution element. Maximum length: 255 |
value | string | Required within parent | Contains the value associated with the execution element. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a successful kiosk preview, returning the initial executable screen with associated data, transitions, and layout metadata. Additional keys: not allowed |
kiosk_preview | array | Required within parent | Contains the preview details for the initial executable screen, including elements, transitions, data, and layout. Maximum items: 1 |
kiosk_preview[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the preview screen for a kiosk state, including executable information, prior states, elements, data, layout width, screen title, and button alignment. Additional keys: not allowed |
button_align | string | Required within parent | The alignment of action buttons. **Possible values:** **right_to_left** - Buttons are aligned from right to left. **left_to_right** - Buttons are aligned from left to right. **center** - Buttons are aligned to the center. Maximum length: 255 |
data | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data |
elements | array | Required within parent | Contains the list of elements rendered on the kiosk preview screen. Maximum items: 2 |
elements[] | JSON | Each item | Represents one element rendered on the kiosk preview screen, such as a record retrieval block or a form field. |
elements[] (anyOf 1) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value |
elements[] (anyOf 2) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value |
executable_info | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info |
kiosk | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk |
previous_states | array | Required within parent | Specifies an array containing the states traversed before the current state in the Kiosk execution flow. The states are listed in the order they were executed, starting from the start state and ending with the state immediately preceding the current state. Maximum items: 2 |
previous_states[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item |
title | string | Required within parent | Represents the display title of the kiosk preview screen. Maximum length: 255 |
width | string | Required within parent | Indicates the display width of the kiosk preview screen. Maximum length: 255 |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the records retrieved by the data elements configured in the Kiosk. This object uses dynamic keys, where each key is the API name of a data element (for example, a Get Records element). Each key maps to an object containing the retrieved record's display name (name) and unique identifier (id). Additional keys: not allowed |
GetRecords_1 | array | Required within parent | Contains the list of record summaries returned by the GetRecords_1 element in the preview screen. Maximum items: 1 |
GetRecords_1[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summarized record item returned as part of the preview data set, including the record name and ID. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the record summary item in the preview data. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the record summary item in the preview data. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field-based element within the kiosk preview screen, including its type classification and current value. Additional keys: not allowed |
field | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field |
type | string | Required within parent | Indicates the type classification of the field-based element in the preview screen. Maximum length: 255 |
value | string | Required within parent | Contains the current value of the field-based element in the preview screen. Maximum length: 255 |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a form or data field in the kiosk preview screen, including its label, API name, data type, UI type, and display constraints. Additional keys: not allowed |
_merge_field | string | Required within parent | Represents the merge field template reference used to populate the field value from a linked kiosk process flow. Maximum length: 255 |
_pick_list_type | JSON | Required within parent | |
_pick_list_type (anyOf 1) | string | Alternative | Indicates the picklist type configuration for the field, when applicable. Known values: global_set, local |
_pick_list_type (anyOf 2) | null | Alternative | Indicates the picklist type configuration for the field, when applicable. Known values: global_set, local |
allow_multiple_upload | null | Required within parent | Indicates whether the field supports multiple file uploads, when applicable. |
api_name | string | Required within parent | Represents the API name of the field as defined in the CRM module. Maximum length: 255 |
currency | null | Required within parent | Indicates the currency configuration for the field, when applicable to currency-type fields. |
data_type | string | Required within parent | Represents the data type of the field, such as text, integer, or ownerlookup. Maximum length: 255 |
decimal_place | null | Required within parent | Indicates the number of decimal places configured for the field, when applicable to numeric fields. |
field_label | string | Required within parent | Represents the display label of the field as shown to the user in the kiosk screen. Maximum length: 255 |
id | string | Required within parent | Contains the unique identifier of the field definition in the kiosk screen. Maximum length: 255 |
length | JSON | Required within parent | |
length (anyOf 1) | integer | Alternative | Indicates the maximum character length configured for the field. Format: int32 |
length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_separator | boolean | Required within parent | Indicates whether the field uses a number separator for display. Possible values: true - A number separator is applied when displaying the field value. false - No number separator is applied. |
pick_list_values | null | Required within parent | Contains the available picklist values for the field, when applicable to picklist field types. |
read_only | boolean | Required within parent | Indicates whether the field is read-only in the kiosk screen. Possible values: true - The field is read-only and cannot be edited by the user. false - The field is editable by the user. |
required | boolean | Required within parent | Indicates whether the field is required in the kiosk screen. Possible values: true - The field must be filled in before the user can proceed. false - The field is optional. |
tooltip | null | Required within parent | Contains the tooltip text displayed for the field, when applicable. |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the UI type identifier that determines how the field is rendered in the kiosk screen. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a preview element data block that aggregates record retrieval configuration, raw values, record data, and pagination flags for a get record element. Additional keys: not allowed |
get_record | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record |
get_record_data | array | Required within parent | Contains the list of CRM records returned by the get record element in the preview screen. Maximum items: 19 |
get_record_data[] | JSON | Each item | Represents a single CRM record entry returned by the get record element, including key field values and owner details. |
get_record_data[] (anyOf 1) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id |
more_records | boolean | Required within parent | Indicates whether additional CRM records are available beyond those returned in the current preview response. Possible values: true - More records are available and can be retrieved. false - All available records have been returned in the current response. |
type | string | Required within parent | Indicates the type classification of the preview element data block. Maximum length: 255 |
value | null | Required within parent | Contains the value of the preview element data block, which may be null when the block uses a record retrieval configuration. |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the configuration for a get record element in the preview screen, including selection details, module information, and the list of selected fields. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the get record element as defined in the kiosk configuration. Maximum length: 255 |
id | string | Required within parent | Contains the unique identifier of the get record element in the kiosk configuration. Maximum length: 255 |
module | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module |
name | string | Required within parent | Represents the display name of the get record element in the kiosk configuration. Maximum length: 255 |
open_record | boolean | Required within parent | Indicates whether the record detail view opens when a user selects a record in the preview. Possible values: true - The record detail view opens on selection. false - The record detail view does not open on selection. |
selected_fields | array | Required within parent | Contains the list of CRM fields configured for display in the get record element of the preview screen. Maximum items: 3 |
selected_fields[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item |
selection_details | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data returned for a previewed CRM record, including key field values and owner details. Additional keys: not allowed |
Company | string | Required within parent | Represents the company name of the previewed CRM record. Maximum length: 255 |
First_Name | JSON | Required within parent | |
First_Name (anyOf 1) | string | Alternative | Represents the first name of the contact or lead in the previewed CRM record. Maximum length: 255 |
First_Name (anyOf 2) | null | Alternative | Represents the first name of the contact or lead in the previewed CRM record. Maximum length: 255 |
Owner | Model | Required within parent | Expand List kiosk executions — response body — kiosk executions item Owner |
id | string | Required within parent | Contains the unique identifier of the previewed CRM record. Maximum length: 255 |
Referenced models: List kiosk executions — response body — kiosk executions item Owner
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the CRM module used in the preview get record element, including its display label, API name, internal name, and ID. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the CRM module used in the preview get record element. Maximum length: 255 |
display_label | string | Required within parent | Represents the display label of the CRM module shown to the user in the preview. Maximum length: 255 |
id | string | Required within parent | Contains the unique identifier of the CRM module used in the preview get record element. Maximum length: 255 |
name | string | Required within parent | Represents the internal name of the CRM module used in the preview get record element. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents metadata for a field included in the preview selection, including the field label, API name, UI type, and data type. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the selected field included in the preview screen. Maximum length: 255 |
data_type | string | Required within parent | Represents the data type of the selected field, such as text or ownerlookup. Maximum length: 255 |
field_label | string | Required within parent | Represents the display label of the selected field as shown in the preview screen. Maximum length: 255 |
id | string | Required within parent | Contains the unique identifier of the selected field definition in the preview screen. Maximum length: 255 |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the UI type identifier that determines how the selected field is rendered in the preview. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines the record selection behavior for a get record element in the preview, including the selection type, result type, and record limit. Additional keys: not allowed |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Indicates the maximum number of records to retrieve in the get record element of the preview. Format: int32 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_type | string | Required within parent | Indicates the type of result set returned by the get record element, such as all records. Known values: single, multiple, all Maximum length: 255 |
selection_type | string | Required within parent | Indicates the selection behavior applied to the records returned by the get record element. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides the current state and available transitions for the executable context of a kiosk preview. 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 | Specifies the list of transitions available from the current state. Each transition contains the display name, unique ID, prop_name,is_connected_end. Maximum items: 1 |
transitions[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item
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 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a transition in the kiosk preview, including the connection flag, display name, ID, and property name of the transition button. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the transition in the kiosk preview. Maximum length: 255 |
is_connected_end | boolean | Required within parent | Indicates whether this transition leads to a connected end state in the kiosk flow. Possible values: true - The transition leads to a connected end state. false - The transition leads to an intermediate state in the kiosk flow. |
name | string | Required within parent | Represents the display name of the transition in the kiosk preview. Maximum length: 255 |
prop_name | string | Required within parent | Specifies the type of button displayed on the Kiosk screen. Each button corresponds to a transition path that the user can select from the current screen. **Possible values:** **primary** - Displays the button as the primary action on the screen, typically used for actions such as Next, Submit, or Save. **default** - Displays the button with the standard appearance, suitable for secondary actions. **outlineprimary** - Displays the button with a primary-colored outline, emphasizing the action without making it the primary button. **failure** - Displays the button with a solid error-themed style, typically used for destructive or critical actions such as Delete or Reject. **outlineredlight** - Displays the button with a red outline, typically used for secondary destructive actions such as Cancel, Discard, or Remove. Known values: primary, default, outlineprimary, failure, outlineredlight Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a minimal summary of the kiosk in the preview, including the kiosk name and ID. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the kiosk associated with the preview. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk associated with the preview. Maximum length: 255 |
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summary of a previously executed kiosk state available in the preview, including the state name, ID, and type. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the previously executed kiosk state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the previously executed kiosk state. Maximum length: 255 |
type | string | Required within parent | Indicates the type classification of the previously executed kiosk state, such as start_state or get_records. Maximum length: 255 |
Update a Kiosk Execution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for advancing a kiosk execution state, containing one or more execution action entries. Additional keys: not allowed |
kiosk_executions | array | Required within parent | Contains one or more execution action entries, each specifying the transition and data context for advancing the kiosk execution to the next state. Maximum items: 1 |
kiosk_executions[] | Model | Each item | Expand Update a Kiosk Execution — request body — body kiosk executions item |
Referenced models: Update a Kiosk Execution — request body — body kiosk executions item
Update a Kiosk Execution — request body — body kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an action entry for progressing a kiosk execution, providing the data context and transition information. Additional keys: not allowed |
data | Model | Optional | Expand Execute a Kiosk — request body — body kiosk execute item data Contains information about the current execution |
transition | Model | Required within parent | Expand Update a Kiosk Execution — request body — body kiosk executions item transition Contains the transition information for next execution (Required) |
Referenced models: Execute a Kiosk — request body — body kiosk execute item data, Update a Kiosk Execution — request body — body kiosk executions item transition
Update a Kiosk Execution — request body — body kiosk executions item transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents transition input providing the transition name and required ID for kiosk execution progression. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the transition that triggers the current execution step. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the transition that triggers the current execution step. Maximum length: 50 |
Update a Kiosk Execution — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates that an execution action completed successfully and provides details of the next executable state and execution ID. Additional keys: not allowed |
kiosk_executions | array | Optional | Contains the result of the execution action, including the status, message, and details of the next executable state. Maximum items: 1 |
kiosk_executions[] | Model | Each item | Expand Update a Kiosk Execution — response body — kiosk executions item |
Referenced models: Update a Kiosk Execution — response body — kiosk executions item
Update a Kiosk Execution — response body — kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of an execution action, including the status code, message, and details of the next executable state. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the execution action result. Maximum length: 255 |
details | Model | Optional | Expand Execute a Kiosk — response body — kiosk execute item details |
message | string | Optional | Contains the message describing the outcome of the execution action. Maximum length: 255 |
status | string | Optional | Indicates the overall status of the execution action result. Maximum length: 255 |
Referenced models: Execute a Kiosk — response body — kiosk execute item details