dRofus icon

dRofus

dRofus API: rooms, items, occurrences, room groups, room templates, systems, and RDL PDF reporting

Other Resource → Get Components

AI-generated

Summary

Retrieve collections of various component-related entities from the dRofus database by specifying a sub-resource type, optionally filtering results and limiting the output.

Inputs

  • Sub-Resource (required) — Choose the specific component collection to retrieve, such as Item Groups, Systems, or Sub-Items.
  • System ID — Numeric primary key to specify a system when retrieving system-related sub-resources. Required only when 'Systems' sub-resource is selected.
  • Return All — Decide whether to fetch all matching results or limit the number returned.
  • Limit — Maximum number of results to return when 'Return All' is false.
  • Filter Mode — Select how to construct the OData $filter parameter: none, builder (structured filter), or raw OData expression.
  • Filter Builder — Configure structured filter conditions and sub-groups when 'Filter Mode' is 'builder'.
  • Filter (Raw OData) — Enter a raw OData $filter expression string when 'Filter Mode' is 'raw'.
  • Query Parameters — Additional query parameters such as $orderby, $top (page size), $select (fields), $skip, or custom non-OData parameters as JSON.

Output shape

a list of records representing the requested component collection from dRofus

Supports pagination and filtering using OData query options. When 'Return All' is set, pagination is handled automatically by following RFC 5988 Link headers. Filter inputs affect which records are returned; limit and returnAll control the volume of data fetched. The specific fields returned can be controlled with the 'select' query parameter.

Examples

Example 1: Get all Item Groups with filtering by name containing 'Office'

Set Sub-Resource to 'Item Groups', Filter Mode to 'raw', and Filter to "contains(name,'Office')", with 'Return All' enabled.

Links

Discussion