foliolib.folio.api.ermUsageHarvester.Periodic

class foliolib.folio.api.ermUsageHarvester.Periodic(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-erm-usage-harvester periodic API

This documents the API calls that can be made to mod-erm-usage-harvester periodic API

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`get_periodics`()	`GET /erm-usage-harvester/periodic`
`set_periodic`(periodic)	`POST /erm-usage-harvester/periodic`

get_periodics()

GET /erm-usage-harvester/periodic

Returns: See Schema below
Return type: dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PeriodicConfig Schema",
  "description": "Settings for periodic harvesting",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "startAt": {
      "description": "the date periodic harvesting should run for the first time",
      "type": "string",
      "format": "date-time"
    },
    "lastTriggeredAt": {
      "description": "the date periodic harvesting was last triggered at",
      "type": "string",
      "format": "date-time"
    },
    "periodicInterval": {
      "description": "period between harvesting attempts",
      "type": "string",
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ]
    }
  },
  "required": [
    "startAt",
    "periodicInterval"
  ],
  "additionalProperties": true
}

set_periodic(periodic: dict)

POST /erm-usage-harvester/periodic

Parameters: periodic (dict) – See Schema below

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PeriodicConfig Schema",
  "description": "Settings for periodic harvesting",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "startAt": {
      "description": "the date periodic harvesting should run for the first time",
      "type": "string",
      "format": "date-time"
    },
    "lastTriggeredAt": {
      "description": "the date periodic harvesting was last triggered at",
      "type": "string",
      "format": "date-time"
    },
    "periodicInterval": {
      "description": "period between harvesting attempts",
      "type": "string",
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ]
    }
  },
  "required": [
    "startAt",
    "periodicInterval"
  ],
  "additionalProperties": true
}