381 lines
9.1 KiB
Markdown
381 lines
9.1 KiB
Markdown
# /json
|
|
|
|
JSON形式のデータやファイルに関するAPIです。
|
|
|
|
## /data/{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>
|
|
|
|
## /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>
|
|
|
|
## /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>
|
|
|
|
## /ownerlist
|
|
|
|
?
|
|
|
|
| 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>
|
|
|
|
## /remove/{id}
|
|
|
|
remove meta and 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>
|
|
|
|
## /update/{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>
|
|
|
|
## /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>
|