Box · Schema

Device pinners

A list of device pins

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
entries array A list of device pins
limit integer The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed.
next_marker integer The marker for the start of the next page of results.
order array The order by which items are returned.
View JSON Schema on GitHub

JSON Schema

box-devicepinners-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DevicePinners",
  "title": "Device pinners",
  "type": "object",
  "x-box-resource-id": "device_pinners",
  "x-box-tag": "device_pinners",
  "description": "A list of device pins",
  "properties": {
    "entries": {
      "type": "array",
      "description": "A list of device pins",
      "items": {
        "$ref": "#/components/schemas/DevicePinner"
      }
    },
    "limit": {
      "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.",
      "default": 100,
      "example": 200,
      "type": "integer",
      "format": "int64"
    },
    "next_marker": {
      "description": "The marker for the start of the next page of results.",
      "example": 3000,
      "type": "integer",
      "format": "int64"
    },
    "order": {
      "description": "The order by which items are returned.",
      "type": "array",
      "items": {
        "type": "object",
        "description": "The order in which a pagination is ordered",
        "properties": {
          "by": {
            "description": "The field that is ordered by",
            "example": "id",
            "enum": [
              "id"
            ],
            "type": "string"
          },
          "direction": {
            "type": "string",
            "description": "The direction to order by, either ascending or descending",
            "example": "asc",
            "enum": [
              "asc",
              "desc"
            ]
          }
        }
      }
    }
  }
}