entidades de uip df

Sintaxe e opções para "uip df entity", que navega e altera os esquemas de entidade do Data Fabric.

uip df entities navega e altera esquemas de entidade do Data Fabric. Uma entidade é um modelo de dados digitados — uma forma de linha com campos e tipos nomeados. Os verbos cobrem descoberta (list, get), criação (create, update) e remoção (delete); operações em nível de registro ao vivo em uip df records.

Resumo

uip df entities list [--native-only] [--folder-key <key> | --include-folders]
uip df entities get <id> [--folder-key <key>]
uip df entities create <name> (-f <path> | --body <json>) [--folder-key <key>]
uip df entities update <id> (-f <path> | --body <json>) [-y --reason <text>] [--folder-key <key>]
uip df entities delete <id> -y --reason <text> [--folder-key <key>]

Verbo

Texto	Finalidade
list	Listar entidades. O padrão é entidades no nível do tenant; --folder-key escopos para uma pasta, --include-folders inclui todas as entidades da pasta junto às entidades no nível do tenant.
get	Retorna o esquema (incluindo todos os campos) de uma única entidade.
create	Crie uma nova entidade a partir de uma definição JSON.
update	Atualizar os metadados ou esquema de uma entidade — adicione campos, atualize metadados de campo ou remova campos (destrutivo, requer -y/--reason).
delete	Exclui uma entidade imediatamente (destrutiva, requer -y/--reason).

--folder-key, --native-only, --include-folders

--folder-key <key> (um GUID de pasta) direciona o escopo de um verbo para uma entidade no nível da pasta em vez do tenant. Ela é aceita em todos os verbos neste grupo. Em list, é mutuamente exclusivo com --include-folders (que lista entidades no nível do tenant juntamente com as entidades de cada pasta em uma chamada). --native-only (apenas em list) filtra entidades federadas — aquelas suportadas por uma conexão de conector externo (identificada por uma matriz externalFields não vazia).

lista de entidades uip df

Listar entidades do Data Fabric.

Opções

Short	Long	Valor	Padrão	Description
—	--native-only	Bandeira	desativada	Mostrar apenas entidades nativas; excluir entidades federadas com conexões externas.
—	--folder-key	chave	—	Chave de pasta (GUID) para delimitar a listagem para uma pasta específica. mutuamente exclusivo com --include-folders.
—	--include-folders	Bandeira	desativada	Liste entidades no nível do tenant junto com entidades de cada pasta que você pode ver. mutuamente exclusivo com --folder-key.

Exemplos

uip df entities list --native-only

uip df entities list --folder-key f1000000-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "EntityList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Invoice",
      "displayName": "Invoice",
      "entityType": "Standard",
      "description": "Invoice records",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "isRbacEnabled": false,
      "fields": [
        { "id": "f1000000-0000-0000-0000-000000000001", "name": "amount" }
      ],
      "externalFields": []
    }
  ]
}

Importante:

As linhas Data aqui são os objetos brutos do SDK, em CamelCase — ao contrário da resposta de get abaixo, list não reformula os nomes de campos da Carga. O folderId de cada linha é o valor a ser passado como --folder-key nos comandos de acompanhamento direcionados a essa entidade.

Obter entidades de uip df

Retorna o esquema de uma única entidade, incluindo todos os campos.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID). Encontre-o com entities list.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplo

uip df entities get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "EntitySchema",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "EntityType": "Standard",
    "Description": "Invoice records",
    "IsRbacEnabled": false,
    "Fields": [
      {
        "Id": "f1000000-0000-0000-0000-000000000002",
        "Name": "amount",
        "DisplayName": "Amount",
        "FieldDataType": {
          "Name": "DECIMAL",
          "DecimalPrecision": 2,
          "MinValue": 0,
          "MaxValue": 999999
        },
        "IsRequired": true,
        "IsUnique": false,
        "IsEncrypted": false,
        "IsRbacEnabled": false,
        "IsPrimaryKey": false,
        "IsSystemField": false
      }
    ]
  }
}

Ao contrário de list, essa resposta é PascalCase. O nome do tipo de um campo e suas restrições (DecimalPrecision, MinValue, MaxValue, LengthLimit e assim por diante, dependendo do tipo) existem aninhados em FieldDataType, não como propriedades planos no campo.

criação de entidades de uip df

Criar uma nova entidade. O nome da entidade deve começar com uma letra e conter apenas letras, números e sublinhados. Passe a definição em linha (--body) ou de um arquivo (--file).

Argumentos

Name	Required	Finalidade
<name>	sim	Nome da entidade (começa com uma letra; somente letras, números e sublinhados).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para um arquivo JSON com a definição da entidade (Matriz fields necessária; displayName, description, isRbacEnabled, isAnalyticsEnabled opcional).
—	--body	JSON	—	Definição da entidade JSON embutida, mesma forma que --file.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta de destino, para criar uma entidade com escopo de pasta em vez de uma no nível do tenant.

Objeto de definição da entidade:

{
  "displayName": "Invoice",
  "description": "Invoice records",
  "isRbacEnabled": false,
  "fields": [
    { "name": "title", "type": "STRING" }
  ]
}

Importante:

