会社のデバイスピンのリストを取得

cURL

curl -i -X GET "https://api.box.com/2.0/enterprises/3442311/device_pinners" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "entries": [
    {
      "id": "11446498",
      "type": "device_pinner",
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "product_name": "iPad"
    }
  ],
  "limit": 200,
  "next_marker": 3000,
  "order": [
    {
      "by": "id",
      "direction": "asc"
    }
  ]
}

GET

enterprises

{enterprise_id}

device_pinners

cURL

curl -i -X GET "https://api.box.com/2.0/enterprises/3442311/device_pinners" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "entries": [
    {
      "id": "11446498",
      "type": "device_pinner",
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "product_name": "iPad"
    }
  ],
  "limit": 200,
  "next_marker": 3000,
  "order": [
    {
      "by": "id",
      "direction": "asc"
    }
  ]
}

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

enterprise_id

string

required

企業のID。

Query Parameters

marker

string

結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

limit

integer<int64>

返す項目の1ページあたりの最大数。

必須範囲: x <= 1000

direction

enum<string>

結果を並べ替える方向。アルファベットの昇順 (ASC) または降順 (DESC) のいずれかを指定できます。

利用可能なオプション:

ASC,

DESC

Response

指定した会社のデバイスピンのリストを返します。

デバイスピンのリスト。

entries

Device Pinner · object[]

デバイスピンのリスト。

表示子属性

entries.id

string

このデバイスピンの一意の識別子。

Example:

"11446498"

entries.type

enum<string>

値は常にdevice_pinnerになります。

利用可能なオプション:

device_pinner

Example:

"device_pinner"

entries.owned_by

ユーザー (Mini) · object

デバイスピンが属するユーザー。

表示子属性

entries.owned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

entries.owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

entries.owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

entries.product_name

string

ピンが設定されているデバイスのタイプ。

Example:

"iPad"

limit

integer<int64>

default:100

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。

Example:

200

next_marker

integer<int64>

次の検索結果ページの開始場所のマーカー。

Example:

3000

order

object[]

項目が返される順序。

表示子属性

order.by

enum<string>

並べ替えに使用するフィールド。

利用可能なオプション:

id

Example:

"id"

order.direction

enum<string>

並べ替えの方向 (昇順または降順)。

利用可能なオプション:

asc,

desc

Example:

"asc"

デバイスピンを取得

デバイスピンを削除

⌘I