"/" にファイルをアップロード
This commit is contained in:
parent
ff945f715f
commit
0b4521f640
1293
index17.md
Normal file
1293
index17.md
Normal file
File diff suppressed because it is too large
Load Diff
238
index18.md
Normal file
238
index18.md
Normal file
@ -0,0 +1,238 @@
|
||||
# /scripts
|
||||
|
||||
スクリプトに関するAPIです。
|
||||
|
||||
## /details/{id}
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /execute
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /list
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /pyraw
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /update
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
380
index19.md
Normal file
380
index19.md
Normal file
@ -0,0 +1,380 @@
|
||||
# /user
|
||||
|
||||
ユーザーに関するAPIです。
|
||||
|
||||
## /remove/userid@primaryteant
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: gray; ">?</span> Fetch resource | データの取得 |
|
||||
| `POST` | <span style="color: gray; ">?</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /removebyid/{id}
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /request/formpost
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /request/post
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /request/list
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /selfupdate
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /udetails/{id}
|
||||
|
||||
ユーザーの詳細情報を取得する。 ※現時点ですべての情報を表示するので、絞り込みは今後対応予定。
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /update
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
568
index20.md
Normal file
568
index20.md
Normal file
@ -0,0 +1,568 @@
|
||||
# /usergroup
|
||||
|
||||
ユーザーグループに関するAPIです。
|
||||
|
||||
## /add
|
||||
|
||||
ユーザーグループにメンバーを追加する。
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /adminlist
|
||||
|
||||
get list of groups for admins
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /delete/{id}
|
||||
|
||||
delete a group
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /details/{id}
|
||||
|
||||
get details and members of group
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /list/{id}
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /members/{id}
|
||||
|
||||
グループのメンバーを取得する。
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /members/email/{id}
|
||||
|
||||
グループに所属するユーザーのメールアドレスを取得する。
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /members/multi
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: gray; ">?</span> Fetch resource | データの取得 |
|
||||
| `POST` | <span style="color: gray; ">?</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /mylist
|
||||
|
||||
get my group list.
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /openlist
|
||||
|
||||
?
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /remove/{id}
|
||||
|
||||
removes members. should be empty before delete
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
|
||||
## /update
|
||||
|
||||
add orupdate group details other than members
|
||||
|
||||
| HTTP Method | Description | |
|
||||
| ---------------- | -------------------------------------- | ---------------------------------- |
|
||||
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
||||
|
||||
:arrow_forward: ^^リクエスト^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルリクエストデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
TBD
|
||||
```
|
||||
|
||||
:arrow_backward: ^^レスポンス^^
|
||||
|
||||
パラメータ
|
||||
|
||||
| 名称 | 型 | 例 | 必須 | 説明 |
|
||||
| ---- | --- | --- | --- | --- |
|
||||
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
||||
|
||||
サンプルレスポンスデータ
|
||||
|
||||
``` JSON title="JSON"
|
||||
{"id":"hogefuga","secret":"abrakadabra"}
|
||||
```
|
||||
|
||||
!!! 補足
|
||||
|
||||
* 最終更新日： 2025/xx/xx
|
||||
|
||||
??? フリーメモ
|
||||
|
||||
* エンジニアが共有などのメモを残していくことができるエリアです
|
||||
* 自由なメモを記載できます
|
||||
|
||||
<br>
|
||||
Loading…
Reference in New Issue
Block a user