foliolib.folio.api.inventoryStorage.InstanceFormat

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

Bases: foliolib.folio.FolioApi

Instance Formats API

This documents the API calls that can be made to query and manage instance formats

Parameters

• tenant (str) – Tenant id

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

Methods

delete_instanceFormat(instanceFormatId)	Delete instanceFormat item with given {instanceFormatId}
get_instanceFormat(instanceFormatId)	Retrieve instanceFormat item with given {instanceFormatId}
get_instanceFormats(**kwargs)	Return a list of instance formats
modify_instanceFormat(instanceFormatId, ...)	Update instanceFormat item with given {instanceFormatId}
set_instanceFormat(instanceFormat)	Create a new instance format

delete_instanceFormat(instanceFormatId: str)

Delete instanceFormat item with given {instanceFormatId}

DELETE /instance-formats/{instanceFormatId}

Parameters

instanceFormatId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_instanceFormat(instanceFormatId: str)

Retrieve instanceFormat item with given {instanceFormatId}

GET /instance-formats/{instanceFormatId}

Parameters

instanceFormatId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "The format of an Instance",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the Instance format",
      "type": "string"
    },
    "code": {
      "description": "distinct code for the Instance format",
      "type": "string"
    },
    "source": {
      "description": "origin of the Instance format record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "code",
    "source"
  ]
}

get_instanceFormats(**kwargs)

Return a list of instance formats

GET /instance-formats

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.

  with valid searchable fields

  Example

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

  • name=aaa

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of Instance format records (controlled vocabulary)",
  "type": "object",
  "properties": {
    "instanceFormats": {
      "description": "List of instance formats",
      "id": "instanceFormat",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "instanceformat.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "instanceFormats",
    "totalRecords"
  ]
}

modify_instanceFormat(instanceFormatId: str, instanceFormat: dict)

Update instanceFormat item with given {instanceFormatId}

PUT /instance-formats/{instanceFormatId}

Parameters

• instanceFormatId (str) –

• instanceFormat (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "The format of an Instance",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the Instance format",
      "type": "string"
    },
    "code": {
      "description": "distinct code for the Instance format",
      "type": "string"
    },
    "source": {
      "description": "origin of the Instance format record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "code",
    "source"
  ]
}

set_instanceFormat(instanceFormat: dict)

Create a new instance format

POST /instance-formats

Parameters

instanceFormat (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created instanceFormat item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "The format of an Instance",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the Instance format",
      "type": "string"
    },
    "code": {
      "description": "distinct code for the Instance format",
      "type": "string"
    },
    "source": {
      "description": "origin of the Instance format record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "code",
    "source"
  ]
}