uip df files

「uip df files」の構文とオプション - Data Fabric レコード ファイル フィールドの BLOB 添付ファイルを管理します。

uip df files は、レコードのファイル フィールドに格納された BLOB 添付ファイルを管理します。3 つの動詞はすべて同じ 3 つの位置引数 (エンティティ ID、レコード ID、フィールド名 (大文字と小文字を区別) を受け取ります。フィールド名は uip df entities getで検出できます。

概要

uip df files upload <entity-id> <record-id> <field-name> -f <path> [--folder-key <key>]
uip df files download <entity-id> <record-id> <field-name> [--destination <path>] [--folder-key <key>]
uip df files delete <entity-id> <record-id> <field-name> -y --reason <text> [--folder-key <key>]

すべての動詞は --folder-key <key> (フォルダー範囲のエンティティに属するレコードの場合はフォルダー GUID) も受け入れます。

動詞

動詞	目的
upload	ファイルをレコード フィールドにアップロードします。
download	レコード フィールドに添付されたファイルをダウンロードします。
delete	レコード フィールドに添付されたファイルを削除します。

uip df files upload

ファイルをレコード フィールドにアップロードします。

引数

名前	Required	目的
<entity-id>	○	エンティティ ID (UUID)。
<record-id>	○	レコード ID (UUID)。
<field-name>	○	ファイル フィールドの名前です (大文字と小文字が区別されます)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-f	--file	パス	必須	アップロードするファイルへのパスです。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

uip df files upload a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 invoice \
    --file ./invoice.pdf

データシェイプ(--output json)

{
  "Code": "FileUploaded",
  "Data": {
    "EntityId": "a1b2c3d4-0000-0000-0000-000000000001",
    "RecordId": "b2c3d4e5-0000-0000-0000-000000000001",
    "FieldName": "invoice",
    "FileName": "invoice.pdf"
  }
}

uip df files download

レコード フィールドに添付されたファイルをダウンロードします。

引数

名前	Required	目的
<entity-id>	○	エンティティ ID (UUID)。
<record-id>	○	レコード ID (UUID)。
<field-name>	○	ファイル フィールドの名前です (大文字と小文字が区別されます)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--destination	パス	<record-id>_<field-name>.bin	出力ファイル パス。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

uip df files download a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 invoice \
    --destination ./invoice.pdf

# Default destination
uip df files download a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 invoice

データシェイプ(--output json)

{
  "Code": "FileDownloaded",
  "Data": {
    "EntityId": "a1b2c3d4-0000-0000-0000-000000000001",
    "RecordId": "b2c3d4e5-0000-0000-0000-000000000001",
    "FieldName": "invoice",
    "OutputPath": "./invoice.pdf"
  }
}

uip df files delete

レコード フィールドに添付されたファイルを削除します。レコード自体は影響を受けず、名前付きフィールドの BLOB のみが削除されます。

引数

名前	Required	目的
<entity-id>	○	エンティティ ID (UUID)。
<record-id>	○	レコード ID (UUID)。
<field-name>	○	ファイル フィールドの名前です (大文字と小文字が区別されます)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-y	--yes	フラグ	—	必須。これは元に戻せない操作であることを確認します。
—	--reason	text	—	必須。削除の理由 — 呼び出し元がログに記録できるように応答でエコーバックされます。
—	--folder-key	キー	—	エンティティを含むフォルダーのフォルダー キー (GUID) (フォルダー範囲のエンティティの場合)。

例

uip df files delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 invoice \
    --yes --reason "wrong file attached"

データシェイプ(--output json)

{
  "Code": "FileDeleted",
  "Data": {
    "EntityId": "a1b2c3d4-0000-0000-0000-000000000001",
    "RecordId": "b2c3d4e5-0000-0000-0000-000000000001",
    "FieldName": "invoice",
    "Reason": "wrong file attached"
  }
}

関連

• uip df entities — entities getを使用してフィールド名を検出します。
• uip df records — これらの添付ファイルを所有するレコードを管理します。

参照

• Data Fabric ツールの概要
• グローバル オプション
• 終了コード