dRofus icon

dRofus

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

Occurrence → Get Occurrence Logs

AI-generated

Summary

Retrieve the log entries associated with a specific Occurrence from the dRofus system, allowing optional filtering and pagination of the returned results.

Inputs

  • Occurrence ID (required) — Numeric primary key of the occurrence (occurrences.{ID} in the dRofus API) for which to fetch logs.
  • Return All — Boolean flag to return all log entries without limiting the number of results.
  • Limit — Maximum number of log entries to return if 'Return All' is false.
  • Filter Mode — Method to construct the OData $filter query parameter: 'None' for no filter, 'Builder' to build complex typed filters, or 'Raw' to enter a manual OData filter expression.
  • Filter Builder — Used when 'Filter Mode' is 'Builder': construct typed filter expressions by combining conditions and groups on occurrence fields with operators.
  • Filter (Raw OData) — Used when 'Filter Mode' is 'Raw': provide a raw OData $filter string expression to filter the logs.
  • Query Parameters — Additional OData and dRofus-specific query parameters such as $orderby (sort), $top (page size), $select (fields to return), $skip (rows to skip), and extra JSON parameters for advanced control.

Output shape

a list of occurrence log entries as JSON objects

Supports pagination controlled via 'Return All' and 'Limit' parameters; filtering is optional and configurable via filter mode settings; the output includes fields as specified by optional $select parameter or defaults to all fields.

Examples

Example 1: Retrieve the first 50 log entries for occurrence ID 123 with no filtering.

Set Occurrence ID to 123, Return All to false, Limit to 50, Filter Mode to None.

Example 2: Retrieve all log entries for occurrence ID 456 filtered to entries containing a specific keyword in a text field.

Set Occurrence ID to 456, Return All to true, Filter Mode to Builder or Raw, and specify appropriate filters on the desired fields.

Links

Discussion