Box · Schema

Trashed Web Link

Represents a trashed web link.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
type string `web_link`
id string The unique identifier for this web link
sequence_id object
etag string The entity tag of this web link. Used with `If-Match` headers.
name string The name of the web link
url string The URL this web link points to
parent object
description string The description accompanying the web link. This is visible within the Box web application.
path_collection object
created_at string When this file was created on Box’s servers.
modified_at string When this file was last updated on the Box servers.
trashed_at string When this file was last moved to the trash.
purged_at string When this file will be permanently deleted.
created_by object
modified_by object
owned_by object
shared_link string The shared link for this bookmark. This will be `null` if a bookmark has been trashed, since the link will no longer be active.
item_status string Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted
View JSON Schema on GitHub

JSON Schema

box-trashweblink-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrashWebLink",
  "title": "Trashed Web Link",
  "type": "object",
  "x-box-resource-id": "trash_web_link",
  "x-box-tag": "trashed_web_links",
  "description": "Represents a trashed web link.",
  "properties": {
    "type": {
      "type": "string",
      "description": "`web_link`",
      "example": "web_link",
      "enum": [
        "web_link"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for this web link",
      "example": "11446498"
    },
    "sequence_id": {
      "allOf": [
        {
          "type": "string",
          "example": "3",
          "nullable": true,
          "description": "A numeric identifier that represents the most recent user event\nthat has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint\nto filter out user events that would have occurred before this\nidentifier was read.\n\nAn example would be where a Box Drive-like application\nwould fetch an item via the API, and then listen to incoming\nuser events for changes to the item. The application would\nignore any user events where the `sequence_id` in the event\nis smaller than or equal to the `sequence_id` in the originally\nfetched resource."
        },
        {
          "nullable": false
        }
      ]
    },
    "etag": {
      "type": "string",
      "example": "1",
      "description": "The entity tag of this web link. Used with `If-Match`\nheaders."
    },
    "name": {
      "type": "string",
      "description": "The name of the web link",
      "example": "My Bookmark"
    },
    "url": {
      "type": "string",
      "example": "https://www.example.com/example/1234",
      "description": "The URL this web link points to"
    },
    "parent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        {
          "description": "The parent object the web link belongs to"
        }
      ]
    },
    "description": {
      "type": "string",
      "example": "Example page",
      "description": "The description accompanying the web link. This is\nvisible within the Box web application."
    },
    "path_collection": {
      "allOf": [
        {
          "title": "Path collection (Trash)",
          "description": "A list of parent folders for an item in the trash.",
          "type": "object",
          "required": [
            "total_count",
            "entries"
          ],
          "properties": {
            "total_count": {
              "description": "The number of folders in this list.",
              "example": 1,
              "type": "integer",
              "format": "int64",
              "nullable": false
            },
            "entries": {
              "description": "Array of folders for this item's path collection",
              "type": "array",
              "items": {
                "type": "object",
                "description": "The parent folder for this item",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "`folder`",
                    "enum": [
                      "folder"
                    ],
                    "example": "folder"
                  },
                  "id": {
                    "type": "string",
                    "description": "The unique identifier that represent a folder.",
                    "example": "123456789"
                  },
                  "sequence_id": {
                    "type": "string",
                    "nullable": true,
                    "example": null,
                    "description": "This field is null for the Trash folder"
                  },
                  "etag": {
                    "type": "string",
                    "nullable": true,
                    "example": null,
                    "description": "This field is null for the Trash folder"
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the Trash folder.",
                    "example": "Trash",
                    "nullable": false
                  }
                }
              }
            }
          }
        },
        {
          "description": "The tree of folders that this web link is contained in,\nstarting at the root."
        },
        {
          "nullable": false
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this file was created on Box\u2019s servers.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this file was last updated on the Box\nservers.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "trashed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When this file was last moved to the trash.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "purged_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When this file will be permanently deleted.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who created this web link"
        }
      ]
    },
    "modified_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who last modified this web link"
        }
      ]
    },
    "owned_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who owns this web link"
        }
      ]
    },
    "shared_link": {
      "type": "string",
      "description": "The shared link for this bookmark. This will\nbe `null` if a bookmark has been trashed, since the link will no longer\nbe active.",
      "example": null,
      "nullable": true
    },
    "item_status": {
      "type": "string",
      "example": "trashed",
      "enum": [
        "active",
        "trashed",
        "deleted"
      ],
      "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted"
    }
  }
}