メソッドの概要

返却値の型 メソッド名
ResultObject addFolderTop (FolderDetail folder, String companyCd)
TOPフォルダを追加します。
ResultObject addFolder (FolderDetail folder)
フォルダを追加します。
ResultObject changeSort (FolderKey parentKey, FolderKey key, Integer fromSortKey, Integer toSortKey)
フォルダ表示順を更新します。
ResultObject deleteFolder (FolderKey[] keys)
フォルダを削除します。
ResultObject findFolderDirectList (FolderKey key)
フォルダ直下のフォルダを取得します。
ResultObject findFolderLimitedList (FolderKey key)
フォルダ配下のフォルダを取得します。
ResultObject findFolderListTop ()
TOPフォルダを取得します。
ResultObject findFolderListTop (String companyCd)
TOPフォルダを取得します。
ResultObject findFolder (FolderKey key)
フォルダを取得します。
ResultObject updateFolder (FolderDetail folder)
フォルダを更新します。

メソッドの詳細

ResultObject addFolderTop (FolderDetail folder, String companyCd)
TOPフォルダを追加します。

指定した会社コードのフォルダとして登録します。
会社コードがNULLの場合、カレント組織の会社のフォルダとして登録します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

  • Collraboration管理者
  • Filelibrary機能管理者

パラメータ
folder : FolderDetail
フォルダ情報
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FolderDetail を設定します。
ResultObject addFolder (FolderDetail folder)
フォルダを追加します。

カレント組織の会社のフォルダとして追加します。

パラメータ
folder : FolderDetail
フォルダ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FolderDetail を設定します。
ResultObject changeSort (FolderKey parentKey, FolderKey key, Integer fromSortKey, Integer toSortKey)
フォルダ表示順を更新します。

同じ親フォルダ内の子フォルダの表示順を更新します。
親フォルダキーがNULLの場合、TOPフォルダの表示順を更新します。
但し、TOPフォルダの表示順更新は、Collaboration管理者のみ操作が可能です。

パラメータ
parentKey : FolderKey
親フォルダキー
key : FolderKey
フォルダキー
fromSortKey : Integer
移動元の表示順位置
toSortKey : Integer
移動先の表示順位置
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteFolder (FolderKey[] keys)
フォルダを削除します。

[ TOPフォルダの削除について ]
TOPフォルダは、以下の管理者のみ削除が可能です。

  • Collraboration管理者
  • filelibrary管理者

  • パラメータ
    keys : FolderKey[]
    フォルダキー
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、FolderKey[] を設定します。
    ResultObject findFolderDirectList (FolderKey key)
    フォルダ直下のフォルダを取得します。

    直下にフォルダがない場合、空の配列を返却します。

    パラメータ
    key : FolderKey
    フォルダキー
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、Folder[] を設定します。
    ResultObject findFolderLimitedList (FolderKey key)
    フォルダ配下のフォルダを取得します。

    配下にフォルダがない場合、空の配列を返却します。

    [ 大量データモードについて ]
    ここで取得するフォルダは、大量データモードによって異なります。

    • 大量データモードがONの場合、指定したフォルダキー直下のフォルダを取得します。
    • 大量データモードがOFFの場合、指定したフォルダキー配下全てのフォルダを取得します。

    パラメータ
    key : FolderKey
    フォルダキー
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、Folder[] を設定します。
    ResultObject findFolderListTop ()
    TOPフォルダを取得します。

    管理権限の範囲で操作可能なTOPフォルダをすべて取得します。

    [ 利用可能な管理者について ]
    このAPIでは、以下の管理者が操作可能です。

    • Filelibrary機能管理者
    • Filelibraryオーナー

    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、Folder[] を設定します。
    ResultObject findFolderListTop (String companyCd)
    TOPフォルダを取得します。

    指定した会社コードに該当するTOPフォルダを取得します。

    [ 利用可能な管理者について ]
    このAPIでは、以下の管理者が操作可能です。

    • Collaboration管理者

    パラメータ
    companyCd : String
    会社コード
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、Folder[] を設定します。
    ResultObject findFolder (FolderKey key)
    フォルダを取得します。
    パラメータ
    key : FolderKey
    フォルダキー
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、FolderDetail を設定します。
    ResultObject updateFolder (FolderDetail folder)
    フォルダを更新します。

    [ フォルダの移動について ]
    フォルダを行うと、指定したフォルダに付与しているアクセス権が全て削除されます。
    フォルダの移動は、管理権限によってできるものが異なります。

    • TOPフォルダを異なるTOPフォルダへの移動は、Collaboration管理者またはFilelibrary機能管理者が利用可能です。
    • 子フォルダからTOPフォルダへの移動は、Collaboration管理者またはFilelibrary機能管理者が利用可能です。
    • 異なるTOPフォルダ間での移動は、Collaboration管理者またはFilelibrary機能管理者、Filelibraryオーナーが利用可能です。
    • 同一TOPフォルダ間での移動は、Collaboration管理者またはFilelibrary機能管理者、Filelibraryオーナーが利用可能です。

    パラメータ
    folder : FolderDetail
    フォルダ情報
    返却値
    ResultObject
    ResultObject 処理結果オブジェクト
    data プロパティには、処理件数 を設定します。