list-data-records Function Type

The list-data-records function type returns a list of all data records in a collection, page by page.

Usage

This function type is used in Actions to provide access to data collection list functionality.

Configuration Example

name: List Tasks
key: list-tasks
type: list-data-records
config:
  dataSource:
    collectionKey: tasks
  fieldMapping:
    importValue:
      title:
        $var: $.summary
      createdAt:
        $var: $.created
  # Optional: filtering and pagination
  filter:
    status: open
  unifiedFilter:
    assigneeId:
      $var: $.input.userId
  cursor:
    $var: $.input.cursor

Configuration Parameters

dataSource - Data source configuration
- collectionKey - Identifier of the data collection to operate on
- collectionParameters - Parameters passed to the collection methods
- udm - (for universal integrations only) Universal Data Model to read
fieldMapping - Field mapping configuration
- importValue - Maps fields from external app to your app format
filter - Filter criteria (values for specific fields that should be matched to return a record)
unifiedFilter - Unified query fields for filtering
cursor - Pagination cursor for next page

Output Schema

type: object
properties:
  cursor:
    type: string
  records:
    type: array
    items:
      type: object # Based on field mapping configuration