Zoho: Kiosks get records schemas
65 Zoho schemas with complete fields and constraints.
← Kiosks get records operations · All schemas
Get Kiosk Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing kiosk association information including detail view page associations. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association data. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item |
Referenced models: Get Kiosk Associations — response body — kiosks item
Get Kiosk Associations — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk item with its association information. Additional keys: not allowed |
_associations | array | Required within parent | List of associations for this kiosk. Maximum items: 50 |
_associations[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item associations item |
id | string | Required within parent | Kiosk identifier. Maximum length: 255 |
Referenced models: Get Kiosk Associations — response body — kiosks item associations item
Get Kiosk Associations — response body — kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk association entry for detail view pages. Additional keys: not allowed |
detail_view_page | array | Required within parent | Detail view page configurations. Maximum items: 50 |
detail_view_page[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item associations item detail view page item |
resources | null | Required within parent | Resources field (null for detail_view_page type). |
type | string | Required within parent | Type of association. Maximum length: 255 |
Referenced models: Get Kiosk Associations — response body — kiosks item associations item detail view page item
Get Kiosk Associations — response body — kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detail view page information. Additional keys: not allowed |
id | string | Required within parent | Unique identifier. Maximum length: 255 |
name | string | Required within parent | Name of the detail view page association. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Display sequence number. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get Records Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing get_record association information. Additional keys: not allowed |
get_records | array | Required within parent | Array of get_record association data. Maximum items: 10 |
get_records[] | Model | Each item | Expand Get Records Associations — response body — get records item |
Referenced models: Get Records Associations — response body — get records item
Get Records Associations — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Get record with its association information. Additional keys: not allowed |
_associations | array | Required within parent | List of associations for this get_record. Maximum items: 10 |
_associations[] | Model | Each item | Expand Get Records Associations — response body — get records item associations item |
id | string | Required within parent | Get record identifier. Maximum length: 19 |
Referenced models: Get Records Associations — response body — get records item associations item
Get Records Associations — response body — get records item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Association entry describing where a component is used. Additional keys: not allowed |
resources | array | Required within parent | Resources that use this component. Maximum items: 25 |
resources[] | Model | Each item | Expand Get Records Associations — response body — get records item associations item resources item |
type | string | Required within parent | Type of association (e.g., 'kiosk_states'). Maximum length: 255 |
Referenced models: Get Records Associations — response body — get records item associations item resources item
Get Records Associations — response body — get records item associations item resources item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Resource that references a component. Additional keys: not allowed |
_details | Model | Required within parent | Expand Get Records Associations — response body — get records item associations item resources item details |
id | string | Required within parent | Unique identifier of the resource. Maximum length: 255 |
name | string | Required within parent | Name of the resource. Maximum length: 255 |
Referenced models: Get Records Associations — response body — get records item associations item resources item details
Get Records Associations — response body — get records item associations item resources item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the resource type. Additional keys: not allowed |
type | string | Required within parent | Type of the resource (e.g., 'get_records', 'action'). Maximum length: 255 |
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing association information for all kiosks. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association data. Maximum items: 200 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk item with its detail view page association information. Additional keys: not allowed |
_associations | array | Required within parent | List of associations for this kiosk. Maximum items: 50 |
_associations[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item |
id | string | Required within parent | Kiosk identifier. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk association entry including detail view page configurations with layout and module details. Additional keys: not allowed |
detail_view_page | array | Required within parent | Detail view page configurations. Maximum items: 50 |
detail_view_page[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item |
resources | null | Required within parent | Resources field (null for detail_view_page type). |
type | string | Required within parent | Type of association. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detail view page information with layout and module details. Additional keys: not allowed |
id | string | Required within parent | Unique identifier. Maximum length: 255 |
layout | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout Layout associated with this detail view page. |
module | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module Module associated with this detail view page. |
name | string | Required within parent | Name of the detail view page association. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Display sequence number. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout, Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Layout details in association responses. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the layout. Maximum length: 19 |
name | string | Required within parent | Name of the layout. Maximum length: 255 |
status | string | Required within parent | Status of the layout. Maximum length: 50 |
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module details in association responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module. Maximum length: 50 |
display_label | string | Required within parent | Display label of the module. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 19 |
name | string | Required within parent | Name of the module. Maximum length: 50 |
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for updating kiosk associations. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association configurations. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for configuring kiosk associations. Additional keys: not allowed |
_associations | array | Required within parent | Association configurations. Maximum items: 1 |
_associations[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item |
id | string | Required within parent | ID of the kiosk to associate. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Association configuration specifying association type and target. Additional keys: not allowed |
detail_view_page | array | Required within parent | Detail view page configurations. Maximum items: 1 |
detail_view_page[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item |
type | string | Required within parent | Type of association. One of: detail_view_page Maximum length: 20 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration for associating a kiosk with a detail view page. Additional keys: not allowed |
_delete | string or null | Optional | Set to trigger deletion of this association. Maximum length: 255 |
layout | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout Layout to associate the kiosk with. |
module | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module Module for the detail view page association. |
name | string | Required within parent | Display name for the association widget on the detail view page. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Layout reference. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the layout. Maximum length: 19 |
Kiosk Associations — kiosks Get Records update Kiosk Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully updating kiosk associations. Additional keys: not allowed |
kiosks | array | Optional | Array of operation results. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item
Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation result for kiosk association operations. Additional keys: not allowed |
code | string | Optional | Result code. Maximum length: 255 |
details | Model | Optional | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details |
message | string | Optional | Human-readable result message. Maximum length: 255 |
status | string | Optional | Status of the operation. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the operation result. Additional keys: not allowed |
id | string | Optional | ID of the created, updated, or deleted resource. Maximum length: 255 |
Kiosk Current Records Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing current record association information. Additional keys: not allowed |
current_record | array | Required within parent | Array of current record association data. Maximum items: 10 |
current_record[] | Model | Each item | Expand Kiosk Current Records Associations — response body — current record item |
Referenced models: Kiosk Current Records Associations — response body — current record item
Kiosk Current Records Associations — response body — current record item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current record with its association information. Additional keys: not allowed |
_associations | array | Required within parent | List of associations for the current record. Maximum items: 1 |
_associations[] | Model | Each item | Expand Get Records Associations — response body — get records item associations item |
id | string | Required within parent | Current record identifier. Maximum length: 255 |
Referenced models: Get Records Associations — response body — get records item associations item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a new get_record component. Additional keys: not allowed |
get_records | array | Required within parent | Array containing the get_record configuration to create. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for creating a get_record component. Defines the module, criteria, selection rules, and sort order. Additional keys: not allowed |
child_relationship | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship Reference to the child relationship. Used when type is 'child'. |
criteria | Model | Required within parent | Expand Related Records — request body — query filters Filter criteria configuration for selecting records. Supports both simple field-based filters and grouped conditions with logical operators (AND/OR). MANDATORY type key is required inside criteria even if it's not mentioned in the schema |
module | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module Module from which records will be fetched. |
name | string | Required within parent | Human-readable name of the get_record component. Must be unique within the kiosk. Maximum length: 50 |
parent_record_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field Reference to the parent module field. Required when type is 'child'. |
selected_fields | array or null | Optional | Fields to display when the get_record is shown on a screen. Only needed when associated with a screen state. Maximum items: 50 |
selected_fields[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details Selection rules controlling how many records are fetched and how users can select from them. |
sort_order | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order Sort order configuration for fetched records. order_by_name is always required. When order_by_name is 'not_sort', order_by_field must not be present. Otherwise, order_by_field is required and its 'id' key must be provided |
type | string or null | Optional | Module type: 'parent' for direct modules (e.g., Leads) or 'child' for related modules (e.g., Calls). One of: parent, child |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship, Related Records — request body — query filters, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the child relationship (e.g., Calls, Tasks) for child-type get_records. Additional keys: not allowed |
display_label | string or null | Optional | Display label of the child relationship. Maximum length: 50 |
id | string | Required within parent | Unique identifier of the child relationship. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module reference with required ID for identifying the CRM module. Additional keys: not allowed |
api_name | string or null | Optional | API name of the module. Maximum length: 50 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 19 |
name | string or null | Optional | Display name of the module. Maximum length: 50 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the parent module's record field. Required when the get_record type is 'child'. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the parent record field. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection rules for controlling record fetching and user selection during kiosk execution. Rules by result_type - 'multiple': range and selection_type are mandatory; range value must be strictly greater than limit. 'all': selection_type and limit are mandatory; range must NOT be provided. 'single': selection_type must not be provided (must be null); range and limit must both be sent as 1. Additional keys: not allowed |
limit | integer or null | Optional | Maximum number of records the user can select. Must be less than range when result_type is 'multiple'. Mandatory when result_type is 'all'. Must be 1 when result_type is 'single'. Format: int32 |
range | integer or null | Optional | Maximum number of records to fetch. Mandatory when result_type is 'multiple' (must be greater than limit). Must be 1 when result_type is 'single'. Must NOT be provided when result_type is 'all'. Format: int32 |
result_type | string | Required within parent | Determines how many records are fetched. 'multiple': range and selection_type are mandatory; range must be greater than limit. 'all': selection_type and limit are mandatory; range must NOT be sent. 'single': range and limit must both be 1; selection_type must not be sent (must be null). One of: single, multiple, all Maximum length: 10 |
selection_type | string or null | Optional | User selection behavior: 'mandate' (required), 'optional', or 'read_only'. Mandatory when result_type is 'multiple' or 'all'. Must be null (not provided) when result_type is 'single'. One of: mandate, optional, read_only |
$ (allOf 1) | JSON | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 3) | JSON | All variants apply |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sort order configuration for fetched records. order_by_name is always required. When order_by_name is 'not_sort', order_by_field must not be present. Otherwise, order_by_field is required and its 'id' key must be provided. Additional keys: not allowed |
order_by_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field Field used for sorting the records. Must not be provided when order_by_name is 'not_sort'. |
order_by_name | string | Required within parent | Sort direction. Defaults to 'ascending' if not specified. One of: ascending, not_sort, descending Maximum length: 50 |
$ (allOf 1) | JSON | All variants apply |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field reference used for ordering fetched records. Additional keys: not allowed |
api_name | string or null | Optional | API name of the sorting field. Maximum length: 50 |
display_label | string or null | Optional | Display label of the sorting field. Maximum length: 255 |
id | string or null | Optional | Unique identifier of the sorting field. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully creating a get_record component. Additional keys: not allowed |
get_records | array | Optional | Array of operation results. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation result for get_record CRUD operations. Additional keys: not allowed |
code | string | Optional | Result code (e.g., 'SUCCESS'). Maximum length: 255 |
details | Model | Optional | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details |
message | string | Optional | Human-readable result message. Maximum length: 255 |
status | string | Optional | Status of the operation (e.g., 'success'). Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
Kiosk Get Record — kiosks Get Records delete Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully deleting a get_record component. Additional keys: not allowed |
get_records | array | Optional | Array of operation results. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for updating an existing get_record component. Additional keys: not allowed |
get_records | array | Required within parent | Array containing the get_record update payload. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for updating a get_record component. All fields are optional - only fields provided will be updated. Additional keys: not allowed |
child_relationship | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship Reference to the child relationship. |
criteria | Model | Optional | Expand Related Records — request body — query filters Filter criteria configuration for selecting records. |
module | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module Module from which records will be fetched. |
name | string or null | Optional | Human-readable name of the get_record component. Maximum length: 50 |
parent_record_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field Reference to the parent module field. |
selected_fields | array or null | Optional | Fields to display when the get_record is shown on a screen. Maximum items: 50 |
selected_fields[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details Selection rules controlling how many records are fetched. |
sort_order | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order Sorting configuration for the fetched records. |
type | string or null | Optional | Module type: 'parent' or 'child'. One of: parent, child |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship, Related Records — request body — query filters, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Child relationship reference for update operations. Additional keys: not allowed |
display_label | string or null | Optional | Display label of the child relationship. Maximum length: 50 |
id | string or null | Optional | Unique identifier of the child relationship. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module reference for update operations. All fields are optional. Additional keys: not allowed |
api_name | string or null | Optional | API name of the module. Maximum length: 50 |
id | string or null | Optional | Unique identifier of the module. Maximum length: 19 |
name | string or null | Optional | Display name of the module. Maximum length: 50 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parent record field reference for update operations. Additional keys: not allowed |
id | string or null | Optional | Unique identifier of the parent record field. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection rules for update operations. All fields are optional. Additional keys: not allowed |
limit | integer or null | Optional | Maximum number of records the user can select. Format: int32 |
range | integer or null | Optional | Maximum number of records to fetch. Format: int32 |
result_type | string or null | Optional | Determines how many records are fetched. One of: single, multiple, all |
selection_type | string or null | Optional | User selection behavior. One of: mandate, optional, read_only |
$ (allOf 1) | JSON | All variants apply | |
$ (allOf 2) | JSON | All variants apply |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sort order configuration for update operations. All fields are optional. When order_by_name is 'not_sort', order_by_field must not be present. If order_by_field is provided, its 'id' key is mandatory. Additional keys: not allowed |
order_by_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field Field used for sorting the records. Must not be provided when order_by_name is 'not_sort'. |
order_by_name | string or null | Optional | Sort direction. One of: ascending, not_sort, descending Maximum length: 50 |
$ (allOf 1) | JSON | All variants apply | |
$ (allOf 2) | JSON | All variants apply |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully updating a get_record component. Additional keys: not allowed |
get_records | array | Optional | Array of operation results. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
Retrieve a specific get record component from a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing all get_record components with their full configuration. Additional keys: not allowed |
get_records | array | Required within parent | Array of get_record component details. Maximum items: 25 |
get_records[] | Model | Each item | Expand Retrieve a specific get record component from a Kiosk — response body — get records item |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item
Retrieve a specific get record component from a Kiosk — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete get_record component data as returned in GET responses. Additional keys: not allowed |
criteria | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria Filter criteria configured for this get_record. |
id | string | Required within parent | Unique identifier of the get_record component. Maximum length: 19 |
module | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item module |
name | string | Required within parent | Name of the get_record component. Maximum length: 255 |
selected_fields | JSON | Required within parent | |
selected_fields (anyOf 1) | array | Alternative | Fields configured for display. Null if not configured. Maximum items: 50 |
selected_fields (anyOf 1)[] | string | Each item | API name of a selected field. Maximum length: 30 |
selected_fields (anyOf 2) | null | Alternative | Fields configured for display. Null if not configured. Maximum items: 50 |
selected_fields (anyOf 2)[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item selection details |
sort_order | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item sort order |
type | string | Required within parent | Module type: 'parent' or 'child'. Maximum length: 255 |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item sort order, Retrieve a specific get record component from a Kiosk — response body — get records item module, Retrieve a specific get record component from a Kiosk — response body — get records item criteria, Retrieve a specific get record component from a Kiosk — response body — get records item selection details
Retrieve a specific get record component from a Kiosk — response body — get records item criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators. |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or |
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: between, not between, type: merge field, pre defined, value, field, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value value, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: in, not in, type: merge field, pre defined, value, field, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
Retrieve a specific get record component from a Kiosk — response body — get records item criteria value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the response for an equality filter criterion that dispatches to either the EqualFilterCriterionResponse or NotEqualFilterCriterionResponse schema based on the comparator value. |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field |
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field
Retrieve a specific get record component from a Kiosk — response body — get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module information in GET responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 255 |
Retrieve a specific get record component from a Kiosk — response body — get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection details in GET responses. selection_type can be null for single result_type. Additional keys: not allowed |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Selection limit. Format: int32 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range | JSON | Required within parent | |
range (anyOf 1) | integer | Alternative | Fetch range. Format: int32 |
range (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_type | string | Required within parent | Result type: single, multiple, or all. Maximum length: 255 |
selection_type | JSON | Required within parent | |
selection_type (anyOf 1) | string | Alternative | Selection behavior type. Null for single record results. Maximum length: 255 |
selection_type (anyOf 2) | null | Alternative | Selection behavior type. Null for single record results. Maximum length: 255 |
Retrieve a specific get record component from a Kiosk — response body — get records item sort order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sort order information in GET responses. When order_by_name is 'not_sort', order_by_field is absent. Otherwise, order_by_field is present and its 'id' is required (enforced by GETOrderByField). Additional keys: not allowed |
order_by_field | Model | Optional | Expand Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field |
order_by_name | string | Required within parent | Sort direction. Maximum length: 255 |
$ (allOf 1) | JSON | All variants apply |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Order by field information in GET responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the field. Maximum length: 255 |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the grouped filter criterion returned in the response, containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group. |
group | array | Required within parent | Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2 |
group[] | JSON | Each item | |
group[] (anyOf 1) | Model | Alternative | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
group[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or |
group_operator | string | Required within parent | Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. Known values: AND, OR, and, or |
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: between, not between, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the between and not_between comparators. The value is an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the between filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the range comparison operator returned for the criterion, indicating whether the field value falls within or outside the specified bounds. Possible values: between - Matches records where the field value falls within the specified range. not_between - Matches records where the field value falls outside the specified range. Known values: between, not_between |
field | JSON | Required within parent | Represents the target field definition to which the range filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the range filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value |
value | array | Required within parent | Contains the two boundary values — [lower_bound, upper_bound] — against which the field was evaluated for the between or not_between comparator. Maximum items: 2 Minimum items: 2 |
value[] | JSON | Each item | |
value[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: in, not in, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the in and not_in comparators. The value is an array of primitive values. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the set filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the set membership comparison operator returned for the criterion. Possible values: in - Matches records where the field value is in the specified set of values. not_in - Matches records where the field value is not in the specified set of values. Known values: in, not_in |
field | JSON | Required within parent | Represents the target field definition to which the set filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the set filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value |
value | array | Required within parent | Contains an array of primitive filter values returned for the set comparison. Maximum items: 500 Minimum items: 1 |
value[] | JSON | Each item | |
value[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the multi-select lookup filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the multi-select lookup comparison operator returned for the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Possible values: include_all - Matches records that include all specified lookup values. include_any - Matches records that include at least one of the specified lookup values. exclude_all - Matches records that exclude all specified lookup values. exclude_any - Matches records that exclude at least one of the specified lookup values. Known values: include_all, include_any, exclude_all, exclude_any |
field | JSON | Required within parent | Represents the target field definition to which the multi-select lookup filter criterion was applied. The field has a data_type of multiuserlookup or multiselectlookup. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value |
value | array | Required within parent | Contains an array of lookup object references returned for the multi-select comparison. Maximum items: 500 Minimum items: 1 |
value[] | Model | Each item | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a lookup object filter criterion value for response bodies, applicable when the field's data_type is lookup, ownerlookup, or userlookup. Both the ID and name properties are included. |
$ (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item id, name |
$ (allOf 2) | object | All variants apply | Represents the constraint that both the ID and name properties are required for the lookup object filter criterion value in response bodies. Additional keys: allowed |
$ (allOf 2).id | JSON | Required within parent | |
$ (allOf 2).name | JSON | Required within parent |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the less_than, less_equal, greater_than, and greater_equal comparators. The value is a scalar; arrays and objects are not valid. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the ordering filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the ordering comparison operator returned for the criterion. Possible values: less_than - Matches records where the field value is less than the specified filter value. less_equal - Matches records where the field value is less than or equal to the specified filter value. greater_than - Matches records where the field value is greater than the specified filter value. greater_equal - Matches records where the field value is greater than or equal to the specified filter value. Known values: less_than, less_equal, greater_than, greater_equal |
field | JSON | Required within parent | Represents the target field definition to which the ordering filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value |
value | JSON | Required within parent | Represents the scalar filter value returned for the ordering comparator. |
value (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
value (anyOf 3) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value is a string scalar or array; SimpleFilterCriterionValueString applies to text-based field types. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the text filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the text comparison operator returned for the criterion. Possible values: like - Matches records where the field value contains the specified pattern. not_like - Matches records where the field value does not contain the specified pattern. starts_with - Matches records where the field value begins with the specified string. ends_with - Matches records where the field value ends with the specified string. contains - Matches records where the field value contains the specified string. not_contains - Matches records where the field value does not contain the specified string. Known values: like, not_like, starts_with, ends_with, contains, not_contains |
field | JSON | Required within parent | Represents the target field definition to which the text filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the text filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value |
value | JSON | Required within parent | Represents the string filter value returned for the text comparator. Contains a scalar string or an array of string values. |
value (anyOf 1) | array | Alternative | Contains an array of primitive string values returned for the text filter comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime; SimpleFilterCriterionValueNumber for integer, currency, or double; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup, ownerlookup, or userlookup; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the equal comparison operator returned for the criterion. Possible values: equal - Matches records where the field value equals the specified filter value. Known values: equal |
field | JSON | Required within parent | Represents the target field definition to which the equal filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, value, pre_defined, field Default: value |
value | JSON | Required within parent | Represents the filter value returned for the equal comparator. Contains a scalar or an array of values, depending on the field's data_type. |
value (anyOf 1) | array | Alternative | Contains an array of filter values returned for the equal comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 1)[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
value (anyOf 1)[] (anyOf 3) | JSON | Alternative | |
value (anyOf 1)[] (anyOf 3) (anyOf 1) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 1)[] (anyOf 3) (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 3) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
value (anyOf 4) | boolean | Alternative | Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field). |
value (anyOf 5) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 6) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value |
value (anyOf 7) | string | Alternative | Represents a predefined placeholder value applicable to any field data_type with the equal comparator. Possible values: ${EMPTY} - Matches records where the field has no value. ${NOTEMPTY} - Matches records where the field has any non-empty value. Known values: ${EMPTY}, ${NOTEMPTY} |
value (anyOf 8) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string |
value (anyOf 9) | string | Alternative | Represents a predefined N-period range placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Follows the pattern ${NEXT_N_<PERIOD>:<n>} or ${LAST_N_<PERIOD>:<n>}, where PERIOD is DAYS, WEEKS, MONTHS, or YEARS and n is a positive integer. The current period is always excluded from the range. Maximum length: 255 Pattern: ^\$\{(LAST_N_|NEXT_N_)(DAYS|WEEKS|MONTHS|YEARS):([0-9]+)\}$ |
value (anyOf 10) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Represents a predefined placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Known values: ${TODAY}, ${TOMORROW}, ${TOMORROWPLUS}, ${YESTERDAY}, ${YESTERDAYMINUS}, ${LASTMONTH}, ${THISMONTH}, ${NEXTMONTH}, ${LASTWEEK}, ${THISWEEK}, ${NEXTWEEK}, ${THISYEAR}, ${THISFY}, ${THISFQ}, ${LASTYEAR}, ${PREVFY}, ${PREVFQ}, ${NEXTYEAR}, ${NEXTFY}, ${NEXTFQ}, ${EMPTY}, ${NOTEMPTY} |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a predefined placeholder object filter criterion value for lookup fields, applicable with equal or not_equal comparators when the field's data_type is ownerlookup or userlookup. Two forms are supported: (1) the currently logged-in user, represented by passing only the name property with the predefined value ${CURRENTUSER} and no ID property; and (2) the logged-in user's role, represented by passing the ID property with the predefined value ${CURRENTUSERROLE} and an optional display label in the name property. For specific real users or roles that are not predefined, use SimpleFilterCriterionValueObjectRequest, which requires the ID property. |
$ (anyOf 1) | object | Alternative | Represents the predefined object form for the currently logged-in user, in which only the name property carries the predefined value ${CURRENTUSER} and no ID property is included. Additional keys: not allowed |
$ (anyOf 1).name | string | Required within parent | Represents the predefined placeholder for the currently logged-in user. Possible values: ${CURRENTUSER} - Represents the currently logged-in user. Known values: ${CURRENTUSER} |
$ (anyOf 2) | object | Alternative | Represents the predefined object form for the currently logged-in user's role, in which the ID property carries the predefined value ${CURRENTUSERROLE} and the name property is an optional display label. Additional keys: allowed |
$ (anyOf 2).id | string | Required within parent | Represents the predefined placeholder for the logged-in user's role record ID. Possible values: ${CURRENTUSERROLE} - Represents the role of the currently logged-in user. Known values: ${CURRENTUSERROLE} |
$ (anyOf 2).name | string | Optional | Represents an optional display label for the predefined role, such as Logged in User Role. Maximum length: 255 |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: not equal, type: merge field, value, pre defined, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a filter criterion using the not_equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text-based types; SimpleFilterCriterionValueNumber for numeric types; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup types; and SimpleFilterCriterionValueObjectPredefined for predefined user or role placeholders. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the not-equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference. |
comparator | string | Required within parent | Represents the not-equal comparison operator returned for the criterion. Possible values: not_equal - Matches records where the field value does not equal the specified filter value. Known values: not_equal |
field | JSON | Required within parent | Represents the target field definition to which the not-equal filter criterion was applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion response. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, value, pre_defined, field Default: value |
value | JSON | Required within parent | Represents the filter value returned for the not_equal comparator. Contains a scalar or an array of values, depending on the field's data_type. |
value (anyOf 1) | array | Alternative | Contains an array of filter values returned for the not_equal comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 1)[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
value (anyOf 1)[] (anyOf 3) | JSON | Alternative | |
value (anyOf 1)[] (anyOf 3) (anyOf 1) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 1)[] (anyOf 3) (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 3) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value |
value (anyOf 4) | boolean | Alternative | Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field). |
value (anyOf 5) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 6) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value |
value (anyOf 7) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item