dRofus icon

dRofus

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

Occurrence → Get Images

AI-generated

Summary

Retrieve images associated with a specific occurrence in dRofus.

Inputs

  • Occurrence ID (required) — The numeric primary key of the occurrence to retrieve images for (corresponds to occurrences.{ID} in the dRofus API).
  • Return All — Whether to retrieve all images or limit the number of results.
  • Limit — Maximum number of image results to return if 'Return All' is false.
  • Filter Mode — Specifies how to construct the OData $filter parameter: 'none' (no filter), 'builder' (use UI filter builder), or 'raw' (enter OData filter expression).
  • Filter Builder — Structured filter conditions to apply when 'Filter Mode' is 'builder', allowing construction of typed filter expressions with combinators and nested groups.
  • Filter (Raw OData) — Raw OData $filter expression string to filter results when 'Filter Mode' is 'raw'.
  • Query Parameters — Additional OData or custom query parameters including ordering, paging (skip, top), select fields, and extra JSON parameters.

Output shape

a list of image objects related to the specified occurrence

Supports pagination and filtering using OData $filter and related query parameters. If 'Return All' is true, all images matching the filters are returned via automatic pagination. Otherwise, the number of images is limited by 'Limit'. Output format conforms to the dRofus API's images endpoint for occurrences.

Examples

Example 1: Retrieve all images linked to occurrence ID 123

Set Occurrence ID to 123, enable 'Return All', leave filters unset.

Example 2: Retrieve up to 10 images for occurrence ID 50 with a filter

Set Occurrence ID to 50, 'Return All' to false, 'Limit' to 10, 'Filter Mode' to 'raw' with OData expression filtering image metadata.

Links

Discussion