dRofus icon

dRofus

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

Other Resource → Get Files

AI-generated

Summary

Retrieve files associated with a specified sub-resource in the Other Resource category from dRofus, optionally filtered, paginated, or limited.

Inputs

  • Sub-Resource (required) — Select the dRofus collection in the Other Resource category to target, such as Item Groups, Systems, Sub-Items, etc.
  • System ID — Provide the numeric primary key of the system when retrieving files related to the 'systems' sub-resource.
  • Return All — Decide whether to fetch all available results or limit the output to a specified number.
  • Limit — If not returning all, specify the maximum number of results to return.
  • Filter Mode — Choose how to apply filtering: no filter, build using a structured filter builder with conditions and groups, or provide a raw OData filter string.
  • Filter Builder — When using builder filter mode, define structured conditions and combinators to filter the results.
  • Filter (Raw OData) — When using raw filter mode, input an OData-compliant filter expression to narrow results.
  • Query Parameters — Include additional OData query parameters such as extra JSON parameters, ordering, page size, selection of fields, and row skipping for advanced data retrieval control.

Output shape

a list of file records associated with the selected sub-resource and filtered/paginated according to parameters

Supports pagination and filtering via OData query options. If 'Return All' is true, pagination is handled internally to retrieve all items. Available fields and operators for filtering can be dynamically loaded. The actual shape of the file data depends on the sub-resource selected.

Examples

Example 1: Fetch up to 20 Item Groups files without filtering

Set Sub-Resource to 'Item Groups', Return All to false, Limit to 20.

Example 2: Retrieve all System files for a given System ID applying a specific OData filter

Set Sub-Resource to 'Systems', provide System ID, set Return All to true, and specify a raw OData filter expression.

Links

Discussion