WFP_API_Document/index10.md

770 lines
20 KiB
Markdown
Raw Permalink Normal View History

# /other
特定のカテゴリに分類されない諸々のAPIです。
## /data/{cmd}/{id}
?
| 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>
## /data/jsonget/{id}
?
| 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>
## /data/jsonset/
?
| 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>
## /data/remove
?
| 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>
## /data/upload
?
| 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>
## /jpn_now
?
| 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>
## /json/{filename}
?
| 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>
## /other/copy_ref_report
?
| 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>
## /other/tenant/list/json/{filename}
?
| 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>
## /pingpong/{counter}
?
| 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>
## /sendmail
?
| 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>
## /sendmail_attached
?
| 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>
## /sscan0/{pattern}
?
| 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>
## /sscan1/{pattern}
?
| 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>
## /utc_now
サーバー時刻の取得
| 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>
## /ws
?
| 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>