Box · Schema

Web link (Base)

Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this web link
type string `web_link`
etag string The entity tag of this web link. Used with `If-Match` headers.
View JSON Schema on GitHub

JSON Schema

box-weblink-base-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebLink--Base",
  "title": "Web link (Base)",
  "type": "object",
  "x-box-resource-id": "web_link--base",
  "x-box-tag": "web_links",
  "x-box-variants": [
    "base",
    "mini",
    "standard"
  ],
  "x-box-variant": "base",
  "description": "Web links are objects that point to URLs. These objects\nare also known as bookmarks within the Box web application.\n\nWeb link objects are treated similarly to file objects,\nthey will also support most actions that apply to regular files.",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this web link",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`web_link`",
      "example": "web_link",
      "enum": [
        "web_link"
      ]
    },
    "etag": {
      "type": "string",
      "example": "1",
      "description": "The entity tag of this web link. Used with `If-Match`\nheaders."
    }
  }
}