Core Resources
コアリソース
最終更新日: 2024年2月21日
形式: PDFとして保存可能
目次
-
コアリソースとは?
-
利用可能なリソース一覧
コアリソースとは?
Expert API における「コアリソース」とは、ページ(Page)、ファイル(File)、ユーザー(User)、グループ(Group) といった、プラットフォーム内で非常に頻繁に使用される基本的なオブジェクトを指します。
これらのリソースは、多くの API エンドポイントの リクエスト/レスポンスのデータ構造 に登場し、XML または JSON において一貫性のある形式で提供されます。このため、API統合において共通のコードで処理しやすい利点があります。
なお、すべてのリソースがコアリソースに分類されるわけではありません。一部の API エンドポイントでは、限定的または特殊なリソースデータを受け取り・返す場合がありますが、それらはこの「コアリソース」には含まれません。
利用可能なリソース
以下のリソースがコアリソースとして Expert API でサポートされています:
-
Group(グループ)
ユーザーを論理的にまとめるためのリソースで、アクセス制御やレポーティングに使用されます。 -
Page(ページ)
サイト構造の中心となるリソース。記事やガイド、カテゴリなどが含まれます。 -
Property(プロパティ)
ページ、ユーザー、サイトなどの拡張メタデータを保持するために使用されるリソース。 -
Security(セキュリティ)
ページやユーザー、その他リソースに対するアクセス権限やロールの情報を含むリソース。 -
User(ユーザー)
サイトに登録されているメンバー、著者、管理者などを表します。