WFP_API_Document/index20.md

/usergroup

ユーザーグループに関するAPIです。

/add

ユーザーグループにメンバーを追加する。

HTTP Method	Description
POST	:material-check: Create resource	データの送信 (主に新規作成)

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/adminlist

get list of groups for admins

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/delete/{id}

delete a group

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/details/{id}

get details and members of group

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/list/{id}

?

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/members/{id}

グループのメンバーを取得する。

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/members/email/{id}

グループに所属するユーザーのメールアドレスを取得する。

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/members/multi

?

HTTP Method	Description
GET	? Fetch resource	データの取得
POST	? Create resource	データの送信 (主に新規作成)

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/mylist

get my group list.

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/openlist

?

HTTP Method	Description
GET	:material-check: Fetch resource	データの取得

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/remove/{id}

removes members. should be empty before delete

HTTP Method	Description
POST	:material-check: Create resource	データの送信 (主に新規作成)

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます

/update

add orupdate group details other than members

HTTP Method	Description
POST	:material-check: Create resource	データの送信 (主に新規作成)

▶️ ^^リクエスト^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルリクエストデータ

TBD

◀️ ^^レスポンス^^

パラメータ

名称	型	例	必須	説明
_	_	_	_	説明がここに記述されます。

サンプルレスポンスデータ

{"id":"hogefuga","secret":"abrakadabra"}

!!! 補足

* 最終更新日： 2025/xx/xx

??? フリーメモ

* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます