Seminar Help Contact us Login Free Trial Document DownloadDocument

コメント

コメント

コメント検索

GET /api/v1/comments HTTP/1.1

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,
  "per_page": 50
}

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/comments?q=検索文字列&note_code=abcdef&page_code=abcdef&comment_by=0000000001&page=2&per_page=50' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "comments": [
    {
      "comment_number": 1,
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "body": "コメント内容",
      "created_at": "2020-08-01T10:10:10+09:00",
      "updated_at": "2020-08-01T10:10:10+09:00",
      "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
  }
}

コメント作成

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

Request

パラメータ 内容 必須 デフォルト値 最大値
body コメント本文 ○
user 以下を指定することでコメントの作成者を上書きすることができる
・ユーザーコード（コードの確認はユーザーAPIをご利用ください）
・ユーザー名 		API実行者
created_at 作成日時を上書きすることができる
形式: ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm) 		現時刻

パラメータ値例

{
  "body": "コメント本文",
  "user": "0000000001",  ※ユーザー名の場合は "山田太郎"
  "created_at": "2020-10-10T11:22:33+09:00"
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/pages/{ページコード}/comments' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "body": "コメント本文",
    "user": "0000000001",
    "created_at": "2020-10-10T11:22:33+09:00"
}'

Response

HTTP/1.1 201 OK
{
  "comment": [
    {
      "comment_number": 1,
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "body": "コメント内容",
      "created_at": "2020-10-10T11:22:33+09:00",
      "updated_at": "2020-10-10T11:22:33+09:00",
      "user": {
        "user_code": "0000000001",
        "name": "Aさん"
      }
    }
  ],
  "meta": {
  }
}

コメント更新

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

Request

パラメータ 内容 必須 デフォルト値 最大値
body コメント本文 ○

パラメータ値例

{
  "body": "コメント本文"
}

cURLでのリクエスト例

curl -X PATCH 'https://{チームドメイン}.notepm.jp/api/v1/pages/{ページコード}/comments/{コメント番号}' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "body": "コメント本文"
}'

Response

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

コメント削除

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

Request

パラメータなし

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/pages/{ページコード}/comments/{コメント番号}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content
Trial Document