foliolib.folio.api.ermUsage.Files

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

Bases: foliolib.folio.FolioApi

mod-erm-usage API

This documents the API calls that can be made to query and manage files in module erm-usage

Parameters
  • tenant (str) – Tenant id

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

Methods

delete_file(filesId)

Delete a file identified by id

get_file(filesId)

Get file by id

upload_file(filePath)

Upload/update a file in module erm-usage.

delete_file(filesId: str)

Delete a file identified by id

DELETE /erm-usage/files/{filesId}

Parameters

filesId (str) –

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

get_file(filesId: str)

Get file by id

GET /erm-usage/files/{filesId}

Parameters

filesId (str) –

Raises
  • OkapiRequestNotFound – Not Found

  • OkapiFatalError – Server Error

upload_file(filePath: str)

Upload/update a file in module erm-usage.

POST /erm-usage/files

Raises
  • OkapiRequestNotFound – Not Found

  • OkapiFatalError – Server Error