カテゴリー
リファレンス（REST API v1）
REST API v1
REST API経由でドキュメント機能のリソースにアクセスする方法をご確認いただけます。
Changelog
REST APIの変更履歴一覧です。
Model Specification
スペース スペースは、ドキュメント機能で管理される他のすべてのリソースを包含する、最上位のエンティティです。 フィールド名 タイプ 要件 説明 例 id string Y idはスペースの一意の識別子 "1" channelId string Y channelIdはスペースが属するチャネルの一意の識別子 "1" createdAt number Y createdAtはスペースが作成された日時のエポックミリ秒単位のタイムスタンプ 1704067200000 updatedAt number Y updatedAtはスペースが最後に更新された日時のエポックミリ秒単位のタイムスタンプ 1704067200000 publishState 'published' | 'unpublished' Y publishStateはスペースが公開されているかどうかを決定。「published」のスペースは公開されており、「unpublished」のスペースは公開されていません。 "published" name map<string, string> Y nameはスペースのローカライズされた名前
Blocks Specification
ドキュメントで使用されているリッチテキストコンテンツ形式である、ブロックモデルの詳細をご確認ください。
Articles
IDと言語によって記事を取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/articles/{articleId} Accept - Content-Type application/json Description 記事IDと言語によって、リクエストされた言語の現在のリビジョンから記事を取得 - リクエスト - Query パラメータ 要件 デフォルト タイプ 説明 例 language O - string リクエストされた言語 ko - Body // (empty) - レスポンス type ArticleView = { article: Article articleCategory?: { articleId: string category: Category } author: Author topics: Topic[] } Slugと言語によって記事を取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/articles/${slug} Accept - Content
Articles & Revisions Management
管理APIは、新しい記事やリビジョンを作成したり、既存のコンテンツを修正したりすることができます。
Authors
執筆者を取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/authors/{authorId} Accept - Content-Type application/json Description IDによって執筆者を取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type AuthorView = { author: Author } 執筆者を一括取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/authors/batch Accept - Content-Type application/json Description IDによって複数の執筆者を取得。最大25人まで取得可能です。 - リクエスト - Query パラメータ 要件 デフォルト タイプ 説明 例 ids[] O - string[] 取得する執筆者のID ?ids[]=42&ids[]=37 - Body // (empty) - レスポンス type Auth
Categories
カテゴリーを取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/categories/{categoryId} Accept - Content-Type application/json Description IDによってカテゴリーを取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type CategoryView = { category: Category } Slugによってカテゴリーを取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/categories/${slug} Accept - Content-Type application/json Description Slugによってカテゴリーを取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type CategoryView = { category: Category } カテゴリーを一括取得する プロパテ
Miscellaneous
システムでサポートされている言語を読み込む プロパティ 説明 Method GET Path /open/v1/languages Accept - Content-Type application/json Description ドキュメント機能でサポートされている言語の一覧を表示（現在、33言語をサポート） - リクエスト - Query (empty) - Body // (empty) - レスポンス type AvailableLanguagesView = { languages: Language[] }
Navigation
スペースのフルナビゲーションを読み込む プロパティ 説明 Method GET Path /open/v1/spaces/$me/nav-nodes/$all Accept - Content-Type application/json Description ペースのナビゲーションツリー内にあるすべてのナビゲーションノードを読み込み - リクエスト - Query (empty) - Body // (empty) - レスポンス type NavNodesAllView = { navNodes: NavNode[] } ルートからナビゲーションノードへのパスを読み込む プロパティ 説明 Method GET Path /open/v1/spaces/$me/nav-nodes/{navNodeId}/$path Accept - Content-Type application/json Description ナビゲーションツリーにおいて、ルートから指定されたノード（ノードIDで指定）までのパスを表示 - リクエスト - Query パラメータ 要件 デフォルト タイプ 説明
Revisions
記事IDとリビジョンIDを指定してリビジョンを取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId} Accept - Content-Type application/json Description 記事IDとリビジョンIDで指定された、特定の記事のリビジョンを取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type RevisionView = { revision: Revision author: Author } 記事IDと複数のリビジョンIDを指定しリビジョンを一括取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/articles/{articleId}/revisions/batch Accept - Content-Type application/json Description IDによって記事の複数のリビジョンを取得。一度に最
Spaces
スペースを取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me Accept - Content-Type application/json Description スペースを取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type SpaceView = { space: Space }
Topics
トピックを取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/topics/{topicId} Accept - Content-Type application/json Description IDで指定されたトピックを取得 - リクエスト - Query (empty) - Body // (empty) - レスポンス type TopicView = { topic: Topic } トピックを一括取得する プロパティ 説明 Method GET Path /open/v1/spaces/$me/topics/batch Accept - Content-Type application/json Description IDによって複数のトピックを取得。最大25トピックまで取得可能です。 - リクエスト - Query パラメータ 要件 デフォルト タイプ 説明 例 ids[] O - string[] 取得するトピックのID ?ids[]=42&ids[]=37 - Body // (empty) - レスポンス type