foliolib.folio.api.inventoryStorage.InstanceSet

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

Bases: foliolib.folio.FolioApi

Instance Set

Get instances, for each instance get related records

Parameters

• tenant (str) – Tenant id

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

Methods

get_instanceSets(**kwargs)

Get instances, for each instance get related records

get_instanceSets(**kwargs)

Get instances, for each instance get related records

GET /inventory-view/instance-set

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –

A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CQL

Example

• (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

• hrid==”in007”

Returns

See Schema below

Return type

binary

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Instance with holdings, items, preceding titles, succeeding titles, super instances, sub instances",
  "type": "object",
  "properties": {
    "id": {
      "description": "Instance id",
      "$ref": "uuid.json"
    },
    "instance": {
      "description": "Instance record",
      "$ref": "instance.json"
    },
    "holdingsRecords": {
      "type": "array",
      "description": "Holdings records of the instance",
      "items": {
        "$ref": "holdingsrecord.json"
      }
    },
    "items": {
      "type": "array",
      "description": "Items of the instance",
      "items": {
        "$ref": "item.json"
      }
    },
    "precedingTitles": {
      "type": "array",
      "description": "Instances that are preceding titles of the instance",
      "items": {
        "$ref": "instanceprecedingsucceedingtitle.json"
      }
    },
    "succeedingTitles": {
      "type": "array",
      "description": "Instances that are succeeding titles of the instance",
      "items": {
        "$ref": "instanceprecedingsucceedingtitle.json"
      }
    },
    "superInstanceRelationships": {
      "type": "array",
      "description": "Instances that are super instances of the instance",
      "items": {
        "$ref": "instancerelationship.json"
      }
    },
    "subInstanceRelationships": {
      "type": "array",
      "description": "Instances that are sub instances of the instance",
      "items": {
        "$ref": "instancerelationship.json"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}