StreamBIMInstall

Summary

Retrieve multiple document records from a specified StreamBIM project, optionally filtered and sorted, with control over the number of results returned.

Inputs

• Project Name or ID (required) — Select the StreamBIM project to query documents from, either by choosing from the list loaded via the credential's region or by specifying a project ID using an expression.
• Filters — Optional filter criteria including file extensions, folder, freetext search, IFC file building assignment, inclusion of deleted documents, document labels, presence or absence of IFC files linked to a building, and sorting order.
• Return All — Decide whether to return all matching documents or limit the number of results.
• Limit — Specify the maximum number of documents to retrieve if not returning all; valid values are 1 to 1000.

Output shape

a list of document objects matching the query criteria

The operation supports pagination and returns up to the specified limit unless 'Return All' is enabled. The documents returned adhere to the structure defined by the StreamBIM API for document resources, including metadata and relationships. Filtering applies server-side, and unsupported or malformed filters may yield no results or errors.

Examples

Example 1: Retrieve the first 50 PDF and IFC documents in project 'ExampleProject' folder 'DesignDocs', sorted by filename ascending.

Set Project Name or ID to 'ExampleProject'; set Filters/fileExtensions to 'pdf,ifc'; set Filters/folderId to 'DesignDocs'; set Filters/sort to 'filename'; set Return All to false; set Limit to 50.

Links

• n8n community nodes installation guide