foliolib.folio.api.folioSpringBase.Tenant

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

Bases: foliolib.folio.FolioApi

Tenant API

Parameters

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

Methods

`deletetenant`(operationId)	drop tenant id
`gettenant`(operationId)	Does tenant id already exist
`posttenant`(tenantAttributes)	Create tenant job (create, upgrade, delete)

deletetenant(operationId)

drop tenant id

DELETE /_/tenant/{operationId}

Raises

OkapiRequestError – Bad request
OkapiFatalError – Internal server error

gettenant(operationId)

Does tenant id already exist

GET /_/tenant/{operationId}

Raises: OkapiFatalError – Internal server error

posttenant(tenantAttributes)

Create tenant job (create, upgrade, delete)

POST /_/tenant

Parameters

tenantAttributes (dict) – See Schema below.

Raises

OkapiRequestError – Bad request
OkapiRequestUnprocessableEntity – Validation errors
OkapiFatalError – Internal server error

Schema

{
    "title": "Tenant job attributes",
    "description": "Configuration how to install, upgrade or delete a module for a tenant",
    "type": "object",
    "properties": {
        "module_from": {
            "description": "Existing module ID. If omitted, the module is not enabled already",
            "type": "string"
        },
        "module_to": {
            "description": "Target module ID. If omitted, the existing module is disabled.",
            "type": "string"
        },
        "purge": {
            "description": "On disable should data also be purged",
            "type": "boolean"
        },
        "parameters": {
            "description": "Parameters that controls what tenant init (eg reference data)",
            "$ref": "parameters.json"
        }
    },
    "additionalProperties": false
}