Arquivos uip df

Sintaxe e opções para "uip df files", que gerencia anexos de blob em campos de arquivo de registro do Data Fabric.

uip df files gerencia anexos de blob armazenados no campo de arquivo de um registro. Todos os três verbos levam os mesmos três argumentos posicionais — ID da entidade, ID de registro e nome de campo (diferenciação de maiúsculas e minúsculas). Os nomes de campos podem ser descobertos por meio de uip df entities get.

Resumo

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>]

Cada verbo também aceita --folder-key <key> (um GUID de pasta, para registros que pertencem a uma entidade com escopo de pasta).

Verbo

Texto	Finalidade
upload	Carregue um arquivo para um campo de registro.
download	Baixe o arquivo anexado a um campo de registro.
delete	Exclua o arquivo anexado a um campo de registro.

upload de arquivos uip df

Carregue um arquivo para um campo de registro.

Argumentos

Name	Required	Finalidade
<entity-id>	sim	ID de entidade (UUID).
<record-id>	sim	ID de registro (UUID).
<field-name>	sim	Nome do campo do arquivo (diferenciação de maiúsculas e minúsculas).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	necessário	Caminho do arquivo a ser carregado.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplos

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

Formato dos dados (--output json)

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

Download de arquivos uip df

Baixe o arquivo anexado a um campo de registro.

Argumentos

Name	Required	Finalidade
<entity-id>	sim	ID de entidade (UUID).
<record-id>	sim	ID de registro (UUID).
<field-name>	sim	Nome do campo do arquivo (diferenciação de maiúsculas e minúsculas).

Opções

Short	Long	Valor	Padrão	Description
—	--destination	Path	<record-id>_<field-name>.bin	Caminho do arquivo de saída.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplos

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

Formato dos dados (--output json)

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

exclusão de arquivos uip df

Exclua o arquivo anexado a um campo de registro. O registro em si não é afetado — apenas o blob no campo nomeado é removido.

Argumentos

Name	Required	Finalidade
<entity-id>	sim	ID de entidade (UUID).
<record-id>	sim	ID de registro (UUID).
<field-name>	sim	Nome do campo do arquivo (diferenciação de maiúsculas e minúsculas).

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma que esta é uma operação irreversível.
—	--reason	text	—	Obrigatório. Motivo da exclusão — retornado na resposta para que o chamador possa registrá-lo.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplos

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

Formato dos dados (--output json)

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

Relacionado

• uip df entities — descubra nomes de campos com entities get.
• uip df records — gerencie os registros que possuem esses anexos.

Veja também

• Visão geral da ferramenta Data Fabric
• Opções globais
• Códigos de saída