Skip to content

Zoho: Kiosks get records schemas

65 Zoho schemas with complete fields and constraints.

← Kiosks get records operations · All schemas

Get Kiosk Associations — response body

FieldTypePresenceDescription and constraints
$objectRootResponse containing kiosk association information including detail view page associations.
Additional keys: not allowed
kiosksarrayRequired within parentArray of kiosk association data.
Maximum items: 1
kiosks[]ModelEach itemExpand Get Kiosk Associations — response body — kiosks item

Referenced models: Get Kiosk Associations — response body — kiosks item

Get Kiosk Associations — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootKiosk item with its association information.
Additional keys: not allowed
_associationsarrayRequired within parentList of associations for this kiosk.
Maximum items: 50
_associations[]ModelEach itemExpand Get Kiosk Associations — response body — kiosks item associations item
idstringRequired within parentKiosk identifier.
Maximum length: 255

Referenced models: Get Kiosk Associations — response body — kiosks item associations item

Get Kiosk Associations — response body — kiosks item associations item

FieldTypePresenceDescription and constraints
$objectRootKiosk association entry for detail view pages.
Additional keys: not allowed
detail_view_pagearrayRequired within parentDetail view page configurations.
Maximum items: 50
detail_view_page[]ModelEach itemExpand Get Kiosk Associations — response body — kiosks item associations item detail view page item
resourcesnullRequired within parentResources field (null for detail_view_page type).
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootDetail view page information.
Additional keys: not allowed
idstringRequired within parentUnique identifier.
Maximum length: 255
namestringRequired within parentName of the detail view page association.
Maximum length: 255
sequence_numberJSONRequired within parent
sequence_number (anyOf 1)integerAlternativeDisplay sequence number.
Format: int32
sequence_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Records Associations — response body

FieldTypePresenceDescription and constraints
$objectRootResponse containing get_record association information.
Additional keys: not allowed
get_recordsarrayRequired within parentArray of get_record association data.
Maximum items: 10
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootGet record with its association information.
Additional keys: not allowed
_associationsarrayRequired within parentList of associations for this get_record.
Maximum items: 10
_associations[]ModelEach itemExpand Get Records Associations — response body — get records item associations item
idstringRequired within parentGet 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

FieldTypePresenceDescription and constraints
$objectRootAssociation entry describing where a component is used.
Additional keys: not allowed
resourcesarrayRequired within parentResources that use this component.
Maximum items: 25
resources[]ModelEach itemExpand Get Records Associations — response body — get records item associations item resources item
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootResource that references a component.
Additional keys: not allowed
_detailsModelRequired within parentExpand Get Records Associations — response body — get records item associations item resources item details
idstringRequired within parentUnique identifier of the resource.
Maximum length: 255
namestringRequired within parentName 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

FieldTypePresenceDescription and constraints
$objectRootDetails about the resource type.
Additional keys: not allowed
typestringRequired within parentType of the resource (e.g., 'get_records', 'action').
Maximum length: 255

Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks

