foliolib.folio.api.audit.CirculationLogs

class foliolib.folio.api.audit.CirculationLogs(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-audit API

This documents the API calls that can be made to query circulation audit logs records

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

get_logs(**kwargs)

Retrieve a list of log items.

get_logs(**kwargs)

Retrieve a list of log items.

GET /audit-data/circulation/logs

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• query (str) –

  A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

  with valid searchable fields, for example userBarcode

  Example

  • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

  • userBarcode=1000024158

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of circulation audit log records",
  "properties": {
    "logRecords": {
      "type": "array",
      "description": "Circulation audit log records",
      "items": {
        "type": "object",
        "$ref": "logRecord.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "logRecords",
    "totalRecords"
  ]
}