Seminar Help Contact us Login Free Trial Document DownloadDocument

ノート

ノート

ノート検索

GET /api/v1/notes HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
include_archived アーカイブノートを含めるかどうか 0
page ページ 1
per_page ページ毎の取得数 20 100

パラメータ値例

{
  "inculde_archived": 0, /* 0, 1 */
  "page": 1,
  "per_page": 20
}

cURLでのリクエスト例

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

Response

HTTP/1.1 200 OK
{
  "notes": [
    {
      "note_code": "abcdef",
      "name": "ノートの名前",
      "description": "ノートの説明",
      "icon_url": "https://cf.notepm.jp/build/assets/s_icon_notepm-nnnnnnnn.png",
      "archived": false,
      "scope": "open", /* open, private */
      "groups": [
        {
          "name": "役員"
        },
        {
          "name": "エンジニア"
        }
      ],
      "users": [
        {
          "user_code": "0000000001",
          "name": "Aさん",
        },
        {
          "user_code": "0000000002",
          "name": "Bさん",
        }
      ]
    }
  ],
  "meta": {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/notes?inculde_archived=0&page=2&per_page=20",
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

ノート詳細取得

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

Request

パラメータなし

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "note":  {
    "note_code": "abcdef",
    "name": "ノートの名前",
    "description": "ノートの説明",
    "icon_url": "https://cf.notepm.jp/build/assets/s_icon_notepm-nnnnnnnn.png",
    "archived": false,
    "scope": "open", /* open, private */
    "users": [
      {
        "user_code": "0000000001",
        "name": "Aさん",
      }
    ],
    "groups": [
      {
        "name": "グループA",
      }
    ]
  },
  "meta": {
  }
}

ノート作成

POST /api/v1/notes HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
icon ノートに設定するアイコン画像。
BASE64でencodeしたStringを設定する。
name ノート名 ○ 30文字
description ノートの説明 200文字
scope open:チームユーザー全員が参加。
private:個別に参加ユーザーを設定する。 		○
groups scope = privateの時のみ有効。
グループ名の配列を設定する。
users ユーザーコードの配列を設定する。
自分のユーザーコードは設定不要。
scope = openの時、未設定でもチームユーザー全員が参加します。ゲスト権限は個別に招待する必要があります。

パラメータ値例

{
  "icon": "xxxxx", /* BASE64でencodeしたString */
  "name": "ノート名",
  "description": "ノートの説明",
  "scope": "private", /* open, private */
  "groups": [
    "役員", "エンジニア"
  ],
  "users": [
    "0000000001",
    "0000000002"
  ]
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/notes' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "icon": "xxxxx",
    "name": "ノート名",
    "description": "ノートの説明",
    "scope": "private",
    "groups": [
        "役員",
        "エンジニア"
    ],
    "users": [
        "0000000001",
        "0000000002"
    ]
}'

Response

HTTP/1.1 201 Created
{
  "note": [
    {
      "note_code": "abcdef",
      "name": "ノートの名前",
      "description": "ノートの説明",
      "icon_url": "https://cf.notepm.jp/build/assets/s_icon_notepm-nnnnnnnn.png",
      "archived": false,
      "scope": "private",
      "groups": [
        {
          "name": "役員"
        },
        {
          "name": "エンジニア"
        }
      ],
      "users": [
        {
          "user_code": "0000000001"
          "name": "Aさん"
        },
        {
          "user_code": "0000000002"
          "name": "Bさん"
        }
      ],
      "services": []
    }
  ],
  "meta": {
  }
}

ノート更新

PATCH /api/v1/notes/:note_code HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
icon ノートに設定するアイコン画像。
BASE64でencodeしたStringを設定する。
※アイコンを削除する場合は空の値を指定する。
name ノート名 30文字
description ノートの説明 200文字
scope open:チームユーザー全員が参加（ゲスト権限は個別に設定が必要）。
private:個別に参加ユーザーを設定する。
groups scope = privateの時のみ有効。
グループ名の配列を設定する。
※削除する場合は空の値を指定する
users ユーザーコードの配列を設定する。
プライベートノート（またはscope = private）時に指定した場合、groupsまたはusersに自分を含めてください。
オープンノート（またはscope = open）時に指定した場合、ユーザーコード（ゲスト権限）が招待されます。

パラメータ値例

{
  "name": "ノート名",
  "description": "ノートの説明",
  "scope": "open" /* open, private */
}

cURLでのリクエスト例

curl -X PATCH 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "ノート名",
    "description": "ノートの説明",
    "scope": "open"
}'

Response

HTTP/1.1 200 OK
{
  "notes": [
    {
      "note_code": "abcdef",
      "name": "ノートの名前",
      "description": "ノートの説明",
      "icon_url": "https://cf.notepm.jp/build/assets/s_icon_notepm-nnnnnnnn.png",
      "archived": false,
      "scope": "open",
      "groups": [
        {
          "name": "役員"
        },
        {
          "name": "エンジニア"
        }
      ],
      "users": [
        {
          "user_code": "0000000001",
          "name": "Aさん"
        },
        {
          "user_code": "0000000002",
          "name": "Bさん"
        }
      ]
    }
  ],
  "meta": {
  }
}

ノート削除

DELETE /api/v1/notes/:note_code HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

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

Response

HTTP/1.1 204 No Content

アーカイブ

PATCH /api/v1/notes/:note_code/archive HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X PATCH 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/archive' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content

アーカイブ戻し

PATCH /api/v1/notes/:note_code/extract HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X PATCH 'https://{チームドメイン}.notepm.jp/api/v1/notes/{ノートコード}/extract' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content
Trial Document