Trashed Web Link (Restored)

Represents a web link restored from the trash.

id string

example"11446498"

The unique identifier for this web link

type string

example"web_link"

web_link

Value is always web_link

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

When this file was created on Box’s servers.

created_byUser (Mini) object

The user who created this web link

description string

example"Example page"

The description accompanying the web link. This is visible within the Box web application.

etag string

example"1"

The entity tag of this web link. Used with If-Match headers.

item_status string

example"trashed"

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

Value is one of active,trashed,deleted

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

When this file was last updated on the Box servers.

modified_byUser (Mini) object

The user who last modified this web link

name string

example"My Bookmark"

The name of the web link

owned_byUser (Mini) object

The user who owns this web link

parentFolder (Mini) object

The parent object the web link belongs to

path_collection object

The tree of folders that this web link is contained in, starting at the root.

path_collection.entriesFolder (Mini) array

The parent folders for this item

path_collection.total_count integer / int64

example1

The number of folders in this list.

purged_at string

examplenull

The time at which this bookmark will be permanently deleted - becomes null after restore.

sequence_id string

example"3"

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

shared_link string

examplenull

The shared link for this bookmark. This will be null if a bookmark had been trashed, even though the original shared link does become active again.

trashed_at string

examplenull

The time at which this bookmark was put in the trash - becomes null after restore.

url string

example"https://www.example.com/example/1234"

The URL this web link points to

Response Example

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "trashed",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "id": "12345",
        "etag": "1",
        "type": "folder",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ],
    "total_count": 1
  },
  "purged_at": "null",
  "sequence_id": "3",
  "shared_link": "null",
  "trashed_at": "null",
  "url": "https://www.example.com/example/1234"
}