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": {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
        }
    }
}