@uipath/skills 1.197.2 → 1.198.0-preview.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/CODEOWNERS +18 -11
  4. package/README.md +1 -0
  5. package/assets/skill-status.json +8 -0
  6. package/hooks/hooks.json +44 -8
  7. package/hooks/send-telemetry.ps1 +392 -0
  8. package/hooks/send-telemetry.sh +118 -86
  9. package/hooks/set-session-env.ps1 +72 -0
  10. package/hooks/set-session-env.sh +64 -0
  11. package/hooks/suggest-permissions.ps1 +45 -0
  12. package/hooks/suggest-permissions.sh +4 -0
  13. package/package.json +1 -1
  14. package/skills/uipath-admin/references/audit-commands.md +2 -2
  15. package/skills/uipath-admin/references/audit-workflow-guide.md +4 -4
  16. package/skills/uipath-agents/references/coded/capabilities/batch-transform/planning.md +1 -1
  17. package/skills/uipath-agents/references/coded/capabilities/deeprag/planning.md +1 -1
  18. package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails-recommend.md +5 -2
  19. package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails.md +8 -4
  20. package/skills/uipath-agents/references/coded/embedding-in-flows.md +1 -1
  21. package/skills/uipath-agents/references/coded/flow-integration.md +2 -2
  22. package/skills/uipath-agents/references/coded/lifecycle/build.md +0 -1
  23. package/skills/uipath-agents/references/coded/lifecycle/setup.md +0 -1
  24. package/skills/uipath-agents/references/coded/quickstart.md +1 -1
  25. package/skills/uipath-agents/references/lowcode/agent-definition.md +24 -5
  26. package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/batch-transform/planning.md +1 -1
  27. package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/deeprag/planning.md +1 -1
  28. package/skills/uipath-agents/references/lowcode/capabilities/context/attachments.md +1 -0
  29. package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +1 -0
  30. package/skills/uipath-api-workflow/references/cli-reference.md +1 -1
  31. package/skills/uipath-api-workflow/references/connector-activity-discovery.md +1 -1
  32. package/skills/uipath-api-workflow/references/troubleshooting.md +1 -1
  33. package/skills/uipath-automation-discovery/SKILL.md +26 -1
  34. package/skills/uipath-automation-discovery/assets/templates/estimation-worksheet-template.md +80 -0
  35. package/skills/uipath-automation-discovery/references/estimation-guide.md +104 -0
  36. package/skills/uipath-connector-builder/SKILL.md +6 -4
  37. package/skills/uipath-connector-builder/references/auth.md +137 -13
  38. package/skills/uipath-connector-builder/references/configuration.md +29 -7
  39. package/skills/uipath-connector-builder/references/debugging.md +1 -1
  40. package/skills/uipath-connector-builder/references/standard-resources.md +162 -13
  41. package/skills/uipath-governance/references/cli-cheatsheet.md +3 -3
  42. package/skills/uipath-governance/references/diagnose/references/failure-modes.md +5 -5
  43. package/skills/uipath-insights/SKILL.md +277 -0
  44. package/skills/uipath-insights/references/investigation-playbook-guide.md +145 -0
  45. package/skills/uipath-insights/references/jobs-commands-guide.md +144 -0
  46. package/skills/uipath-ixp/SKILL.md +4 -1
  47. package/skills/uipath-ixp/references/cli-reference.md +18 -3
  48. package/skills/uipath-maestro-bpmn/references/cli-conventions.md +2 -0
  49. package/skills/uipath-maestro-bpmn/validator/README.md +12 -2
  50. package/skills/uipath-maestro-case/SKILL.md +27 -13
  51. package/skills/uipath-maestro-case/assets/templates/sdd-template-examples.md +37 -4
  52. package/skills/uipath-maestro-case/assets/templates/sdd-template.md +20 -9
  53. package/skills/uipath-maestro-case/assets/templates/sdd-viewer.html +8 -7
  54. package/skills/uipath-maestro-case/references/bindings-v2-sync.md +5 -1
  55. package/skills/uipath-maestro-case/references/brownfield.md +86 -0
  56. package/skills/uipath-maestro-case/references/case-commands.md +8 -0
  57. package/skills/uipath-maestro-case/references/case-editing-operations.md +230 -21
  58. package/skills/uipath-maestro-case/references/case-schema.md +29 -11
  59. package/skills/uipath-maestro-case/references/connector-integration.md +1 -1
  60. package/skills/uipath-maestro-case/references/connector-trigger-common.md +1 -1
  61. package/skills/uipath-maestro-case/references/entry-points-sync.md +204 -0
  62. package/skills/uipath-maestro-case/references/implementation.md +19 -9
  63. package/skills/uipath-maestro-case/references/phase-0-interview.md +10 -8
  64. package/skills/uipath-maestro-case/references/phased-execution.md +11 -4
  65. package/skills/uipath-maestro-case/references/placeholder-tasks.md +24 -2
  66. package/skills/uipath-maestro-case/references/planning.md +9 -3
  67. package/skills/uipath-maestro-case/references/plugins/case/planning.md +2 -0
  68. package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +1 -1
  69. package/skills/uipath-maestro-case/references/plugins/sla/planning.md +1 -1
  70. package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +11 -10
  71. package/skills/uipath-maestro-case/references/plugins/stages/planning.md +13 -14
  72. package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +3 -1
  73. package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +91 -2
  74. package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +3 -1
  75. package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +87 -2
  76. package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +1 -1
  77. package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +1 -1
  78. package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +3 -1
  79. package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +2 -1
  80. package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +2 -0
  81. package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +20 -10
  82. package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +9 -8
  83. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +1 -1
  84. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +1 -1
  85. package/skills/uipath-maestro-case/references/registry-discovery.md +87 -10
  86. package/skills/uipath-maestro-case/references/sdd-generation-rules.md +34 -26
  87. package/skills/uipath-maestro-flow/SKILL.md +4 -1
  88. package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +1 -2
  89. package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +3 -3
  90. package/skills/uipath-maestro-flow/references/author/references/greenfield.md +4 -2
  91. package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +0 -1
  92. package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +0 -1
  93. package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +1 -0
  94. package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +7 -7
  95. package/skills/uipath-maestro-flow/references/author/references/plugins/ixp/impl.md +14 -14
  96. package/skills/uipath-maestro-flow/references/author/references/plugins/script/impl.md +10 -6
  97. package/skills/uipath-maestro-flow/references/shared/cli-conventions.md +7 -0
  98. package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
  99. package/skills/uipath-mcp-servers/references/is-activity-workflow.md +3 -3
  100. package/skills/uipath-planner/SKILL.md +1 -1
  101. package/skills/uipath-platform/SKILL.md +4 -14
  102. package/skills/uipath-platform/references/data-fabric/data-fabric.md +1 -1
  103. package/skills/uipath-platform/references/integration-service/agent-workflow.md +4 -4
  104. package/skills/uipath-platform/references/integration-service/reference-resolution.md +1 -1
  105. package/skills/uipath-platform/references/integration-service/resources.md +5 -5
  106. package/skills/uipath-platform/references/integration-service/triggers.md +10 -9
  107. package/skills/uipath-platform/references/orchestrator/setup-environment.md +2 -0
  108. package/skills/uipath-review/SKILL.md +8 -4
  109. package/skills/uipath-review/references/agents/agent-review-checklist.md +1 -22
  110. package/skills/uipath-review/references/agents/agents-coded-rules.md +24 -7
  111. package/skills/uipath-review/references/agents/agents-lowcode-rules.md +0 -1
  112. package/skills/uipath-review/references/agents/guardrails/coded-guardrails-review.md +231 -0
  113. package/skills/uipath-review/references/rule-catalog-workflow.md +4 -2
  114. package/skills/uipath-rpa/SKILL.md +2 -2
  115. package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/guides/data-service-filter-builder-guide.md +1 -1
  116. package/skills/uipath-rpa/references/activity-docs/UiPath.Web.Activities/2.5/coded/coded-api.md +1 -1
  117. package/skills/uipath-rpa/references/activity-docs/UiPath.Web.Activities/2.5/coded/curl-import.md +3 -3
  118. package/skills/uipath-rpa/references/activity-docs/UiPath.Web.Activities/2.5/coded/http-request-upgrade.md +3 -3
  119. package/skills/uipath-rpa/references/activity-docs/UiPath.Web.Activities/2.5/coded/service-discovery.md +2 -2
  120. package/skills/uipath-rpa/references/coded/coding-guidelines.md +1 -1
  121. package/skills/uipath-rpa/references/ui-automation-guide.md +7 -7
  122. package/skills/uipath-rpa/references/uia-configure-target-workflows.md +5 -5
  123. package/skills/uipath-rpa/references/uia-elements-interaction-guide.md +19 -10
  124. package/skills/uipath-rpa/references/uia-prerequisites.md +7 -7
  125. package/skills/uipath-rpa/references/validation-guide.md +2 -2
  126. package/skills/uipath-rpa/references/xaml/common-pitfalls.md +4 -0
  127. package/skills/uipath-rpa/references/xaml/csharp-activity-binding-guide.md +3 -1
  128. package/skills/uipath-rpa/references/xaml/csharp-expression-pitfalls.md +9 -4
  129. package/skills/uipath-rpa/references/xaml/workflow-guide.md +2 -2
  130. package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +1 -1
  131. package/skills/uipath-solution/SKILL.md +4 -4
  132. package/skills/uipath-solution/references/activate-and-manage.md +6 -1
  133. package/skills/uipath-solution/references/develop-solution.md +24 -5
  134. package/skills/uipath-solution/references/pack-and-deploy.md +5 -2
  135. package/skills/uipath-solution/references/scenarios/manual-edits.md +2 -2
  136. package/skills/uipath-solution/references/solution-overview.md +2 -2
  137. package/skills/uipath-troubleshoot/SKILL.md +3 -3
  138. package/skills/uipath-troubleshoot/references/products/agents/playbooks/context-grounding-index-not-found.md +0 -2
  139. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/personal-automation-quota.md +1 -1
  140. package/version-manifest.json +3 -3
  141. package/hooks/ensure-uip.sh +0 -220
  142. package/skills/uipath-maestro-flow/references/author/references/plugins/connector/data-fabric/impl.md +0 -683
  143. package/skills/uipath-maestro-flow/references/author/references/plugins/connector/data-fabric/planning.md +0 -45
