reportTitles

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-report-titles-schema.json",
  "title": "reportTitles",
  "description": "report titles (for both request and response)",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-eusage-reports-eusage-reports-1-0-openapi.yml#/components/schemas/reportTitles",
  "type": "object",
  "properties": {
    "titles": {
      "description": "List of titles",
      "type": "array",
      "items": {
        "$ref": "#/$defs/reportTitle"
      }
    },
    "resultInfo": {
      "$ref": "#/$defs/resultInfo"
    }
  },
  "additionalProperties": false,
  "required": [
    "titles"
  ],
  "$defs": {
    "reportTitle": {
      "description": "report title entry",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "title identifier (UUID)"
        },
        "counterReportTitle": {
          "type": "string",
          "description": "Title as it appears in counter report"
        },
        "kbTitleName": {
          "type": "string",
          "description": "KB title name"
        },
        "kbTitleId": {
          "type": "string",
          "description": "KB title identifier. If not given, title is ignored (kbManualMatch=true) or unmatched (kbManualMatch=false)",
          "format": "uuid"
        },
        "kbManualMatch": {
          "type": "boolean",
          "description": "whether the counter title to kb title is manually set or ignored"
        },
        "printISSN": {
          "type": "string",
          "description": "ISSN for print instance"
        },
        "onlineISSN": {
          "type": "string",
          "description": "ISSN for online instance"
        },
        "ISBN": {
          "type": "string",
          "description": "ISBN-13 with hyphens"
        },
        "DOI": {
          "type": "string",
          "description": "Digital Object identifier"
        },
        "publicationType": {
          "type": "string",
          "description": "publication type from ERM ('serial', 'monograph')"
        }
      },
      "required": [
        "id"
      ]
    },
    "resultInfo": {
      "description": "Common result set information for streaming response",
      "type": "object",
      "properties": {
        "totalRecords": {
          "description": "Total number of entries in response",
          "type": "integer"
        },
        "diagnostics": {
          "description": "Diagnostics for response",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "description": "single diagnostic message",
                "type": "string"
              }
            }
          }
        },
        "facets": {
          "type": "array",
          "description": "Array of facets",
          "items": {
            "type": "object",
            "description": "A facet",
            "properties": {
              "facetValues": {
                "type": "array",
                "description": "Array of facet values",
                "items": {
                  "type": "object",
                  "description": "A facet value",
                  "properties": {
                    "count": {
                      "type": "integer",
                      "description": "Count of facet values"
                    },
                    "value": {
                      "description": "Value Object"
                    }
                  }
                }
              },
              "type": {
                "type": "string",
                "description": "Type of facet"
              }
            }
          }
        }
      },
      "additionalProperties": false
    }
  }
}