コメント

コメント

コメント検索

GET /api/v1/comments HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
q 検索する文字列を設定
note_code 検索するノートのコードを設定
page_code 検索するページのコードを設定
comment_by コメントしたユーザーコード
page ページ 1
per_page ページ毎の取得数 20 100
{
  "q": "検索文字列",
  "note_code": "abcdef",
  "page_code": "abcdef",
  "comment_by": "0000000001",
  "page": 2,
  "page": 50
}
Copy

Response

HTTP/1.1 200 OK
{
  "comments": [
    {
      "comment_number": 1,
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "body": "コメント内容",
      "created_at": "2020-08-01T10:10:10Z",
      "updated_at": "2020-08-01T10:10:10Z",
      "user": {
        "user_code": "0000000001",
        "name": "Aさん",
      }
    }
  ],
  "meta": {
    "previous_page": "https://projectmode.notepm.jp/api/v1/comments?q=&include_archived=1&note_code=abcdef&&comment_by=0000000001&page=1&per_page=50",
    "next_page": "https://projectmode.notepm.jp/api/v1/comments?q=&include_archived=1&note_code=abcdef&comment_by=0000000001&page=3&per_page=50",
    "page": 2,
    "per_page": 50,
    "total": 500
  }
}

Copy

コメント作成

POST /api/v1/pages/:page_code/comments HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
body コメント本文
{
  "body": "コメント本文",
}
Copy

Response

HTTP/1.1 201 OK
{
  "comment": [
    {
      "comment_number": 1,
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "body": "コメント内容",
      "created_at": "2020-08-01T10:10:10Z",
      "updated_at": "2020-08-01T10:10:10Z",
      "user": {
        "user_code": "0000000001",
        "name": "Aさん"
      }
    }
  ],
  "meta": {
  }
}
Copy

コメント更新

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

Request

パラメータ 内容 必須 デフォルト値 最大値
body コメント本文
{
  "body": "コメント本文"
}
Copy

Response

HTTP/1.1 200 OK
{
  "comments": [
    {
      "comment_number": 1,
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "body": "コメント内容",
      "created_at": "2020-08-01T10:10:10Z",
      "updated_at": "2020-08-01T10:10:10Z",
      "user": {
        "user_code": "0000000001",
        "name": "Aさん"
      }
    }
  ],
  "meta": {
  }
}
Copy

コメント削除

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

Request

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

Response

HTTP/1.1 204 No Content
Copy