foliolib.folio.api.inventory.InventoryConfig

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

Bases: foliolib.folio.FolioApi

Inventory configuration API

API for interacting with configuration for Instances, Items, Holdings

Parameters

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

Methods

`get_blockedFields_holdings`()	Provides configuration with blocked fields of holdings
`get_blockedFields_instances`()	Provides configuration with blocked fields of instance

get_blockedFields_holdings()

Provides configuration with blocked fields of holdings

GET /inventory/config/holdings/blocked-fields

Returns: See Schema below
Return type: dict
Raises: OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Blocked fields of instance",
  "type": "object",
  "properties": {
    "blockedFields": {
      "description": "Array of blocked fields",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "blockedFields"
  ]
}

get_blockedFields_instances()

Provides configuration with blocked fields of instance

GET /inventory/config/instances/blocked-fields

Returns: See Schema below
Return type: dict
Raises: OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Blocked fields of instance",
  "type": "object",
  "properties": {
    "blockedFields": {
      "description": "Array of blocked fields",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "blockedFields"
  ]
}