ページ

ページ

ページ検索

GET /api/v1/pages HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
q 検索する文字列を設定
include_archived アーカイブされたノートも対象にする場合に設定 false
note_code 検索するノートのコードを設定
tag_name 検索するタグ名を設定
created 作成者で絞り込む場合に設定
page ページ 1
per_page ページ毎の取得数 20 100
{
  "q": "検索文字列",
  "include_archived": true,
  "note_code": "abcdef",
  "tag_name": "タグ名",
  "created": "0000000001",
  "page": 2,
  "page": 50
}
Copy

Response

HTTP/1.1 200 OK
{
  "pages": [
    {
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "folder_id": 1
      "title:" "ページのタイトル",
      "body": "ページ本文",
      "created_at": "2020-08-01T10:10:10Z",
      "updated_at": "2020-08-01T10:10:10Z",
      "created_by": {
        "user_code": "0000000001",
        "name": "Aさん"
      },
      "updated_by": {
        "user_code": "0000000001",
        "name": "Aさん"
      },
      "tags": [
        {
          "name": "タグA"
        },
        {
          "name": "タグB"
        }
      ]
    }
  ],
  "meta": {
    "previous_page": "https://projectmode.notepm.jp/api/v1/pages?page=1&per_page=50",
    "next_page": "https://projectmode.notepm.jp/api/v1/notes?pages=3&per_page=50",
    "page": 2,
    "per_page": 50,
    "total": 500
  }
}
Copy

ページ作成

POST /api/v1/pages HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
note_code ノートコード
folder_id フォルダID
title ページタイトル 100文字
body ページ本文
memo 変更履歴メモ
通知や変更履歴に表示される
255文字
tags タグ名を配列で設定
user 以下を指定することでページの作成者を上書きすることができる
・ユーザーコード(コードの確認はユーザーAPIをご利用くださいをご利用ください)
・ユーザー名
・NotePM-bot
API実行者
created_at 作成日時を上書きすることができる
(ISO-8601)
現時刻
{
  "note_code": "abcdef",
  "folder_id": 1,
  "title": "ページのタイトル",
  "body": "ページの本文",
  "memo": "新規作成しました。",
  "tags": [
    "タグA", "タグB"
  ],
  "user": "0000000001",  ※ユーザー名の場合は「山田太郎」、NotePM-botの場合は「NotePM-bot」
  "created_at": "2020-10-10 11:22:33"
}
Copy

Response

HTTP/1.1 201 OK
{
  "page":  {
    "page_code": "aaaaad0001",
    "note_code": "abcdef",
    "folder_id": 1
    "title:" "ページのタイトル",
    "body": "ページ本文",
    "created_at": "2020-08-01T10:10:10Z",
    "updated_at": "2020-08-01T10:10:10Z"
    "created_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "updated_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "tags": [
      {
        "name": "タグA",
      },
      {
        "name": "タグB",
      }
    ]
  },
  "meta": {
  }
}
Copy

ページ詳細取得

GET /api/v1/pages/:page_code HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
なし
Copy

Response

HTTP/1.1 200 OK
{
  "page":  {
    "page_code": "aaaaad0001",
    "note_code": "abcdef",
    "folder_id": 1
    "title:" "ページのタイトル",
    "body": "ページ本文",
    "created_at": "2020-08-01T10:10:10Z",
    "updated_at": "2020-08-01T10:10:10Z",
    "created_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "updated_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "tags": [
      {
        "name": "タグA"
      },
      {
        "name": "タグB"
      }
    ]
  },
  "meta": {
  }
Copy

ページ更新

PATCH /api/v1/pages/:page_code HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
note_code ノートコード
folder_id フォルダID
title ページタイトル 100文字
body ページ本文
memo 変更履歴メモ
通知や変更履歴に表示される
255文字
tags タグ名を配列で設定
タグを削除する場合は空を指定
{
  "note_code": "abcdef",
  "folder_id": 1
  "title": "ページのタイトル",
  "body": "ページの本文",
  "memo": "新規作成しました。",
  "tags": [
    "タグA", "タグB"
  ]
}
Copy

Response

HTTP/1.1 200 OK
{
  "page":  {
    "page_code": "aaaaad0001",
    "note_code": "abcdef",
    "folder_id": 1
    "title:" "ページのタイトル",
    "body": "ページ本文",
    "created_at": "2020-08-01T10:10:10Z",
    "updated_at": "2020-08-01T10:10:10Z",
    "created_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "updated_by": {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    "tags": [
      {
        "name": "タグA"
      }
    ],
    "comments": [
      {
        "comment": "コメント",
        "user_code": "0000000001",
        "name": "Aさん",
        "created_at": "2020-08-01T10:10:10Z",
        "updated_at": "2020-08-01T10:10:10Z"
      }
    ]
  },
  "meta": {
  }
Copy

ページ削除

DELETE /api/v1/pages/:page_code HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
なし
Copy

Response

HTTP/1.1 204 No Content
Copy