entidades de uip df

uip df entities 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) e criação (create, update); operações em nível de registro ao vivo em uip df records. A remoção de campo é intencionalmente não suportada por meio de update.

Resumo

uip df entities <verb> [options]

Verbo

Texto	Finalidade
list	Listar todas as entidades no tenant; opcionalmente, exclua os federados.
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	Atualize os metadados ou esquema de uma entidade (adicionar ou atualizar campos; removeFields é rejeitado).

lista de entidades uip df

Liste todas as entidades no tenant.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--native-only	Bandeira	desativada	Mostrar apenas entidades nativas; excluir entidades federadas suportadas por uma conexão de conector externo.

Exemplos

uip df entities list

uip df entities list --native-only

uip df entities list \
    --output-filter 'Data[].{name:Name, id:ID, fields:FieldCount}'

Formato dos dados (--output json)

{
  "Code": "EntityList",
  "Data": [
    {
      "Name": "Invoice",
      "DisplayName": "Invoice",
      "ID": "a1b2c3d4-0000-0000-0000-000000000001",
      "Type": "Standard",
      "Source": "Native",
      "Description": "Invoice records",
      "FieldCount": 8
    }
  ]
}

As entidades federadas relatam Source como Federated ou Federated (<connector>).

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

# Just the field list
uip df entities get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Fields[].{name:Name, type:Type}'

Formato dos dados (--output json)

{
  "Code": "EntitySchema",
  "Data": {
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "Type": "Standard",
    "Description": "Invoice records",
    "Fields": [
      {
        "ID": "f1000000-0000-0000-0000-000000000001",
        "Name": "id",
        "DisplayName": "ID",
        "Type": "Guid",
        "Required": true,
        "PrimaryKey": true,
        "System": true
      }
    ]
  }
}

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); os dois são mutuamente exclusivos.

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	—	Caminho para o arquivo JSON com a definição da entidade (Matriz fields necessária).
—	--body	JSON	—	Definição de entidade JSON embutida.

Objeto de definição da entidade:

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

Cada campo deve incluir fieldName como uma string. Os valores type válidos são extraídos do enum EntityFieldDataType do SDK (por exemplo, STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME). Os tipos inválidos falham com ValidationError listando o conjunto permitido.

Exemplos

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

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

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, displayName, description e isRbacEnabled. removeFields é rejeitado intencionalmente — a remoção de campo não é compatível. Cada entrada addFields requer fieldName; cada entrada updateFields requer id (descubra IDs de campo com entities get).

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	—	Caminho para o arquivo JSON com opções de atualização.
—	--body	JSON	—	Opções de atualização JSON embutidas.

Exemplos

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

# Rename an existing field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Total"}]}'

Formato dos dados (--output json)

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

Relacionado

• uip df records — gerencie as linhas mantidas por essas entidades.
• uip df files — anexos de arquivo em registros.
• 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