特別タグ用 REST API について

[Yuto Nagano]

検索・登録に使用する特別タグの REST API の仕様を決めます。

API仕様

エントリーポイント (Base):
https://domain/wp-json/dms/v1

GET /special-tags

概要
全てのタグ一覧を取得する

パラメーター
なし

成功時(200)レスポンス

フィールド名	型	説明
id	number	カテゴリーID (表示順を兼ねます)
name	string	カテゴリー名 (e.g. 文書種類、担当者)
tags	tag_object (array)	タグ一覧

タグオブジェクト

フィールド名	型	説明
tag_id	number	タグID
slug	string	スラッグ
name	string	タグ名

PUT /special-tags/{category_id}

概要
カテゴリーを追加・更新する

パラメーター

フィールド名	型	説明
category_id	number	カテゴリーID (表示順を兼ねます)
name	string	カテゴリー名 (e.g. 文書種類、担当者)
tag_ids	number (array)	タグ一覧

DELETE /special-tags/{category_id}

概要
カテゴリーを削除する

パラメーター

フィールド名	型	説明
category_id	number	カテゴリーID