Cada objeto de campo requer name, não fieldName — passar fieldName falha com o erro de validação Each field must include a 'name' string. Um objeto de campo copiado textual da saída de entities get (que usa Name/FieldDataType e PascalCase) também é aceito aqui e normalizado automaticamente para este formato de gravação simples.

Os valores type válidos vêm do enum EntityFieldDataType do SDK — um tipo inválido falha com um ValidationError listando o conjunto permitido completo. Além dos tipos escalares simples (STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME, …), vários tipos levam propriedades extras exigidas no objeto de campo:

Tipo	Propriedades extras necessárias
CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE	choiceSetId — UUID de df choice-sets list.
RELATIONSHIP	referenceEntityId (UUID da entidade de destino, de entities list) e referenceFieldId (UUID de um campo na entidade de destino, de entities get <target-id>). Opcionalmente, referenceFolderKey quando a entidade de destino estiver em uma pasta diferente.
FILE	Apenas name e type — o servidor conecta automaticamente a referência de anexo interno. Preencha o valor posteriormente com uip df files upload.
MULTILINE_MAX	Opcional lengthLimit ( orçamento de byte UTF-16, 1 – 131072; o padrão é de cerca de 65.536 caracteres). Não filtrável ou classificável; records list/query retornam apenas um marcador de tamanho para ela — leia o conteúdo completo com records get. Fechado pelo sinalizador de funcionalidade MultilineMax do tenant.

Uma coluna RELATIONSHIP em um registro sempre armazena o Id do registro de destino (um UUID), independentemente de qual referenceFieldId configurou a junção — consulte records insert para saber como escrever o valor.

Exemplos

uip df entities create Invoice --file ./invoice.entity.json

uip df entities create Invoice \
    --body '{"displayName":"Invoice","fields":[{"name":"amount","type":"DECIMAL"}]}'

# choice-set, relationship, file, and large-text fields
uip df entities create Expense \
    --body '{"displayName":"Expense","fields":[{"name":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"name":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"name":"receipt","type":"FILE"},{"name":"notes","type":"MULTILINE_MAX"}]}'

Formato dos dados (--output json)

{
  "Code": "EntityCreated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

atualização de entidades de uip df

Atualizar os metadados ou o esquema de uma entidade. O corpo aceita addFields, updateFields, removeFields, displayName, description e isAnalyticsEnabled/isRbacEnabled. A entidade name em si é imutável — não pode ser incluída no corpo da atualização.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com opções de atualização.
—	--body	JSON	—	Opções de atualização JSON embutidas.
-y	--yes	Bandeira	—	Obrigatório quando removeFields não está vazio — reconhece que a exclusão do campo é irreversível.
—	--reason	text	—	Obrigatório quando removeFields está não vazio — 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.

• addFields array de novos campos, forma de gravação simples (name + type, mais extras específicos do tipo — consulte a seção create acima). Um objeto de campo copiado de entities get também é aceito e normalizado.
• updateFields — matriz chaveada pelo campo id (de entities get), com as propriedades de metadados sendo alteradas (por exemplo displayName, description, isRequired, isRbacEnabled, isEncrypted, isHiddenField, defaultValue, restrições). Não cole um objeto de campo completo copiado aqui — passe id mais apenas as propriedades simples que estão sendo alteradas. updateFields não pode alterar o type ou sua configuração isUnique de um campo.
• removeFields Array de objetos {"name": "<fieldName>"} , identificados pelo nome, não pelo id. Requer -y/--yes e --reason "<text>" — a operação exclui os valores armazenados do campo e não pode ser desfeita.
• A atualização dos metadados de entidade (description, isRbacEnabled, isAnalyticsEnabled) exige que displayName também esteja presente no mesmo corpo, mesmo que esteja inalterado — busque o displayName atual com entities get primeiro se você não fizer isso já o tem.

Exemplos

# Add a field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"addFields":[{"name":"note","type":"STRING","lengthLimit":200}]}'

# Rename an existing field's display name
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Amount (USD)","isRequired":true}]}'

# Remove a field — destructive, requires --yes and --reason
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"removeFields":[{"name":"oldColumn"}]}' \
    --yes --reason "quarterly cleanup"

Formato dos dados (--output json)

{
  "Code": "EntityUpdated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

Quando a atualização removeFields inclui, a resposta também reflete o que foi removido:

{
  "Code": "EntityUpdated",
  "Data": {
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedFields": ["oldColumn"],
    "Reason": "quarterly cleanup"
  }
}

exclusão de entidades do uip df

Excluir uma entidade completamente. Isso é irreversível e remove o esquema da entidade juntamente com todos os seus registros.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

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.

Exemplo

uip df entities delete a1b2c3d4-0000-0000-0000-000000000001 \
    --yes --reason "test entity cleanup"

Formato dos dados (--output json)

{
  "Code": "EntityDeleted",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Reason": "test entity cleanup"
  }
}

Relacionado

• uip df records — gerencie as linhas mantidas por essas entidades.
• uip df files — anexos de arquivo em registros.
• uip df choice-sets — os conjuntos de escolhas referenciados pelos campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .
• uip vss generate — geram tipos TypeScript a partir de uma exportação de esquema do Data Fabric.

Veja também

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