foliolib.folio.api.inventoryStorage.InstanceRelationshipType

class foliolib.folio.api.inventoryStorage.InstanceRelationshipType(tenant: str)

Bases: foliolib.folio.FolioApi

Instance Relationship Types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_instanceRelationshipType(...)

Delete instanceRelationshipType item with given {instanceRelationshipTypeId}

get_instanceRelationshipType(relationshipTypeId)

Retrieve instanceRelationshipType item with given {instanceRelationshipTypeId}

get_instanceRelationshipTypes(**kwargs)

Return a list of relationship types

modify_instanceRelationshipType(...)

Update instanceRelationshipType item with given {instanceRelationshipTypeId}

set_instanceRelationshipType(...)

Create a new relationship type
delete_instanceRelationshipType(relationshipTypeId: str)

Delete instanceRelationshipType item with given {instanceRelationshipTypeId}

DELETE /instance-relationship-types/{relationshipTypeId}

Parameters

relationshipTypeId (str) –

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiRequestFatalError – Server Error

get_instanceRelationshipType(relationshipTypeId: str)

Retrieve instanceRelationshipType item with given {instanceRelationshipTypeId}

GET /instance-relationship-types/{relationshipTypeId}

Parameters

relationshipTypeId (str) –

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A qualifier indicating the type of relationship between two Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the relationship type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ]
}
get_instanceRelationshipTypes(**kwargs)

Return a list of relationship types

GET /instance-relationship-types

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

  • totalRecords (str) –

    (default=auto) How to calculate the totalRecords property. “exact” for the correct number, “estimated” for an estimation, “auto” to automatically select “exact” or “estimated”, “none” for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example

    • none

  • 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

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of InstanceRelationshipType records (controlled vocabulary)",
  "type": "object",
  "properties": {
    "instanceRelationshipTypes": {
      "description": "List of instance relationship types",
      "id": "instanceRelationshipType",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "instancerelationshiptype.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "instanceRelationshipTypes",
    "totalRecords"
  ]
}
modify_instanceRelationshipType(relationshipTypeId: str, instanceRelationshipType: dict)

Update instanceRelationshipType item with given {instanceRelationshipTypeId}

PUT /instance-relationship-types/{relationshipTypeId}

Parameters

  • relationshipTypeId (str) –

  • instanceRelationshipType (dict) – See Schema below

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiRequestConflict – Conflict

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A qualifier indicating the type of relationship between two Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the relationship type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ]
}
set_instanceRelationshipType(instanceRelationshipType: dict)

Create a new relationship type

POST /instance-relationship-types

Parameters

instanceRelationshipType (dict) – See Schema below

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnauthorized – Authentication is required

  • OkapiRequestFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

  • Location - URI to the created instanceRelationshipType item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A qualifier indicating the type of relationship between two Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the relationship type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ]
}