attachment get

Description

添付ファイルの情報を取得します。

Examples

以下のコマンドは、ページ内の添付ファイルの情報を出力します。

$ confluence attachment get --page_id ${PAGE_ID} > out.json

:caption: out.json


[
{
    "id": "1521975743",
    "type": "attachment",
    "status": "current",
    "title": "B",
    "metadata": {
    "mediaType": "image/png",
    "labels": {
        }
    },
    "_expandable": {
        "currentuser": "",
        "properties": "",
        "frontend": "",
        "editorHtml": ""
    }
    },
    "extensions": {
    },
    "_links": {
    },
    "_expandable": {
    }
}
]

Usage Details

添付ファイルの情報を取得します。

usage: confluence attachment get [-h] [--debug]
                                 [--confluence_base_url CONFLUENCE_BASE_URL]
                                 [--confluence_user_name CONFLUENCE_USER_NAME]
                                 [--confluence_user_password CONFLUENCE_USER_PASSWORD]
                                 -p PAGE_ID [--filename FILENAME]
                                 [--media_type MEDIA_TYPE]
                                 [--expand EXPAND [EXPAND ...]] [-o OUTPUT]

Named Arguments

-p, --page_id

取得した添付ファイルが存在するページまたはブログのID

--filename

filter parameter to return only the Attachment with the matching file name

--media_type

filter parameter to return only Attachments with a matching Media-Type

--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`の値を参照します。