ごみ箱内のウェブリンクリソース

削除されて現在ごみ箱にあるウェブリンク。

ごみ箱内のウェブリンク

ごみ箱内のウェブリンクを表します。

属性と例

プロパティ	型	必須	説明
`type`	`enum<string>`	いいえ	値は常に`web_link`になります。使用可能なオプション: `web_link`.
`id`	`string`	いいえ	このウェブリンクの一意の識別子。
`sequence_id`	`string`	いいえ	この項目に適用された最新のUser Eventを表す数値の識別子。これを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。 `null` を指定できます。
`etag`	`string`	いいえ	このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。
`name`	`string`	いいえ	ウェブリンクの名前。
`url`	`string`	いいえ	このウェブリンクが指すURL。
`parent`	フォルダ (Mini)	いいえ	ウェブリンクが属する親オブジェクト。
`description`	`string`	いいえ	ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。
`path_collection`	`object`	いいえ	ごみ箱内の項目の親フォルダのリスト。
`created_at`	`string`	いいえ	このファイルがBoxのサーバー上に作成された日時。
`modified_at`	`string`	いいえ	このファイルがBoxサーバー上で最後に更新された日時。
`trashed_at`	`string`	いいえ	このファイルが最後にごみ箱に移動された日時。 `null` を指定できます。
`purged_at`	`string`	いいえ	このファイルが完全に削除される日時。 `null` を指定できます。
`created_by`	ユーザー (Mini)	いいえ	このウェブリンクを作成したユーザー。
`modified_by`	ユーザー (Mini)	いいえ	このウェブリンクを最後に変更したユーザー。
`owned_by`	ユーザー (Mini)	いいえ	このウェブリンクを所有するユーザー。
`shared_link`	`string`	いいえ	このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。 `null` を指定できます。
`item_status`	`enum<string>`	いいえ	この項目が削除されたかどうか。値には、`active`、`trashed` (ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。使用可能なオプション: `active`, `trashed`, `deleted`.

例

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

ごみ箱内のウェブリンク (復元済み)

ごみ箱から復元されたウェブリンクを表します。

属性と例

プロパティ	型	必須	説明
`type`	`enum<string>`	いいえ	値は常に`web_link`になります。使用可能なオプション: `web_link`.
`id`	`string`	いいえ	このウェブリンクの一意の識別子。
`sequence_id`	`string`	はい	この項目に適用された最新のUser Eventを表す数値の識別子。これを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。 `null` を指定できます。
`etag`	`string`	いいえ	このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。
`name`	`string`	いいえ	ウェブリンクの名前。
`url`	`string`	いいえ	このウェブリンクが指すURL。
`parent`	フォルダ (Mini)	いいえ	ウェブリンクが属する親オブジェクト。
`description`	`string`	いいえ	ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。
`path_collection`	`object`	はい	項目の親フォルダのリスト。
`created_at`	`string`	いいえ	このファイルがBoxのサーバー上に作成された日時。
`modified_at`	`string`	いいえ	このファイルがBoxサーバー上で最後に更新された日時。
`trashed_at`	`string`	いいえ	このブックマークがごみ箱に移動された日時。復元後は`null`になります。 `null` を指定できます。
`purged_at`	`string`	いいえ	このブックマークが完全に削除される予定日時。復元後は`null`になります。 `null` を指定できます。
`created_by`	ユーザー (Mini)	いいえ	このウェブリンクを作成したユーザー。
`modified_by`	ユーザー (Mini)	いいえ	このウェブリンクを最後に変更したユーザー。
`owned_by`	ユーザー (Mini)	いいえ	このウェブリンクを所有するユーザー。
`shared_link`	`string`	いいえ	このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。 `null` を指定できます。
`item_status`	`enum<string>`	いいえ	この項目が削除されたかどうか。値には、`active`、`trashed` (ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。使用可能なオプション: `active`, `trashed`, `deleted`.

例

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

​ごみ箱内のウェブリンク

​ごみ箱内のウェブリンク (復元済み)

ごみ箱内のウェブリンク

ごみ箱内のウェブリンク (復元済み)