Drive API の概要

    LINE WORKS Drive API は、LINE WORKS Drive でのファイルのアップロード・ダウンロード、ファイルやグループフォルダ情報の閲覧などの機能を提供します。

    Drive API の使用準備

    Drive API の利用には API ID が必要となります。ただし、ファイルのアップロード・ダウンロードについては API ID は必要ありません。

    API ID の発行

    API ID は、Drive API の URL に使われます。API ID の発行については、API 共通ガイドを参考にしてください。

    OAuth 2.0 認証

    OAuth 2.0 認証を行うには、認証トークンとコンシューマーキーが必要です。コンシューマーキーとサーバートークンの発行については、API 共通ガイドを参考にしてください。

    使用方法

    以下のように API リクエストヘッダーに渡された認証トークンとコンシューマーキーを追加します。認証トークンは、「Authorization」項目に「Bearer」タイプで追加し、コンシューマーキーは「consumerKey」項目に追加します。

    method.setRequestHeader("Authorization", "Bearer AAAA…");
    method.setRequestHeader("consumerKey", "AbCdEfGhIjKlMn");
    

    Sample Code for Java

    String url = "https://apis.worksmobile.com/{API ID}/drive/getQuota/v1";
    HttpClient client = new HttpClient();
    HttpMethod method = new GetMethod(url);
    method.setRequestHeader("Authorization", "Bearer AAAA8…");
    method.setRequestHeader("consumerKey", "AbCdEfGhIjKlMn");
    client.executeMethod(method);
    LOGGER.debug("result : {}", method.getResponseBodyAsString());
    

    API 共通情報

    Drive API は、ファイルのアップロード・ダウンロードを行う API と、その他のAPIに分かれています。それぞれ呼び出すサーバードメインが異なるので、各 API のドキュメントを参照してください。

    Response 共通

    ファイルのアップロード・ダウンロード以外のすべての API リクエストは、API Gateway を経て Drive API サーバーへ受け付けられます。OAuth 認証エラーが発生した場合は、API Gateway よりエラーコードを返します。

    {
    "errorCode":"028",
    "errorMessage":"Authentication header not exists"
    }
    

    API Gateway を通った API リクエストは、Drive API サーバーで処理を行い JSON 形式で返されます。応答フォーマットは、code、message、result の項目になっています。実際の結果値は、'result'項目に含まれます。

    {
    
      "code" : "0",
      "message" : "success",
      "result" : {
        "cycle" : 30,
        "size" : 50000
      }
    
    }
    

    結果コード

    API 呼び出しに成功したらコードとして「0」を返します。失敗した場合は、エラーコードを返します。 下記は、ファイルのアップロード・ダウンロード以外の API 呼び出し失敗時に返すエラーコードです。

    表 1 API 呼び出し失敗時のエラーコード(ファイルのアップロード・ダウンロードAPI を除く)

    分類 エラーコード エラーメッセージ 説明
    共通 1000 Internal Server Error 内部サーバーエラー
    1001 Invalid Parameters パラメータエラー
    1002 Service Not Available LINE WORKS Drive サービスのメンテナンス中
    1003 File operation API not Available ファイル操作 API(ファイルのコピー、移動、名前の変更、フォルダ作成など) のメンテナンス中
    1004 Not Supported Operation 非対応の操作
    1005 Your request is currently being processed. You can check again later to see the request has been processed. ファイル操作 API 実行時間が30秒を超えた場合に発生するエラーコード。30秒を超えても、処理は継続されます。
    1006 Private folder not available 個人フォルダを使用できない
    1101 Works Domain is Not Active LINE WORKS のドメイン情報が無効
    1102 Works Drive Service is Not Active LINE WORKS Drive サービスが無効
    認証エラー 2001 Authentication Fail 認証エラー
    2003 Read Only User 閲覧権限のみのアカウント
    2004 ID Change Fail ID 変更エラー
    2005 Not Supported During Storage Move (利用データセンター移行) OWFS 移行時に非対応の機能
    アカウントエラー 2101 Not Registered User LINE WORKS Drive サービス未登録
    2105 Forbidden User LINE WORKS Drive サービスへのアクセスが禁止されている状態
    2106 Share Forbidden user 共有機能の利用が禁止されているユーザー
    2107 Multi IP Access Forbidden User アクセス元の IP アドレスが変更されたため、アクセスが禁止されたユーザー
    不正なデータリクエスト 3011 Invalid data format 正常でないデータでリクエスト
    存在しないリソース 3101 Resource Not Exist リソースが存在しない
    3102 Folder Not Exist フォルダが存在しない
    3103 File Not Exist ファイルが存在しない
    3104 Source Resource Not Exist 参照元のリソースが存在しない
    3105 Destination Resource Not Exist 対象のリソースが存在しない
    3111 Share Folder Not Exist 共有フォルダが存在しない
    リソースの重複 3201 Resource already Exist リソースの重複
    3202 Folder already Exist フォルダの重複
    3203 File already Exist ファイルの重複
    3204 File Name Same as Input Folder Name Exist ファイル名と同一のフォルダ名が存在
    3205 Folder Name Same as Input File Name Exist フォルダ名と同一のファイル名が存在
    3206 Duplicated Share Folder Exist 共有フォルダの重複
    保護されたリソースの重複 3211 Protected Folder Exist 保護されたフォルダの重複
    3212 Protected File Exist 保護されたファイルの重複
    3213 Protected Share Folder Exist 保護された共有フォルダの重複
    3214 Protected Share File Exist 保護されたファイルの重複
    3215 Protected Resource Exist in Sub Folder サブフォルダに重要表示されたリソースが存在
    その他のエラー 3301 Exceeds Data Capacity Driveの容量超過
    3302 Over Max Folder Name Length フォルダ名の超過
    3303 Over Max File Name Length ファイル名の超過
    3304 Over Total Path Length パス全体の長さが超過
    3305 Invalid Resource Path 無効なパス
    3306 Resource Lock リソースがロックされている。
    3402 Virus File マルウェアに感染しているファイル
    3403 Blocked Extension File アップロード/ダウンロードが制限されたファイル形式
    共有フォルダまたはグループフォルダ関連エラー 4101 Auth Fail 共有フォルダまたはグループフォルダ権限エラー
    4102 Write Permission Needed 編集権限が必要
    4103 Not Supported In Share/Group Folder 共有フォルダ、またはグループフォルダで対応しない機能
    4104 Exceed Share User Count 共有者数を超過している。
    4105 Already Shared or Authorized Folder すでに共有されているか、権限が与えられているフォルダ
    4106 Exceed Share Folder Count フォルダ共有可能な最大回数を超過している。

    参考

    • 今後、エラーコードは細分化される可能性があるため、存在しないリソースや重複リソースに関するエラーは「表 1」のエラーコードの範囲内で処理することを推奨します。

    下記は、ファイルのアップロード・ダウンロードAPIを呼び出した際のエラー発生時に返すエラーコードです。

    表 2ファイルのアップロード・ダウンロードAPI呼び出し失敗時のエラーコード

    エラーコード エラーメッセージ 説明
    10000 System Error 内部システムエラー
    1216 Share Folder 共有フォルダではない
    1600 WORKS AUTH FAIL LINE WORKS の認証エラー
    1120 Auth Fail アップロード権限がないか、共有に問題がある
    1210 Need Write Auth 編集権限がない
    1001 Parent Folder Not Found 親フォルダが存在しない
    1042 Total Path(Max) Size Over 全体のパスの長さが超過
    1063 Total Name(Max) Size Over ファイル名の長さが超過
    1007 Exist Protected File 対象ファイルが保護ファイルに設定されている(アップロードで既存のファイルの上書き時)
    1009 Duplicated File Exist 対象ファイルが存在する(ファイルアップロード時)
    1059 Folder Lock アップロード先のフォルダがロックされている
    1003 Over Upload Quota ユーザーの割り当て容量不足
    1022 Over Quota File Size 制限されたファイルサイズを超過
    1016 Not Allowed Name 非対応の名前形式
    1202 Not Exist Shared Folder 共有フォルダが存在しない
    1068 Client File Lock 他のメンバーにより対象ファイルがロックされている
    1011 Not Exist Path ファイル(フォルダ)が存在しない
    1036 File Information Not Found ファイル情報が存在しない
    1037 Folder Information Not Found フォルダ情報が存在しない
    1071 Virus File Fail マルウェアに感染しているファイルのアクセス制限
    1076 Restrict Upload File Extension 制限されたファイル形式のアップロードの制限
    1078 Locked File ファイルがロックされている
    2001 File Storage Error ストレージのエラー
    2002 Invalidation Cookie アップロード/ダウンロードの時に Cookie が無効