2.5 登録者グループの API
2.5.1 グループの追加 (/api/v1/group)
概要
グループを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
2.5.2 登録者グループリストの表示 list (/api/v1/group)
概要
登録者グループのリストを表示します。デフォルトの順序はID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
エラーレスポンスのフィールド
2.5.3 グループの登録者リストの取得 (/api/v1/group/user)
概要
グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group/user
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
2.5.4 登録者グループの更新 (/api/v3/group/update)
概要
登録者グループを更新します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/group/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
device フィールドの説明
エラーレスポンスのフィールド
2.5.5 グループの削除 (/api/v1/group/delete/{id})
概要
グループを削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/group/delete/{id}
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
2.5.6 登録者のグループへの一括追加 (/api/v1/user/add/group)
概要
登録者を一括でグループに追加します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/add/group
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスフィールドの説明
エラーレスポンスのフィールド
2.5.7 登録者のグループからの一括削除 (/api/v1/user/remove/group)
概要
グループから一括で登録者を削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/remove/group
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
最終更新