FOLIO · Schema

Capability Set Object Schema

Object containing details of a capability set

CompanyLibraryLibrary Services PlatformOpen SourceMicroservicesEducation

Properties

Name Type Description
id string A unique identifier for this capability
name string a human-readable name/label for this capability. Takes the form of {resourceName}.{scope}, e.g. item.create
description string Free form description of the capability
resource string The resource this capability is associated with, e.g. item
action object The action this capability is associated with, e.g. create
applicationId string The id of the application which defines the capability
moduleId string The id of the module which defines the capability
type object The type of capability
permission string Folio permission name
capabilities array List with assigned capability ids
metadata object
visible boolean Is visible in UI
View JSON Schema on GitHub

JSON Schema

folio-capability-set-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$id": "https://artifacts.apis.io/folio/json-schema/folio-capability-set-schema.json",
  "title": "Capability Set Object Schema",
  "description": "Object containing details of a capability set",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-capability-set-api-openapi.yml#/components/schemas/capabilitySet",
  "type": "object",
  "properties": {
    "id": {
      "description": "A unique identifier for this capability",
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "description": "a human-readable name/label for this capability.  Takes the form of {resourceName}.{scope}, e.g. item.create",
      "type": "string",
      "readOnly": true
    },
    "description": {
      "description": "Free form description of the capability",
      "type": "string"
    },
    "resource": {
      "description": "The resource this capability is associated with, e.g. item",
      "type": "string",
      "pattern": "^[A-Za-z\\s]+$"
    },
    "action": {
      "description": "The action this capability is associated with, e.g. create",
      "$ref": "#/$defs/capabilityAction"
    },
    "applicationId": {
      "description": "The id of the application which defines the capability",
      "type": "string"
    },
    "moduleId": {
      "description": "The id of the module which defines the capability",
      "type": "string"
    },
    "type": {
      "description": "The type of capability",
      "$ref": "#/$defs/capabilityType"
    },
    "permission": {
      "description": "Folio permission name",
      "type": "string"
    },
    "capabilities": {
      "description": "List with assigned capability ids",
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "description": "Capability identifier",
        "format": "uuid"
      }
    },
    "metadata": {
      "$ref": "#/$defs/metadata",
      "readOnly": true
    },
    "visible": {
      "description": "Is visible in UI",
      "type": "boolean"
    }
  },
  "required": [
    "resource",
    "action",
    "permissions",
    "type",
    "applicationId"
  ],
  "$defs": {
    "capabilityAction": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "The action this capability is associated with, e.g. create",
      "type": "string",
      "enum": [
        "view",
        "create",
        "edit",
        "delete",
        "manage",
        "execute"
      ]
    },
    "capabilityType": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "The type of capability",
      "type": "string",
      "enum": [
        "settings",
        "data",
        "procedural"
      ]
    },
    "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)",
          "type": "string",
          "format": "uuid"
        },
        "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)",
          "type": "string",
          "format": "uuid"
        }
      },
      "additionalProperties": false
    }
  }
}

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-capability-set"
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.