FOLIO · Schema

storageConfigurations

CompanyLibraryLibrary Services PlatformOpen SourceMicroservicesEducation

Properties

Name Type Description
totalRecords integer total records value
configurations array
View JSON Schema on GitHub

JSON Schema

folio-storage-configurations-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/folio/json-schema/folio-storage-configurations-schema.json",
  "title": "storageConfigurations",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-configurations-api-openapi.yml#/components/schemas/storageConfigurations",
  "allOf": [
    {
      "$ref": "#/$defs/baseCollection"
    },
    {
      "type": "object",
      "properties": {
        "configurations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/storageConfiguration"
          }
        }
      },
      "required": [
        "configurations"
      ]
    }
  ],
  "$defs": {
    "accessionWorkflowDetails": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Accession workflow details",
      "type": "string",
      "enum": [
        "Duplicate holdings",
        "Change permanent location"
      ]
    },
    "baseCollection": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Basic object to create pageable responses",
      "type": "object",
      "properties": {
        "totalRecords": {
          "description": "total records value",
          "type": "integer"
        }
      }
    },
    "metadata": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "type": "object",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "$ref": "#/$defs/uuid"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "$ref": "#/$defs/uuid"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "returningWorkflowDetails": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Return workflow details",
      "type": "string",
      "enum": [
        "Scanned to folio",
        "Scanned to CaiaSoft"
      ]
    },
    "storageConfiguration": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Remote storage configuration",
      "type": "object",
      "properties": {
        "id": {
          "description": "configuration id",
          "$ref": "#/$defs/uuid"
        },
        "name": {
          "description": "configuration name",
          "type": "string"
        },
        "apiKey": {
          "description": "remote storage apiKey",
          "type": "string"
        },
        "providerName": {
          "description": "remote storage provider name",
          "type": "string"
        },
        "url": {
          "description": "remote storage url",
          "type": "string"
        },
        "statusUrl": {
          "description": "remote storage url",
          "type": "string"
        },
        "accessionDelay": {
          "description": "accession schedule delay",
          "type": "integer",
          "minimum": 1
        },
        "accessionTimeUnit": {
          "description": "accession schedule time unit",
          "type": "object",
          "$ref": "#/$defs/timeUnits"
        },
        "accessionWorkflowDetails": {
          "description": "accession workflow details",
          "type": "object",
          "$ref": "#/$defs/accessionWorkflowDetails"
        },
        "returningWorkflowDetails": {
          "description": "return workflow details",
          "type": "object",
          "$ref": "#/$defs/returningWorkflowDetails"
        },
        "metadata": {
          "description": "Entity metadata",
          "type": "object",
          "$ref": "#/$defs/metadata"
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "providerName"
      ]
    },
    "timeUnits": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Time units",
      "type": "string",
      "enum": [
        "minutes",
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "uuid": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Regexp pattern for UUID validation",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/folio-storage-configurations"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.