dRofus icon

dRofus

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

Actions69

Occurrence → Get Systems

AI-generated

Summary

Retrieve systems associated with a specific occurrence by its numeric ID, optionally including subsystem memberships, with support for filtering, pagination, and custom query parameters.

Inputs

  • Occurrence ID (required) — Numeric primary key of the occurrence to fetch systems for (occurrences.{ID}).
  • Include Subsystems — Boolean flag to include subsystems memberships within the returned systems data.
  • Return All — Boolean flag to return all matching systems or limit the number of results.
  • Limit — Maximum number of systems to return when not returning all.
  • Filter Mode — Method to define OData filter for the systems list: none, builder (typed conditions), or raw OData expression.
  • Filter Builder — Condition groups and fields to construct a typed OData $filter expression when using builder mode.
  • Filter (Raw OData) — Raw OData $filter query string to filter the returned systems.
  • Query Parameters — Additional OData and non-OData query parameters including order, paging (top, skip), select fields, and extra JSON parameters like includeSubs.

Output shape

a list of system objects associated with the specified occurrence, optionally including subsystem memberships.

If 'Return All' is enabled, pagination occurs automatically following RFC 5988 Link headers; otherwise limited by 'Limit'. Filtering is applied according to selected filter mode and parameters. The 'Include Subsystems' input sets the non-OData 'includeSubs' query flag to true or false to include nested subsystem data in the response.

Links

Discussion