Query API Supports Single-row Result Layout Queries

Kristen Jackson
Kristen Jackson Blackbaud Employee
Fifth Anniversary Name Dropper Facilitator 1 Kudos 1
edited July 14 in SKY Developer Announcements
Getty 1390242644.jpg

The Query API now supports single-row result layout queries, which are web view's equivalent to database view Export. Single-row queries return exactly one row per base record with related data flattened into columns.

Added

  • Single-row result layout (SingleRow) for queries
    • Returns one row per base record
    • Flattens related data into columns (similar to Export in database view)
  • child_selects structure for defining output fields in single-row queries
  • node_type metadata to identify relationships in the fields tree

Updated

  • Query endpoints now support the result_layout property
  • GET /v2/queries introduced to return both multi-row and single-row queries
  • Metadata endpoints now support filtering fields by result layout

Changed behavior

  • Result layout is set at creation and cannot be changed
  • Single-row queries are web view only and do not connect to database view

Limitations (Preview)

  • Not all fields and filters are supported yet
  • Not available for favorites
  • Feature is subject to change before general availability

To review the Single-Row Result Layout Feature documentation, see Query resources.

Categories