UIP DF ファイル

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

概要

uip df files <verb> [options]

動詞

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

uip df ファイルのアップロード

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-f	--file	パス	必須	アップロードするファイルへのパスです。

例

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 ファイルのダウンロード

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--destination	パス	<record-id>_<field-name>.bin	出力ファイル パス。

例

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 ファイルの削除

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip df files delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 invoice

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

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

関連

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

参照

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