{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

Shuttle

Shuttleサブジェクトマッピングインポートを作成

Boxに保存されているサブジェクト (ユーザーおよびグループ) マッピングのスプレッドシートを承認し、ジョブのサブジェクトマッピングを置き換えます。そのファイルがサブジェクトマッピングワークブックではない場合や、サイズの上限 (Boxのダウンロード上限である10 MiB) または行数の上限 (マッピング行数50,000) を超過している場合には、同期的に400が返され、ジョブに変更が加えられません。インポートが承認されると、常にそのジョブのサブジェクトマッピングがすべて置き換えられます。すべての行が有効である場合、ワークブックの内容がすべて導入されます。いずれかの行が無効である場合、サブジェクトマッピングが一切行われないままジョブが終了し、次回のインポートまたは次回の手動サブジェクトマッピング変更までmapping_stateがsubjects_import_rejectedになります。行の問題は、GET /shuttle_mapping_errors?job_id=…をカテゴリsubject_importで使用することでリスト表示できます。メッセージはRow N: …形式で、最大500個のエントリと1個のオーバーフローエントリが表示されます。承認後、検証と導入が非同期的に実行されます。mapping_stateがimporting_subjectsである間に、GET /shuttle_jobs/{shuttle_job_id}をポーリングします。1つのジョブで同時に実行できるインポートは1つのみです。ジョブでは必ずサブジェクト (account_mappingが有効) をマッピングし、そのソーススキャンを終了する必要があります。そうしない場合、リクエストが409を返します。

想定されるワークブックの形式 (APIクライアントはUIテンプレートをダウンロードできません): シートはUsersまたはGroups (Subjectsという名前のシートも使用できます)。Usersの列はSource User <Key>、Target User <Key>、Skip、Groupsの列はSource Group <Key>、Target Group <Key>、Skipです。ここで、<Key>は、そのロールおよびシステムにおけるプライマリ識別子です。

ユーザー: ほとんどのシステムではEmail、SharePoint (2007/2010/2013) ではID、WindowsではName (windows_union。ユーザーIDとして保存されます)。
グループ: ほとんどのシステムではName、Googleドライブ管理者グループではEmail。テンプレートのソース行はGET /shuttle_discovered_subjectsから取得できます。

POST

shuttle_subject_mapping_imports

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

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

ヘッダー

box-version

enum<string>

必須

Version header.

利用可能なオプション:

2026.0

ボディ

application/json

Boxに保存済みのスプレッドシートからShuttleジョブのサブジェクトマッピングをインポートするために使用するリクエスト本文。

job_id

string

必須

サブジェクトマッピングが置き換えられるShuttleジョブの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

file_id

string

必須

マッピングワークブックが格納されているBoxファイルの一意の識別子。このファイルは呼び出し元ユーザーとして読み取られるため、そのユーザーがダウンロードできる場所に保存されている必要があります。

例:

"12345678901"

レスポンス

インポートが承認されると、引き続いて検証と導入が非同期的に実行されます。mapping_stateがimporting_subjectsでなくなるまで、GET /shuttle_jobs/{shuttle_job_id}をポーリングします。拒否されたインポートはmapping_state subjects_import_rejectedで終了し、空のサブジェクトマッピングリストが返されます。インポートが成功すると、mapping_completeやreadyなど、その後のマッピング準備状態に移行します。

最終更新日 2026年11月4日

APIリファレンス

v2025.0

v2026.0

APIリファレンス

APIリファレンス

Shuttleサブジェクトマッピングインポートを作成

承認

ヘッダー

ボディ

レスポンス