フォルダ

フォルダ

フォルダ検索

GET /api/v1/notes/:note_code/folders HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
page ページ 1
per_page ページ毎の取得数 20 100
{
  "page": 2,
  "page": 50
}
Copy

Response

HTTP/1.1 200 OK
{
  "folders": [
    {
      "folder_id": 1,
      "name": "フォルダA",
      "parent_folder_id": null
    },
    {
      "folder_id": 2,
      "name": "フォルダA-A",
      "parent_folder_id": 1
    },
    {
      "folder_id": 3,
      "name": "フォルダA-B",
      "parent_folder_id": 1
    },
    {
      "folder_id": 4,
      "name": "フォルダA-B-A",
      "parent_folder_id": 3
    },
    {
      "folder_id": 5,
      "name": "フォルダB",
      "parent_folder_id": null
    }
  ],
  "meta": {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/attachments?q=検索文字列&include_archived=1&file_name=image&note_code=abcdef&page_code=aaaaad0001&page=2&per_ page=50",
    "page": 1,
    "per_page": 50,
    "total": 100
  }
}
Copy

フォルダ作成

POST /api/v1/notes/:note_code/folders HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
name フォルダ名 20文字
parent_folder_id 親フォルダID
指定が無い場合はノート直下に作成する
{
  "name": "フォルダ名"
  "parent_folder_id": 1
}

Copy

Response

HTTP/1.1 201 OK
{
  "folder": {
    "folder_id": 2,
    "name": "フォルダ名",
    "parent_folder_id": 1
  }
  "meta": {
  }
}
Copy