フォルダ

フォルダ検索

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

Request

パラメータ	内容	デフォルト値	最大値
include_archived	アーカイブされたフォルダも対象にする場合に設定	0
page	ページ	1
per_page	ページ毎の取得数	20	100

パラメータ値例

{
  "include_archived": 1, /* 0, 1 */
  "page": 2,
  "per_page": 50
}

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/folders?include_archived=1&page=2&per_page=50' \
-H 'Authorization: Bearer {アクセストークン}'

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/notes/abcdef/folders?page=2&per_page=50",
    "page": 1,
    "per_page": 50,
    "total": 100
  }
}

フォルダ作成

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

Request

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

パラメータ値例

{
  "name": "フォルダ名",
  "parent_folder_id": 1
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/folders' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "フォルダ名",
    "parent_folder_id": 1
}'

Response

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