クォータ状況取得

HULFT-WebFileTransferのシステム全体および各グループ別のクォータ状況を取得します。検索条件を指定した場合は、完全一致で検索が行われます。

(1) 必要な権限

GetQuotaStatus APIを使用するには以下の権限のいずれかが必要です。

  • 履歴の参照権限

  • 履歴の削除権限

= 備考 =

権限がなくても、APIを使用するユーザが所属するグループのクォータ状況は取得できます。

(2) リクエストURL

http(s)://Domain:xxxx/コンテキスト名/GetQuotaStatus

(3) リクエストインタフェース

表1.85 クォータ状況取得のリクエストインタフェースの項目

項目名

説明

文字

省略

省略値

group_id

グループID(検索条件)(*1)

クォータ状況を取得したいグループIDを32バイトで指定します。

半角

ブランク

display_type

表示種別(検索条件)(*1)

取得するクォータ状況の条件を指定します。

0

すべてのグループ

1

使用容量がグループの警告値以下のグループのみ(*2)

2

使用容量がグループの警告値を超過したグループのみ

3

使用容量がグループの上限値以下のグループのみ(*3)

4

使用容量がグループの上限値を超過したグループのみ

半角

0

*1

:

group_id(グループID)およびdisplay_type(表示種別)を同時に指定するとエラーになります。

*2

:

グループの警告値を設定していないグループも取得します。

*3

:

グループの上限値を設定していないグループも取得します。

(4) レスポンスインタフェース

表1.86 クォータ状況取得のレスポンスインタフェースの項目

項目名

説明

備考

info_quota_system

システムのクォータ状況

システムのクォータ状況が返却されます。

※履歴参照権限がない場合、返却されません。

「システムのクォータ状況(info_quota_system)」参照

info_quota_group

グループのクォータ状況

グループのクォータ状況が返却されます。リクエストインタフェースで指定した検索条件を満たすグループIDが複数ある場合、グループIDの昇順で返却されます。

※履歴参照権限がない場合、ログインユーザの所属するグループのクォータ状況のみ返却されます。

「グループのクォータ状況(info_quota_group)」参照