カテゴリマップ取得 (REST APIリファレンス)/ref_api/record/categories_list

カテゴリマップを取得します。

リクエスト

メソッド

GET

URL

https:////categories//rest_api=1.0/

の指定は任意です。を指定した場合は、対応するカテゴリとその下層に属するサブカテゴリを出力します。

ヘッダー

パラメータ名値
Content-Type application/json

すべてのリソースで共通するリクエストヘッダーの仕様は、こちらをご参照ください。

コンテント

リクエスト例

curl　-v　-X　GET
　　　　　　　-H　"CONTENT-TYPE:　application/json"　
　　　　　　　-H　"X-ECHO-APP-ID:　fd15eacfaf2388fac2980fef163c6116"　
　　　　　　　-H　"X-ECHO-APP-KEY:　0cdf8bc765d7d9604e83becf93137d42"　
　　　　　　　"https://hogehoge.echopf.com/blogs/categories/rest_api=1.0/"

レスポンス

HTTPステータス

ステータスコード内容
200 取得成功

ヘッダー

パラメータ名値
Content-Type application/json

コンテント

カテゴリマップが出力されます。

フィールド名型説明
categories 配列 カテゴリマップ（各要素はカテゴリマップオブジェクト）
カテゴリマップオブジェクト

ツリー構造をとるカテゴリマップは、次に示すように再帰的に表現されます。

フィールド名型説明
カ
テ
ゴ
リ
マ
ッ
プ
オ
ブ
ジ
ェ
ク
ト		カ
テ
ゴ
リ
オ
ブ
ジ
ェ
ク
ト		 refid 文字列 カテゴリID
name 文字列 カテゴリ名
description 文字列 概要
keywords 文字列 キーワード
acl ACLオブジェクト アクセスコントロール (ACL)
children 配列 サブカテゴリマップ（各要素はカテゴリマップオブジェクト）

レスポンス例

{"categories":[
　　{
　　　　"refid":"root_category",
　　　　"name":"ルートカテゴリ",
　　　　"description":"ルートカテゴリです。",
　　　　"keywords":"ルート,カテゴリ",
　　　　"children":[
　　　　　　{
　　　　　　　　"refid":"category_a",
　　　　　　　　"name":"カテゴリA",
　　　　　　　　"description":"カテゴリAです。",
　　　　　　　　"keywords":"カテゴリ,A",
　　　　　　　　"children":[],
　　　　　　　　"acl":{
　　　　　　　　　　"*"　{
　　　　　　　　　　　　"list":true,
　　　　　　　　　　　　"edit":true,
　　　　　　　　　　　　"delete":true
　　　　　　　　　　}
　　　　　　　　}
　　　　　　},
　　　　　　{
　　　　　　　　"refid":"category_b",
　　　　　　　　"name":"カテゴリB",
　　　　　　　　"description":"カテゴリBです。",
　　　　　　　　"keywords":"カテゴリ,B",
　　　　　　　　"children":[],
　　　　　　　　"acl":{
　　　　　　　　　　"*"　{
　　　　　　　　　　　　"list":true,
　　　　　　　　　　　　"edit":true,
　　　　　　　　　　　　"delete":true
　　　　　　　　　　}
　　　　　　　　}
　　　　　　}
　　　　],
　　　　"acl":{
　　　　　　"*"　{
　　　　　　　　"list":true,
　　　　　　　　"edit":true,
　　　　　　　　"delete":true
　　　　　　}
　　　　}
　　}
]}