@@ -1,683 +0,0 @@
1
- # Data Fabric Activity Nodes — Implementation
2
-
3
- Step-by-step guide for building Data Fabric connector nodes in a `.flow` file.
4
-
5
- - For activity selection, entity discovery, parameter defaults, CEQL filter syntax: [planning.md](planning.md)
6
- - For the standard IS connector workflow: [parent connector impl.md](../impl.md)
7
-
8
- ---
9
-
10
- ## Step 1 — Resolve the Connection
11
-
12
- Per [parent impl.md § Step 1](../impl.md#step-1--fetch-and-bind-a-connection), filter by `ConnectorKey = "uipath-uipath-dataservice"`. Capture `Id` (→ `<connectionId>`), `FolderKey` (→ `<folderKey>`), and `Name` (→ `<IS connection Name>`).
13
-
14
- ---
15
-
16
- ## Step 2 — Resolve the Entity Name
17
-
18
- ```bash
19
- uip df entities list --native-only --output json
20
- ```
21
-
22
- Use the exact CamelCase `Name` (e.g. `BankDetails`). For Create/Update, also run `uip df entities get <entity-id> --output json` for field names — skip system fields (`Id`, `CreatedBy`, `CreateTime`, `UpdatedBy`, `UpdateTime`, `RecordOwner`).
23
-
24
- ---
25
-
26
- ## Step 3 — Set Up the Flow File
27
-
28
- Author the standard top-level `bindings[]` pair (`ConnectionId` + `FolderKey`) per [parent impl.md § Top-level `bindings[]` shape](../impl.md#top-level-bindings-shape-cli-emitted-reference-only). Data Fabric specifics:
29
-
30
- - Connection binding `name` = the IS connection display name (not the `<CONNECTOR_KEY> connection` placeholder), since `node configure` is run with this value pre-resolved.
31
- - Both bindings share the same `resourceKey` = `<connectionId>`.
32
-
33
- Add one `definitions[]` entry per activity type used — copy the complete entry from the Definitions Templates section below. The `form` block is required ([parent impl.md § Critical: Connector Definition Must Include `form`](../impl.md#critical-connector-definition-must-include-form)).
34
-
35
- ---
36
-
37
- ## Step 4 — Create `bindings_v2.json`
38
-
39
- > **Data Fabric exception to [parent impl.md § Bindings](../impl.md#bindings--top-level-flow-bindings).** The parent guide says `bindings_v2.json` is regenerated from top-level `bindings[]` and must never be hand-edited. For Data Fabric Maestro Flow projects this regeneration does not happen — Studio Web returns 500 on designer load if `bindings_v2.json` is missing or shaped differently from the block below. Author it by hand using the exact format here.
40
-
41
- Create this file manually alongside the `.flow` file.
42
-
43
- ```json
44
- {
45
- "version": "2.0",
46
- "resources": [{
47
- "resource": "Connection",
48
- "key": "<connectionId>",
49
- "id": "Connection<connectionId>",
50
- "value": { "ConnectionId": { "defaultValue": "<connectionId>", "isExpression": false, "displayName": "<IS connection Name>" } },
51
- "metadata": { "ActivityName": "<first connector node label>", "BindingsVersion": "2.2", "DisplayLabel": "<IS connection Name>", "UseConnectionService": "true", "Connector": "uipath-uipath-dataservice" }
52
- }]
53
- }
54
- ```
55
-
56
- ---
57
-
58
- ## Step 5 — Create the Connection Resource File
59
-
60
- Create `resources/solution_folder/connection/uipath-uipath-dataservice/<IS connection Name>.json` manually in the solution directory.
61
-
62
- ```json
63
- {
64
- "docVersion": "1.0.0",
65
- "resource": {
66
- "name": "<IS connection Name>", "kind": "connection", "type": "uipath-uipath-dataservice",
67
- "apiVersion": "integrationservice.uipath.com/v1", "isOverridable": true,
68
- "dependencies": [], "runtimeDependencies": [],
69
- "folders": [{ "fullyQualifiedName": "solution_folder" }],
70
- "spec": { "connectorName": "Data Fabric", "name": "<IS connection Name>", "authenticationType": "AuthenticateAfterDeployment", "connectorVersion": "<IS Connector version>", "connectorKey": "uipath-uipath-dataservice", "pollingInterval": 5 },
71
- "locks": [], "key": "<connectionId>", "files": []
72
- }
73
- }
74
- ```
75
-
76
- ---
77
-
78
- ## Step 6 — Write Connector Nodes
79
-
80
- Write nodes directly into the `.flow` JSON using the templates below — `uip maestro flow node add` does not support `uipath.connector.*` types.
81
-
82
- For each node, set `connectionId`, `connectionResourceId` (same value), `connectionFolderKey`, `pathParameters.entityName`, and `bodyParameters`/`queryParameters` as needed. Copy the `configuration` string verbatim from the templates, replacing only `<EntityName>`.
83
-
84
- For wiring upstream node outputs (`=js:$vars.<sourceNodeId>.output.<field>`), see [parent impl.md § Step 5b](../impl.md#step-5b--wire-outputs-from-previous-nodes). Data Fabric specifics:
85
-
86
- - `expansionLevel` is always string `"3"`, never a number.
87
- - `queryExpression` is a raw CEQL string — no `=js:` prefix (e.g., `"queryExpression": "FieldName = 'value' AND OtherField > 10"`).
88
-
89
- ---
90
-
91
- ## Step 7 — Run `node configure` and Restore Configuration
92
-
93
- Run `uip maestro flow node configure` on each connector node per [parent impl.md § Step 6](../impl.md#step-6--configure-the-node). Use `method` and `endpoint` from the Activity Reference table below; pass `pathParameters.entityName` and any activity-specific `queryParameters`/`bodyParameters` in `--detail`.
94
-
95
- > **Data Fabric quirk — restore `configuration` after configure.** `node configure` resets `customFieldsRequestDetails` to `null` in the `configuration` string. Restore the correct `configuration` string on **every node except Delete** using the exact strings from the Configuration Strings section below. Delete is the only activity where `customFieldsRequestDetails: null` is correct.
96
-
97
- ---
98
-
99
- ## `inputs.detail` — Data Fabric Specifics
100
-
101
- For the full set of `inputs.detail` fields populated by `node configure`, see [parent impl.md § How Connector Nodes Differ from OOTB](../impl.md#how-connector-nodes-differ-from-ootb). Data Fabric–specific values:
102
-
103
- | Field | Value |
104
- |---|---|
105
- | `connector` | Always `"uipath-uipath-dataservice"` |
106
- | `connectionResourceId` | Same UUID as `connectionId` — both required (Data Fabric requires both) |
107
- | `pathParameters` | `{ "entityName": "<CamelCaseEntityName>" }` — every Data Fabric activity uses this |
108
- | `bodyParameters` | Required for Create/Update; omit for Query/Delete/GetById |
109
- | `method` / `endpoint` / `uiPathActivityTypeId` / `telemetryData` | Per-activity values — see Activity Reference table below |
110
- | `configuration` | `=jsonString:{...}` — see Configuration Strings section below |
111
-
112
- ### Activity Reference
113
-
114
- | Activity | Method | Endpoint | `uiPathActivityTypeId` | `operationType` | `objectName` |
115
- |---|---|---|---|---|---|
116
- | Query Entity Records | `POST` | `/v2/{entityName}/qer` | `703065b9-a310-33b8-9d4d-12df0a6f520b` | `list` | `QueryEntityRecordsCurated` |
117
- | Create Entity Record | `POST` | `/v2/{entityName}/CreateEntityRecord` | `dfd2bc7a-ca4b-3316-8a1f-57c9e106dfbf` | `create` | `CreateEntityRecordCurated` |
118
- | Update Entity Record | `PUT` | `/v2/{entityName}/UpdateEntityRecord` | `718fdc36-73a8-3607-8604-ddef95bb9967` | `replace` | `UpdateEntityRecordV2` |
119
- | Delete Entity Record | `POST` | `/v2/{entityName}/DeleteEntityRecord` | `9c8029ee-ff5f-3b82-92cc-34cee15e9f1d` | `delete` | `DeleteEntityRecordCurated` |
120
- | Get Entity Record by ID | `GET` | `/v2/{entityName}/GetEntityRecord` | `81291b95-ff0c-3822-bdaa-3065391c1997` | `retrieve` | `GetEntityRecordByIdCurated` |
121
-
122
- ---
123
-
124
- ## Configuration Strings
125
-
126
- `<activityVersion>` is the `version` field inside the definition's `connectorDetail.configuration` JSON string — a **connector-internal activity version, distinct from the node `typeVersion`**. Read its value from the `definitions[]` entry you copied from `registry get` (do not hardcode it); the same value fills every `<activityVersion>` placeholder in the configuration string. `connectorVersion` is set by `node configure` at run time.
127
-
128
- **Query Entity Records:**
129
- ```
130
- =jsonString:{"essentialConfiguration":{"connectorVersion":"<connectorVersion>","customFieldsRequestDetails":{"objectActionName":"GenerateSchema","parameterValues":[["entityName","<EntityName>"]]},"instanceParameters":{"connectorKey":"uipath-uipath-dataservice","objectName":"QueryEntityRecordsCurated","httpMethod":"POST","activityType":"Curated","version":"<activityVersion>","supportsStreaming":false,"subType":"standard"},"objectName":"QueryEntityRecordsCurated","operation":"list","packageVersion":"<activityVersion>","httpMethod":"POST","path":"/v2/{entityName}/qer","unifiedTypesCompatible":true}}
131
- ```
132
-
133
- **Create Entity Record:**
134
- ```
135
- =jsonString:{"essentialConfiguration":{"connectorVersion":"<connectorVersion>","customFieldsRequestDetails":{"objectActionName":"GenerateSchema","parameterValues":[["entityName","<EntityName>"]]},"instanceParameters":{"connectorKey":"uipath-uipath-dataservice","objectName":"CreateEntityRecordCurated","httpMethod":"POST","activityType":"Curated","version":"<activityVersion>","supportsStreaming":false,"subType":"standard"},"objectName":"CreateEntityRecordCurated","operation":"create","packageVersion":"<activityVersion>","httpMethod":"POST","path":"/v2/{entityName}/CreateEntityRecord","unifiedTypesCompatible":true,"savedJitInputFieldId":"in_CreateEntityRecordCurated"}}
136
- ```
137
-
138
- **Update Entity Record:**
139
- ```
140
- =jsonString:{"essentialConfiguration":{"connectorVersion":"<connectorVersion>","customFieldsRequestDetails":{"objectActionName":"GenerateSchema","parameterValues":[["entityName","<EntityName>"]]},"instanceParameters":{"connectorKey":"uipath-uipath-dataservice","objectName":"UpdateEntityRecordV2","httpMethod":"PUT","activityType":"Curated","version":"<activityVersion>","supportsStreaming":false,"subType":"standard"},"objectName":"UpdateEntityRecordV2","operation":"replace","packageVersion":"<activityVersion>","httpMethod":"PUT","path":"/v2/{entityName}/UpdateEntityRecord","unifiedTypesCompatible":true,"savedJitInputFieldId":"in_UpdateEntityRecordV2"}}
141
- ```
142
-
143
- **Get Entity Record by ID:**
144
- ```
145
- =jsonString:{"essentialConfiguration":{"connectorVersion":"<connectorVersion>","customFieldsRequestDetails":{"objectActionName":"GenerateSchema","parameterValues":[["entityName","<EntityName>"]]},"instanceParameters":{"connectorKey":"uipath-uipath-dataservice","objectName":"GetEntityRecordByIdCurated","httpMethod":"GET","activityType":"Curated","version":"<activityVersion>","supportsStreaming":false,"subType":"standard"},"objectName":"GetEntityRecordByIdCurated","operation":"retrieve","packageVersion":"<activityVersion>","httpMethod":"GET","path":"/v2/{entityName}/GetEntityRecord","unifiedTypesCompatible":true,"savedJitInputFieldId":"in_GetEntityRecordByIdCurated"}}
146
- ```
147
-
148
- **Delete Entity Record:**
149
- ```
150
- =jsonString:{"essentialConfiguration":{"connectorVersion":"<connectorVersion>","customFieldsRequestDetails":null,"instanceParameters":{"connectorKey":"uipath-uipath-dataservice","objectName":"DeleteEntityRecordCurated","httpMethod":"POST","activityType":"Curated","version":"<activityVersion>","supportsStreaming":false,"subType":"standard"},"objectName":"DeleteEntityRecordCurated","operation":"delete","packageVersion":"<activityVersion>","httpMethod":"POST","path":"/v2/{entityName}/DeleteEntityRecord","unifiedTypesCompatible":true}}
151
- ```
152
-
153
- > Delete is the only activity where `customFieldsRequestDetails` is `null` — do not restore it after `node configure`.
154
-
155
- ---
156
-
157
- ## Definitions Templates
158
-
159
- Add one entry per activity type used to `definitions[]` in the `.flow` file (sibling of `nodes`/`edges`/`bindings`). Replace `<cloud_host>/<org_id>` in `display.icon` with your tenant URL prefix. The icon hash is stable across tenants.
160
-
161
- > The `assemblyQualifiedName` version (`1.26.0.0`) reflects the IS connector package at time of authoring. If stale, fetch the current value: `uip maestro flow registry get uipath.connector.uipath-uipath-dataservice.query-entity-records --connection-id <connectionId> --output json` and read `Data.Node.form.sections[0].fields[0].componentProps.connectorDetail.assemblyQualifiedName`.
162
-
163
- > `definitions[]` must be present before running `node configure` — without it, configure fails with `No instanceParameters found in definition`.
164
-
165
- ### Query Entity Records
166
-
167
- ```json
168
- {
169
- "nodeType": "uipath.connector.uipath-uipath-dataservice.query-entity-records",
170
- "version": "1.0.0",
171
- "description": "(Data Fabric) Retrieves a list of records for the selected Entity from Data Fabric, according to specified filters.",
172
- "category": "connector.196550",
173
- "tags": ["connector", "activity"],
174
- "sortOrder": 515,
175
- "display": {
176
- "label": "Query Entity Records",
177
- "description": "(Data Fabric) Retrieves a list of records for the selected Entity from Data Fabric, according to specified filters.",
178
- "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
179
- "iconBackground": "linear-gradient(225deg, #FAFAFB 0%, #ECEDEF 100%)",
180
- "iconBackgroundDark": "linear-gradient(225deg, #526069 0%, rgba(50, 60, 66, 0.6) 100%)"
181
- },
182
- "handleConfiguration": [
183
- { "position": "left", "handles": [{ "id": "input", "type": "target", "handleType": "input", "label": "" }] },
184
- { "position": "right", "handles": [{ "id": "output", "type": "source", "handleType": "output", "label": "" }] }
185
- ],
186
- "inputDefaults": {},
187
- "inputDefinition": {},
188
- "outputDefinition": {
189
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
190
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
191
- },
192
- "debug": { "runtime": "bpmnEngine" },
193
- "model": {
194
- "type": "bpmn:SendTask",
195
- "serviceType": "Intsvc.ActivityExecution",
196
- "debug": { "runtime": "bpmnEngine" },
197
- "context": [
198
- { "name": "connectorKey", "type": "string", "value": "uipath-uipath-dataservice" },
199
- { "name": "operation", "type": "string" },
200
- { "name": "objectName", "type": "string", "value": "QueryEntityRecordsCurated" },
201
- { "name": "method", "type": "string", "value": "POST" },
202
- { "name": "connection", "type": "string", "value": "<bindings.<IS connection Name>>" },
203
- { "name": "folderKey", "type": "string", "value": "<bindings.FolderKey>" },
204
- { "name": "activityConfigurationVersion", "type": "string", "value": "v1" },
205
- { "name": "metadata", "type": "json", "body": { "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Query Entity Records" }, "inputMetadata": {}, "errorState": { "hasError": false } } }
206
- ]
207
- },
208
- "form": {
209
- "id": "connector-properties", "title": "Connector configuration",
210
- "sections": [{ "id": "connector", "title": "Connector", "collapsible": true, "defaultExpanded": true, "fields": [{
211
- "label": "", "name": "inputs.detail", "type": "custom", "component": "dap-config",
212
- "componentProps": { "connectorDetail": {
213
- "isAppActivity": false, "packageId": 196550,
214
- "svgIconUrl": "icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
215
- "displayName": "Query Entity Records",
216
- "assemblyQualifiedName": "UiPath.IntegrationService.Activities.Runtime.Activities.ConnectorActivity, UiPath.IntegrationService.Activities.Runtime, Version=1.26.0.0, Culture=neutral, PublicKeyToken=null",
217
- "description": "(Data Fabric) Retrieves a list of records for the selected Entity from Data Fabric, according to specified filters.",
218
- "activityColor": "#E56D5C",
219
- "configuration": "{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"QueryEntityRecordsCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"1.0.0\",\"supportsStreaming\":false,\"subType\":\"standard\"}",
220
- "uiPathActivityTypeId": "703065b9-a310-33b8-9d4d-12df0a6f520b",
221
- "isExperimental": true,
222
- "helpUrlTemplate": "https://docs.uipath.com/{0}/activities/other/latest/integration-service/uipath-uipath-dataservice-Query-Entity-Records",
223
- "isEnabled": true, "targetPlatform": "CrossPlatform", "isAdvanced": false, "isRestricted": false, "tags": []
224
- }}
225
- }]}]
226
- }
227
- }
228
- ```
229
-
230
- ### Create Entity Record
231
-
232
- ```json
233
- {
234
- "nodeType": "uipath.connector.uipath-uipath-dataservice.create-entity-record",
235
- "version": "1.0.0",
236
- "description": "(Data Fabric) Creates a new record for the selected Entity in Data Fabric",
237
- "category": "connector.196550",
238
- "tags": ["connector", "activity"],
239
- "sortOrder": 515,
240
- "display": {
241
- "label": "Create Entity Record",
242
- "description": "(Data Fabric) Creates a new record for the selected Entity in Data Fabric",
243
- "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
244
- "iconBackground": "linear-gradient(225deg, #FAFAFB 0%, #ECEDEF 100%)",
245
- "iconBackgroundDark": "linear-gradient(225deg, #526069 0%, rgba(50, 60, 66, 0.6) 100%)"
246
- },
247
- "handleConfiguration": [
248
- { "position": "left", "handles": [{ "id": "input", "type": "target", "handleType": "input", "label": "" }] },
249
- { "position": "right", "handles": [{ "id": "output", "type": "source", "handleType": "output", "label": "" }] }
250
- ],
251
- "inputDefaults": {},
252
- "inputDefinition": {},
253
- "outputDefinition": {
254
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
255
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
256
- },
257
- "debug": { "runtime": "bpmnEngine" },
258
- "model": {
259
- "type": "bpmn:SendTask",
260
- "serviceType": "Intsvc.ActivityExecution",
261
- "debug": { "runtime": "bpmnEngine" },
262
- "context": [
263
- { "name": "connectorKey", "type": "string", "value": "uipath-uipath-dataservice" },
264
- { "name": "operation", "type": "string" },
265
- { "name": "objectName", "type": "string", "value": "CreateEntityRecordCurated" },
266
- { "name": "method", "type": "string", "value": "POST" },
267
- { "name": "connection", "type": "string", "value": "<bindings.<IS connection Name>>" },
268
- { "name": "folderKey", "type": "string", "value": "<bindings.FolderKey>" },
269
- { "name": "activityConfigurationVersion", "type": "string", "value": "v1" },
270
- { "name": "metadata", "type": "json", "body": { "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Create Entity Record" }, "inputMetadata": {}, "errorState": { "hasError": false } } }
271
- ]
272
- },
273
- "form": {
274
- "id": "connector-properties", "title": "Connector configuration",
275
- "sections": [{ "id": "connector", "title": "Connector", "collapsible": true, "defaultExpanded": true, "fields": [{
276
- "label": "", "name": "inputs.detail", "type": "custom", "component": "dap-config",
277
- "componentProps": { "connectorDetail": {
278
- "isAppActivity": false, "packageId": 196550,
279
- "svgIconUrl": "icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
280
- "displayName": "Create Entity Record",
281
- "assemblyQualifiedName": "UiPath.IntegrationService.Activities.Runtime.Activities.ConnectorActivity, UiPath.IntegrationService.Activities.Runtime, Version=1.26.0.0, Culture=neutral, PublicKeyToken=null",
282
- "description": "(Data Fabric) Creates a new record for the selected Entity in Data Fabric",
283
- "activityColor": "#E56D5C",
284
- "configuration": "{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"CreateEntityRecordCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"1.0.0\",\"supportsStreaming\":false,\"subType\":\"standard\"}",
285
- "uiPathActivityTypeId": "dfd2bc7a-ca4b-3316-8a1f-57c9e106dfbf",
286
- "isExperimental": true,
287
- "helpUrlTemplate": "https://docs.uipath.com/{0}/activities/other/latest/integration-service/uipath-uipath-dataservice-Create-Entity-Record",
288
- "isEnabled": true, "targetPlatform": "CrossPlatform", "isAdvanced": false, "isRestricted": false, "tags": []
289
- }}
290
- }]}]
291
- }
292
- }
293
- ```
294
-
295
- ### Update Entity Record
296
-
297
- ```json
298
- {
299
- "nodeType": "uipath.connector.uipath-uipath-dataservice.update-entity-record",
300
- "version": "1.0.0",
301
- "description": "(Data Fabric) Updates an existing record in a Data Fabric entity",
302
- "category": "connector.196550",
303
- "tags": ["connector", "activity"],
304
- "sortOrder": 515,
305
- "display": {
306
- "label": "Update Entity Record",
307
- "description": "(Data Fabric) Updates an existing record in a Data Fabric entity",
308
- "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
309
- "iconBackground": "linear-gradient(225deg, #FAFAFB 0%, #ECEDEF 100%)",
310
- "iconBackgroundDark": "linear-gradient(225deg, #526069 0%, rgba(50, 60, 66, 0.6) 100%)"
311
- },
312
- "handleConfiguration": [
313
- { "position": "left", "handles": [{ "id": "input", "type": "target", "handleType": "input", "label": "" }] },
314
- { "position": "right", "handles": [{ "id": "output", "type": "source", "handleType": "output", "label": "" }] }
315
- ],
316
- "inputDefaults": {},
317
- "inputDefinition": {},
318
- "outputDefinition": {
319
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
320
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
321
- },
322
- "debug": { "runtime": "bpmnEngine" },
323
- "model": {
324
- "type": "bpmn:SendTask",
325
- "serviceType": "Intsvc.ActivityExecution",
326
- "debug": { "runtime": "bpmnEngine" },
327
- "context": [
328
- { "name": "connectorKey", "type": "string", "value": "uipath-uipath-dataservice" },
329
- { "name": "operation", "type": "string" },
330
- { "name": "objectName", "type": "string", "value": "UpdateEntityRecordV2" },
331
- { "name": "method", "type": "string", "value": "PUT" },
332
- { "name": "connection", "type": "string", "value": "<bindings.<IS connection Name>>" },
333
- { "name": "folderKey", "type": "string", "value": "<bindings.FolderKey>" },
334
- { "name": "activityConfigurationVersion", "type": "string", "value": "v1" },
335
- { "name": "metadata", "type": "json", "body": { "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Update Entity Record" }, "inputMetadata": {}, "errorState": { "hasError": false } } }
336
- ]
337
- },
338
- "form": {
339
- "id": "connector-properties", "title": "Connector configuration",
340
- "sections": [{ "id": "connector", "title": "Connector", "collapsible": true, "defaultExpanded": true, "fields": [{
341
- "label": "", "name": "inputs.detail", "type": "custom", "component": "dap-config",
342
- "componentProps": { "connectorDetail": {
343
- "isAppActivity": false, "packageId": 196550,
344
- "svgIconUrl": "icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
345
- "displayName": "Update Entity Record",
346
- "assemblyQualifiedName": "UiPath.IntegrationService.Activities.Runtime.Activities.ConnectorActivity, UiPath.IntegrationService.Activities.Runtime, Version=1.26.0.0, Culture=neutral, PublicKeyToken=null",
347
- "description": "(Data Fabric) Updates an existing record in a Data Fabric entity",
348
- "activityColor": "#E56D5C",
349
- "configuration": "{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"UpdateEntityRecordV2\",\"httpMethod\":\"PUT\",\"activityType\":\"Curated\",\"version\":\"1.0.0\",\"supportsStreaming\":false,\"subType\":\"standard\"}",
350
- "uiPathActivityTypeId": "718fdc36-73a8-3607-8604-ddef95bb9967",
351
- "isExperimental": true,
352
- "helpUrlTemplate": "https://docs.uipath.com/{0}/activities/other/latest/integration-service/uipath-uipath-dataservice-Update-Entity-Record",
353
- "isEnabled": true, "targetPlatform": "CrossPlatform", "isAdvanced": false, "isRestricted": false, "tags": []
354
- }}
355
- }]}]
356
- }
357
- }
358
- ```
359
-
360
- ### Delete Entity Record
361
-
362
- ```json
363
- {
364
- "nodeType": "uipath.connector.uipath-uipath-dataservice.delete-entity-record",
365
- "version": "1.0.0",
366
- "description": "(Data Fabric) Deletes an existing record for the selected entity from Data Fabric",
367
- "category": "connector.196550",
368
- "tags": ["connector", "activity"],
369
- "sortOrder": 515,
370
- "display": {
371
- "label": "Delete Entity Record",
372
- "description": "(Data Fabric) Deletes an existing record for the selected entity from Data Fabric",
373
- "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
374
- "iconBackground": "linear-gradient(225deg, #FAFAFB 0%, #ECEDEF 100%)",
375
- "iconBackgroundDark": "linear-gradient(225deg, #526069 0%, rgba(50, 60, 66, 0.6) 100%)"
376
- },
377
- "handleConfiguration": [
378
- { "position": "left", "handles": [{ "id": "input", "type": "target", "handleType": "input", "label": "" }] },
379
- { "position": "right", "handles": [{ "id": "output", "type": "source", "handleType": "output", "label": "" }] }
380
- ],
381
- "inputDefaults": {},
382
- "inputDefinition": {},
383
- "outputDefinition": {
384
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
385
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
386
- },
387
- "debug": { "runtime": "bpmnEngine" },
388
- "model": {
389
- "type": "bpmn:SendTask",
390
- "serviceType": "Intsvc.ActivityExecution",
391
- "debug": { "runtime": "bpmnEngine" },
392
- "context": [
393
- { "name": "connectorKey", "type": "string", "value": "uipath-uipath-dataservice" },
394
- { "name": "operation", "type": "string" },
395
- { "name": "objectName", "type": "string", "value": "DeleteEntityRecordCurated" },
396
- { "name": "method", "type": "string", "value": "POST" },
397
- { "name": "connection", "type": "string", "value": "<bindings.<IS connection Name>>" },
398
- { "name": "folderKey", "type": "string", "value": "<bindings.FolderKey>" },
399
- { "name": "activityConfigurationVersion", "type": "string", "value": "v1" },
400
- { "name": "metadata", "type": "json", "body": { "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Delete Entity Record" }, "inputMetadata": {}, "errorState": { "hasError": false } } }
401
- ]
402
- },
403
- "form": {
404
- "id": "connector-properties", "title": "Connector configuration",
405
- "sections": [{ "id": "connector", "title": "Connector", "collapsible": true, "defaultExpanded": true, "fields": [{
406
- "label": "", "name": "inputs.detail", "type": "custom", "component": "dap-config",
407
- "componentProps": { "connectorDetail": {
408
- "isAppActivity": false, "packageId": 196550,
409
- "svgIconUrl": "icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
410
- "displayName": "Delete Entity Record",
411
- "assemblyQualifiedName": "UiPath.IntegrationService.Activities.Runtime.Activities.ConnectorActivity, UiPath.IntegrationService.Activities.Runtime, Version=1.26.0.0, Culture=neutral, PublicKeyToken=null",
412
- "description": "(Data Fabric) Deletes an existing record for the selected entity from Data Fabric",
413
- "activityColor": "#E56D5C",
414
- "configuration": "{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"DeleteEntityRecordCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"1.0.0\",\"supportsStreaming\":false,\"subType\":\"standard\"}",
415
- "uiPathActivityTypeId": "9c8029ee-ff5f-3b82-92cc-34cee15e9f1d",
416
- "isExperimental": true,
417
- "helpUrlTemplate": "https://docs.uipath.com/{0}/activities/other/latest/integration-service/uipath-uipath-dataservice-Delete-Entity-Record",
418
- "isEnabled": true, "targetPlatform": "CrossPlatform", "isAdvanced": false, "isRestricted": false, "tags": []
419
- }}
420
- }]}]
421
- }
422
- }
423
- ```
424
-
425
- ### Get Entity Record by ID
426
-
427
- ```json
428
- {
429
- "nodeType": "uipath.connector.uipath-uipath-dataservice.get-entity-record-by-id",
430
- "version": "1.0.0",
431
- "description": "(Data Fabric) Reads an existing record for the selected entity from Data Fabric",
432
- "category": "connector.196550",
433
- "tags": ["connector", "activity"],
434
- "sortOrder": 515,
435
- "display": {
436
- "label": "Get Entity Record by ID",
437
- "description": "(Data Fabric) Reads an existing record for the selected entity from Data Fabric",
438
- "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
439
- "iconBackground": "linear-gradient(225deg, #FAFAFB 0%, #ECEDEF 100%)",
440
- "iconBackgroundDark": "linear-gradient(225deg, #526069 0%, rgba(50, 60, 66, 0.6) 100%)"
441
- },
442
- "handleConfiguration": [
443
- { "position": "left", "handles": [{ "id": "input", "type": "target", "handleType": "input", "label": "" }] },
444
- { "position": "right", "handles": [{ "id": "output", "type": "source", "handleType": "output", "label": "" }] }
445
- ],
446
- "inputDefaults": {},
447
- "inputDefinition": {},
448
- "outputDefinition": {
449
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
450
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
451
- },
452
- "debug": { "runtime": "bpmnEngine" },
453
- "model": {
454
- "type": "bpmn:SendTask",
455
- "serviceType": "Intsvc.ActivityExecution",
456
- "debug": { "runtime": "bpmnEngine" },
457
- "context": [
458
- { "name": "connectorKey", "type": "string", "value": "uipath-uipath-dataservice" },
459
- { "name": "operation", "type": "string" },
460
- { "name": "objectName", "type": "string", "value": "GetEntityRecordByIdCurated" },
461
- { "name": "method", "type": "string", "value": "GET" },
462
- { "name": "connection", "type": "string", "value": "<bindings.<IS connection Name>>" },
463
- { "name": "folderKey", "type": "string", "value": "<bindings.FolderKey>" },
464
- { "name": "activityConfigurationVersion", "type": "string", "value": "v1" },
465
- { "name": "metadata", "type": "json", "body": { "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Get Entity Record by ID" }, "inputMetadata": {}, "errorState": { "hasError": false } } }
466
- ]
467
- },
468
- "form": {
469
- "id": "connector-properties", "title": "Connector configuration",
470
- "sections": [{ "id": "connector", "title": "Connector", "collapsible": true, "defaultExpanded": true, "fields": [{
471
- "label": "", "name": "inputs.detail", "type": "custom", "component": "dap-config",
472
- "componentProps": { "connectorDetail": {
473
- "isAppActivity": false, "packageId": 196550,
474
- "svgIconUrl": "icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg",
475
- "displayName": "Get Entity Record by ID",
476
- "assemblyQualifiedName": "UiPath.IntegrationService.Activities.Runtime.Activities.ConnectorActivity, UiPath.IntegrationService.Activities.Runtime, Version=1.26.0.0, Culture=neutral, PublicKeyToken=null",
477
- "description": "(Data Fabric) Reads an existing record for the selected entity from Data Fabric",
478
- "activityColor": "#E56D5C",
479
- "configuration": "{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"GetEntityRecordByIdCurated\",\"httpMethod\":\"GET\",\"activityType\":\"Curated\",\"version\":\"1.0.0\",\"supportsStreaming\":false,\"subType\":\"standard\"}",
480
- "uiPathActivityTypeId": "81291b95-ff0c-3822-bdaa-3065391c1997",
481
- "isExperimental": true,
482
- "helpUrlTemplate": "https://docs.uipath.com/{0}/activities/other/latest/integration-service/uipath-uipath-dataservice-Get-Entity-Record-by-ID",
483
- "isEnabled": true, "targetPlatform": "CrossPlatform", "isAdvanced": false, "isRestricted": false, "tags": []
484
- }}
485
- }]}]
486
- }
487
- }
488
- ```
489
-
490
- ---
491
-
492
- ## Node JSON Templates
493
-
494
- Substitute `<EntityName>`, `<connectionId>`, `<folderKey>`, and `<IS connection Name>` with actual values. Use the same tenant URL prefix for `display.icon` as in the Definitions Templates above.
495
-
496
- ### Query Entity Records
497
-
498
- ```json
499
- {
500
- "id": "queryEntityRecords1",
501
- "type": "uipath.connector.uipath-uipath-dataservice.query-entity-records",
502
- "typeVersion": "1.0.0",
503
- "display": { "label": "Query <EntityName>", "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg", "subLabel": "" },
504
- "inputs": {
505
- "detail": {
506
- "connector": "uipath-uipath-dataservice",
507
- "connectionId": "<connectionId>",
508
- "connectionResourceId": "<connectionId>",
509
- "connectionFolderKey": "<folderKey>",
510
- "method": "POST",
511
- "endpoint": "/v2/{entityName}/qer",
512
- "pathParameters": { "entityName": "<EntityName>" },
513
- "queryParameters": { "start": 0, "limit": 100, "expansionLevel": "3", "isAscending": false },
514
- "uiPathActivityTypeId": "703065b9-a310-33b8-9d4d-12df0a6f520b",
515
- "errorState": { "issues": [] },
516
- "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Data Fabric", "operationType": "list", "objectName": "QueryEntityRecordsCurated", "objectDisplayName": "Query Entity Records", "primaryKeyName": "" },
517
- "configuration": "=jsonString:{\"essentialConfiguration\":{\"connectorVersion\":\"<connectorVersion>\",\"customFieldsRequestDetails\":{\"objectActionName\":\"GenerateSchema\",\"parameterValues\":[[\"entityName\",\"<EntityName>\"]]},\"instanceParameters\":{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"QueryEntityRecordsCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"<activityVersion>\",\"supportsStreaming\":false,\"subType\":\"standard\"},\"objectName\":\"QueryEntityRecordsCurated\",\"operation\":\"list\",\"packageVersion\":\"<activityVersion>\",\"httpMethod\":\"POST\",\"path\":\"/v2/{entityName}/qer\",\"unifiedTypesCompatible\":true}}"
518
- }
519
- },
520
- "outputs": {
521
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
522
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
523
- }
524
- }
525
- ```
526
-
527
- **Pagination defaults** — `start`, `limit`, and `isAscending` are adjustable. Use `queryExpression` to filter: `"queryExpression": "<FilterExpression>"` (e.g. `"FieldName = 'value' AND OtherField > 10"`).
528
-
529
- **Output:** `<nodeId>.output` — array of records. Access fields as `=js:$vars.<nodeId>.output[0].<FieldName>`.
530
-
531
- ---
532
-
533
- ### Create Entity Record
534
-
535
- ```json
536
- {
537
- "id": "createEntityRecord1",
538
- "type": "uipath.connector.uipath-uipath-dataservice.create-entity-record",
539
- "typeVersion": "1.0.0",
540
- "display": { "label": "Create <EntityName>", "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg", "subLabel": "" },
541
- "inputs": {
542
- "detail": {
543
- "connector": "uipath-uipath-dataservice",
544
- "connectionId": "<connectionId>",
545
- "connectionResourceId": "<connectionId>",
546
- "connectionFolderKey": "<folderKey>",
547
- "method": "POST",
548
- "endpoint": "/v2/{entityName}/CreateEntityRecord",
549
- "pathParameters": { "entityName": "<EntityName>" },
550
- "queryParameters": { "expansionLevel": "3" },
551
- "bodyParameters": { "FieldName1": "<value1>", "FieldName2": "<value2>" },
552
- "uiPathActivityTypeId": "dfd2bc7a-ca4b-3316-8a1f-57c9e106dfbf",
553
- "errorState": { "issues": [] },
554
- "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Data Fabric", "operationType": "create", "objectName": "CreateEntityRecordCurated", "objectDisplayName": "Create Entity Record", "primaryKeyName": "" },
555
- "configuration": "=jsonString:{\"essentialConfiguration\":{\"connectorVersion\":\"<connectorVersion>\",\"customFieldsRequestDetails\":{\"objectActionName\":\"GenerateSchema\",\"parameterValues\":[[\"entityName\",\"<EntityName>\"]]},\"instanceParameters\":{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"CreateEntityRecordCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"<activityVersion>\",\"supportsStreaming\":false,\"subType\":\"standard\"},\"objectName\":\"CreateEntityRecordCurated\",\"operation\":\"create\",\"packageVersion\":\"<activityVersion>\",\"httpMethod\":\"POST\",\"path\":\"/v2/{entityName}/CreateEntityRecord\",\"unifiedTypesCompatible\":true,\"savedJitInputFieldId\":\"in_CreateEntityRecordCurated\"}}"
556
- }
557
- },
558
- "outputs": {
559
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
560
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
561
- }
562
- }
563
- ```
564
-
565
- **Output:** `<nodeId>.output` — the newly created record object (includes `Id`).
566
-
567
- ---
568
-
569
- ### Update Entity Record
570
-
571
- ```json
572
- {
573
- "id": "updateEntityRecord1",
574
- "type": "uipath.connector.uipath-uipath-dataservice.update-entity-record",
575
- "typeVersion": "1.0.0",
576
- "display": { "label": "Update <EntityName>", "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg", "subLabel": "" },
577
- "inputs": {
578
- "detail": {
579
- "connector": "uipath-uipath-dataservice",
580
- "connectionId": "<connectionId>",
581
- "connectionResourceId": "<connectionId>",
582
- "connectionFolderKey": "<folderKey>",
583
- "method": "PUT",
584
- "endpoint": "/v2/{entityName}/UpdateEntityRecord",
585
- "pathParameters": { "entityName": "<EntityName>" },
586
- "queryParameters": { "recordId": "=js:$vars.<sourceNodeId>.output.Id", "expansionLevel": "3" },
587
- "bodyParameters": { "FieldToUpdate": "<newValue>" },
588
- "uiPathActivityTypeId": "718fdc36-73a8-3607-8604-ddef95bb9967",
589
- "errorState": { "issues": [] },
590
- "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Data Fabric", "operationType": "replace", "objectName": "UpdateEntityRecordV2", "objectDisplayName": "Update Entity Record", "primaryKeyName": "" },
591
- "configuration": "=jsonString:{\"essentialConfiguration\":{\"connectorVersion\":\"<connectorVersion>\",\"customFieldsRequestDetails\":{\"objectActionName\":\"GenerateSchema\",\"parameterValues\":[[\"entityName\",\"<EntityName>\"]]},\"instanceParameters\":{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"UpdateEntityRecordV2\",\"httpMethod\":\"PUT\",\"activityType\":\"Curated\",\"version\":\"<activityVersion>\",\"supportsStreaming\":false,\"subType\":\"standard\"},\"objectName\":\"UpdateEntityRecordV2\",\"operation\":\"replace\",\"packageVersion\":\"<activityVersion>\",\"httpMethod\":\"PUT\",\"path\":\"/v2/{entityName}/UpdateEntityRecord\",\"unifiedTypesCompatible\":true,\"savedJitInputFieldId\":\"in_UpdateEntityRecordV2\"}}"
592
- }
593
- },
594
- "outputs": {
595
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
596
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
597
- }
598
- }
599
- ```
600
-
601
- ---
602
-
603
- ### Delete Entity Record
604
-
605
- ```json
606
- {
607
- "id": "deleteEntityRecord1",
608
- "type": "uipath.connector.uipath-uipath-dataservice.delete-entity-record",
609
- "typeVersion": "1.0.0",
610
- "display": { "label": "Delete <EntityName>", "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg", "subLabel": "" },
611
- "inputs": {
612
- "detail": {
613
- "connector": "uipath-uipath-dataservice",
614
- "connectionId": "<connectionId>",
615
- "connectionResourceId": "<connectionId>",
616
- "connectionFolderKey": "<folderKey>",
617
- "method": "POST",
618
- "endpoint": "/v2/{entityName}/DeleteEntityRecord",
619
- "pathParameters": { "entityName": "<EntityName>" },
620
- "queryParameters": { "recordId": "=js:$vars.<sourceNodeId>.output.Id" },
621
- "uiPathActivityTypeId": "9c8029ee-ff5f-3b82-92cc-34cee15e9f1d",
622
- "errorState": { "issues": [] },
623
- "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Data Fabric", "operationType": "delete", "objectName": "DeleteEntityRecordCurated", "objectDisplayName": "Delete Entity Record", "primaryKeyName": "" },
624
- "configuration": "=jsonString:{\"essentialConfiguration\":{\"connectorVersion\":\"<connectorVersion>\",\"customFieldsRequestDetails\":null,\"instanceParameters\":{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"DeleteEntityRecordCurated\",\"httpMethod\":\"POST\",\"activityType\":\"Curated\",\"version\":\"<activityVersion>\",\"supportsStreaming\":false,\"subType\":\"standard\"},\"objectName\":\"DeleteEntityRecordCurated\",\"operation\":\"delete\",\"packageVersion\":\"<activityVersion>\",\"httpMethod\":\"POST\",\"path\":\"/v2/{entityName}/DeleteEntityRecord\",\"unifiedTypesCompatible\":true}}"
625
- }
626
- },
627
- "outputs": {
628
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
629
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
630
- }
631
- }
632
- ```
633
-
634
- ---
635
-
636
- ### Get Entity Record by ID
637
-
638
- ```json
639
- {
640
- "id": "getEntityRecord1",
641
- "type": "uipath.connector.uipath-uipath-dataservice.get-entity-record-by-id",
642
- "typeVersion": "1.0.0",
643
- "display": { "label": "Get <EntityName> By Id", "icon": "https://<cloud_host>/<org_id>/studio_/typecache/icons/98381fa079bbcf73264f551006d6ef7580fb53992f3d9f94361eb5d9e06040cb.svg", "subLabel": "" },
644
- "inputs": {
645
- "detail": {
646
- "connector": "uipath-uipath-dataservice",
647
- "connectionId": "<connectionId>",
648
- "connectionResourceId": "<connectionId>",
649
- "connectionFolderKey": "<folderKey>",
650
- "method": "GET",
651
- "endpoint": "/v2/{entityName}/GetEntityRecord",
652
- "pathParameters": { "entityName": "<EntityName>" },
653
- "queryParameters": { "recordId": "=js:$vars.<sourceNodeId>.output.Id", "expansionLevel": "3" },
654
- "uiPathActivityTypeId": "81291b95-ff0c-3822-bdaa-3065391c1997",
655
- "errorState": { "issues": [] },
656
- "telemetryData": { "connectorKey": "uipath-uipath-dataservice", "connectorName": "Data Fabric", "operationType": "retrieve", "objectName": "GetEntityRecordByIdCurated", "objectDisplayName": "Get Entity Record by ID", "primaryKeyName": "" },
657
- "configuration": "=jsonString:{\"essentialConfiguration\":{\"connectorVersion\":\"<connectorVersion>\",\"customFieldsRequestDetails\":{\"objectActionName\":\"GenerateSchema\",\"parameterValues\":[[\"entityName\",\"<EntityName>\"]]},\"instanceParameters\":{\"connectorKey\":\"uipath-uipath-dataservice\",\"objectName\":\"GetEntityRecordByIdCurated\",\"httpMethod\":\"GET\",\"activityType\":\"Curated\",\"version\":\"<activityVersion>\",\"supportsStreaming\":false,\"subType\":\"standard\"},\"objectName\":\"GetEntityRecordByIdCurated\",\"operation\":\"retrieve\",\"packageVersion\":\"<activityVersion>\",\"httpMethod\":\"GET\",\"path\":\"/v2/{entityName}/GetEntityRecord\",\"unifiedTypesCompatible\":true,\"savedJitInputFieldId\":\"in_GetEntityRecordByIdCurated\"}}"
658
- }
659
- },
660
- "outputs": {
661
- "output": { "type": "object", "description": "The return value of the connector.", "source": "=result.response", "var": "output" },
662
- "error": { "type": "object", "description": "Error information if the node fails", "source": "=Error", "var": "error" }
663
- }
664
- }
665
- ```
666
-
667
- ---
668
-
669
- ## Script Nodes That Consume Query Results
670
-
671
- When writing a script node that reads query output, guard against empty results:
672
-
673
- ```javascript
674
- /** @type {any[]} */
675
- const results = $vars.<queryNodeId>.output;
676
- if (!results || results.length === 0) {
677
- return { skipped: true, reason: 'No matching records.' };
678
- }
679
- /** @type {any} */
680
- const record = results[0];
681
- ```
682
-
683
- Studio Web types `$vars.<nodeId>.output` as `unknown` — use a JSDoc cast (`/** @type {any} */`) to suppress TypeScript property warnings. These are design-time warnings only and do not affect runtime.