FieldTypePresenceDescription and constraints
$objectRootResponse containing association information for all kiosks.
Additional keys: not allowed
kiosksarrayRequired within parentArray of kiosk association data.
Maximum items: 200
kiosks[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootKiosk item with its detail view page association information.
Additional keys: not allowed
_associationsarrayRequired within parentList of associations for this kiosk.
Maximum items: 50
_associations[]ModelEach itemExpand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item
idstringRequired within parentKiosk 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

FieldTypePresenceDescription and constraints
$objectRootKiosk association entry including detail view page configurations with layout and module details.
Additional keys: not allowed
detail_view_pagearrayRequired within parentDetail view page configurations.
Maximum items: 50
detail_view_page[]ModelEach itemExpand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item
resourcesnullRequired within parentResources field (null for detail_view_page type).
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootDetail view page information with layout and module details.
Additional keys: not allowed
idstringRequired within parentUnique identifier.
Maximum length: 255
layoutModelRequired within parentExpand 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.
moduleModelRequired within parentExpand 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.
namestringRequired within parentName of the detail view page association.
Maximum length: 255
sequence_numberJSONRequired within parent
sequence_number (anyOf 1)integerAlternativeDisplay sequence number.
Format: int32
sequence_number (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootLayout details in association responses.
Additional keys: not allowed
idstringRequired within parentUnique identifier of the layout.
Maximum length: 19
namestringRequired within parentName of the layout.
Maximum length: 255
statusstringRequired within parentStatus 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

FieldTypePresenceDescription and constraints
$objectRootModule details in association responses.
Additional keys: not allowed
api_namestringRequired within parentAPI name of the module.
Maximum length: 50
display_labelstringRequired within parentDisplay label of the module.
Maximum length: 255
idstringRequired within parentUnique identifier of the module.
Maximum length: 19
namestringRequired within parentName of the module.
Maximum length: 50

Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for updating kiosk associations.
Additional keys: not allowed
kiosksarrayRequired within parentArray of kiosk association configurations.
Maximum items: 1
kiosks[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootPayload for configuring kiosk associations.
Additional keys: not allowed
_associationsarrayRequired within parentAssociation configurations.
Maximum items: 1
_associations[]ModelEach itemExpand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item
idstringRequired within parentID 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

FieldTypePresenceDescription and constraints
$objectRootAssociation configuration specifying association type and target.
Additional keys: not allowed
detail_view_pagearrayRequired within parentDetail view page configurations.
Maximum items: 1
detail_view_page[]ModelEach itemExpand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootConfiguration for associating a kiosk with a detail view page.
Additional keys: not allowed
_deletestring or nullOptionalSet to trigger deletion of this association.
Maximum length: 255
layoutModelRequired within parentExpand 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.
moduleModelRequired within parentExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
Module for the detail view page association.
namestringRequired within parentDisplay 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

FieldTypePresenceDescription and constraints
$objectRootLayout reference.
Additional keys: not allowed
idstringRequired within parentUnique identifier of the layout.
Maximum length: 19

Kiosk Associations — kiosks Get Records update Kiosk Associations — response body

FieldTypePresenceDescription and constraints
$objectRootResponse after successfully updating kiosk associations.
Additional keys: not allowed
kiosksarrayOptionalArray of operation results.
Maximum items: 1
kiosks[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootOperation result for kiosk association operations.
Additional keys: not allowed
codestringOptionalResult code.
Maximum length: 255
detailsModelOptionalExpand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
messagestringOptionalHuman-readable result message.
Maximum length: 255
statusstringOptionalStatus 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

FieldTypePresenceDescription and constraints
$objectRootDetails of the operation result.
Additional keys: not allowed
idstringOptionalID of the created, updated, or deleted resource.
Maximum length: 255

Kiosk Current Records Associations — response body

FieldTypePresenceDescription and constraints
$objectRootResponse containing current record association information.
Additional keys: not allowed
current_recordarrayRequired within parentArray of current record association data.
Maximum items: 10
current_record[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootCurrent record with its association information.
Additional keys: not allowed
_associationsarrayRequired within parentList of associations for the current record.
Maximum items: 1
_associations[]ModelEach itemExpand Get Records Associations — response body — get records item associations item
idstringRequired within parentCurrent 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

FieldTypePresenceDescription and constraints
$objectRootRequest body for creating a new get_record component.
Additional keys: not allowed
get_recordsarrayRequired within parentArray containing the get_record configuration to create.
Maximum items: 1
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootPayload for creating a get_record component. Defines the module, criteria, selection rules, and sort order.
Additional keys: not allowed
child_relationshipModelOptionalExpand 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'.
criteriaModelRequired within parentExpand 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
moduleModelRequired within parentExpand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module
Module from which records will be fetched.
namestringRequired within parentHuman-readable name of the get_record component. Must be unique within the kiosk.
Maximum length: 50
parent_record_fieldModelOptionalExpand 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_fieldsarray or nullOptionalFields to display when the get_record is shown on a screen. Only needed when associated with a screen state.
Maximum items: 50
selected_fields[]stringEach itemAPI name of a selected field.
Maximum length: 30
selection_detailsModelOptionalExpand 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_orderModelRequired within parentExpand 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
typestring or nullOptionalModule 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

FieldTypePresenceDescription and constraints
$objectRootReference to the child relationship (e.g., Calls, Tasks) for child-type get_records.
Additional keys: not allowed
display_labelstring or nullOptionalDisplay label of the child relationship.
Maximum length: 50
idstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRootModule reference with required ID for identifying the CRM module.
Additional keys: not allowed
api_namestring or nullOptionalAPI name of the module.
Maximum length: 50
idstringRequired within parentUnique identifier of the module.
Maximum length: 19
namestring or nullOptionalDisplay 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

FieldTypePresenceDescription and constraints
$objectRootReference to the parent module's record field. Required when the get_record type is 'child'.
Additional keys: not allowed
idstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRootSelection 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
limitinteger or nullOptionalMaximum 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
rangeinteger or nullOptionalMaximum 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_typestringRequired within parentDetermines 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_typestring or nullOptionalUser 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)JSONAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 3)JSONAll variants apply

Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order

FieldTypePresenceDescription and constraints
$objectRootSort 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_fieldModelOptionalExpand 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_namestringRequired within parentSort direction. Defaults to 'ascending' if not specified.
One of: ascending, not_sort, descending
Maximum length: 50
$ (allOf 1)JSONAll 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

FieldTypePresenceDescription and constraints
$objectRootField reference used for ordering fetched records.
Additional keys: not allowed
api_namestring or nullOptionalAPI name of the sorting field.
Maximum length: 50
display_labelstring or nullOptionalDisplay label of the sorting field.
Maximum length: 255
idstring or nullOptionalUnique identifier of the sorting field.
Maximum length: 19

Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body

FieldTypePresenceDescription and constraints
$objectRootResponse after successfully creating a get_record component.
Additional keys: not allowed
get_recordsarrayOptionalArray of operation results.
Maximum items: 1
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootOperation result for get_record CRUD operations.
Additional keys: not allowed
codestringOptionalResult code (e.g., 'SUCCESS').
Maximum length: 255
detailsModelOptionalExpand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
messagestringOptionalHuman-readable result message.
Maximum length: 255
statusstringOptionalStatus 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

FieldTypePresenceDescription and constraints
$objectRootResponse after successfully deleting a get_record component.
Additional keys: not allowed
get_recordsarrayOptionalArray of operation results.
Maximum items: 1
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRequest body for updating an existing get_record component.
Additional keys: not allowed
get_recordsarrayRequired within parentArray containing the get_record update payload.
Maximum items: 1
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootPayload for updating a get_record component. All fields are optional - only fields provided will be updated.
Additional keys: not allowed
child_relationshipModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship
Reference to the child relationship.
criteriaModelOptionalExpand Related Records — request body — query filters
Filter criteria configuration for selecting records.
moduleModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
Module from which records will be fetched.
namestring or nullOptionalHuman-readable name of the get_record component.
Maximum length: 50
parent_record_fieldModelOptionalExpand 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_fieldsarray or nullOptionalFields to display when the get_record is shown on a screen.
Maximum items: 50
selected_fields[]stringEach itemAPI name of a selected field.
Maximum length: 30
selection_detailsModelOptionalExpand 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_orderModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order
Sorting configuration for the fetched records.
typestring or nullOptionalModule 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

FieldTypePresenceDescription and constraints
$objectRootChild relationship reference for update operations.
Additional keys: not allowed
display_labelstring or nullOptionalDisplay label of the child relationship.
Maximum length: 50
idstring or nullOptionalUnique 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

FieldTypePresenceDescription and constraints
$objectRootModule reference for update operations. All fields are optional.
Additional keys: not allowed
api_namestring or nullOptionalAPI name of the module.
Maximum length: 50
idstring or nullOptionalUnique identifier of the module.
Maximum length: 19
namestring or nullOptionalDisplay 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

FieldTypePresenceDescription and constraints
$objectRootParent record field reference for update operations.
Additional keys: not allowed
idstring or nullOptionalUnique 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

FieldTypePresenceDescription and constraints
$objectRootSelection rules for update operations. All fields are optional.
Additional keys: not allowed
limitinteger or nullOptionalMaximum number of records the user can select.
Format: int32
rangeinteger or nullOptionalMaximum number of records to fetch.
Format: int32
result_typestring or nullOptionalDetermines how many records are fetched.
One of: single, multiple, all
selection_typestring or nullOptionalUser selection behavior.
One of: mandate, optional, read_only
$ (allOf 1)JSONAll variants apply
$ (allOf 2)JSONAll variants apply

Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order

FieldTypePresenceDescription and constraints
$objectRootSort 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_fieldModelOptionalExpand 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_namestring or nullOptionalSort direction.
One of: ascending, not_sort, descending
Maximum length: 50
$ (allOf 1)JSONAll variants apply
$ (allOf 2)JSONAll 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

FieldTypePresenceDescription and constraints
$objectRootResponse after successfully updating a get_record component.
Additional keys: not allowed
get_recordsarrayOptionalArray of operation results.
Maximum items: 1
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootResponse containing all get_record components with their full configuration.
Additional keys: not allowed
get_recordsarrayRequired within parentArray of get_record component details.
Maximum items: 25
get_records[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootComplete get_record component data as returned in GET responses.
Additional keys: not allowed
criteriaModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria
Filter criteria configured for this get_record.
idstringRequired within parentUnique identifier of the get_record component.
Maximum length: 19
moduleModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item module
namestringRequired within parentName of the get_record component.
Maximum length: 255
selected_fieldsJSONRequired within parent
selected_fields (anyOf 1)arrayAlternativeFields configured for display. Null if not configured.
Maximum items: 50
selected_fields (anyOf 1)[]stringEach itemAPI name of a selected field.
Maximum length: 30
selected_fields (anyOf 2)nullAlternativeFields configured for display. Null if not configured.
Maximum items: 50
selected_fields (anyOf 2)[]stringEach itemAPI name of a selected field.
Maximum length: 30
selection_detailsModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item selection details
sort_orderModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item sort order
typestringRequired within parentModule 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

FieldTypePresenceDescription and constraints
$JSONRootRepresents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators.
$ (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$JSONRootRepresents the response for a simple field-based filter criterion, dispatching to the appropriate comparator-specific response schema.
$ (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value value
$ (anyOf 2)ModelAlternativeExpand 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
$ (anyOf 3)ModelAlternativeExpand 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
$ (anyOf 4)ModelAlternativeExpand 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
$ (anyOf 5)ModelAlternativeExpand 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
$ (anyOf 6)ModelAlternativeExpand 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

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

FieldTypePresenceDescription and constraints
$JSONRootRepresents the response for an equality filter criterion that dispatches to either the EqualFilterCriterionResponse or NotEqualFilterCriterionResponse schema based on the comparator value.
$ (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootModule information in GET responses.
Additional keys: not allowed
api_namestringRequired within parentAPI name of the module.
Maximum length: 255
idstringRequired within parentUnique identifier of the module.
Maximum length: 255

Retrieve a specific get record component from a Kiosk — response body — get records item selection details

FieldTypePresenceDescription and constraints
$objectRootSelection details in GET responses. selection_type can be null for single result_type.
Additional keys: not allowed
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeSelection limit.
Format: int32
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rangeJSONRequired within parent
range (anyOf 1)integerAlternativeFetch range.
Format: int32
range (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_typestringRequired within parentResult type: single, multiple, or all.
Maximum length: 255
selection_typeJSONRequired within parent
selection_type (anyOf 1)stringAlternativeSelection behavior type. Null for single record results.
Maximum length: 255
selection_type (anyOf 2)nullAlternativeSelection 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

FieldTypePresenceDescription and constraints
$objectRootSort 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_fieldModelOptionalExpand Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
order_by_namestringRequired within parentSort direction.
Maximum length: 255
$ (allOf 1)JSONAll 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

FieldTypePresenceDescription and constraints
$objectRootOrder by field information in GET responses.
Additional keys: not allowed
api_namestringRequired within parentAPI name of the field.
Maximum length: 255
idstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group.
grouparrayRequired within parentContains an array of filter conditions grouped together and evaluated with the specified logical operator.
Maximum items: 25
Minimum items: 2
group[]JSONEach item
group[] (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
group[] (anyOf 2)ModelAlternativeExpand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or
group_operatorstringRequired within parentRepresents 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the between filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the range filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the range filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valuearrayRequired within parentContains 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[]JSONEach item
value[] (anyOf 1)stringAlternativeRepresents 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the set filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the set filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the set filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valuearrayRequired within parentContains an array of primitive filter values returned for the set comparison.
Maximum items: 500
Minimum items: 1
value[]JSONEach item
value[] (anyOf 1)stringAlternativeRepresents 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the multi-select lookup filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents 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)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valuearrayRequired within parentContains an array of lookup object references returned for the multi-select comparison.
Maximum items: 500
Minimum items: 1
value[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$JSONRootRepresents 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)ModelAll variants applyExpand 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)objectAll variants applyRepresents 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).idJSONRequired within parent
$ (allOf 2).nameJSONRequired within parent

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the ordering filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the ordering filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the ordering filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valueJSONRequired within parentRepresents the scalar filter value returned for the ordering comparator.
value (anyOf 1)stringAlternativeRepresents 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)ModelAlternativeExpand 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeRepresents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double.
$ (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the text filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the text filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the text filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valueJSONRequired within parentRepresents the string filter value returned for the text comparator. Contains a scalar string or an array of string values.
value (anyOf 1)arrayAlternativeContains an array of primitive string values returned for the text filter comparator.
Maximum items: 500
Minimum items: 1
value (anyOf 1)[]JSONEach item
value (anyOf 1)[] (anyOf 1)stringAlternativeRepresents 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)stringAlternativeRepresents 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the equal filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the equal filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valueJSONRequired within parentRepresents 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)arrayAlternativeContains an array of filter values returned for the equal comparator.
Maximum items: 500
Minimum items: 1
value (anyOf 1)[]JSONEach item
value (anyOf 1)[] (anyOf 1)stringAlternativeRepresents 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)ModelAlternativeExpand 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)JSONAlternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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)stringAlternativeRepresents 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)ModelAlternativeExpand 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)booleanAlternativeRepresents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)ModelAlternativeExpand 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)ModelAlternativeExpand 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)stringAlternativeRepresents 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)ModelAlternativeExpand 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)stringAlternativeRepresents 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$stringRootRepresents 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

