foliolib.folio.api.requestsMediated.Requestsmediated

class foliolib.folio.api.requestsMediated.Requestsmediated(tenant: str)

Bases: foliolib.folio.FolioApi

Request Mediated API

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

get(requestId)

Retrieve secure request object by id

get(requestId)

Retrieve secure request object by id

GET /requests-mediated/secure-requests/{requestId}

Parameters

requestId (str) – (format: uuid)

Returns

See Schema below.

Return type

dict

Raises
  • OkapiRequestError – Bad request

  • OkapiRequestNotFound – Not found

  • OkapiRequestFatalError – Internal server error

Schema

{
    "description": "Secure request",
    "type": "object",
    "properties": {
        "id": {
            "description": "Id of the secure request",
            "$ref": "uuid.yaml"
        }
    }
}