Powered by NotePM

API仕様書のサンプル（NotePM API）

Published on 29/12/2021 15:22
  • 14797

概要

NotePM API について仕様を説明します。

ホスト プロトコル バージョン データ形式
notepm.jp https v1 JSON

URL
https://{チームドメイン}.notepm.jp/api/v1
例） https://demo.notepm.jp/api/v1

アクセストークン

全てのAPIリクエストにNotePM内で取得したAPIアクセストークンを Authorizationリクエストヘッダに付与してください。

例
Authorization: Bearer dAu9ceALVbaD6DbApXaAs2y0LRVVLae5rn0Ll9UiV6wtMOBf5thOm6yvPLTTZGbK

ステータスコード

下記のコードを返却します。

ステータスコード 説明
200 リクエスト成功
201 登録成功
204 リクエストに成功したが返却するbodyが存在しない
400 不正なリクエストパラメータを指定している
401 APIアクセストークンが不正、または権限不正
404 存在しないURLにアクセス
429 リクエスト制限を超えている
500 不明なエラー

利用制限

ユーザ毎に1分間に60リクエストまで受け付けます。

決められた制限を超える場合は、429 Too Many Requests が返却されます。

ページ

ページ検索

GET /api/v1/pages HTTP/1.1

Request

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

Response

HTTP/1.1 200 OK
{
  "pages": [
    {
      "page_code": "aaaaad0001",
      "note_code": "abcdef",
      "folder_id": 1
      "title:" "ページのタイトル",
      "body": "ページ本文",
      "created_at": "2020-08-01T10:10:10+09:00",
      "updated_at": "2020-08-01T10:10:10+09:00",
      "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
  }
}

ページ更新

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

Request

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

Response

HTTP/1.1 200 OK
{
  "page":  {
    "page_code": "aaaaad0001",
    "note_code": "abcdef",
    "folder_id": 1
    "title:" "ページのタイトル",
    "body": "ページ本文",
    "created_at": "2020-08-01T10:10:10+09:00",
    "updated_at": "2020-08-01T10:10:10+09:00",
    "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:10+09:00",
        "updated_at": "2020-08-01T10:10:10+09:00"
      }
    ]
  },
  "meta": {
  }

ページ削除

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

Request

なし

Response

HTTP/1.1 204 No Content

　


【おすすめの情報共有ツール】

このテンプレートを表示している、マニュアル作成・ナレッジ管理ツール「NotePM」 は、社員が登録したさまざまなナレッジを蓄積し、強力な検索機能でほしい情報がすぐに見つけられるサービスです。マニュアル、手順書、報告書、ノウハウ、社内FAQ、日報、議事録など、何度も検索するようなストック型の情報管理に便利です。


NotePM公式サイト：https://notepm.jp/
　

Trial Document