Confluence Cloud REST API におけるアプリのアクセス

アプリ アクセス ルールのデータ ブロックはアーリー アクセス機能であり、変更される可能性があります。アーリー アクセス プログラム (EAP) の参加者のみが利用できます。

このドキュメントは作成中であり、アトラシアンにより近日中に更新予定です。

概要

アプリ アクセス ルールは、Confluence Cloud でアプリが読み書きできる情報を制御します。既定では、インストールされているアプリはどの Confluence スペースのデータにもアクセスできます。Confluence 管理者と組織管理者は、Confluence 全体または特定のスペースでアプリ アクセスをブロックすることを選択できます。

アプリは REST API を使用して、Confluence スペース内のデータとスペース内のコンテンツを読み書きします。API がアプリ アクセス ルールによってブロックされた場合、組織管理者は、アプリによるそのコンテンツへのアクセス、または選択したスペースでのそのアクションの実行を許可またはブロックできます。

アプリ アクセス ルールでブロックされていない API を使用すると、管理者がアプリ アクセスをブロックするよう決定した場合でも、アプリはスペース内の任意のスペースまたはコンテンツを読み書きできます。

注: アプリがスペースからブロックされると、スペース内のあらゆるオブジェクトに対して読み書きができなくなりますが、スペース レベルのデータを読み書きすることはできます。

このドキュメントで使用する用語

用語

定義

上位

左側のナビゲーション コンテンツ ツリーの "親" ページや、"子" コメントの返信先の "親" コメントなど、あるコンテンツのすぐ上にあるコンテンツ。

匿名ユーザー

Confluence にログインしていないユーザー。既定では、このようなユーザーはスペースやコンテンツにアクセスできません。しかし、管理者は匿名ユーザーに権限を与えることができます。

API

アプリ プログラミング インターフェースにより、アプリは Confluence にアクセスして情報の読み取り、書き込み、削除ができます。

添付ファイル

Confluence にアップロードされた画像や文書などのファイル。

監査ログ

Confluence サイトに加えられた変更のリスト。変更したユーザーや変更日時のデータを含みます。

監査ログの作成、表示には、Confluence のグローバル管理者権限が必要です。

バイナリ データ

画像などの添付ファイルに含まれるファイル データ。

ブログ投稿

スペースのブログに投稿されたコンテンツ。

本文テキスト

コンテンツに含まれるテキストとスタイル。

子コンテンツ

別のコンテンツに含まれている、または表示されるすべてのコンテンツ。

  • ページの場合は、コンテンツ ツリーの下にあるページ、コメント、添付ファイルが含まれます。

  • ブログ投稿の場合は、コメントと添付ファイルが含まれます。

  • 添付ファイルの場合は、コメントが含まれます。

  • コメントの場合は、添付ファイルが含まれます。

コメント、フッター

ページの下部に記載されたコメント。

インライン コメント

ページ本文の特定の場所に記載されたコメント。

Confluence クエリ言語 (CQL)

Confluence を検索する方法。複数のパラメーターと検索文字列を使用できます。

コンテンツ

Confluence スペース内のページ、ブログ投稿、インライン コメント、フッター コメント、添付ファイル、カスタムコンテンツの総称。

コンテンツの状態

コンテンツには、次の 3 つの状態があります。

  • 現在: Confluence で表示可能なライブ ページまたはブログ投稿。

  • 下書き: 自動保存または未公開の下書きで、Confluence ではこれを作成したユーザーまたはコラボレーターと共有したユーザーのみが閲覧できます。

  • アーカイブ済み: アーカイブに移動されたページまたはブログ投稿。

カスタム コンテンツ

Confluence に新しい機能を追加するためにアプリによって作成、制御される特殊なコンテンツ。例としては、マクロの添付ファイルやフォームがあります。

動的モジュール

Confluence で特定のコードを実行できるようにする、アプリ開発者向け機能

グループ

権限をまとめて付与できるユーザーの集まり。

ID

Confluecne がコンテンツ、ラベル、ユーザー、またはグループを一意に識別するために使用する文字のセット。

インライン タスク

タスクをご参照ください。

ラベル

コンテンツの検索とフィルタリングに使用されるユーザー生成タグ。

長時間実行タスク

ユーザーが他のことをしている間に、Confluence によってバックグラウンドで実行される操作。一般的な例は、複数のページをあるスペースから別のスペースに移動するなどです。

マクロ本文

マクロ内のテキストまたはその他のコンテンツ。

たとえば、Expand マクロには、ユーザーがクリックしたときにのみ表示されるテキストが含まれています。

運用

ユーザーまたは API がコンテンツまたはスペースに対して実行する権限を持てるアクション。例としては、作成、読み取り、コピー、移動、削除などがあります。

ページ

ID で識別される Confluence スペース内のコンテンツの一部。すべてのページはスペースの中に含まれています。ページには、テキスト、スタイル、添付ファイル、制限、マクロを含めることができます。

関連コンテンツは、ナビゲーションのコンテンツの「上」にあります。親を使用して、関連コンテンツを整理します。

  • ページの場合、親ページは左側のナビゲーション コンテンツ ツリーの子ページの上に表示されます。子ページには少しだけインデントされています。

  • フッター コメントの場合の親は、コメントの返信先のコメントです。子フッターのコメントは少しだけインデントされています。

  • インライン コメントの場合の親は、コメントの返信先のコメントです。子のインライン コメントは、親と同じポップアップに表示されます。

権限

権限には 3 つのレベルがあります。

  • グローバル: サイト全体の権限。

  • スペース: スペース内のコンテンツを閲覧、追加、編集、削除する権限。ユーザー、グループ、匿名ユーザーに適用されます。

  • ページとブログ投稿: 既定で、スペースにアクセスできるユーザーとグループはすべてのページを閲覧、編集できます。ユーザーは制限を追加して特定のページを保護できます。

個人を特定できる情報 (PII)

特定の人物に関する情報。ユーザーの名前、メール アドレス、プロファイル写真、その他の PII を Confluence アカウントに含められます。

ユーザーは自分のアカウントのプライバシーを設定して、PII へのアクセスをブロックできます。

管理者がユーザーに代わってプライバシー設定を行い、PII へのアクセスをブロックすることもできます。

プレフィックス

ラベルにフィルタリング オプションが追加されました。

  • グローバル: ラベルは Confluence サイトのすべてのスペースで使用できます。ユーザーがラベルを作成すると既定で追加されます。

  • my: ユーザーによって適用される (たとえば、"my: new-label" というラベルを作成する)、またはページにお気に入りのラベルを付けると適用される ("my: favorite" となる) プレフィックス。

  • チーム: チーム固有のラベルに適用されるプレフィックス。

プロパティ

API でアクセスできるページ、ブログ投稿、スペースに関するデータ。ユーザーの個人データや機密の設定データを含めないようにしてください。

プライバシー設定

ユーザーのプライバシー設定により、名前、メール アドレス、プロファイル写真などの個人を特定できる情報への API アクセスを制限できます。

管理者はユーザーに代わってプライバシー設定を行い、この情報へのアクセスをグローバルに制限することができます。

スペースのごみ箱から削除したページを完全に削除し、

削除権限を持つユーザーは、ページやその他のコンテンツをゴミ箱に移動できます。スペース管理者はさらに一歩進んで、Confluence からコンテンツを完全削除できます。

関係

ユーザー、スペース、コンテンツの間に関係が存在する場合があります。ユーザーとコンテンツの間には、既定で「お気に入り」の関係が存在します。ユーザーとアプリは、カスタム名で新しい関係を作成できます。

制限

ページやブログ投稿に適用される設定で、ユーザーやグループがそのスペースの閲覧権限を持っていても閲覧できないようにします。

スペース

Confluence でコンテンツを ID で識別される意味のあるカテゴリ別に整理する方法です。スペースにはユーザーまたはグループを許可またはブロックする権限を設定でき、ユーザーは特定のスペースの管理者になることができます。

タスク

ユーザーに割り当てられたアクション アイテム。

V1 API のインライン タスクとも呼ばれます。

ユーザー

Confluence のユーザーは ID で識別されます。ユーザーは特定のスペースにアクセスする権限を持つことができ、グループに属することもできます。

user プロパティ

アプリ内に保存された特定のユーザーの情報。ユーザー プロパティにアクセスできるのは、そのアプリ本体のみです。他のアプリやその他のユーザーは利用できません。

アプリのアクセス ルールが適用されるとブロックする

管理者がアプリ アクセス ルールを有効にしても、これらの API はブロックされます。これらの API を使用しているアプリは、コンテンツへのアクセスや下記アクションの実行ができなくなります。

DEPRECATED タグが付いたバージョン 1 API は、対応する 1 つ以上のバージョン 2 API に置き換えられました。古いアプリの中にはまだバージョン 1 API を使用しているものもありますが、新しいアプリは別の新しいバージョンを使用します。

アナリティクス API (バージョン 1)

名前

説明

API ドキュメント リンク

ビューを取得

ID を指定することにより、コンテンツの視聴回数の合計を返します。これには、ページ、ブログ投稿、コメント、添付ファイル、カスタム コンテンツが含まれます。

GET - ビューを取得

ビューアーを取得

コンテンツを視聴した個別ビューアーの総数を返します。

GET - ビューアーを取得

上位要素 API (バージョン 2)

名前

説明

API ドキュメント リンク

ページの祖先をすべて取得

特定のページの「親ページ」を含む祖先を上から順に返します。ページの祖先とは、そのページの親ページと親ページの親です。この API は、コンテンツ ツリーのずっと上にある親のページ ID を返します。

GET - ページの祖先をすべて取得

添付ファイル API (バージョン 2)

添付ファイルとは、ユーザーが Confluence にアップロードした画像や文書などのファイルです。添付ファイルは、ページ、ブログ投稿、ラベル、カスタム コンテンツに使用できます。

名前

説明

API ドキュメント リンク

添付ファイルを取得

コンテンツのすべてのコメントを返します。

GET - 添付ファイルを取得

ID で添付ファイルを取得

指定された添付ファイルを返します。

GET - ID で添付ファイルを取得

添付ファイルを削除

添付ファイルを削除します。

DEL - 添付ファイルを削除

ブログ投稿の添付ファイルを取得

指定されたブログ投稿のすべての添付ファイルを返します。

GET - ブログ投稿の添付ファイルを取得

カスタム コンテンツの添付ファイルを取得

指定されたカスタム コンテンツのすべての添付ファイルを返します。

GET - カスタム コンテンツの添付ファイルを取得

ラベルの添付ファイルを取得

指定されたラベルのすべての添付ファイルを返します。

GET - ラベルの添付ファイルを取得

ページの添付ファイルを取得

指定されたページのすべての添付ファイルを返します。

GET - ページの添付ファイルを取得

ブログ投稿 API (バージョン 2)

名前

説明

API ドキュメント リンク

ブログ投稿を取得

すべてのブログ投稿を返します。

GET - ブログ投稿を取得

ブログ投稿を作成

指定されたスペースに新しいブログ投稿を作成します。

POST - ブログ投稿を作成

ID でブログ投稿を取得

指定されたブログ投稿を返します。

GET - ID でブログ投稿を取得

ブログ投稿を更新

指定されたブログ投稿を更新します。

PUT - ブログ投稿を更新

ブログ投稿を削除

指定されたブログ投稿を削除します。

DEL - ブログ投稿を削除

ラベルのブログ投稿を取得

特定のラベルの付いたすべてのブログ投稿を返します。

GET - ラベルのブログ投稿を取得

スペースでブログ投稿を取得

指定されたスペースのすべてのブログ投稿を返します。

GET - スペースでブログ投稿を取得

子 API (バージョン 2)

名前

説明

API ドキュメント リンク

子ページを取得

指定されたスペースのすべての子ページを返します。

GET - 子ページを取得

子カスタム コンテンツを取得

特定のカスタム コンテンツのすべての子カスタム コンテンツ アイテムを返します。

カスタム コンテンツとは、Confluence に新しい機能を追加するためにアプリによって作成、制御される特殊なコンテンツです。詳細は、「カスタム コンテンツ」をご確認ください。

GET - 子カスタム コンテンツを取得

コメント API (バージョン 2)

名前

説明

API ドキュメント リンク

ページのフッター コメントを取得

特定のページの下部に表示される第 1 レベルのコメント (親コメントとも呼ばれます) を返しますが、返信 (子コメント) は返しません。

GET - ページのフッター コメントを取得

ページのインライン コメントを取得

特定のページの親インライン コメント (ページ上の特定の場所に残されたコメント) を返信なしで返します。

GET - ページのインライン コメントを取得

ブログ投稿のフッター コメントを取得

特定のブログ投稿からの親フッター コメントを返信なしで返します。

GET - ブログ投稿のフッター コメントを取得

ブログ投稿のインライン コメントを取得

特定のブログ投稿にある親のインライン コメントを返信なしで返します。

GET - ブログ投稿のインライン コメントを取得

フッター コメントを取得

親のコメントや返信を含めて、特定のページの下部にあるすべてのコメントを返します。

GET - フッター コメントを取得

フッター コメントを作成

指定されたページの下部に新しいコメントを作成します。

POST - フッター コメントを作成

ID でフッター コメントを取得

ID を指定して特定のコメントを返します。

GET - ID でフッター コメントを取得

フッター コメントを更新

ID で指定されたコメントの本文を更新します。

PUT - フッター コメントを更新

フッター コメントを削除

ID で指定されたコメントを削除します。

DEL - フッター コメントを削除

子フッター コメントを取得

ID で指定されたコメントの子コメントを返します。

GET - 子フッター コメントを取得

インライン コメントを取得

特定のページにあるすべてのインライン コメントを返します。

GET - インライン コメントを取得

インライン コメントを作成

指定されたページの指定された場所に新しいインライン コメントを作成します。

POST - インライン コメントを作成

ID でインライン コメントを取得

ID で指定されたインライン コメントを返します。

GET - ID でインライン コメントを取得

インライン コメントを更新

ID で指定されたインライン コメントの本文を更新します。

PUT - インライン コメントを更新

インライン コメントを削除

ID で指定されたインライン コメントを削除します。

DEL - インライン コメントを削除

子インライン コメントを取得

ID で指定されたコメントの子インライン コメントを返します。

GET - 子インライン コメントを取得

コンテンツ API (バージョン 1)

名前

説明

API ドキュメント リンク

Confluence からすべてのコンテンツを取得

DEPRECATED

Confluence インスタンスからすべてのコンテンツを返します。

コンテンツを取得

新しいコンテンツを作成

DEPRECATED

新しいコンテンツを作成するか、以前に作成した下書きを公開します。

POST - コンテンツを作成

ページをアーカイブする

 

ページをアーカイブに移動するタスクを開始します。進行中のアーカイブ タスクを監視できるように ID が返されます。

POST - ページをアーカイブ

共有下書きを公開

ページの共有下書きを公開します。

PUT - 共有下書きを公開

従来の下書きを公開

従来の下書き方式を使用して下書きを公開します。共有下書き方式に置き換わる予定です。

POST - 従来の下書きを公開

CQL でコンテンツを検索

Confluence クエリ言語 (CQL) を使用して開始された検索リクエストを返します。

GET - CQL でコンテンツを検索

ID でコンテンツを取得

DEPRECATED

ID を送信して特定のコンテンツを返します。これには本文と添付ファイルだけでなく、コンテンツの属性も含めることができます。子コンテンツを返すこともできます。

GET - ID でコンテンツを取得

コンテンツを更新

DEPRECATED

タイトル、本文、ステータス、親ページ、その他のプロパティを変更して、特定のコンテンツを更新します。

PUT - コンテンツを更新

コンテンツを削除

DEPRECATED

ページ、ブログ投稿、添付ファイルなどのコンテンツをスペースのゴミ箱に移動します。そのコンテンツがすでにゴミ箱に入っている場合は、完全削除されます。コメントは、ゴミ箱に移動する前にそのまま完全削除されます。

スペース管理者は完全削除されたコンテンツを復元できません。

DEL - コンテンツを削除

コンテンツ履歴を取得

DEPRECATED

コンテンツの最新の更新を返します。

コンテンツの最新の更新を返します。

コンテンツ API (バージョン 2)

名前

説明

API ドキュメント リンク

コンテンツ ID をコンテンツ タイプに変換

コンテンツ ID のリストをそれぞれ関連するコンテンツ タイプに変換します。

POST コンテンツ ID をコンテンツ タイプに変換

コンテンツ - 添付ファイル API (バージョン 1)

名前

説明

API ドキュメント リンク

添付ファイルを取得

DEPRECATED

コンテンツのすべてのコメントを返します。

POST - 添付ファイルを作成

添付ファイルを作成または更新

コンテンツに新しい添付ファイルを追加するか、既存の添付ファイルを新しいバージョンで更新します。

PUT - 添付ファイル プロパティを更新

添付ファイルの作成

コンテンツに新しい添付ファイルを追加します。

POST - 添付ファイルを作成

添付ファイル プロパティを更新

添付ファイルを、新しい文字列、オブジェクト、コンテナ、またはその他のプロパティで更新します。

PUT - 添付ファイル プロパティを更新

添付ファイル データを更新

テキスト文字列やバイナリ ファイルなど、添付ファイルのデータを更新します。

POST - 添付ファイル データを更新

添付ファイルのダウンロード URI を取得

添付ファイルの Web アドレスを返します。

GET - 添付ファイルのダウンロード URI を取得

コンテンツ - 本文 API (バージョン 1)

名前

説明

API ドキュメント リンク

コンテンツ本文を変換

特定のコンテンツの本文を新しい形式に変換します。保存されているコンテンツにアクセスして、表示モードまたは編集モードで表示する際に使用できます。使用例には、アプリがこの API を使用して、カスタム アプリのコンテンツを PDF エクスポート機能に対応した形式に変換するなどがあります。

POST コンテンツ本文を変換

コンテンツ本文を非同期的に変換

特定のコンテンツの本文を新しい形式に非同期で変換します。5 分間結果を取得するために使用できる非同期 ID を返します。

POST コンテンツ本文を非同期的に変換

コンテンツ - 子と子孫 API (バージョン 1)

子コンテンツ (子孫とも呼ばれます) とは、別のコンテンツに含まれる次のようなコンテンツを指します。

  • ページの場合は、コンテンツ ツリーの下にあるページ、コメント、添付ファイルが含まれます。

  • ブログ投稿の場合は、コメントと添付ファイルが含まれます。

  • 添付ファイルの場合は、コメントが含まれます。

  • コメントの場合は、添付ファイルが含まれます。

名前

説明

API ドキュメント リンク

コンテンツの子を取得

DEPRECATED

特定のコンテンツのすべての子コンテンツのリストを返します。

GET - 添付ファイルを取得

ターゲット ページを基準として新しい場所にページを移動

ページをコンテンツ ツリーの別の位置に移動します。新しい親を指定することも、別の子ページを基準にした新しい順序を指定することもできます。

PUT ターゲット ページを基準として新しい場所にページを移動

コンテンツの子をタイプ別に取得

コンテンツのすべての子を返します。子ページ、コメント、または添付ファイルのみを指定できます。

GET コンテンツの子をタイプ別に取得

コンテンツの子孫を取得

特定のコンテンツのすべての "子コンテンツ" (すべてのレベルのコンテンツ) のリストを返します。

GET コンテンツの子孫を取得

コンテンツの子孫をタイプ別に取得

すべてのレベルのコンテンツを含め、コンテンツのすべての子コンテンツを返します。子ページ、子コメント、子添付ファイル、または子カスタム コンテンツのみを指定できます。

GET コンテンツの子孫をタイプ別に取得

ページ階層のコピー

階層内のページとその下にあるすべてのコンテンツを新しい親ページにコピーします。

  • 添付ファイル、権限、プロパティ、ラベル、カスタム コンテンツ、子孫をコピーするかどうかを指定するオプションが含まれています。

  • プレフィックスまたは検索と置換を使用してページ タイトルを更新するオプションが含まれています。

POST ページ階層をコピー

単一ページをコピー

ページを新しいスペースまたは親ページにコピーします。コピーによって既存のページを置き換えることができます。

POST 単一ページをコピー

コンテンツ - コメント API (バージョン 1)

名前

説明

API ドキュメント リンク

コメントを取得

DEPRECATED

コンテンツのすべてのコメントを返します。

GET コンテンツのコメントを取得

コンテンツ - ラベル API (バージョン 1)

ラベルは、コンテンツの検索とフィルタリングに役立つユーザー生成タグです。

名前

説明

API ドキュメント リンク

コンテンツのラベルを取得

DEPRECATED

コンテンツのすべてのラベルを返します。ラベルには、プレフィックス (フィルタリングに使用)、名前、ID、ラベル文字列を含めることができます。

GET コンテンツのラベルを取得

コンテンツにラベルを追加

既存のラベルを削除せずにコンテンツにラベルを追加します。ラベルには、プレフィックス、名前、またはその他の属性が含まれます。

POST コンテンツにラベルを追加

クエリ パラメーターを使用してコンテンツからラベルを削除

ラベルの名前を照会して、コンテンツからラベルを削除します。

DEL クエリ パラメーターを使用してコンテンツからラベルを削除

コンテンツからラベルを削除

ID と削除したいラベルを指定して、コンテンツからラベルを削除します。

DEL コンテンツからラベルを削除

コンテンツ - マクロ本体 API (バージョン 1)

マクロ本文はマクロ内に含まれるテキストやその他のコンテンツです。たとえば、Expand マクロには、ユーザーがクリックしたときにのみ表示されるテキストを含めることができます。

名前

説明

API ドキュメント リンク

マクロ ID 別にマクロ本文を取得

マクロの本文を返します。マクロ本文にはマクロの本文を返すというものもあります。マクロ本文にはタイトルとその他のパラメーターも含まれます。

GET マクロ ID 別にマクロ本文を取得

マクロ ID 別にマクロ本文を取得し、その表現を同期的に変換

マクロ本文を返し、指定した形式にすぐに変換できます。マクロ本文にはタイトルとその他のパラメーターも含まれます。

GET マクロ ID 別にマクロ本文を取得し、その表現を同期的に変換

マクロ ID 別にマクロ本文を取得し、その表現を非同期的に変換

マクロ本文を返し、提供された非同期 ID を使用して 5 分間使用できる、指定した形式に変換できます。マクロ本文にはタイトルとその他のパラメーターも含まれます。

GET マクロ ID 別にマクロ本文を取得し、その表現を非同期的に変換

コンテンツ - 権限 API (バージョン 1)

名前

説明

API ドキュメント リンク

コンテンツ権限を確認

指定したユーザーまたはグループが特定のコンテンツに対して持っている権限を返します。

Confluence 管理者は、ID を指定することで別のユーザーまたはユーザー グループの権限を確認できます。ただし、一般的なユーザーは自分の権限しか確認できません。

POST コンテンツ権限を確認

コンテンツ - プロパティ API (バージョン 1)

プロパティとは、API でアクセスできるページ、ブログ投稿、スペースに関するデータのことです。ユーザーの個人データや機密の設定データを含めないようにしてください。

名前

説明

API ドキュメント リンク

コンテンツ プロパティを取得

DEPRECATED

コンテンツのすべてのプロパティを返します。

GET コンテンツ プロパティを取得

コンテンツ プロパティを作成

DEPRECATED

コンテンツに新しいプロパティを追加します。

POST コンテンツ プロパティを作成

コンテンツ プロパティを取得

DEPRECATED

特定のコンテンツの特定のプロパティを返します。

GET コンテンツ プロパティを取得

コンテンツ プロパティを更新

DEPRECATED

特定のコンテンツの特定のプロパティを更新するか、コンテンツにそのプロパティがまだ存在していない場合は作成します。

PUT コンテンツ プロパティを更新

キーのコンテンツ プロパティを作成

DEPRECATED

リクエスト URL のパスにあるコンテンツ キーを指定して、コンテンツに新しいプロパティを追加します。

POST キーのコンテンツ プロパティを作成

コンテンツ プロパティを削除

DEPRECATED

特定のコンテンツの特定のプロパティを削除します。

DEL コンテンツ プロパティを削除

コンテンツ - プロパティ API (バージョン 2)

名前

説明

API ドキュメント リンク

添付ファイルのコンテンツ プロパティを取得

指定された添付ファイルのすべてのコンテンツ プロパティを返します。

GET 添付ファイルのコンテンツ プロパティを取得

添付ファイルのコンテンツ プロパティを作成

指定された添付ファイルの新しいコンテンツ プロパティを作成します。

POST 添付ファイルのコンテンツ プロパティを作成

添付ファイルのコンテンツ プロパティを ID 別に取得

特定の添付ファイルの特定のコンテンツ プロパティを ID 別に返します。

GET 添付ファイルのコンテンツ プロパティを ID 別に取得

添付ファイルのコンテンツ プロパティを ID 別に更新

特定の添付ファイルの特定のコンテンツ プロパティを ID 別に更新します。

PUT 添付ファイルのコンテンツ プロパティを ID 別に更新

添付ファイルのコンテンツ プロパティを ID 別に削除

特定の添付ファイルの特定のコンテンツ プロパティを ID 別に削除します。

DEL 添付ファイルのコンテンツ プロパティを ID 別に削除

ブログ投稿のコンテンツ プロパティを取得

指定されたブログ投稿のすべてのコンテンツ プロパティを返します。

GET ブログ投稿のコンテンツ プロパティを取得

ブログ投稿のコンテンツ プロパティを作成

指定されたブログ投稿の新しいコンテンツ プロパティを作成します。

POST ブログ投稿のコンテンツ プロパティを作成

ブログ投稿のコンテンツ プロパティを ID 別に取得

特定のブログ投稿の特定のコンテンツ プロパティを ID 別に返します。

GET ブログ投稿のコンテンツ プロパティを ID 別に取得

ブログ投稿のコンテンツ プロパティを ID 別に更新

特定のブログ投稿の特定のコンテンツ プロパティを ID 別に更新します。

PUT ブログ投稿のコンテンツ プロパティを ID 別に更新

ブログ投稿のコンテンツ プロパティを ID 別に削除

特定のブログ投稿の特定のコンテンツ プロパティを ID 別に削除します。

DEL ブログ投稿のコンテンツ プロパティを ID 別に削除

カスタム コンテンツのコンテンツ プロパティを取得

指定されたカスタム コンテンツのすべてのコンテンツ プロパティを返します。

GET カスタム コンテンツのコンテンツ プロパティを取得

カスタム コンテンツのコンテンツ プロパティを作成

指定されたカスタム コンテンツの新しいコンテンツ プロパティを作成します。

POST カスタム コンテンツのコンテンツ プロパティを作成

カスタム コンテンツのコンテンツ プロパティを ID 別に取得

特定のカスタム コンテンツの特定のコンテンツ プロパティを ID 別に返します。

GET カスタム コンテンツのコンテンツ プロパティを ID 別に取得

カスタム コンテンツのコンテンツ プロパティを ID 別に更新

特定のカスタム コンテンツの特定のコンテンツ プロパティを ID 別に更新します。

PUT カスタム コンテンツのコンテンツ プロパティを ID 別に更新

カスタム コンテンツのコンテンツ プロパティを ID 別に削除

特定のカスタム コンテンツの特定のコンテンツ プロパティを ID 別に削除します。

DEL カスタム コンテンツのコンテンツ プロパティを ID 別に削除

ページのコンテンツ プロパティを取得

指定されたページのすべてのコンテンツ プロパティを返します。

GET ページのコンテンツ プロパティを取得

ページのコンテンツ プロパティを作成

指定されたページの新しいコンテンツ プロパティを作成します。

POST ページのコンテンツ プロパティを作成

ページのコンテンツ プロパティを ID 別に取得

特定のページの特定のコンテンツ プロパティを ID 別に返します。

GET ページのコンテンツ プロパティを ID 別に取得

ページのコンテンツ プロパティを ID 別に更新

特定のページの特定のコンテンツ プロパティを ID 別に更新します。

PUT ページのコンテンツ プロパティを ID 別に更新

ページのコンテンツ プロパティを ID 別に削除

特定のページの特定のコンテンツ プロパティを ID 別に削除します。

DEL ページのコンテンツ プロパティを ID 別に削除

コメントのコンテンツ プロパティを取得

指定されたコメントのすべてのコンテンツ プロパティを返します。

GET コメントのコンテンツ プロパティを取得

コメントのコンテンツ プロパティを作成

指定されたコメントの新しいコンテンツ プロパティを作成します。

POST コメントのコンテンツ プロパティを作成

コメントのコンテンツ プロパティを ID 別に取得

特定のコメントの特定のコンテンツ プロパティを ID 別に返します。

GET コメントのコンテンツ プロパティを ID 別に取得

コメントのコンテンツ プロパティを ID 別に更新

特定のコメントの特定のコンテンツ プロパティを ID 別に更新します。

PUT コメントのコンテンツ プロパティを ID 別に更新

コメントのコンテンツ プロパティを ID 別に削除

特定のコメントの特定のコンテンツ プロパティを ID 別に削除します。

DEL コメントのコンテンツ プロパティを ID 別に削除

コンテンツ - 制限 API (バージョン 1)

既定では、その特定のスペースに対する権限を持つすべてのユーザーまたはグループがページとブログ投稿を閲覧、編集、削除できるようになっています。制限とは、スペースにアクセスできるユーザーであっても閲覧、編集、削除できないようにする、ページやブログ投稿に適用されるルールのことです。

名前

説明

API ドキュメント リンク

コンテンツの制限を取得

特定のコンテンツに対する制限を返します。

GET 制限を取得

制限を更新

現在の制限を削除し、リクエストで指定されたものに置き換えることで、コンテンツの制限を更新します。

PUT 制限を更新

コンテンツの制限を追加

現在の制限を置き換えることなく、特定のコンテンツに新しい制限を追加します。

POST 制限を追加

コンテンツの制限を削除

特定のコンテンツからすべての読み取り制限と更新制限を削除します。

DEL 制限を削除

操作ごとに制限を取得

コンテンツに対する制限を返し、結果を操作 (読み取りと更新) ごとに整理します。

GET 操作ごとに制限を取得

操作の制限を取得

特定の操作 (読み取りまたは更新) における特定のコンテンツに対する制限を返します。

GET 操作の制限を取得

グループのコンテンツ制限ステータスを取得

DEPRECATED

指定されたグループの指定されたコンテンツに対する制限を返します。このリクエストはコンテンツ自体の権限に関するものですが、スペース、アカウント、または製品アクセスから継承された権限に関するものではないことに注意してください。

GET グループのコンテンツ制限ステータスを取得

コンテンツ制限にグループを追加

DEPRECATED

特定のグループの権限をコンテンツに追加または更新します。

PUT コンテンツ制限にグループを追加

コンテンツ制限からグループを削除

DEPRECATED

コンテンツ制限からグループを削除します。

PUT コンテンツ制限にグループを追加

グループのコンテンツ制限ステータスを取得

特定のグループが特定のコンテンツに対する権限を持っているかどうかを返します。このリクエストはコンテンツ自体の権限に関するものですが、スペース、アカウント、または製品アクセスから継承された権限に関するものではないことに注意してください。

GET グループのコンテンツ制限ステータスを取得

コンテンツ制限にグループを追加

特定のコンテンツの制限 (読み取りまたは更新) にグループを追加します。

PUT コンテンツ制限にグループを追加

コンテンツ制限からグループを削除

特定のコンテンツからグループの制限 (読み取りまたは更新) を削除します。

DEL コンテンツ制限からグループを削除

ユーザーのコンテンツ制限ステータスを取得

特定のコンテンツについて、特定のユーザーにコンテンツ制限が適用されているかどうかを返します。このリクエストはコンテンツ自体の権限に関するものですが、スペース、アカウント、または製品アクセスから継承された権限に関するものではないことに注意してください。

GET ユーザーのコンテンツ制限ステータスを取得

コンテンツ制限にユーザーを追加

特定のコンテンツに対する読み取り権限または更新権限をユーザーに付与します。

PUT コンテンツ制限にユーザーを追加

コンテンツ制限からユーザーを削除

特定のコンテンツからユーザーの読み取り制限または更新制限を削除します。

DEL コンテンツ制限からユーザーを削除

コンテンツ - 状態 API (バージョン 1)

コンテンツには、次の 3 つの状態があります。

  • 現在: Confluence で表示可能なライブ ページまたはブログ投稿。

  • 下書き: 自動保存または未公開の下書きで、Confluence ではこれを作成したユーザーまたはコラボレーターと共有したユーザーのみが閲覧できます。

  • アーカイブ済み: アーカイブに移動されたページまたはブログ投稿。

名前

説明

API ドキュメント リンク

コンテンツの状態を取得

特定のコンテンツまたはそのコンテンツの特定の下書きの現在の状態を返します。

GET - コンテンツ状態を取得

コンテンツのコンテンツ状態を設定し、そのコンテンツの新バージョンを公開

特定のコンテンツの現在の状態を設定し、そのコンテンツの新バージョンを新しい状態で作成します。

PUT - コンテンツのコンテンツ状態を設定し、そのコンテンツの新バージョンを公開

コンテンツのコンテンツ状態を削除し、新バージョンを公開

特定のコンテンツの現在の状態を削除し、そのコンテンツの新バージョンを新しい状態で作成します。

DEL - コンテンツのコンテンツ状態を削除し、新バージョンを公開

コンテンツで利用可能なコンテンツ状態を取得

特定のコンテンツに現在設定できる状態をすべて返します。

GET - コンテンツで利用可能なコンテンツ状態を取得

コンテンツのコンテンツ状態を一括設定

複数のコンテンツのドラフト バージョンまたは公開バージョンのコンテンツ状態を設定するプロセスを開始します。

PUT - 多くのコンテンツのコンテンツ状態を一括設定

カスタム コンテンツの状態を取得

特定のユーザーが作成したすべてのカスタム コンテンツの状態を返します。

GET - カスタム コンテンツの状態を取得

コンテンツ状態をコンテンツから一括削除

複数のコンテンツのドラフト バージョンまたは公開バージョンのコンテンツ状態を削除するプロセスを開始します。

POST - コンテンツ状態をコンテンツから一括削除

コンテンツ状態を設定する長時間実行タスクの最新情報を取得

コンテンツ状態を変更するために実行中の一括アクションの現在のステータスを返します。

GET - コンテンツ状態を設定する長時間実行タスクの最新情報を取得

指定されたコンテンツ状態を持つスペースのコンテンツを取得

特定のコンテンツ状態を持つスペースのページを返します。

GET - 指定されたコンテンツ状態を持つスペースのコンテンツを取得

コンテンツ - バージョン (バージョン 1)

名前

説明

API ドキュメント リンク

コンテンツ バージョンを取得

DEPRECATED

特定のコンテンツのすべてのバージョンを、指定された属性と各バージョンのテキスト本文を含めて降順で返します。

GET - コンテンツ バージョンを取得

コンテンツ バージョンを復元

古いバージョンのコンテンツで新しいバージョンを作成して、コンテンツの古いバージョンを現在のバージョンに設定します。

POST - コンテンツ バージョンを復元

コンテンツ バージョンを取得

DEPRECATED

特定のコンテンツの特定のバージョンを返します。

GET - コンテンツ バージョンを取得

コンテンツ バージョンを削除

特定のコンテンツの古いバージョンを削除します。

DEL - コンテンツ バージョンを削除

コンテンツ - ウォッチ API (バージョン 1)

名前

説明

API ドキュメント リンク

ページのウォッチを取得

ページのウォッチ リストを返します。

GET - ページのウォッチを取得

コンテンツのウォッチ ステータスを取得

特定のユーザーまたは現在のユーザーが特定のコンテンツをウォッチしているかどうかを返します。

GET - コンテンツのウォッチ ステータスを取得

コンテンツ ウォッチャーを追加

指定されたユーザーまたは現在のユーザーをウォッチャーとして特定のコンテンツに追加します。

POST - コンテンツ ウォッチャーを追加

コンテンツ ウォッチャーを削除

指定されたユーザーまたは現在のユーザーをウォッチャーとして特定のコンテンツから削除します。

DEL - コンテンツ ウォッチャーを削除

カスタム コンテンツ API (バージョン 2)

カスタム コンテンツとは、Confluence に新しい機能を追加するためにアプリによって作成および制御される特殊なコンテンツのことです。例としては、マクロの添付ファイルやフォームがあります。

名前

説明

API ドキュメント リンク

ブログ投稿のカスタム コンテンツをタイプ別に取得

ブログ投稿から特定のタイプのすべてのカスタム コンテンツを返します。

GET ブログ投稿のカスタム コンテンツをタイプ別に取得

カスタム コンテンツをタイプ別に取得

カスタム コンテンツ ID またはスペース ID でフィルタリングして、特定のタイプのすべてのカスタム コンテンツを返します。

GET カスタム コンテンツをタイプ別に取得

カスタム コンテンツを作成

特定のスペース、ページ、ブログ投稿、または別のカスタム コンテンツに新しいカスタム コンテンツを作成します。

POST カスタム コンテンツを作成

カスタム コンテンツを ID 別に取得

特定のカスタム コンテンツを ID 別に返します。

GET カスタム コンテンツを ID 別に取得

カスタム コンテンツを更新

特定のカスタム コンテンツを ID 別に更新します。

PUT カスタム コンテンツを更新

カスタム コンテンツを削除

カスタム コンテンツを ID 別に削除します。

DEL カスタム コンテンツを削除

ページのカスタム コンテンツをタイプ別に取得

指定されたページの指定されたタイプのカスタム コンテンツをすべて返します。

GET ページのカスタム コンテンツをタイプ別に取得

スペースのカスタム コンテンツをタイプ別に取得

指定されたスペースの指定されたタイプのカスタム コンテンツをすべて返します。

GET ページのカスタム コンテンツをタイプ別に取得

実験的な API (バージョン 1)

名前

説明

API ドキュメント リンク

ページ ツリーを削除

ページとその子孫 (左側のナビゲーション ツリーでその下にあるページ) すべてをスペースのゴミ箱に移動します。

DEL - ページを削除

インライン タスク API (バージョン 1)

タスクは、ユーザーに割り当てることができるアクション アイテムです。

名前

説明

API ドキュメント リンク

検索パラメーターに基づいてインライン タスクを取得

DEPRECATED

検索クエリに基づいてインライン タスクを返します。クエリには、ページ、担当者、作成者、タスクを完了したユーザー、日付、現在のステータスを指定できます。

GET - 検索パラメーターに基づいてインライン タスクを取得

グローバル ID に基づいてインライン タスクを取得

DEPRECATED

タスク ID に基づいてインライン タスクを返します。

GET - グローバル ID に基づいてインライン タスクを取得

グローバル ID を指定してインライン タスクを更新

特定のタスクのステータスを変更します。

PUT - グローバル ID を指定してインライン タスクを更新

ラベル API (バージョン 1)

ラベルは、コンテンツの検索とフィルタリングに使用されるユーザー生成タグです。

名前

説明

API ドキュメント リンク

ラベル情報を取得

ラベルと、そのラベルに関連付けられたすべてのコンテンツについての情報を返します。

GET - ラベル情報を取得

ラベル API (バージョン 2)

名前

説明

API ドキュメント リンク

添付ファイルのラベルを取得

指定された添付ファイルに適用されているすべてのラベルを返します。

GET - 添付ファイルのラベルを取得

ブログ投稿のラベルを取得

指定されたブログ投稿に適用されているすべてのラベルを返します。

GET - ブログ投稿のラベルを取得

カスタム コンテンツのラベルを取得

指定されたカスタム コンテンツに適用されているすべてのラベルを返します。

GET - カスタム コンテンツのラベルを取得

ページのラベルを取得

指定されたページに適用されているすべてのラベルを返します。

GET - ページのラベルを取得

スペースのラベルを取得

指定されたスペースのすべてのページを返します。

GET - スペースのラベルを取得

スペース コンテンツのラベルを取得

スペース内のコンテンツに適用されているすべてのラベルを返します。

GET - スペース コンテンツのラベルを取得

いいね! API (バージョン 2)

名前

説明

API ドキュメント リンク

ブログ投稿のいいね!数を取得

ブログ投稿のすべてのいいね!の数を返します。

GET - ブログ投稿のいいね!数を取得

ブログ投稿にいいね!を付けたアカウント ID を取得

ブログ投稿にいいね!を付けたすべてのユーザーのアカウント ID を返します。

GET - ブログ投稿にいいね!を付けたアカウント ID を取得

ページのいいね!数を取得

ページのすべてのいいね!の数を返します。

GET - ページのいいね!数を取得

ページにいいね!を付けたアカウント ID を取得

ページにいいね!を付けたすべてのユーザーのアカウント ID を返します。

GET - ページにいいね!を付けたアカウント ID を取得

フッター コメントのいいね!数を取得

フッター コメントのすべてのいいね!の数を返します。

GET - フッター コメントのいいね!数を取得

フッター コメントにいいね!を付けたアカウント ID を取得

フッター コメントにいいね!を付けたすべてのユーザーのアカウント ID を返します。

GET - フッター コメントにいいね!を付けたアカウント ID を取得

インライン コメントのいいね!数を取得

インライン コメントのすべてのいいね!の数を返します。

GET - インライン コメントのいいね!数を取得

インライン コメントにいいね!を付けたアカウント ID を取得

インライン コメントにいいね!を付けたすべてのユーザーのアカウント ID を返します。

GET - インライン コメントにいいね!を付けたアカウント ID を取得

操作 API (バージョン 2)

操作とは、ユーザーまたは API が特定のコンテンツまたはスペースに対して実行できるアクションです。例としては、作成、読み取り、更新、削除、コピー、エクスポート、完全削除などがありますが、これらに限定されません。

名前

説明

API ドキュメント リンク

添付ファイルに対して許可されている操作を取得

指定された添付ファイルに対して許可されているすべての操作を返します。

GET - 添付ファイルに対して許可されている操作を取得

ブログ投稿に対して許可されている操作を取得

指定されたブログ投稿に対して許可されているすべての操作を返します。

GET - ブログ投稿に対して許可されている操作を取得

カスタム コンテンツに対して許可されている操作を取得

指定されたカスタム コンテンツに対して許可されているすべての操作を返します。

GET - カスタム コンテンツに対して許可されている操作を取得

ページに対して許可されている操作を取得

指定されたページに対して許可されているすべての操作を返します。

GET - ページに対して許可されている操作を取得

フッター コメントに対して許可されている操作を取得

指定されたフッター コメントに対して許可されているすべての操作を返します。

GET - フッター コメントに対して許可されている操作を取得

インライン コメントに対して許可されている操作を取得

指定されたインライン コメントに対して許可されているすべての操作を返します。

GET - インライン コメントに対して許可されている操作を取得

ページ API (バージョン 2)

名前

説明

API ドキュメント リンク

ラベルが適用されているページを取得

指定されたラベルが適用されているすべてのページを返します。

GET - ラベルが適用されているページを取得

ページを取得

すべてのページを返します。ページ ID、スペース、現在のステータス、ページ タイトル、ページ本文の書式設定でフィルタリングできます。

GET - ページを取得

ページを作成する

指定されたスペースに新しいページを作成します。

POST - ページを作成

ID でページを取得

ID で指定された特定のページを返します。

GET - ID でページを取得

ページを更新

ページを更新します。

PUT - ページを更新

ページの削除

ページを削除します。

DEL - ページを削除

スペース内のページを取得

指定されたスペースのすべてのページを返します。

GET - スペース内のページを取得

関係 API (バージョン 1)

ユーザー、スペース、コンテンツの間に関係が存在する場合があります。ユーザーとコンテンツの間には、既定で「お気に入り」の関係が存在します。ユーザーとアプリは、カスタム名で新しい関係を作成できます。

名前

説明

API ドキュメント リンク

ソース エンティティに関連するターゲット エンティティを検索

検索パラメーターで指定されたソース エンティティと特定の関係を持つすべてのエンティティ (ユーザー、コンテンツ、またはスペース) を返します。

GET - ソース エンティティに関連するターゲット エンティティを検索

ソースからターゲットへの関係を検索

2 つのエンティティ (ユーザー、コンテンツ、またはスペース) 間に特定種類の関係が存在するかどうかを返します。

GET - ソースからターゲットへの関係を検索

関係を作成

2 つのエンティティ (ユーザー、コンテンツ、またはスペース) 間の関係を作成します。

PUT - 関係を作成

関係を削除

2 つのエンティティ (ユーザー、コンテンツ、またはスペース) 間の関係を削除します。

DEL - 関係を削除

ターゲット エンティティに関連するソース エンティティを検索

検索パラメーターで指定されたターゲット エンティティと特定の関係を持つすべてのエンティティ (ユーザー、コンテンツ、またはスペース) を返します。

GET - ターゲット エンティティに関連するソース エンティティを検索

検索 API (バージョン 1)

名前

説明

API ドキュメント リンク

CQL でコンテンツを検索

Confluence クエリ言語 (CQL) を使用してコンテンツを検索します。

GET - コンテンツを検索

スペース API (バージョン 1)

名前

説明

API ドキュメント リンク

スペースを取得

DEPRECATED

サイト上のすべてのスペースとスペースに関する情報を、スペース キーのアルファベット順で昇順に並べて返します。

GET - スペースを取得

スペースのコンテンツを取得

DEPRECATED

スペース内のすべてのコンテンツをコンテンツ タイプでグループ化し、コンテンツ ID で昇順に並べて返します。

GET - スペースのコンテンツを取得

スペースのコンテンツをタイプ別に取得

DEPRECATED

指定されたタイプのすべてのコンテンツ (ページ、ブログ投稿、カスタム コンテンツ) を返します。

GET - スペースのコンテンツをタイプ別に取得

スペースを削除

長時間実行タスクの一部としてスペースを削除し、タスクを監視するための固有の識別子を返します。

DEL - スペースを削除

スペースを取得

DEPRECATED

スペースに関するすべての情報を返しますが、コンテンツの情報は返しません。スペースの ID、名前、説明、権限などの情報が含まれます。

GET スペースを取得

タスク API (バージョン 2)

タスクは、ユーザーに割り当てることができるアクション アイテムです。

注: バージョン 1 の API は、インライン タスク API として上記に記載されています。

名前

説明

API ドキュメント リンク

タスクを取得

すべてのタスクを返します。フィルタリングでは、本文の書式設定の種類、現在のステータス、タスク ID、スペース ID、ページ ID、ブログ投稿 ID、およびタスクを操作した各種ユーザー (担当者や作成者など) を指定できます。

GET - タスクを取得

ID でタスクを取得

ID で指定された特定のタスクを返します。

GET - ID でタスクを取得

タスクを更新

ID で指定された特定のタスクを更新します。

PUT - タスクを更新

バージョン API (バージョン 2)

名前

説明

API ドキュメント リンク

添付ファイル バージョンを取得

特定の添付ファイルのバージョン情報を返します。

GET - 添付ファイル バージョンを取得

添付ファイル バージョンのバージョン詳細情報を取得

指定された添付ファイルと指定されたバージョンのバージョン詳細情報を返します。

GET - 添付ファイル バージョンのバージョン詳細情報を取得

ブログ投稿バージョンを取得

特定のブログ投稿のバージョン情報を返します。

GET - ブログ投稿バージョンを取得

ブログ投稿バージョンのバージョン詳細情報を取得

指定されたブログ投稿と指定されたバージョンのバージョン詳細情報を返します。

GET - ブログ投稿バージョンのバージョン詳細情報を取得

ページ バージョンを取得

特定のページのバージョン情報を返します。

GET - ページ バージョンを取得

ページ バージョンのバージョン詳細情報を取得

指定されたページと指定されたバージョンのバージョン詳細情報を返します。

GET - ページ バージョンのバージョン詳細情報を取得

カスタム コンテンツ バージョンを取得

特定のカスタム コンテンツのバージョン情報を返します。

GET - カスタム コンテンツ バージョンを取得

カスタム コンテンツ バージョンのバージョン詳細情報を取得

指定されたカスタム コンテンツと指定されたバージョンのバージョン詳細情報を返します。

GET - カスタム コンテンツ バージョンのバージョン詳細情報を取得

フッター コメント バージョンを取得

特定のフッター コメントのバージョン情報を返します。

GET - フッター コメント バージョンを取得

フッター コメント バージョンのバージョン詳細情報を取得

指定されたフッター コメントと指定されたバージョンのバージョン詳細情報を返します。

GET - フッター コメント バージョンのバージョン詳細情報を取得

インライン コメント バージョンを取得

特定のインライン コメントのバージョン情報を返します。

GET - インライン コメント バージョンを取得

インライン コメント バージョンのバージョン詳細情報を取得

指定されたインライン コメントと指定されたバージョンのバージョン詳細情報を返します。

GET - インライン コメント バージョンのバージョン詳細情報を取得

アプリのアクセス ルールが適用されるとブロックしない

管理者がアプリのアクセス ルールを有効にしても、これらの API はブロックされません。つまり、管理者がアプリのアクセスをブロックしても、アプリは引き続きこれらの API を使用して Confluence のスペースやコンテンツにアクセスできます。

DEPRECATED タグが付いた V1 API は、対応する 1 つまたは複数の V2 API に置き換えられました。古いアプリの中にはまだ V1 API を使用しているものもありますが、新しいアプリは別の新しいバージョンを使用します。

カスタム マクロのコピー

アプリのアクセス ルールによって、マクロを導入したアプリがデータ セキュリティ ポリシーに追加された後でも、カスタム マクロをコピーしたり、カスタム マクロからコンテンツをコピーしたりすることは可能です。ただし、マクロ内のコンテンツには、元のスペースとページのルールが引き続き適用されます。アプリはこのコンテンツにアクセスできなくなります。

コンテンツにアクセスする必要があるユーザーは、元の場所にあるマクロに移動して、コンテンツを個別にコピーする必要があります。

監査 API (バージョン 1)

Confluence サイトに加えられた変更のリスト。変更したユーザーや変更日時のデータを含みます。これには、ユーザーの名前、メール アドレス、その他の個人を特定できる情報 (PII) が含まれます。

監査ログの作成、表示には、Confluence のグローバル管理者権限が必要です。

名前

説明

API ドキュメント リンク

日付別監査レコードを取得

すべての監査ログ レコード、または日付範囲のレコードを返します。

GET 監査レコードを取得

監査レコードを作成

監査ログにレコードを追加します。

POST 監査レコードを作成

監査レコードをファイルにエクスポート

すべての監査ログ レコードを含むカンマ区切り値 (CSV) または圧縮 (ZIP) ファイルを作成します。

GET 監査レコードをエクスポート

監査ログ レコードの保存期間を取得

監査ログのレコードが作成されてから削除されるまでの時間を返します。

GET 保存期間を取得

監査ログ レコードの保存期間を設定

レコードが作成されてから削除されるまでの保存期間を、最大 1 年の間で変更します。

PUT 保存期間を設定

一定期間の監査レコードを取得

過去のある時点から現在の日付までの一連のレコードを監査ログから返します。結果は、レコード インデックス、特定の文字列、返されたレコードの総数でフィルタリングすることもできます。

GET 一定期間の監査レコードを取得

コンテンツ - 本文 API (バージョン 1)

名前

説明

API ドキュメント リンク

タスクの ID または現在のステータスから非同期的に変換されたコンテンツ本文を取得します。

特定の非同期 ID のコンテンツ本文変換の結果を返します。

GET タスクの ID または現在のステータスから非同期的に変換されたコンテンツ本文を取得

コンテンツ - 状態 (バージョン 1)

名前

説明

API ドキュメント リンク

スペースで提案されているコンテンツの状態を取得

特定のスペースで提案されているコンテンツの状態を返します。

GET - スペースで提案されているコンテンツの状態を取得

スペースのコンテンツ状態設定を取得

コンテンツ状態がスペースで許可されているかどうか、カスタム コンテンツ状態またはスペース コンテンツ状態が制限されているかどうか、およびスペースで許可されているコンテンツ状態のリストを返します。

GET - スペースのコンテンツ状態設定を取得

コンテンツ - ウォッチ (バージョン 1)

ウォッチ API は、ユーザーの名前やプロファイル写真などの PII を返すことができますが、ユーザーのプライバシー設定により、PII が返されないようにブロックできます。

特定のユーザーのデータにアクセスするには、Confluence のグローバル管理者権限が必要です。

名前

説明

API ドキュメント リンク

スペースのウォッチを取得

スペース内のすべてのページのウォッチ リストを返します。

GET スペースのウォッチを取得

スペース ウォッチャーを取得

スペースのウォッチャーのリストを返します。

GET スペース ウォッチャーを取得

ラベルのウォッチ ステータスを取得

指定されたユーザーまたは現在のユーザーが特定のラベルをウォッチしているかどうかを返します。

GET ラベルのウォッチ ステータスを取得

ラベル ウォッチャーを追加

指定したユーザーまたは現在のユーザーをウォッチャーとして特定のラベルに追加します。

POST ラベル ウォッチャーを追加

ラベル ウォッチャーを削除

指定したユーザーまたは現在のユーザーをウォッチャーとして特定のラベルから削除します。

DEL ラベル ウォッチャーを削除

スペースのウォッチ ステータスを取得

特定のユーザーまたは現在のユーザーがスペースをウォッチしているかどうかを返します。

GET スペースのウォッチ ステータスを取得

スペース ウォッチャーを追加

指定したユーザーまたは現在のユーザーをスペースのウォッチャーとして追加します。

POST スペース ウォッチャーを追加

スペースのウォッチを削除

指定したユーザーまたは現在のユーザーをスペースのウォッチャーとして削除します。

DEL スペースのウォッチを削除

動的モジュール API (バージョン 1)

動的モジュールにより、アプリは Confluence で特定のコードを実行できます。

名前

説明

API ドキュメント リンク

モジュールを取得

動的に登録されたすべてのモジュールを返します(Connect アプリにのみ使用されます)。

GET モジュールを取得

モジュールを登録

モジュールのリストを登録します。

POST モジュールを登録

モジュールを削除

すべてのモジュールまたはリストで指定されたモジュールを登録から削除します。

DEL モジュールを削除

実験的な API (バージョン 1)

名前

説明

API ドキュメント リンク

スペース ラベルを取得

スペースに関連付けられているラベルのリストを返します。

GET - スペース ラベルを取得

スペースにラベルを追加

スペースにラベルを追加します。

POST - スペースにラベルを追加

スペースからラベルを削除

スペースからラベルを削除します。

DEL - スペースからラベルを削除

グループ API (バージョン 1)

グループ API は、ユーザーの名前やプロファイル写真などの PII を返すことができますが、ユーザーのプライバシー設定で PII が返されないようにブロックすることができ、管理者はすべてのユーザーにプライバシー ポリシーを設定できます。

名前

説明

API ドキュメント リンク

グループを取得

すべてのユーザー グループをアルファベット順で昇順に並べて返します。

GET グループを取得

新しいユーザー グループを作成

新しいユーザー グループを作成します。

POST 新しいユーザー グループを作成

ユーザー グループを削除

DEPRECATED

名前を指定してユーザー グループを削除します。

DEL ユーザー グループを削除

グループを取得

DEPRECATED

名前で指定した特定のユーザー グループの情報を返します。

GET グループを取得

グループを取得

ID で指定した特定のユーザー グループの情報を返します。

GET グループを取得

ユーザー グループを削除

ID を指定してユーザー グループを削除します。

DEL ユーザー グループを削除

グループを取得

DEPRECATED

名前で指定したユーザー グループを返します。

GET グループを取得

グループ メンバーを取得

DEPRECATED

グループのメンバーを返します。

GET グループ メンバーを取得

グループ メンバーを取得

DEPRECATED

グループのメンバーを返します。

GET グループ メンバーを取得

部分一致クエリでグループを検索

検索文字列でフィルタリングしてグループのメンバーを返します。

GET 部分一致クエリでグループを検索

グループ ID を指定してメンバーをグループに追加

グループ ID とユーザー アカウント ID を指定して、ユーザーをグループに追加します。

POST groupId を指定してメンバーをグループに追加

グループ ID を使用してメンバーをグループから削除

グループ ID とユーザー アカウント ID を指定して、ユーザーをグループから削除します。

DEL groupId を使用してメンバーをグループから削除

グループ メンバーを取得

グループ ID を指定して、グループのメンバーを返します。

GET グループ メンバーを取得

メンバーをグループに追加

DEPRECATED

グループ名とアカウント ID を指定して、ユーザーをグループに追加します。

POST グループにメンバーを追加

グループからメンバーを削除

DEPRECATED

グループ名とアカウント ID を指定して、ユーザーをグループから削除します。

DEL グループからメンバーを削除

ラベル API (バージョン 2)

名前

説明

API ドキュメント リンク

ラベルを取得

すべてのラベルを返します。

GET - ラベルを取得

長時間実行タスク API (バージョン 1)

長時間実行タスクは、ユーザーが他のことをしている間に、Confluence によってバックグラウンドで実行される操作です。一般的な例は、複数のページをあるスペースから別のスペースに移動するなどです。

名前

説明

API ドキュメント リンク

長時間実行タスクを取得

他の API によって開始されたすべてのアクティブな長時間実行タスクに関する情報を返します。

GET - 長時間実行タスクを取得

特定の長時間実行タスクを取得

他の API によって開始された指定の長時間実行タスクに関する情報を返します。

GET - 長時間実行タスクを取得

操作 API (バージョン 2)

操作とは、ユーザーまたは API が特定のコンテンツまたはスペースに対して実行できるアクションです。例としては、スペースの作成、スペースの移動、スペースのアーカイブなどがありますが、これらに限定されません。

名前

説明

API ドキュメント リンク

スペースに対して許可されている操作を取得

指定されたスペースに対して許可されているすべての操作を返します。

GET スペースに対して許可されている操作を取得

検索 API (バージョン 1)

名前

説明

API ドキュメント リンク

CQL でユーザーを検索

Confluence クエリ言語 (CQL) を使用してユーザーを検索します。

GET - ユーザーを検索

設定 API (バージョン 1)

名前

説明

API ドキュメント リンク

ルック & フィールの設定を取得

特定のスペースの「ルック & フィール」設定ページから現在の設定値を返します。

GET ルック & フィールの設定を取得

ルック & フィールの設定を選択

スペースの「ルック & フィール」設定を、既定、カスタム設定、または現在のテーマの設定、のいずれかに設定します。

PUT ルック & フィールの設定を選択

ルック & フィールの設定を更新

現在のカスタム設定を更新するか、新しいカスタム設定を作成して、サイトまたはスペースの特定の「ルック & フィール」設定を更新します。

POST ルック & フィール設定を更新

ルック & フィール設定をリセット

スペースまたはサイトの「ルック & フィール」設定を既定値に設定します。

DEL ルック & フィール設定をリセット

スペースのルック & フィール設定を実行

DEPRECATED

スペースまたはサイトの「ルック & フィール」設定を、カスタム設定または既定値のいずれかを使用するように設定します。

PUT ルック & フィール設定を実行

システム情報を取得

Confluence Cloud テナントのシステム情報を返します。

GET システム情報を取得

スペース API (バージョン 1)

名前

説明

API ドキュメント リンク

スペースの作成

スペース キー、名前、説明、権限、その他のオプションを指定して、新しいスペースを作成します。

POST スペースを作成

プライベート スペースを作成

作成者だけが表示できる新しいスペースを作成します。これは、現在のユーザーのみに権限を設定して、スペース作成 API を使用するのと同じです。

POST プライベート スペースを作成

スペースを更新

スペースの名前、説明、ホームページ、タイプ、ステータス、またはその他のプロパティを更新します。

PUT スペースを更新

スペース API (バージョン 2)

名前

説明

API ドキュメント リンク

スペースを取得

指定されたスペースに対して許可されているすべての権限を返します。

GET - スペースを取得

ID を指定してスペースを取得

ID で指定した特定のスペースの情報を返します。

GET ID を指定してスペースを取得

スペース – 権限 API (バージョン 1)

スペース権限 API を実行するには、ユーザーがスペース管理者権限を持っている必要があります。

名前

説明

API ドキュメント リンク

スペースに新しい権限を追加

ユーザーまたはグループのスペースに新しい権限を追加します。

POST スペースに新しい権限を追加

スペースに新しいカスタム コンテンツ権限を追加

スペースに新しいカスタム コンテンツの権限を追加します。

POST スペースに新しいカスタム コンテンツ権限を追加

スペース権限を削除

ユーザーまたはグループからスペース権限を削除します。

DEL スペース権限を削除

スペース – 権限 API (バージョン 2)

名前

説明

API ドキュメント リンク

スペース権限を取得

指定されたスペースに対して許可されているすべての権限を返します。

GET スペース権限を取得

スペース – プロパティ (バージョン 1)

名前

説明

API ドキュメント リンク

スペース プロパティを取得

DEPRECATED

特定のスペースのすべてのプロパティを返します。

GET スペース プロパティを取得

スペース プロパティを作成

DEPRECATED

新しいスペース プロパティを作成します。

POST スペース プロパティを作成

スペース プロパティを取得

DEPRECATED

特定のスペースの特定のプロパティを返します。

GET スペース プロパティを取得

スペース プロパティを更新

DEPRECATED

スペースのプロパティの値を更新します。

PUT スペース プロパティを更新

キーのスペース プロパティを作成

DEPRECATED

リクエスト本文ではなく、URL のパス パラメータにプロパティ キーを渡して、新しいスペース プロパティを作成します。

POST キーのスペース プロパティを作成

スペース プロパティを削除

DEPRECATED

スペース プロパティを削除します。

DEL スペース プロパティを削除

スペース - プロパティ (バージョン 2)

名前

説明

API ドキュメント リンク

スペース内のスペース プロパティを取得

指定されたスペースに設定されているすべてのプロパティを返します。

GET スペース内のスペース プロパティを取得

スペースにスペース プロパティを作成

新しいスペース プロパティを作成します。

POST スペースにスペース プロパティを作成

ID を指定してスペース プロパティを取得

ID で指定されたスペース プロパティを返します。

GET ID を指定してスペース プロパティを取得

ID を指定してスペース プロパティを更新

ID で指定されたスペース プロパティを更新します。

PUT ID を指定してスペース プロパティを更新

ID を指定してスペース プロパティを削除

ID で指定されたスペース プロパティを削除します。

DEL ID を指定してスペース プロパティを削除

スペース – 設定 (バージョン 1)

名前

説明

API ドキュメント リンク

スペース設定を取得

スペースの routeOverrideEnabled 設定を返します。

GET スペース設定を取得

スペース設定を更新

スペースの routeOverrideEnabled 設定を更新します。

PUT スペース設定を更新

テンプレート API (バージョン 1)

名前

説明

API ドキュメント リンク

コンテンツ テンプレートを更新

名前、タイプ、本文、説明、ラベル、スペース (スペース テンプレートの場合)、その他のプロパティを含むコンテンツ テンプレートを更新します。

PUT コンテンツ テンプレートを更新

コンテンツ テンプレートを作成

名前、タイプ、本文、説明、ラベル、スペース (スペース テンプレートの場合)、およびその他のプロパティを指定して、新しいコンテンツ テンプレートを作成します。

POST コンテンツ テンプレート作成

ブループリント テンプレートを取得

ブループリントで提供されるすべてのテンプレートを返します。

GET ブループリント テンプレートを取得

コンテンツ テンプレートを取得

サイトまたはスペースのすべてのコンテンツ テンプレートを返します。

GET コンテンツ テンプレートを取得

コンテンツ テンプレートを取得

テンプレートの ID で指定されたコンテンツ テンプレートを返します。

GET コンテンツ テンプレートを取得

テンプレートを削除

テンプレートを削除し、必要に応じて、変更されたブループリント テンプレートを元の既定のテンプレートに置き換えます。

DEL テンプレートを削除

テーマ API (バージョン 1)

名前

説明

API ドキュメント リンク

テーマを取得

サイトまたはスペースで管理者が設定したすべてのテーマを返します。既定のテーマは含まれません。

GET テーマを取得

グローバル テーマを取得

サイトで現在グローバルに割り当てられている、管理者が設定したテーマを返します。

GET グローバル テーマを取得

テーマを取得

サイトに追加されている、管理者が設定した特定のテーマに関する情報を返します。

GET テーマを取得

スペー ステーマを取得

現在スペースにテーマがあれば、それを返します。

GET スペース テーマを取得

スペース テーマを設定

管理者が設定したテーマをスペースに設定します (既定のスペース以外)。

PUT スペース テーマを設定

スペース テーマをリセット

管理者が設定したスペースのテーマを、グローバル設定されたテーマに設定します。

DEL スペース テーマをリセット

ユーザー API (バージョン 1)

ユーザー API には PII が含まれている可能性がありますが、ユーザーのプライバシー設定によって、PII が返されないように制御できます。

名前

説明

API ドキュメント リンク

ユーザーを取得

指定されたユーザーに関するすべての情報を返します。

GET ユーザーを取得

匿名ユーザーを取得

サイトの匿名ユーザーのプロファイル写真と表示名に関する情報を返します。

GET 匿名ユーザーを取得

現在のユーザーを取得

現在ログインしているユーザーに関するすべての情報を返します。

GET 現在のユーザーを取得

ユーザーのグループ メンバーシップを取得

特定のユーザーのグループ メンバーシップを返します。

GET ユーザーのグループ メンバーシップを取得

ID を使って複数のユーザーを取得

複数のユーザーからのすべての情報を返します。

GET ID を使って複数のユーザーを取得

ユーザーのメール アドレスを取得

ユーザーのメール アドレスを返します。

GET ユーザーのメール アドレスを取得する

ユーザーのメール アドレスを一括取得する

複数のユーザーのメール アドレスを返します。

GET ユーザーのメール アドレスを一括取得する

ユーザー API (バージョン 2)

名前

説明

API ドキュメント リンク

メールのリストに対するサイト アクセスを確認する

メール アドレスのリストを取得して、サイト アクセスを保持していないものを返します。

POST メールのリストに対するサイト アクセスを確認する

メールのリストをサイトに招待する

メール アドレスのリストを取得して、サイトへの招待を送信します。

POST メールのリストをサイトに招待する

ユーザー – プロパティ API (バージョン 1)

ユーザー プロパティとは、アプリ内に保存されている特定のユーザーに関する情報です。ユーザー プロパティにアクセスできるのは、そのアプリ本体のみです。他のアプリやその他のユーザーはアクセスできません。

名前

説明

API ドキュメント リンク

ユーザー プロパティを取得する

特定のユーザーのすべてのプロパティをプロパティ キーのリストとして返します。

GET ユーザー プロパティを取得する

ユーザー プロパティを取得する

ユーザーの特定のキーからプロパティを返します。

GET ユーザー プロパティを取得する

ユーザー プロパティを更新する

ユーザーの指定されたプロパティ値を更新します。

PUT ユーザー プロパティを更新する

キーでユーザー プロパティを作成する

キーを使用して、ユーザーの新しいプロパティを作成します。

POST キーでユーザー プロパティを作成する

ユーザー プロパティを削除する

ユーザーからプロパティを削除します。

DEL ユーザー プロパティを削除する

 

その他のヘルプ