FieldTypePresenceDescription and constraints
$JSONRootRepresents 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)objectAlternativeRepresents 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).namestringRequired within parentRepresents the predefined placeholder for the currently logged-in user.
Possible values:
${CURRENTUSER} - Represents the currently logged-in user.
Known values: ${CURRENTUSER}
$ (anyOf 2)objectAlternativeRepresents 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).idstringRequired within parentRepresents 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).namestringOptionalRepresents 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the not-equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.
comparatorstringRequired within parentRepresents 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
fieldJSONRequired within parentRepresents the target field definition to which the not-equal filter criterion was applied, conforming to the base field structure.
field (allOf 1)ModelAll variants applyExpand 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)objectAll variants applyRepresents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion response.
Additional keys: allowed
typestringOptionalIndicates 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
valueJSONRequired within parentRepresents 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)arrayAlternativeContains an array of filter values returned for the not_equal comparator.
Maximum items: 500
Minimum items: 1
value (anyOf 1)[]JSONEach item
value (anyOf 1)[] (anyOf 1)stringAlternativeRepresents 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)ModelAlternativeExpand 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)JSONAlternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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)stringAlternativeRepresents 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)ModelAlternativeExpand 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)booleanAlternativeRepresents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)ModelAlternativeExpand 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)ModelAlternativeExpand 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)ModelAlternativeExpand 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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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