WFP_API_Document/index07.md

9.1 KiB

/json

JSON形式のデータやファイルに関するAPIです。

/data/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/file/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/list

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/meta/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/ownerlist

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/remove/{id}

remove meta and file

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/update/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/update/meta/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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