1294 lines
32 KiB
Markdown
1294 lines
32 KiB
Markdown
# /request
|
|
|
|
リクエスト一般に関するAPIです。
|
|
|
|
## /{id}
|
|
|
|
参照。ワイルドカード使用可。
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
|
※GETもPOSTもある様子
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /actionowners
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /actionlist
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /bulkupload
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /clist/exwild
|
|
|
|
参照。_idを使用してSQLのように書ける。
|
|
|
|
| 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>
|
|
|
|
## /clist/exwild/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>
|
|
|
|
## /clist/multiple
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /clist/multiple/filtered
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /clist/wdate
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /clist/wild
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /csv
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## ~~/formpost~~
|
|
|
|
廃止されたAPIです。
|
|
|
|
## /history
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /historylist
|
|
|
|
?
|
|
|
|
| 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: 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>
|
|
|
|
## /masterdata/data/delete_by_key
|
|
|
|
マスターデータ更新（つるや様シフト表で使用）
|
|
|
|
| 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>
|
|
|
|
## /masterdata/data/insert_by_key
|
|
|
|
マスターデータ更新（つるや様シフト表で使用）
|
|
|
|
| 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>
|
|
|
|
## /masterdata/update_by_key
|
|
|
|
マスターデータ更新（つるや様シフト表で使用）
|
|
|
|
| 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>
|
|
|
|
## /metadata/query
|
|
|
|
マスターデータ参照。idをテーブル名とするSQLで検索。
|
|
|
|
| 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>
|
|
|
|
## /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>
|
|
|
|
## /postappend
|
|
|
|
ページ更新。
|
|
|
|
| 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>
|
|
|
|
## ~~/remove~~
|
|
|
|
廃止されたAPIです。
|
|
|
|
## /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>
|
|
|
|
## /report/{templateid}
|
|
|
|
参照。templateidで検索。
|
|
|
|
| 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>
|
|
|
|
## /report/query
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /report/query/filtered
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /reportlist
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /submittedby
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /viewlist
|
|
|
|
?
|
|
|
|
| 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>
|