ContentsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-contents-request-schema.json",
  "title": "ContentsRequest",
  "description": "Request for a set of contents",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-folio-query-tool-metadata-querytool-openapi.yml#/components/schemas/ContentsRequest",
  "type": "object",
  "properties": {
    "entityTypeId": {
      "$ref": "#/$defs/UUID"
    },
    "fields": {
      "description": "Fields to be included in results",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "ids": {
      "description": "Ids to retrieve results for",
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "localize": {
      "description": "Whether to localize dates in content response",
      "type": "boolean",
      "default": false
    },
    "userId": {
      "$ref": "#/$defs/UUID"
    }
  },
  "required": [
    "entityTypeId",
    "fields",
    "ids"
  ],
  "additionalProperties": false,
  "$defs": {
    "UUID": {
      "description": "The content row represented as a map.",
      "type": "string",
      "format": "uuid"
    }
  }
}