WFP_API_Document/index03.md

15 KiB
Raw Blame History

/csv

CSVに関するAPIです。※Power BI連携を見据えたAPI

/{id}

get csv file

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/append/

データ追加

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/columnize/{id}

?

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/data/{id}

データ表示

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/drop/{id}

ファイル削除

HTTP Method Description
GET :material-check: Fetch 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

??? フリーメモ

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

/json/{id}

データ表示JSON形式

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

??? フリーメモ

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

/new

CSVファイルを新規アップロードする

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/ownerlist

一覧表示owner権限のあるファイル

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

▶️ ^^リクエスト^^

パラメータ

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

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

TBD

◀️ ^^レスポンス^^

パラメータ

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

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

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

!!! 補足

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

??? フリーメモ

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

/update/{id}

すでにアップロードされているCSVファイルを差し替える

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

??? フリーメモ

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