foliolib.folio.api.organizationsStorage.Category

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

Bases: foliolib.folio.FolioApi

Categories

CRUD APIs used to manage cateogries.

Parameters

• tenant (str) – Tenant id

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

Methods

delete_category(categoriesId)	Delete category item with given {categoryId}
get_categories(**kwargs)	Get list of categories
get_category(categoriesId)	Retrieve category item with given {categoryId}
modify_category(categoriesId, category)	Update category item with given {categoryId}
set_category(category)	Create a new category item.

delete_category(categoriesId: str)

Delete category item with given {categoryId}

DELETE /organizations-storage/categories/{categoriesId}

Parameters

categoriesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_categories(**kwargs)

Get list of categories

GET /organizations-storage/categories

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: for example code

  Example

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

  • [“code”, “MEDGRANT”, “=”]

• 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

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of category records",
  "type": "object",
  "properties": {
    "categories": {
      "description": "The list of categories in this collection",
      "type": "array",
      "id": "categories",
      "items": {
        "type": "object",
        "$ref": "category.json"
      }
    },
    "totalRecords": {
      "description": "The number of category objects returned in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "categories",
    "totalRecords"
  ]
}

get_category(categoriesId: str)

Retrieve category item with given {categoryId}

GET /organizations-storage/categories/{categoriesId}

Parameters

categoriesId (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": "An organization category",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this category",
      "$ref": "../../common/schemas/uuid.json"
    },
    "value": {
      "description": "The value of this category",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

modify_category(categoriesId: str, category: dict)

Update category item with given {categoryId}

PUT /organizations-storage/categories/{categoriesId}

Parameters

• categoriesId (str) –

• category (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": "An organization category",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this category",
      "$ref": "../../common/schemas/uuid.json"
    },
    "value": {
      "description": "The value of this category",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

set_category(category: dict)

Create a new category item.

POST /organizations-storage/categories

Parameters

category (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Headers

• Location - URI to the created category item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An organization category",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this category",
      "$ref": "../../common/schemas/uuid.json"
    },
    "value": {
      "description": "The value of this category",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}