@uipath/data-fabric-tool 1.197.0 → 1.198.0-preview.80

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uipath/data-fabric-tool",
   "license": "MIT",
-  "version": "1.197.0",
+  "version": "1.198.0-preview.80",
   "description": "Manage Data Fabric entities and records.",
   "type": "module",
   "main": "./dist/tool.js",
@@ -14,5 +14,5 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "56f68b263cec4ea1f2a39d738bd99ecf52f88fea"
+  "gitHead": "9b2c3c0f21a256d2f38dd28bc97e72e6f7b10a9c"
 }

package/src/commands/entities.ts

@@ -147,10 +147,11 @@ const ENTITIES_CREATE_EXAMPLES: CommandExample[] = [
         Description:
             "Create an entity with choice-set, relationship, and file fields. " +
             "CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE require 'choiceSetId' (from 'df choice-sets list'). " +
-            "RELATIONSHIP and FILE both require 'referenceEntityId' (UUID of the target entity, from 'df entities list') and 'referenceFieldId' (UUID of the field on the target entity, from 'df entities get <target-id>'). " +
-            "Note: a RELATIONSHIP column on a record always stores the target record's UUID 'Id' (regardless of which 'referenceFieldId' configured the join) — see 'df records insert' for how to write the value.",
+            "RELATIONSHIP requires 'referenceEntityId' (UUID of the target entity, from 'df entities list') and 'referenceFieldId' (UUID of the field on the target entity, from 'df entities get <target-id>'). " +
+            "Note: a RELATIONSHIP column on a record always stores the target record's UUID 'Id' (regardless of which 'referenceFieldId' configured the join) — see 'df records insert' for how to write the value. " +
+            "FILE fields take only 'fieldName' and 'type' — the server auto-wires the internal attachment reference; populate them later with 'uip df files upload <entity-id> <record-id> <field-name> --file <path>'.",
         Command:
-            'uip df entities create Expense --body \'{"displayName":"Expense","fields":[{"fieldName":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"fieldName":"tags","type":"CHOICE_SET_MULTIPLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000002"},{"fieldName":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"fieldName":"receipt","type":"FILE","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000099","referenceFieldId":"f1000000-0000-0000-0000-000000000199"}]}\'',
+            'uip df entities create Expense --body \'{"displayName":"Expense","fields":[{"fieldName":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"fieldName":"tags","type":"CHOICE_SET_MULTIPLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000002"},{"fieldName":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"fieldName":"receipt","type":"FILE"}]}\'',
         Output: {
             Code: "EntityCreated",
             Data: { ID: "a1b2c3d4-0000-0000-0000-000000000004" },
@@ -160,7 +161,7 @@ const ENTITIES_CREATE_EXAMPLES: CommandExample[] = [
         Description:
             "Create a folder-scoped entity with cross-folder references. " +
             "Pass '--folder-key' to place the new entity in a folder. " +
-            "Per-field 'referenceFolderKey' points a RELATIONSHIP, FILE, or CHOICE_SET_* field at a target that lives in a different folder (or at the tenant level when omitted). " +
+            "Per-field 'referenceFolderKey' points a RELATIONSHIP or CHOICE_SET_* field at a target that lives in a different folder (or at the tenant level when omitted). " +
             "Get target entity/field IDs from 'df entities list --folder-key <key>' and 'df entities get <id> --folder-key <key>'; get choice-set IDs from 'df choice-sets list --folder-key <key>' (omit '--folder-key' for tenant-level choice sets).",
         Command:
             'uip df entities create OrderLine --folder-key f1000000-0000-0000-0000-000000000050 --body \'{"displayName":"Order Line","fields":[{"fieldName":"order","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","referenceFolderKey":"f1000000-0000-0000-0000-000000000060","isRequired":true},{"fieldName":"userType","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000077"}]}\'',

package/src/commands/records.ts

@@ -161,6 +161,46 @@ const RECORDS_UPDATE_EXAMPLES: CommandExample[] = [
     },
 ];
 
+const RECORDS_QUERY_EXAMPLES: CommandExample[] = [
+    {
+        Description:
+            "Filter records — exact keys: filterGroup / queryFilters / fieldName / operator / value. " +
+            "Operators: = != > < >= <= contains 'not contains' startswith endswith in 'not in'. " +
+            "Not accepted: 'filters', 'field', '==', 'Equals', 'eq', 'like'.",
+        Command:
+            "uip df records query a1b2c3d4-0000-0000-0000-000000000001 " +
+            '--body \'{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"status","operator":"=","value":"Paid"}]}}\'',
+        Output: {
+            Code: "RecordQuery",
+            Data: {
+                items: [
+                    {
+                        Id: "b2c3d4e5-0000-0000-0000-000000000001",
+                        status: "Paid",
+                    },
+                ],
+                totalCount: 1,
+                hasNextPage: false,
+            },
+        },
+    },
+    {
+        Description: "Aggregate — COUNT grouped by a field.",
+        Command:
+            "uip df records query a1b2c3d4-0000-0000-0000-000000000001 " +
+            '--body \'{"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}],"groupBy":["status"]}\'',
+        Output: {
+            Code: "RecordQuery",
+            Data: {
+                items: [
+                    { status: "Paid", total: 12 },
+                    { status: "Pending", total: 3 },
+                ],
+            },
+        },
+    },
+];
+
 const RECORDS_DELETE_EXAMPLES: CommandExample[] = [
     {
         Description: "Delete records by ID",
@@ -585,6 +625,7 @@ export const registerRecordsCommand = (program: Command) => {
             "--folder-key <key>",
             "Folder key (GUID) of the folder containing the entity (for folder-scoped entities)",
         )
+        .examples(RECORDS_QUERY_EXAMPLES)
         .trackedAction(
             processContext,
             async (entityId: string, options: QueryOptions) => {