foliolib.folio.api.fqmManager.Fqmmanager

class foliolib.folio.api.fqmManager.Fqmmanager(tenant: str)

Bases: foliolib.folio.FolioApi

mod-fqm-manager API

Base class of the Folio API

Parameters: tenant (str) – Tenant id

Methods

`deleteoldqueries`()	Deletes all queries that are older than the configured duration.
`getentitytypesummary`(**kwargs)	Get names for a list of entity type ids.
`refreshmaterializedviews`()	Refresh all materialized views for a tenant.

deleteoldqueries()

Deletes all queries that are older than the configured duration.

POST /fqm/query/purge

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException

Schema

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "IDs of deleted queries",
    "description": "IDs of deleted queries",
    "type": "object",
    "properties": {
        "deletedQueryIds": {
            "description": "Ids of the deleted queries",
            "type": "array",
            "items": {
                "type": "string",
                "format": "UUID"
            }
        }
    },
    "required": [
        "deletedQueryIds"
    ]
}

getentitytypesummary(**kwargs)

Get names for a list of entity type ids.

GET /fqm/entity-types

Keyword Arguments

ids (list) – List of entity type ids (items: (type: string, format: UUID))

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException

Schema

{
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Entity Type Summary DTO",
        "type": "object",
        "properties": {
            "id": {
                "description": "Entity type id",
                "type": "string",
                "format": "UUID"
            },
            "label": {
                "description": "Entity type label",
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "id",
            "label"
        ]
    }
}

refreshmaterializedviews()

Refresh all materialized views for a tenant.

POST /fqm/entity-types/materialized-views/refresh

Raises

OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException