Acoustic Connect icon

Acoustic Connect

Interact with Acoustic Connect GraphQL API

Reference Set → Get Reference Set Records

AI-generated

Summary

Retrieve records from a reference set, optionally filtered, sorted, and limited.

Inputs

  • dataSetId (required) — The ID of the reference set data set to query.
  • returnAll — If true, return all matching records regardless of limit; otherwise respects the limit.
  • limit — Maximum number of records to return when returnAll is false; must be at least 1.
  • options — Collection of filter, sort, and select settings.

Output shape

An array of reference set records; may include additional metadata depending on response.

If returnAll is false, only up to limit records are returned. The exact shape may include pagination fields not documented here.

Examples

Example 1: Fetch all records from reference set ID 'REF123'.

dataSetId='REF123', returnAll=true

Example 2: Get up to 20 filtered records with a filter on field 'status' equals 'active'.

dataSetId='REF123', filters={[ {field:'status', operation:'eq', value:'active'} ], limit=20}

Example 3: Select specific attributes 'name' and 'description' from a reference set.

dataSetId='REF123', selectByName='name,description'

Links

Discussion