SubmitQuery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-submit-query-schema.json",
  "title": "SubmitQuery",
  "description": "Request to submit query",
  "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/SubmitQuery",
  "type": "object",
  "properties": {
    "fqlQuery": {
      "type": "string"
    },
    "entityTypeId": {
      "$ref": "#/$defs/UUID"
    },
    "fields": {
      "description": "Fields to be included in query results",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortResults": {
      "description": "Whether to sort results based on entity type's sort criteria",
      "type": "boolean"
    },
    "maxSize": {
      "description": "Maximum number of results to retrieve for the query",
      "type": "integer"
    }
  },
  "required": [
    "entityTypeId",
    "fqlQuery"
  ],
  "additionalProperties": false,
  "$defs": {
    "UUID": {
      "description": "The content row represented as a map.",
      "type": "string",
      "format": "uuid"
    }
  }
}