WFP_API_Document/index03.md

# /csv

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

## /{id}

get csv file

| 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>

## /append/

データ追加

| 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>

## /columnize/{id}

?

| 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>

## /data/{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>

## /drop/{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>

## /file/{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>

## /json/{id}

データ表示（JSON形式）

| 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>

## /list

一覧表示

| 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>

## /meta{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>

## /new

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

| 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>

## /ownerlist

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

| 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>

## /update/{id}

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

| 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>

## /update/meta/{id}

メタデータを更新する

| 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>