foliolib.folio.api.organizationsStorage.Setting

class foliolib.folio.api.organizationsStorage.Setting(tenant: str)

Bases: foliolib.folio.FolioApi

Settings

CRUD APIs used to manage settings.

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

get_setting(settingsId)	Retrieve setting item with given {settingId}
get_settings(**kwargs)	Get a list of settings
modify_setting(settingsId)	PUT /organizations-storage/settings/{settingsId}

get_setting(settingsId: str)

Retrieve setting item with given {settingId}

GET /organizations-storage/settings/{settingsId}

Parameters

settingsId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A setting for organization",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this setting",
      "$ref": "../../common/schemas/uuid.json"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "key": {
      "description": "The key of this setting",
      "type": "string"
    },
    "value": {
      "description": "The value of this setting",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "key",
    "value"
  ]
}

get_settings(**kwargs)

Get a list of settings

GET /organizations-storage/settings

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.

  CQL query

  Example

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

  • key=BANKING_INFORMATION_ENABLED

• 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

• OkapiRequestNotFound – Not Found

• OkapiRequestFatalError – Server Error

Schema

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

modify_setting(settingsId: str)

PUT /organizations-storage/settings/{settingsId}

Parameters

settingsId (str) –