Box Developerドキュメント
 
    最新バージョン

    ファイルに分類を追加

    post
    https://api.box.com/2.0
    /files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    追加する分類のラベルを指定することで、ファイルに分類を追加します。

    このAPIは、/files/:id//enterprise_12345/securityClassification-6VMVochwUWoのように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    パスパラメータ

    stringパス内必須
    12345

    ファイルを表す一意の識別子。

    ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_id123です。

    リクエスト本文

    string本文内省略可能
    "Sensitive"

    このファイルに適用する分類の名前。

    会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される分類テンプレートを取得します。

    レスポンス

    application/json分類

    ファイルに適用された分類テンプレートインスタンスを返します。

    リクエスト本文が無効な場合にエラーを返します。

    • schema_validation_failed - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。

    ファイルテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。

    • not_found - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。
    • instance_tuple_not_found - メタデータテンプレートが見つかりませんでした。

    このメタデータテンプレートのインスタンスがすでにファイルに存在する場合はエラーを返します。

    • tuple_already_exists - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。

    予期しないクライアントエラー。

    post
    ファイルに分類を追加
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X POST "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
         -H "authorization: Bearer <ACCESS_TOKEN>" \
         -H "content-type: application/json" \
         -d '{
           "Box__Security__Classification__Key": "Sensitive"
    
         }'

    レスポンスの例

    {
      "$canEdit": true,
      "$parent": "folder_59449484661,",
      "$scope": "enterprise_27335",
      "$template": "securityClassification-6VMVochwUWo",
      "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
      "$typeVersion": 5,
      "$version": 1,
      "Box__Security__Classification__Key": "Sensitive"
    }