StreamBIM icon

StreamBIM

StreamBIM API: projects, IFC files, IFC search, converter jobs, sync, users, workflows, topics, checklists, attachments, documents

Checklist → Export JSON

AI-generated

Summary

Export checklist data from a specified StreamBIM project in JSON format, allowing grouping by IFC object or checklist and supporting filtering, sorting, pagination, time zone adjustment, and optional use of a raw base64-encoded query object.

Inputs

  • Project Name or ID (required) — Select the StreamBIM project from which to export checklist data, either from the dropdown loaded via credentials or by specifying an ID via expression.
  • Advanced — Use Raw Query Object JSON — Set to true to bypass the standard export form fields and provide a raw base64-encoded JSON query object for fine-tuned control of the export parameters.
  • Key — Choose the grouping key for the export: 'object' to group checklist data by IFC object, or 'checklist' to list checklists.
  • Filter Checklist Name or ID (required) — Specify which checklist to export by selecting from the list or providing its ID; required when grouping by 'object'.
  • Snapshot — Optionally specify a snapshot identifier to export data from a prior saved state; omit to use the latest data.
  • Sort Field — Field attribute to sort the exported checklist rows, defaulting to 'title'.
  • Sort Descending — Set to true to sort the export rows in descending order.
  • Time Zone — IANA time zone string that defines how to render dates in the export, defaulting to 'Europe/Stockholm'.
  • Format — Output format of the export, with only 'json' supported.
  • Filename — Optional filename suggestion sent with the export response.
  • Page Skip — Integer offset to skip rows for pagination.
  • Page Limit — Maximum number of rows to include in the export, defaulting to 10000.
  • Export Query Object (Raw JSON) — When using raw query mode, provide a base64-encoded JSON object defining the export query parameters per StreamBIM export API schema.

Output shape

a single JSON-encoded export result representing checklist data, optionally grouped and filtered as specified.

The export returns JSON data matching the requested filters and grouping. Pagination parameters control size and offset. Only JSON format is supported. When using the raw query object, all export parameters must be defined within it, bypassing other form fields.

Examples

Example 1: Export checklist data grouped by IFC object

Select project ID, choose grouping key 'object', select checklist to filter, set sorting and pagination as needed, then run the node to get JSON export.

Example 2: Export using raw base64-encoded query object

Enable raw query mode and supply a base64-encoded JSON export query object specifying all desired filters, grouping, sorting, pagination, and format; then run node for customized export.

Links

Discussion