UiPath Data Fabric — Agent Skill

Preview — skill is under active development; surface and behavior may change.

Data Fabric is UiPath’s structured data store. Entities are typed schemas; records are rows; file fields store binary attachments.

All operations go through uip df <subject> <verb> --output json.

When to Use

• Creating or modifying entity schemas (add fields, update metadata)
• Reading, inserting, updating, or deleting records
• Filtering records with complex predicates
• Computing aggregate metrics for dashboards / KPIs (counts, sums, averages, group-by) — see references/records-query.md
• Importing bulk data from CSV files
• Uploading or downloading file attachments on records

When NOT to Use — Hand Off to Another Skill

Embedding Data Fabric reads/writes inside a .flow file as connector activity nodes (Query / Create / Update / Delete / Get Entity Record by ID) is owned by uipath-maestro-flow. That skill knows the node JSON, bindings_v2.json, connection-resource layout, and node configure mechanics.

Use this skill (uipath-data-fabric) for entity discovery and record seeding from the CLI; hand off to uipath-maestro-flow for in-flow node authoring.

Not Supported — Never Attempt These

Respond that the operation is not supported. Do not try to work around it.

Critical Rules

1. Install the tool first. If uip df returns “unknown command”: uip tools install @uipath/data-fabric-tool. See Tool Version Requirements below for the floor needed per feature.

2. Verify login and tenant first. Run uip login status --output json. Switch with uip login tenant set <tenant> if needed. For full login/environment setup, see the uipath-platform skill.

3. Always resolve entity ID first. Use entities list before any operation. Never assume an entity ID.

4. Entity and field names must pass validation: start with a letter, contain only letters/digits/underscores ([a-zA-Z0-9_]), 3–100 characters. No hyphens or spaces. Reserved field names that will error: Id, CreatedBy, CreateTime, UpdatedBy, UpdateTime.

5. All updates require Id in the body. The CLI routes single vs batch by whether the body is a JSON object (1 record) or array (multiple). Both require "Id" in the record. Use records list or records query to retrieve record IDs before updating.

6. File fields are separate from record data. Use files upload/download, not records insert. Field must be type FILE.

7. CSV headers must match exact field names (case-sensitive). Use entities get to discover field names before importing.

8. Never create duplicate entities. Always entities list first; reuse if it already exists.

9. Only work with native entities. When listing entities before a write, use entities list --native-only to filter out federated entities. Never write to federated entities.

10. Never attempt entity delete. No command exists. Respond: “Deleting entities is not supported via the CLI.”

11. Never attempt field delete. Do not pass removeFields in entities update. Respond: “Removing fields is not supported via the CLI.”

12. Complex field types need extra config and lookups, just like DECIMAL needs decimalPrecision. CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE require choiceSetId (from choice-sets list); RELATIONSHIP requires referenceEntityName (target’s technical Name) + referenceFieldName (usually Id), and the target entity must exist first. Full shape in references/entity-schema.md.

13. choice-sets is read-only. CLI has only list / get — author choice sets in the Data Fabric web UI. If a needed choice set is missing, stop and ask; do not fall back to STRING.

14. Choice / relationship record values use lookup tokens, not labels. Choice value → integer NumberId (single) or array of NumberIds (multi), from choice-sets get. Relationship value → target record’s UUID Id regardless of referenceFieldName. Filter / groupBy use the same tokens; CHOICE_SET_MULTIPLE filtering has special operator semantics — see references/records-query.md.

15. Answer with records query, not from memory. Counts, sums, filters, lookups — issue a fresh records query (or records list) and use the server’s response. Do not reuse cached insert responses, IDs you generated earlier, or values from previous tool results. Exception: the Id returned by the same records insert you just made.

Tool Version Requirements

Upgrade with uip tools install @uipath/data-fabric-tool@latest when a feature appears to silently no-op (e.g. aggregate body keys returning raw record lists).

Quick Start

# List entities (use --native-only before any write)
uip df entities list --native-only --output json

# Get entity schema (field names and types)
uip df entities get <entity-id> --output json

# List records (first page)
uip df records list <entity-id> --limit 50 --output json

# Insert one record
uip df records insert <entity-id> --body '{"Name":"Alice","Score":95}' --output json

# Query with a filter
uip df records query <entity-id> \
  --body '{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"Status","operator":"=","value":"active"}]}}' \
  --output json

# Aggregate query — count of records per Status (server-side groupBy)
uip df records query <entity-id> \
  --body '{"selectedFields":["Status"],"groupBy":["Status"],"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}]}' \
  --output json

For Complex types field shapes and value formats, see references/entity-schema.md and references/records-query.md.

Task Navigation

Field Types

Pass the exact EntityFieldDataType string — the CLI is case-sensitive. Common types: STRING, INTEGER, DECIMAL, BOOLEAN, DATE, DATETIME, UUID, FILE. Complex types that require extra config: CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE (need choiceSetId), RELATIONSHIP (needs referenceEntityName + referenceFieldName), AUTO_NUMBER. Full table with SQL backing types, required extras, and value semantics in references/entity-schema.md.

Advanced Field Constraints

Optional per-type constraints on create/update — lengthLimit (STRING, MULTILINE_TEXT), maxValue / minValue (INTEGER, BIG_INTEGER, DECIMAL, FLOAT, DOUBLE), decimalPrecision (DECIMAL, FLOAT, DOUBLE). See references/entity-schema.md for ranges and examples.

Workflow: Discover → Act → Verify

1. Discover — list entities, get schema, check existing records
2. Act — create/insert/update
3. Verify — re-read to confirm the operation succeeded

uip df entities list --native-only --output json
uip df entities get <entity-id> --output json
uip df records insert <entity-id> --body '{"Name":"Alice","Score":95}' --output json
uip df records list <entity-id> --limit 50 --output json
# Use HasNextPage + NextCursor to page through results
uip df records list <entity-id> --cursor <NextCursor> --output json

Query Request Format

Pass via --body or --file. Use --limit, --cursor, and --offset CLI flags for pagination — not body keys. See Pagination below.

{
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      { "fieldName": "Status", "operator": "=", "value": "active" },
      { "fieldName": "Score", "operator": ">=", "value": "80" }
    ]
  },
  "sortOptions": [{ "fieldName": "Score", "isDescending": true }],
  "selectedFields": ["Title", "Score", "Status"]
}

• logicalOperator: 0 = AND, 1 = OR
• Operators: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in
• For in / not in use "valueList": ["a","b","c"] — not a comma-separated value string
• Response includes HasNextPage and NextCursor — pass NextCursor to --cursor for the next page

Pagination

records list / records query paginate via --limit, --cursor, --offset. See references/records-query.md.

Troubleshooting

References

• references/entity-schema.md — Field definitions, supported types, schema update patterns, choice-set + relationship field shapes
• references/choice-sets.md — Browse choice sets, look up NumberIds, add CHOICE_SET fields to entities, write choice values on records
• references/records-query.md — Query filter syntax, pagination, sorting, choice/relationship semantics on read & write
• references/file-attachments.md — File field upload/download/delete file
• references/bulk-import.md — CSV format requirements and the Basic-fields-only limitation (complex types are silently dropped — use records insert with a JSON body instead)