From 0b4521f640241b232ded4022704df6ab18cc7fae Mon Sep 17 00:00:00 2001 From: ItAdmin Date: Wed, 22 Apr 2026 05:03:30 +0000 Subject: [PATCH] =?UTF-8?q?"/"=20=E3=81=AB=E3=83=95=E3=82=A1=E3=82=A4?= =?UTF-8?q?=E3=83=AB=E3=82=92=E3=82=A2=E3=83=83=E3=83=97=E3=83=AD=E3=83=BC?= =?UTF-8?q?=E3=83=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index17.md | 1293 ++++++++++++++++++++++++++++++++++++++++++++++++++++ index18.md | 238 ++++++++++ index19.md | 380 +++++++++++++++ index20.md | 568 +++++++++++++++++++++++ 4 files changed, 2479 insertions(+) create mode 100644 index17.md create mode 100644 index18.md create mode 100644 index19.md create mode 100644 index20.md diff --git a/index17.md b/index17.md new file mode 100644 index 0000000..e03e2c8 --- /dev/null +++ b/index17.md @@ -0,0 +1,1293 @@ +# /request + +リクエスト一般に関するAPIです。 + +## /{id} + +参照。ワイルドカード使用可。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | +※GETもPOSTもある様子 + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /actionowners + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /actionlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /bulkupload + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/exwild + +参照。_idを使用してSQLのように書ける。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/exwild/id + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/multiple + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/multiple/filtered + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/wdate + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /clist/wild + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /csv + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## ~~/formpost~~ + +廃止されたAPIです。 + +## /history + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /historylist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /masterdata/data/delete_by_key + +マスターデータ更新（つるや様シフト表で使用） + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /masterdata/data/insert_by_key + +マスターデータ更新（つるや様シフト表で使用） + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /masterdata/update_by_key + +マスターデータ更新（つるや様シフト表で使用） + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /metadata/query + +マスターデータ参照。idをテーブル名とするSQLで検索。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /post + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /postappend + +ページ更新。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## ~~/remove~~ + +廃止されたAPIです。 + +## /removebyid/ {id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /report/{templateid} + +参照。templateidで検索。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /report/query + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /report/query/filtered + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /reportlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /submittedby + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /viewlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index18.md b/index18.md new file mode 100644 index 0000000..187557e --- /dev/null +++ b/index18.md @@ -0,0 +1,238 @@ +# /scripts + +スクリプトに関するAPIです。 + +## /details/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /execute + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /pyraw + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index19.md b/index19.md new file mode 100644 index 0000000..d07ea9b --- /dev/null +++ b/index19.md @@ -0,0 +1,380 @@ +# /user + +ユーザーに関するAPIです。 + +## /remove/userid@primaryteant + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /removebyid/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /request/formpost + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /request/post + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /request/list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /selfupdate + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /udetails/{id} + +ユーザーの詳細情報を取得する。　※現時点ですべての情報を表示するので、絞り込みは今後対応予定。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index20.md b/index20.md new file mode 100644 index 0000000..61bb620 --- /dev/null +++ b/index20.md @@ -0,0 +1,568 @@ +# /usergroup + +ユーザーグループに関するAPIです。 + +## /add + +ユーザーグループにメンバーを追加する。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /adminlist + +get list of groups for admins + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /delete/{id} + +delete a group + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /details/{id} + +get details and members of group + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /members/{id} + +グループのメンバーを取得する。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /members/email/{id} + +グループに所属するユーザーのメールアドレスを取得する。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /members/multi + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /mylist + +get my group list. + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /openlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /remove/{id} + +removes members. should be empty before delete + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update + +add orupdate group details other than members + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +