content get_by_id#

Description#

コンテンツの情報を取得します。

Examples#

以下のコマンドは、 ${CONTENT_ID} のコンテンツ情報を取得します。

$ confluence content get_by_id --content_id ${CONTENT_ID} > output.json
:caption: output.json

{
    "id": "863699179",
    "type": "page",
    "status": "current",
    "title": "test",
    "space": {
    "id": 690323457,
    "key": "parent",
    "name": "yuji38kwmt",
    "type": "personal",
    "_links": {},
    ...
}

Usage Details#

コンテンツの情報を取得します。

usage: confluence content get_by_id [-h] [--debug]
                                    [--confluence_base_url CONFLUENCE_BASE_URL]
                                    [--confluence_user_name CONFLUENCE_USER_NAME]
                                    [--confluence_user_password CONFLUENCE_USER_PASSWORD]
                                    -c CONTENT_ID
                                    [--expand EXPAND [EXPAND ...]] [-o OUTPUT]

Named Arguments#

-c, --content_id

取得対象のコンテンツのID

--expand

取得したい情報のプロパティ。指定できる値は出力結果の`_expandable`を参照してください。

-o, --output

出力先

global optional arguments#

--debug

指定するとデバッグ用のログが出力されます。

--confluence_base_url

アクセスするConfluenceのURL(たとえば`https://kurusugawa.jp/confluence`)です。アクセスするAPIのURLは'{confluence_base_url}'/rest/api/...'です。未指定の場合は環境変数`CONFLUENCE_BASE_URL`の値を参照します。

--confluence_user_name

Confluenceにログインする際のユーザー名。未指定の場合は環境変数`CONFLUENCE_USER_NAME`の値を参照します。

--confluence_user_password

Confluenceにログインする際のパスワード。未指定の場合は環境変数`CONFLUENCE_USER_PASSWORD`の値を参照します。