Box · Schema

Metadata query search results

A page of files and folders that matched the metadata query.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
entries array The mini representation of the files and folders that match the search terms. By default, this endpoint returns only the most basic info about the items. To get additional fields for each item, includ
limit integer The limit that was used for this search. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed.
next_marker string The marker for the start of the next page of results.
View JSON Schema on GitHub

JSON Schema

box-metadataqueryresults-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetadataQueryResults",
  "title": "Metadata query search results",
  "type": "object",
  "x-box-tag": "search",
  "x-box-resource-id": "metadata_query_results",
  "description": "A page of files and folders that matched the metadata query.",
  "properties": {
    "entries": {
      "description": "The mini representation of the files and folders that match the search\nterms.\n\nBy default, this endpoint returns only the most basic info about the\nitems. To get additional fields for each item, including any of the\nmetadata, use the `fields` attribute in the query.",
      "type": "array",
      "x-box-resource-variant": 1,
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/File"
          },
          {
            "$ref": "#/components/schemas/Folder"
          }
        ]
      }
    },
    "limit": {
      "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.",
      "default": 100,
      "example": 100,
      "type": "integer",
      "format": "int64"
    },
    "next_marker": {
      "description": "The marker for the start of the next page of results.",
      "example": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ..",
      "type": "string"
    }
  }
}