Box · Schema

Trashed Folder (Restored)

Represents a folder restored from the trash.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier that represent a folder. The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.
etag string The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.
type string `folder`
sequence_id object
name string The name of the folder.
created_at string The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.
modified_at string The date and time when the folder was last updated. This value may be `null` for some folders such as the root folder or the trash folder.
description object
size integer The folder size in bytes. Be careful parsing this integer as its value can get very large.
path_collection object
created_by object
modified_by object
trashed_at string The time at which this folder was put in the trash - becomes `null` after restore.
purged_at string The time at which this folder is expected to be purged from the trash - becomes `null` after restore.
content_created_at string The date and time at which this folder was originally created.
content_modified_at string The date and time at which this folder was last updated.
owned_by object
shared_link string The shared link for this file. This will be `null` if a folder had been trashed, even though the original shared link does become active again.
folder_upload_email string The folder upload email for this folder. This will be `null` if a folder has been trashed, even though the original upload email does become active again.
parent object
item_status string Defines if this item has been deleted or not. * `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been
View JSON Schema on GitHub

JSON Schema

box-trashfolderrestored-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrashFolderRestored",
  "title": "Trashed Folder (Restored)",
  "type": "object",
  "x-box-resource-id": "trash_folder_restored",
  "x-box-tag": "trashed_folders",
  "description": "Represents a folder restored from the trash.",
  "properties": {
    "id": {
      "type": "string",
      "nullable": false,
      "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting a folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folders/123`\nthe `folder_id` is `123`.",
      "example": "123456789"
    },
    "etag": {
      "type": "string",
      "nullable": true,
      "example": "1",
      "description": "The HTTP `etag` of this folder. This can be used within some API\nendpoints in the `If-Match` and `If-None-Match` headers to only\nperform changes on the folder if (no) changes have happened."
    },
    "type": {
      "type": "string",
      "description": "`folder`",
      "example": "folder",
      "enum": [
        "folder"
      ],
      "nullable": false
    },
    "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
        }
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the folder.",
      "example": "Contracts",
      "nullable": false
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The date and time when the folder was created. This value may\nbe `null` for some folders such as the root folder or the trash\nfolder.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the folder was last updated. This value may\nbe `null` for some folders such as the root folder or the trash\nfolder.",
      "example": "2012-12-12T10:53:43-08:00",
      "nullable": true
    },
    "description": {
      "allOf": [
        {
          "type": "string",
          "description": "The optional description of this folder",
          "maxLength": 256,
          "example": "Legal contracts for the new ACME deal",
          "nullable": false
        },
        {
          "nullable": false
        }
      ]
    },
    "size": {
      "type": "integer",
      "format": "int64",
      "description": "The folder size in bytes.\n\nBe careful parsing this integer as its\nvalue can get very large.",
      "example": 629644,
      "nullable": false
    },
    "path_collection": {
      "allOf": [
        {
          "title": "Path collection",
          "description": "A list of parent folders for an item.",
          "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": {
              "type": "array",
              "description": "The parent folders for this item",
              "nullable": false,
              "items": {
                "$ref": "#/components/schemas/Folder--Mini"
              }
            }
          }
        },
        {
          "description": "The tree of folders that this file is contained in,\nstarting at the root."
        },
        {
          "nullable": false
        }
      ]
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who created this folder"
        },
        {
          "nullable": false
        }
      ]
    },
    "modified_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who last modified this folder."
        },
        {
          "nullable": false
        }
      ]
    },
    "trashed_at": {
      "type": "string",
      "description": "The time at which this folder was put in the\ntrash - becomes `null` after restore.",
      "example": null,
      "nullable": true
    },
    "purged_at": {
      "type": "string",
      "description": "The time at which this folder is expected to be purged\nfrom the trash  - becomes `null` after restore.",
      "example": null,
      "nullable": true
    },
    "content_created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The date and time at which this folder was originally\ncreated.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "content_modified_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The date and time at which this folder was last updated.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "owned_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who owns this folder."
        },
        {
          "nullable": false
        }
      ]
    },
    "shared_link": {
      "type": "string",
      "description": "The shared link for this file. This will\nbe `null` if a folder had been trashed, even though the original shared\nlink does become active again.",
      "example": null,
      "nullable": true
    },
    "folder_upload_email": {
      "type": "string",
      "description": "The folder upload email for this folder. This will\nbe `null` if a folder has been trashed, even though the original upload\nemail does become active again.",
      "example": null,
      "nullable": true
    },
    "parent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Folder--Mini"
        },
        {
          "description": "The optional folder that this folder is located within.\n\nThis value may be `null` for some folders such as the\nroot folder or the trash folder."
        },
        {
          "nullable": true
        }
      ]
    },
    "item_status": {
      "type": "string",
      "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted.",
      "enum": [
        "active",
        "trashed",
        "deleted"
      ],
      "nullable": false,
      "example": "active"
    }
  }
}