Seminar Help Contact us Login Free Trial Document DownloadDocument

タグ

タグ

タグ検索

GET /api/v1/tags HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
page ページ 1
per_page ページ毎の取得数 20 100

パラメータ値例

{
  "page": 1,
  "per_page": 50
}

cURLでのリクエスト例

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

Response

HTTP/1.1 200 OK
{
  "tags": [
    {
      "name": "タグA",
      "page_count": 10,
      "children": [
        {
          "name": "タグA1-1",
          "page_count": 5
        },
        {
          "name": "タグA1-2",
          "page_count": 0
        },
      ]
    },
    {
      "name": "タグB",
      "page_count": 11,
      "children": []
    },
    {
      "name": "タグC",
      "page_count": 12,
      "children": []
    }
  ],
  "meta": {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/tags?page=2&per_page=50",
    "page": 1,
    "per_page": 50,
    "total": 100
  }
}

タグ作成

POST /api/v1/tags HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
name タグ名 ○ 30文字
parent_name 親タグ名 30文字

パラメータ値例

{
  "name": "タグA",
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/tags' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "タグA"
}'

Response

HTTP/1.1 201 Created
{
  "tag": [
    {
      "name": "タグA",
    }
  ],
  "meta": {}
}

タグ削除

DELETE /api/v1/tags HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
name タグ名 ○ 30文字

パラメータ値例

{
  "name": "タグA",
}

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/tags' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "タグA"
}'

Response

HTTP/1.1 204 No Content
Trial Document