StreamBIM icon

StreamBIM

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

IFC Search → Export JSON

AI-generated

Summary

Export IFC Search results as JSON data from a specified StreamBIM project using a search ID, with options to customize included fields, sorting, pagination, and query parameters.

Inputs

  • Project Name or ID — Select the StreamBIM project from your account using the credential region or specify its ID via expression.
  • Search ID (required) — The identifier of the IFC Search result to export, obtained from a prior Create operation.
  • Field Names — List of IFC field names to include in the export; these are combined with a pipe separator and base64-encoded at runtime. Defaults to ["GUID","Name","IFC Type"].
  • Field Union — Boolean flag indicating whether to return the union of fields across all result rows.
  • Job Fields — Boolean flag to include job-specific fields in the export data.
  • Field Limit — Maximum number of fields to return, where 0 means no limit.
  • Sort Descending — Whether to sort the exported results in descending order.
  • Return All — Determines if all result pages are returned or only up to the specified limit.
  • Limit — Number of rows per API page when Return All is true, or maximum rows for a single request if false.
  • Advanced — Use Raw JSON Query — Flag to override standard field options and provide additional query parameters as a raw JSON object.
  • Additional Query Parameters (Raw JSON) — A JSON object with extra query parameters merged into the export request; note that pagination keys (page[limit], page[skip]) are ignored in favor of Return All and Limit settings.

Output shape

a single JSON object containing IFC Search result data exported according to the specified options and pagination; the export conforms to StreamBIM API's JSON format for IFC Search exports.

If 'Return All' is true, this operation paginates through all available results; otherwise, it returns a limited subset. When 'Use Raw JSON Query' is enabled, standard field-related options are ignored and replaced by the raw JSON parameters provided.

Examples

Example 1: Export all IFC Search results from a project with specific fields

Specify the Project, provide a Search ID, and set Field Names to include 'GUID', 'Name', and 'IFC Type'; keep Return All true to retrieve all matching rows.

Example 2: Export a limited set of IFC Search results with descending sort

Set Return All to false, specify a Limit (e.g., 100), enable Sort Descending, and set other fields as needed.

Links

Discussion