WFP_API_Document/index17.md

32 KiB

/request

リクエスト一般に関するAPIです。

/{id}

参照。ワイルドカード使用可。

HTTP Method Description
GET :material-check: Fetch resource データの取得
POST :material-check: Create resource データの送信 (主に新規作成)
※GETもPOSTもある様子

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/actionowners

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/actionlist

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/bulkupload

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/exwild

参照。_idを使用してSQLのように書ける。

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/exwild/id

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/multiple

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/multiple/filtered

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/wdate

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/clist/wild

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/csv

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/formpost

廃止されたAPIです。

/history

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/historylist

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/list

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/masterdata/data/delete_by_key

マスターデータ更新(つるや様シフト表で使用)

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/masterdata/data/insert_by_key

マスターデータ更新(つるや様シフト表で使用)

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/masterdata/update_by_key

マスターデータ更新(つるや様シフト表で使用)

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/metadata/query

マスターデータ参照。idをテーブル名とするSQLで検索。

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/post

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/postappend

ページ更新。

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/remove

廃止されたAPIです。

/removebyid/ {id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/report/{templateid}

参照。templateidで検索。

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/report/query

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/report/query/filtered

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/reportlist

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/submittedby

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/viewlist

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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