@uipath/skills 1.195.0 → 1.196.0
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.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/CODEOWNERS +16 -10
- package/README.md +39 -4
- package/assets/skill-status.json +189 -0
- package/assets/uip-catalog-snapshot.json +67 -97
- package/commands/install-permissions.md +46 -2
- package/hooks/suggest-permissions.sh +0 -0
- package/hooks/validate-skill-descriptions.sh +0 -0
- package/package.json +1 -1
- package/skills/uipath-admin/SKILL.md +6 -7
- package/skills/uipath-admin/references/audit-commands.md +32 -10
- package/skills/uipath-admin/references/audit-workflow-guide.md +25 -6
- package/skills/uipath-admin/references/ip-restriction/ip-restriction-commands.md +1 -1
- package/skills/uipath-agents/SKILL.md +5 -3
- package/skills/uipath-agents/references/coded/embedding-in-flows.md +6 -0
- package/skills/uipath-agents/references/coded/flow-integration.md +1 -0
- package/skills/uipath-agents/references/coded/frameworks/langgraph-integration.md +2 -2
- package/skills/uipath-agents/references/coded/frameworks/llamaindex-integration.md +1 -1
- package/skills/uipath-agents/references/coded/frameworks/openai-agents-integration.md +5 -1
- package/skills/uipath-agents/references/coded/lifecycle/build.md +1 -0
- package/skills/uipath-agents/references/coded/lifecycle/evaluate.md +8 -6
- package/skills/uipath-agents/references/coded/quickstart.md +17 -12
- package/skills/uipath-agents/references/lowcode/agent-definition.md +17 -16
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/analyze-attachments.md +2 -2
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/batch-transform/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/built-in-tools.md +4 -4
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/deeprag/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/context.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/datafabric.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/index.md +12 -12
- package/skills/uipath-agents/references/lowcode/capabilities/escalation/escalation.md +14 -14
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +23 -20
- package/skills/uipath-agents/references/lowcode/capabilities/inline-in-flow/inline-in-flow.md +27 -26
- package/skills/uipath-agents/references/lowcode/capabilities/integration-service/integration-service.md +12 -13
- package/skills/uipath-agents/references/lowcode/capabilities/mcp/mcp.md +133 -0
- package/skills/uipath-agents/references/lowcode/capabilities/memory/memory.md +9 -9
- package/skills/uipath-agents/references/lowcode/capabilities/process/process.md +25 -24
- package/skills/uipath-agents/references/lowcode/capabilities/process/solution-files.md +6 -6
- package/skills/uipath-agents/references/lowcode/critical-rules.md +17 -17
- package/skills/uipath-agents/references/lowcode/debug.md +55 -0
- package/skills/uipath-agents/references/lowcode/evaluations/evaluate.md +6 -6
- package/skills/uipath-agents/references/lowcode/evaluations/evaluation-sets.md +1 -1
- package/skills/uipath-agents/references/lowcode/evaluations/evaluators.md +3 -3
- package/skills/uipath-agents/references/lowcode/evaluations/running-evaluations.md +8 -8
- package/skills/uipath-agents/references/lowcode/lowcode.md +18 -12
- package/skills/uipath-agents/references/lowcode/model-selection-guide.md +3 -3
- package/skills/uipath-agents/references/lowcode/project-lifecycle.md +53 -33
- package/skills/uipath-agents/references/lowcode/solution-resources.md +8 -8
- package/skills/uipath-api-workflow/SKILL.md +32 -83
- package/skills/uipath-api-workflow/references/cli-reference.md +40 -26
- package/skills/uipath-api-workflow/references/connector-activity-discovery.md +75 -23
- package/skills/uipath-api-workflow/references/troubleshooting.md +4 -12
- package/skills/uipath-automation-discovery/SKILL.md +234 -0
- package/skills/uipath-automation-discovery/references/intake-guide.md +85 -0
- package/skills/uipath-automation-discovery/references/mining-guide.md +156 -0
- package/skills/uipath-automation-discovery/references/report-template.md +95 -0
- package/skills/uipath-coded-apps/SKILL.md +0 -2
- package/skills/uipath-data-fabric/SKILL.md +0 -2
- package/skills/uipath-feedback/SKILL.md +1 -1
- package/skills/uipath-governance/SKILL.md +0 -2
- package/skills/uipath-human-in-the-loop/SKILL.md +2 -3
- package/skills/uipath-maestro-bpmn/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.py +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.sh +0 -0
- package/skills/uipath-maestro-bpmn/references/author/references/task-recipes/api-workflow.md +1 -1
- package/skills/uipath-maestro-bpmn/references/operate/references/run.md +1 -1
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +2 -2
- package/skills/uipath-maestro-bpmn/references/shared/wrapper-shells.md +1 -1
- package/skills/uipath-maestro-case/SKILL.md +22 -27
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +7 -1
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +7 -16
- package/skills/uipath-maestro-case/references/case-commands.md +9 -9
- package/skills/uipath-maestro-case/references/case-editing-operations.md +51 -67
- package/skills/uipath-maestro-case/references/case-schema.md +74 -138
- package/skills/uipath-maestro-case/references/connector-integration.md +32 -5
- package/skills/uipath-maestro-case/references/connector-trigger-common.md +39 -12
- package/skills/uipath-maestro-case/references/evals/evals.json +9 -23
- package/skills/uipath-maestro-case/references/implementation.md +24 -24
- package/skills/uipath-maestro-case/references/phased-execution.md +24 -38
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +9 -9
- package/skills/uipath-maestro-case/references/planning.md +20 -79
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +15 -122
- package/skills/uipath-maestro-case/references/plugins/case/planning.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/impl-json.md +10 -22
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +7 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/logging/impl-json.md +10 -0
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +10 -42
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +8 -79
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +7 -14
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +2 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +12 -7
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +3 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +6 -7
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +4 -2
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +4 -27
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +8 -20
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +6 -11
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +15 -30
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +8 -7
- package/skills/uipath-maestro-case/references/registry-discovery.md +4 -4
- package/skills/uipath-maestro-case/references/sdd-generation-rules.md +12 -10
- package/skills/uipath-maestro-case/references/troubleshooting-guide.md +1 -1
- package/skills/uipath-maestro-flow/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-versions.sh +0 -0
- package/skills/uipath-maestro-flow/SKILL.md +9 -6
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +4 -4
- package/skills/uipath-maestro-flow/references/author/references/brownfield.md +17 -2
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-cli.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +3 -3
- package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +9 -9
- package/skills/uipath-maestro-flow/references/author/references/greenfield.md +13 -10
- package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +75 -5
- package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +2 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +14 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +20 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/planning.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-connector.md +81 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-manual.md +63 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl.md +59 -57
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/planning.md +8 -7
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/impl.md +23 -23
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/planning.md +2 -2
- package/skills/uipath-maestro-flow/references/diagnose/CAPABILITY.md +1 -1
- package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +6 -6
- package/skills/uipath-maestro-flow/references/evaluate/CAPABILITY.md +2 -2
- package/skills/uipath-maestro-flow/references/evaluate/references/upload-safety.md +1 -1
- package/skills/uipath-maestro-flow/references/operate/CAPABILITY.md +8 -8
- package/skills/uipath-maestro-flow/references/operate/references/run.md +2 -2
- package/skills/uipath-maestro-flow/references/operate/references/ship.md +7 -7
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +19 -17
- package/skills/uipath-maestro-flow/references/shared/cli-conventions.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/ux-narration-and-todos.md +7 -7
- package/skills/uipath-planner/SKILL.md +110 -74
- package/skills/{uipath-solution → uipath-planner}/assets/templates/agent-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/api-workflow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/case-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/coded-app-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/flow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/rpa-sdd-template.md +11 -11
- package/skills/uipath-planner/references/multi-skill-patterns-guide.md +3 -3
- package/skills/uipath-planner/references/non-pdd-lane-guide.md +10 -6
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +17 -7
- package/skills/uipath-planner/references/plan-and-tasks-format.md +2 -2
- package/skills/{uipath-solution/references/design → uipath-planner/references}/product-selection-guide.md +8 -8
- package/skills/{uipath-solution/references/design → uipath-planner/references}/rpa-product-guide.md +1 -1
- package/skills/{uipath-solution/references/design → uipath-planner/references}/sdd-generation-guide.md +26 -39
- package/skills/{uipath-solution/references/design → uipath-planner/references}/tenant-library-search-guide.md +7 -7
- package/skills/uipath-platform/SKILL.md +21 -48
- package/skills/uipath-platform/references/integration-service/http-request.md +5 -2
- package/skills/uipath-platform/references/integration-service/reference-resolution.md +19 -1
- package/skills/uipath-platform/references/integration-service/triggers.md +21 -5
- package/skills/uipath-platform/references/licensing/consumables-report.md +1 -1
- package/skills/uipath-platform/references/licensing/tenant-allocations.md +1 -1
- package/skills/uipath-platform/references/licensing/user-licenses-allocations.md +1 -1
- package/skills/uipath-platform/references/{resources → orchestrator}/manage-assets.md +37 -34
- package/skills/uipath-platform/references/orchestrator/manage-sessions.md +1 -1
- package/skills/uipath-platform/references/orchestrator/orchestrator.md +4 -31
- package/skills/uipath-platform/references/{resources → orchestrator}/process-queues.md +61 -50
- package/skills/uipath-platform/references/{resources → orchestrator}/resources.md +21 -21
- package/skills/uipath-platform/references/orchestrator/run-jobs.md +26 -14
- package/skills/uipath-platform/references/orchestrator/setup-environment.md +20 -16
- package/skills/uipath-platform/references/orchestrator/tenant-admin.md +7 -7
- package/skills/uipath-platform/references/{resources → orchestrator}/triggers-and-webhooks.md +41 -37
- package/skills/uipath-platform/references/{resources → orchestrator}/work-with-storage.md +56 -34
- package/skills/uipath-platform/references/uip-commands.md +20 -19
- package/skills/uipath-review/SKILL.md +81 -7
- package/skills/uipath-review/references/agents/agent-common-issues.md +42 -0
- package/skills/uipath-review/references/agents/agent-review-checklist.md +79 -57
- package/skills/uipath-review/references/agents/agents-coded-rules.md +160 -0
- package/skills/uipath-review/references/agents/agents-common-rules.md +32 -0
- package/skills/uipath-review/references/agents/agents-lowcode-rules.md +128 -0
- package/skills/uipath-review/references/platform/platform-resources-checklist.md +2 -2
- package/skills/uipath-review/references/review-workflow-guide.md +1 -1
- package/skills/uipath-review/references/rpa/rpa-review-checklist.md +2 -2
- package/skills/uipath-review/references/rule-catalog-workflow.md +90 -0
- package/skills/uipath-review/references/rule-format.md +91 -0
- package/skills/uipath-rpa/SKILL.md +16 -6
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateEntityRecord.md +149 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteEntityRecord.md +44 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteFileFromRecordField.md +56 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteMultipleEntityRecords.md +65 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DownloadFileFromRecordField.md +115 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/GetEntityRecordById.md +50 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/QueryEntityRecords.md +69 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateEntityRecord.md +120 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UploadFileToRecordField.md +103 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/guides/data-service-filter-builder-guide.md +461 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/overview.md +355 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AppendRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFillX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFitX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangeDataRangeModification.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangePivotTableDataSourceX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ClearRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CopyPasteRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreatePivotTableXv2.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreateTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DuplicateSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExportExcelToCsvX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FillRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindFirstLastDataRowX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindReplaceValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FormatRangeX.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertExcelChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/LookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/PivotTableFieldX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ProtectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellFormulaX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RefreshPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RemoveDuplicatesX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RenameSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveAsPdfX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveExcelFileX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UnprotectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UpdateChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/VLookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/WriteCellX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.GSuite.Activities/3.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Mail.Activities/2.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/SendMailConnections.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/overview.md +3 -3
- package/skills/uipath-rpa/references/activity-docs/UiPath.Presentations.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.System.Activities/25.10/activities/overview.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Word.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/cli-reference.md +108 -554
- package/skills/uipath-rpa/references/coded/coding-guidelines.md +1 -1
- package/skills/uipath-rpa/references/coded/operations-guide.md +3 -3
- package/skills/uipath-rpa/references/coded/third-party-packages-guide.md +1 -1
- package/skills/uipath-rpa/references/connector-capabilities.md +3 -2
- package/skills/uipath-rpa/references/debugging.md +43 -36
- package/skills/uipath-rpa/references/environment-setup.md +3 -3
- package/skills/uipath-rpa/references/is-connector-xaml-guide.md +3 -3
- package/skills/uipath-rpa/references/library-authoring-guide.md +226 -0
- package/skills/uipath-rpa/references/project-structure-guide.md +43 -0
- package/skills/uipath-rpa/references/publishing-guide.md +5 -5
- package/skills/uipath-rpa/references/tenant-library-search-guide.md +18 -14
- package/skills/uipath-rpa/references/testing-guide.md +6 -6
- package/skills/uipath-rpa/references/trigger-pattern-guide.md +2 -2
- package/skills/uipath-rpa/references/ui-automation-guide.md +43 -6
- package/skills/uipath-rpa/references/uia-configure-target-workflows.md +2 -2
- package/skills/uipath-rpa/references/uia-prerequisites.md +1 -1
- package/skills/uipath-rpa/references/validation-guide.md +4 -4
- package/skills/uipath-rpa/references/xaml/canvas-layout-guide.md +4 -1
- package/skills/uipath-rpa/references/xaml/common-pitfalls.md +18 -6
- package/skills/uipath-rpa/references/xaml/long-running-workflow-guide.md +304 -0
- package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +3 -0
- package/skills/uipath-solution/SKILL.md +23 -125
- package/skills/uipath-solution/references/{operate/activate-and-manage.md → activate-and-manage.md} +1 -1
- package/skills/uipath-solution/references/{operate/develop-solution.md → develop-solution.md} +43 -37
- package/skills/uipath-solution/references/{operate/pack-and-deploy.md → pack-and-deploy.md} +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/intra-solution-references.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/manual-edits.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/same-name-across-folders.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/shared-cloud-resource.md +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/virtual-resource.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios.md → scenarios.md} +5 -5
- package/skills/uipath-solution/references/{operate/solution-overview.md → solution-overview.md} +3 -3
- package/skills/uipath-tasks/SKILL.md +0 -2
- package/skills/uipath-test/SKILL.md +26 -7
- package/skills/uipath-troubleshoot/agents/triage.md +6 -4
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/overview.md +55 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/add-queue-item-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/application-launch-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-open-or-attach-failed.md +59 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/file-operation-failed.md +60 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/foreach-row-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/image-target-not-found.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-code-failed.md +54 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/kill-process-failed.md +49 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-configuration-error.md +80 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-timeout.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-interaction-failed.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-not-found.md +64 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +24 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-locked.md +142 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-not-found.md +140 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-null-reference.md +119 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-sheet-not-found.md +146 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/write-cell-failures.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/summary.md +5 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/investigation_guide.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/overview.md +16 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/activity-configuration-error.md +42 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-not-found.md +84 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-open-failed.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/browser-navigation-failed.md +45 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-coordinate-off-screen.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/disabled-element.md +0 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/element-found-not-actionable.md +43 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-no-license.md +12 -12
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-orch-issues.md +108 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/inject-js-failed.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +7 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/select-item-no-items.md +37 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-manual.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/timeout-issue.md +2 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/wrong-target-application.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +12 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +111 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-connection-disabled.md +90 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-credentials.md +123 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-element-instance.md +96 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/llm-insufficient-information.md +1 -1
- package/skills/uipath-troubleshoot/references/products/agents/summary.md +4 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/investigation_guide.md +7 -7
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-no-host.md +3 -1
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-stale-dispatch.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stopped-exit-code-0x40010004.md +104 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/summary.md +10 -1
- package/version-manifest.json +2 -2
- package/skills/uipath-ixp/SKILL.md +0 -84
- package/skills/uipath-ixp/references/cli-reference.md +0 -113
- package/skills/uipath-ixp/references/improve-prompts-guide.md +0 -283
- package/skills/uipath-ixp/references/label-documents-guide.md +0 -175
- package/skills/uipath-ixp/references/project-setup-guide.md +0 -90
- package/skills/uipath-maestro-case/references/plugins/edges/impl-json.md +0 -152
- package/skills/uipath-maestro-case/references/plugins/edges/planning.md +0 -93
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/package-selection-guide.md +0 -0
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/pdd-analysis-guide.md +0 -0
- /package/skills/uipath-solution/references/{operate/scenarios → scenarios}/failure-modes.md +0 -0
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: uipath-platform
|
|
3
|
-
description: "UiPath platform ops via the uip CLI — use this skill for ANY task hitting UiPath Cloud / Orchestrator / Studio Web / Integration Service / LLM Gateway. Load BEFORE writing any code that calls a UiPath API. Covers auth, folders, assets, queues, storage buckets, bucket files, libraries, webhooks, triggers, processes, jobs, machines, users, roles, sessions, calendars, IS connectors/connections/activities, BYO LLM product configurations (`uip llm-configuration byo-connections` — register / audit / re-probe
|
|
4
|
-
when_to_use: "User mentions UiPath / Orchestrator / Studio Web / Integration Service / LLM Gateway / 'uip' CLI / asset / queue / bucket / library / webhook / trigger / connector / connection / tenant / folder / robot / package / BYO LLM. Also 'upload to UiPath', 'create asset', 'start job', 'list queues', 'deploy a single package to Orchestrator', 'OAuth2 token', 'register my own LLM key', 'configure a model substitution', 'my BYO LLM key stopped working / returns errors', 're-probe / audit a BYO configuration', 'uipath.com REST'.
|
|
3
|
+
description: "UiPath platform ops via the uip CLI — use this skill for ANY task hitting UiPath Cloud / Orchestrator / Studio Web / Integration Service / LLM Gateway. Load BEFORE writing any code that calls a UiPath API. Covers auth, folders, assets, queues, storage buckets, bucket files, libraries, webhooks, triggers, processes, jobs, machines, users, roles, sessions, calendars, IS connectors/connections/activities, BYO LLM product configurations (`uip llm-configuration byo-connections` — register / audit / re-probe tenant-owned OpenAI / Azure OpenAI / Bedrock / Vertex / Anthropic keys), traces, licensing. For 'why did X fail' / root-cause / error investigations→uipath-troubleshoot. For `uip solution` lifecycle→uipath-solution. For PDD/SDD design & task planning→uipath-planner. For workflow code (.xaml/.cs)→uipath-rpa, .flow→uipath-maestro-flow, .bpmn→uipath-maestro-bpmn, agents (.py/agent.json)→uipath-agents, Test Manager→uipath-test."
|
|
4
|
+
when_to_use: "User mentions UiPath / Orchestrator / Studio Web / Integration Service / LLM Gateway / 'uip' CLI / asset / queue / bucket / library / webhook / trigger / connector / connection / tenant / folder / robot / package / BYO LLM. Also 'upload to UiPath', 'create asset', 'start job', 'list queues', 'deploy a single package to Orchestrator', 'OAuth2 token', 'register my own LLM key', 'configure a model substitution', 'my BYO LLM key stopped working / returns errors', 're-probe / audit a BYO configuration', 'uipath.com REST'. For `uip solution` ops or `.uipx` deploys→uipath-solution."
|
|
5
5
|
allowed-tools: Bash, Read, Write, Glob, Grep
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# UiPath Platform — uip CLI Assistant
|
|
9
9
|
|
|
10
|
-
Comprehensive guide for UiPath Cloud / Orchestrator / Studio Web / Integration Service, end-to-end via the `uip` CLI. For `uip solution` lifecycle
|
|
10
|
+
Comprehensive guide for UiPath Cloud / Orchestrator / Studio Web / Integration Service, end-to-end via the `uip` CLI. For `uip solution` lifecycle load [`uipath-solution`](/uipath:uipath-solution); for PDD/SDD design & task planning load [`uipath-planner`](/uipath:uipath-planner).
|
|
11
11
|
|
|
12
12
|
## Use the CLI. Don't roll your own REST.
|
|
13
13
|
|
|
@@ -17,8 +17,8 @@ Hand-rolling HTTP calls — reading `~/.uipath/.auth` and POSTing to `/odata/...
|
|
|
17
17
|
|
|
18
18
|
If you find yourself about to `curl` `https://cloud.uipath.com/...` — stop. Search the command index first. Examples of what people often miss:
|
|
19
19
|
|
|
20
|
-
- "upload a file to a storage bucket" → `uip
|
|
21
|
-
- "create an asset" → `uip
|
|
20
|
+
- "upload a file to a storage bucket" → `uip or bucket-files upload` (NOT a `PUT /buckets/.../signedUrl` dance)
|
|
21
|
+
- "create an asset" → `uip or assets create` (NOT a `POST /odata/Assets`)
|
|
22
22
|
- "start a job for a process" → `uip or jobs start <process-key>` (NOT `POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs`)
|
|
23
23
|
- "configure an Integration Service connection" → `uip is connections create <connector-key>` (NOT a hand-rolled OAuth flow)
|
|
24
24
|
|
|
@@ -43,7 +43,7 @@ For `uip solution` lifecycle (init / pack / publish / deploy / activate / upload
|
|
|
43
43
|
The CLI stores credentials at **`~/.uipath/.auth`** after login:
|
|
44
44
|
```
|
|
45
45
|
UIPATH_URL=https://alpha.uipath.com
|
|
46
|
-
|
|
46
|
+
UIPATH_ORGANIZATION_NAME=my_org
|
|
47
47
|
UIPATH_TENANT_NAME=my_tenant
|
|
48
48
|
UIPATH_ACCESS_TOKEN=eyJ...
|
|
49
49
|
UIPATH_ORGANIZATION_ID=...
|
|
@@ -58,7 +58,14 @@ This token can be reused for direct Orchestrator REST API calls when CLI command
|
|
|
58
58
|
|
|
59
59
|
Before interacting with Orchestrator, solutions, or Integration Service, the user must be logged in.
|
|
60
60
|
|
|
61
|
-
**
|
|
61
|
+
**Always check first** — most sessions are already authenticated:
|
|
62
|
+
```bash
|
|
63
|
+
uip login status --output json
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
If it reports `Logged in`, skip the rest of this step. There is no `--check` flag — `status` is the verification subcommand.
|
|
67
|
+
|
|
68
|
+
**Interactive login (browser OAuth2):** `uip login` opens a browser window on the user's machine and blocks until they complete it. In a non-interactive or automated session, do NOT run it yourself — tell the user to run it and wait.
|
|
62
69
|
```bash
|
|
63
70
|
uip login --output json
|
|
64
71
|
```
|
|
@@ -73,11 +80,6 @@ For non-interactive (CI/CD) scenarios, use client credentials:
|
|
|
73
80
|
uip login --client-id "<ID>" --client-secret "<SECRET>" --tenant "<TENANT>" --output json
|
|
74
81
|
```
|
|
75
82
|
|
|
76
|
-
Check login status:
|
|
77
|
-
```bash
|
|
78
|
-
uip login status --output json
|
|
79
|
-
```
|
|
80
|
-
|
|
81
83
|
### Step 2 — Select a Tenant
|
|
82
84
|
|
|
83
85
|
List available tenants and set the active one:
|
|
@@ -108,10 +110,10 @@ Choose the appropriate operation from the Task Navigation table below. For `uip
|
|
|
108
110
|
| **Manage sessions and runtimes** | [references/orchestrator/manage-sessions.md](references/orchestrator/manage-sessions.md) |
|
|
109
111
|
| **Tenant settings, calendars, audit logs** | [references/orchestrator/tenant-admin.md](references/orchestrator/tenant-admin.md) |
|
|
110
112
|
| **Understand Orchestrator concepts** | [references/orchestrator/orchestrator.md](references/orchestrator/orchestrator.md) |
|
|
111
|
-
| **Manage assets** | [references/
|
|
112
|
-
| **Work with queues and queue items** | [references/
|
|
113
|
-
| **Work with storage buckets and files** | [references/
|
|
114
|
-
| **Set up triggers and webhooks** | [references/
|
|
113
|
+
| **Manage assets** | [references/orchestrator/manage-assets.md](references/orchestrator/manage-assets.md) |
|
|
114
|
+
| **Work with queues and queue items** | [references/orchestrator/process-queues.md](references/orchestrator/process-queues.md) |
|
|
115
|
+
| **Work with storage buckets and files** | [references/orchestrator/work-with-storage.md](references/orchestrator/work-with-storage.md) |
|
|
116
|
+
| **Set up triggers and webhooks** | [references/orchestrator/triggers-and-webhooks.md](references/orchestrator/triggers-and-webhooks.md) |
|
|
115
117
|
| **Develop / pack / publish / deploy / activate solutions; set up CI/CD** | [/uipath:uipath-solution](/uipath:uipath-solution) |
|
|
116
118
|
| **Debug LLM/agent traces (spans)** | [references/traces/traces.md](references/traces/traces.md) |
|
|
117
119
|
| **Annotate traces with feedback** | [references/traces/feedback.md](references/traces/feedback.md) |
|
|
@@ -240,42 +242,13 @@ Every `uip` command accepts:
|
|
|
240
242
|
- **For `uip solution` pack / publish / deploy / activate flows, load [`uipath-solution`](/uipath:uipath-solution).** This skill owns the auth and Orchestrator surface those flows depend on; the solution skill owns the lifecycle commands.
|
|
241
243
|
- **Fallback: direct REST API.** When CLI tools don't support an operation, use the Orchestrator REST API with the access token from `~/.uipath/.auth`. See [references/orchestrator/orchestrator.md - REST API](references/orchestrator/orchestrator.md).
|
|
242
244
|
|
|
243
|
-
## Orchestrator REST API (Fallback)
|
|
244
|
-
|
|
245
|
-
When CLI commands are insufficient, use the Orchestrator REST API directly with the stored access token:
|
|
246
|
-
|
|
247
|
-
```bash
|
|
248
|
-
source ~/.uipath/.auth
|
|
249
|
-
|
|
250
|
-
# Upload a .nupkg package
|
|
251
|
-
curl -X POST "${UIPATH_URL}/${UIPATH_ORG_NAME}/${UIPATH_TENANT_NAME}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage" \
|
|
252
|
-
-H "Authorization: Bearer ${UIPATH_ACCESS_TOKEN}" \
|
|
253
|
-
-H "X-UIPATH-OrganizationUnitId: <FOLDER_ID>" \
|
|
254
|
-
-F "file=@./MyProject.1.0.0.nupkg"
|
|
255
|
-
|
|
256
|
-
# Create a process (release) from an uploaded package
|
|
257
|
-
curl -X POST "${UIPATH_URL}/${UIPATH_ORG_NAME}/${UIPATH_TENANT_NAME}/orchestrator_/odata/Releases" \
|
|
258
|
-
-H "Authorization: Bearer ${UIPATH_ACCESS_TOKEN}" \
|
|
259
|
-
-H "Content-Type: application/json" \
|
|
260
|
-
-H "X-UIPATH-OrganizationUnitId: <FOLDER_ID>" \
|
|
261
|
-
-d '{"Name":"MyProcess","ProcessKey":"MyProject","ProcessVersion":"1.0.0"}'
|
|
262
|
-
|
|
263
|
-
# Start a job
|
|
264
|
-
curl -X POST "${UIPATH_URL}/${UIPATH_ORG_NAME}/${UIPATH_TENANT_NAME}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs" \
|
|
265
|
-
-H "Authorization: Bearer ${UIPATH_ACCESS_TOKEN}" \
|
|
266
|
-
-H "Content-Type: application/json" \
|
|
267
|
-
-H "X-UIPATH-OrganizationUnitId: <FOLDER_ID>" \
|
|
268
|
-
-d '{"startInfo":{"ReleaseKey":"<RELEASE_KEY>","Strategy":"ModernJobsCount","JobsCount":1,"RuntimeType":"Unattended","InputArguments":"{}"}}'
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
The `X-UIPATH-OrganizationUnitId` header is the **folder ID** (get it from `uip or folders list`).
|
|
272
|
-
|
|
273
245
|
## References
|
|
274
246
|
|
|
275
247
|
- **[CLI Command Reference](references/uip-commands.md)** — Every `uip` command with workflow links
|
|
276
248
|
- **[Orchestrator](references/orchestrator/orchestrator.md)** — Concepts, folders, jobs, processes, machines, users
|
|
277
|
-
- **[Resources](references/
|
|
278
|
-
- **[Solutions](/uipath:uipath-solution)** — Solution lifecycle (`uip solution init/pack/publish/deploy/activate`)
|
|
249
|
+
- **[Resources](references/orchestrator/resources.md)** — Assets, queues, buckets, triggers, libraries, webhooks
|
|
250
|
+
- **[Solutions](/uipath:uipath-solution)** — Solution lifecycle (`uip solution init/pack/publish/deploy/activate`)
|
|
251
|
+
- **[Planner](/uipath:uipath-planner)** — PDD/SDD design + multi-skill task planning (Process → Solution Design Document → task list)
|
|
279
252
|
- **[Traces — Spans](references/traces/traces.md)** — LLM execution trace observability
|
|
280
253
|
- **[Traces — Feedback](references/traces/feedback.md)** — Annotate traces with sentiment and comments
|
|
281
254
|
- **[Integration Service](references/integration-service/integration-service.md)** — Connectors, connections, activities, resources
|
|
@@ -8,7 +8,7 @@ Consumers: Maestro Flow, Maestro BPMN, API Workflows, Case Management, etc. Each
|
|
|
8
8
|
|
|
9
9
|
## What is Managed HTTP Request?
|
|
10
10
|
|
|
11
|
-
A built-in way to make an HTTP call from a UiPath automation
|
|
11
|
+
A built-in way to make an HTTP call from a UiPath automation. Runs in two modes - **connector mode** and **manual mode**:
|
|
12
12
|
|
|
13
13
|
| Mode | When | `url` | Auth |
|
|
14
14
|
|---|---|---|---|
|
|
@@ -17,9 +17,11 @@ A built-in way to make an HTTP call from a UiPath automation when there's no cur
|
|
|
17
17
|
|
|
18
18
|
## Connector-Mode Rules
|
|
19
19
|
|
|
20
|
+
- **Connector mode only works if the connector supports HTTP request activity** — verify by running `uip is connectors get "<connector-key>"` and checking the `HasHttpRequest` flag.
|
|
20
21
|
- `url` must be **relative**. Wrong: `"url": "https://example.atlassian.net/rest/api/2/issue"`. Right: `"url": "/issue"`.
|
|
21
22
|
- The connection's base URL is prepended automatically.
|
|
22
23
|
- The auth header is applied automatically - do not set `Authorization`.
|
|
24
|
+
- **`application/json` only - request and response.** No other content type is supported. File upload/download operations are the most common violation (`multipart/form-data`, `application/octet-stream`, binary/stream responses) - check the operation's request and response content types before authoring. If non-JSON, connector mode cannot call it - use a curated connector activity; if none exists, surface to the user.
|
|
23
25
|
- Get the exact vendor base URL for a connection via (so you can compose the relative `url` correctly):
|
|
24
26
|
|
|
25
27
|
```bash
|
|
@@ -58,7 +60,7 @@ uip is resources run create "<connector-key>" http-request \
|
|
|
58
60
|
| `method` | Yes | Uppercase HTTP verb |
|
|
59
61
|
| `url` | Yes | **Relative** to the connection's vendor base URL (same convention as Managed HTTP Request connector mode) |
|
|
60
62
|
| `headers` | No | Extra headers. Do NOT set `Authorization`. |
|
|
61
|
-
| `body` | For POST/PUT/PATCH | **Stringified** JSON. Only `application/json` is supported today
|
|
63
|
+
| `body` | For POST/PUT/PATCH | **Stringified** JSON. Only `application/json` is supported today — no other content type. |
|
|
62
64
|
|
|
63
65
|
`http-request` command uses the same connection that Managed HTTP Request will use at runtime, so auth + base URL are applied automatically - same convention as Managed HTTP Request itself.
|
|
64
66
|
|
|
@@ -114,3 +116,4 @@ All steps 1-2 are GETs because we are in the authoring phase. The POST to `/issu
|
|
|
114
116
|
2. **Do NOT use an absolute URL in connector-mode `url`.** Wrong: `"url": "https://example.atlassian.net/rest/api/2/project"`. Right: `"url": "/project"`.
|
|
115
117
|
3. **Do NOT issue writes via CLI during authoring.** See "Read-Only During Authoring" above.
|
|
116
118
|
4. **Do NOT guess the base URL.** Use `uip is connections base-url <connection-id>`.
|
|
119
|
+
5. **In connector mode, request and response bodies are `application/json` only.** No other content type is supported; do NOT set `Content-Type` to anything else. Same rule applies to the `http-request` helper command body (it runs through a connection). Manual mode has no such limit — you supply your own `Content-Type` and body.
|
|
@@ -148,7 +148,9 @@ Some reference fields point to **search endpoints** that require user input as a
|
|
|
148
148
|
|
|
149
149
|
### How to detect
|
|
150
150
|
|
|
151
|
-
If `reference.filterPattern` exists, the reference
|
|
151
|
+
If `reference.filterPattern` exists, the reference supports server-side filtering. Omitting the filter does NOT reliably error — some connectors (Microsoft Graph-backed: Teams, Outlook) return the **entire unfiltered collection** instead (thousands of rows, 50/page). Arbitrary query params (`searchTerm=`, `where=`, `filter=`) are silently ignored — only the exact `filterPattern` key filters. Always apply it; never brute-force paginate a large directory when a `filterPattern` exists.
|
|
152
|
+
|
|
153
|
+
`filterPattern` is surfaced only by `uip is resources describe` (IS-level metadata). Representations that strip it (e.g. Maestro flow `registry get` reference object, which keeps only `objectName`/`lookupValue`/`lookupNames`/`path`/`childPath`) are not authoritative — re-describe at IS level before concluding a reference cannot be filtered.
|
|
152
154
|
|
|
153
155
|
### Resolution workflow (search)
|
|
154
156
|
|
|
@@ -178,6 +180,22 @@ User says: "Create a ticket for product Widget Pro"
|
|
|
178
180
|
→ `{ "productCode": "WP-100", "id": "1892000000056007" }`
|
|
179
181
|
3. **Use** the `lookupValue` (`id`) → `"1892000000056007"` in `--body`
|
|
180
182
|
|
|
183
|
+
### Example: Resolving a Microsoft Teams user (OData `$filter`)
|
|
184
|
+
|
|
185
|
+
`filterPattern` may be a full OData `$filter` expression, not just `key={filter}`. Same mechanic: substitute `{filter}`, pass the whole string as `--query`.
|
|
186
|
+
|
|
187
|
+
1. **Describe** the activity's object (e.g. `bot_direct_messages`) → `userId` reference has `filterPattern: "$filter=startswith(userPrincipalName,'{filter}')"`
|
|
188
|
+
2. **Substitute and pass as `--query`.** Single-quote the value so the shell does not expand the literal `$`:
|
|
189
|
+
```bash
|
|
190
|
+
uip is resources run list "uipath-microsoft-teams" "users" \
|
|
191
|
+
--connection-id "<id>" \
|
|
192
|
+
--query '$filter=startswith(userPrincipalName,'"'"'jane.doe'"'"')' --output json
|
|
193
|
+
```
|
|
194
|
+
→ one row: `{ "id": "7a621d6b-…", "userPrincipalName": "jane.doe@example.com" }`
|
|
195
|
+
3. **Use** `lookupValue` (`id`) as the resolved value.
|
|
196
|
+
|
|
197
|
+
Without the `$filter` this `/users` listing returns the full tenant directory (50/page, thousands of rows). A dedicated by-key endpoint (e.g. Teams `user-by-email/{email}`) is a fallback only when no `filterPattern` exists.
|
|
198
|
+
|
|
181
199
|
> **If the user doesn't provide a search term**, ask them. Search references cannot be resolved without user input — do NOT call the search endpoint with an empty filter.
|
|
182
200
|
|
|
183
201
|
---
|
|
@@ -11,6 +11,7 @@ Triggers are event-based activities that fire when something happens in an exter
|
|
|
11
11
|
- [List Trigger Activities](#list-trigger-activities)
|
|
12
12
|
- [Trigger Objects](#trigger-objects)
|
|
13
13
|
- [`parameters[]` — canonical event-parameter input fields](#parameters--canonical-event-parameter-input-fields)
|
|
14
|
+
- [Object Name Resolution](#object-name-resolution)
|
|
14
15
|
- [Trigger Metadata (Describe)](#trigger-metadata-describe)
|
|
15
16
|
- [CRUD vs Non-CRUD Triggers](#crud-vs-non-crud-triggers)
|
|
16
17
|
- [Response Fields](#response-fields)
|
|
@@ -24,12 +25,14 @@ Triggers are event-based activities that fire when something happens in an exter
|
|
|
24
25
|
|
|
25
26
|
```
|
|
26
27
|
[ ] 1. List trigger activities → pick one → note its **Operation**
|
|
27
|
-
[ ] 2. If Operation is CREATED/UPDATED/DELETED → get objects →
|
|
28
|
-
[ ] 3.
|
|
28
|
+
[ ] 2. If Operation is CREATED/UPDATED/DELETED → get objects → resolve object name (ask user if unclear)
|
|
29
|
+
[ ] 3. Describe the resolved object + operation → field metadata
|
|
29
30
|
```
|
|
30
31
|
|
|
31
32
|
**Decision point at step 2**: CREATED, UPDATED, and DELETED operations require an intermediate "objects" step. For other trigger operations, skip to step 3 using the activity's **ObjectName**.
|
|
32
33
|
|
|
34
|
+
> **Source of truth:** Event-parameter inputs come from `triggers objects` → `parameters[]`. Field metadata comes from `triggers describe`. Configure trigger nodes exclusively from these two responses — do not invent parameters or fields, and do not substitute metadata from other commands.
|
|
35
|
+
|
|
33
36
|
---
|
|
34
37
|
|
|
35
38
|
## List Trigger Activities
|
|
@@ -60,20 +63,33 @@ uip is triggers objects "<connector-key>" "<OPERATION>" \
|
|
|
60
63
|
|
|
61
64
|
---
|
|
62
65
|
|
|
66
|
+
## Object Name Resolution
|
|
67
|
+
|
|
68
|
+
`triggers describe` requires an exact object name. Resolve it from the `triggers objects` response (`Data[].Name`):
|
|
69
|
+
|
|
70
|
+
1. Match the user's intent against each object's `Name` / `DisplayName` (case-insensitive).
|
|
71
|
+
2. Exactly one match → use its `Name` verbatim.
|
|
72
|
+
3. No match or ambiguous → **ask the user** — present candidate objects by `displayName`. Do NOT guess or fabricate an object name; `triggers describe` with a wrong name returns empty or wrong field metadata.
|
|
73
|
+
|
|
74
|
+
For non-CRUD operations there is no objects step — use the trigger activity's **ObjectName** field directly.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
63
78
|
## Trigger Metadata (Describe)
|
|
64
79
|
|
|
65
80
|
Get field metadata for a trigger object:
|
|
66
81
|
|
|
67
82
|
```bash
|
|
68
|
-
uip is triggers describe "<connector-key>" "<OPERATION>" "<object-name>" --output json
|
|
69
|
-
|
|
70
|
-
# With connection (includes custom fields):
|
|
71
83
|
uip is triggers describe "<connector-key>" "<OPERATION>" "<object-name>" \
|
|
72
84
|
--connection-id "<id>" --output json
|
|
73
85
|
```
|
|
74
86
|
|
|
75
87
|
Returns field definitions with names, types, and descriptions. Always requests `allFields=true` from the API.
|
|
76
88
|
|
|
89
|
+
- `<object-name>` comes from [Object Name Resolution](#object-name-resolution) above
|
|
90
|
+
- Always pass `--connection-id` — without it, results omit custom/connection-specific fields
|
|
91
|
+
- The returned fields are the **source of truth** for the trigger's field metadata. Use them verbatim — do not guess field names
|
|
92
|
+
|
|
77
93
|
---
|
|
78
94
|
|
|
79
95
|
## CRUD vs Non-CRUD Triggers
|
|
@@ -16,7 +16,7 @@ Report consumption of consumable license units (`AIU`, `AGU`, `RU`, `PLTU`, `HEA
|
|
|
16
16
|
|
|
17
17
|
## Prerequisites
|
|
18
18
|
|
|
19
|
-
1. Authenticated
|
|
19
|
+
1. Authenticated — verify with `uip login status`; if not, ask the user to run `uip login` (interactive browser flow)
|
|
20
20
|
2. Org admin permissions to read account product allocations
|
|
21
21
|
3. For `daily` / `folders` modes: know the target tenant name and consumable unit code
|
|
22
22
|
|
|
@@ -15,7 +15,7 @@ Allocate license units (`UNATT`, `RU`, `PLTU`, `NONPR`, etc.) from the account p
|
|
|
15
15
|
|
|
16
16
|
## Prerequisites
|
|
17
17
|
|
|
18
|
-
1. Authenticated
|
|
18
|
+
1. Authenticated — verify with `uip login status`; if not, ask the user to run `uip login` (interactive browser flow)
|
|
19
19
|
2. Org admin permissions to allocate licenses
|
|
20
20
|
3. Tenant key (GUID) of the target tenant — discover with `uip or settings list --tenant <name>` or the Automation Cloud portal
|
|
21
21
|
|
|
@@ -17,7 +17,7 @@ Assign user-bundle licenses (e.g., `RPADEVPRONU`, `ATTUNU`, `TSTNU`) directly to
|
|
|
17
17
|
|
|
18
18
|
## Prerequisites
|
|
19
19
|
|
|
20
|
-
1. Authenticated
|
|
20
|
+
1. Authenticated — verify with `uip login status`; if not, ask the user to run `uip login` (interactive browser flow)
|
|
21
21
|
2. Org admin permissions for license allocation
|
|
22
22
|
3. For `users licenses set/get`: the user is resolvable from a directory search — name or email prefix must match **exactly one** user
|
|
23
23
|
4. For `groups rules details/set`: the group name prefix must match **exactly one** group
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Create configuration assets, share them across folders, and manage credential rotation.
|
|
4
4
|
|
|
5
|
-
> For full option details on any command, use `--help` (e.g., `uip
|
|
5
|
+
> For full option details on any command, use `--help` (e.g., `uip or assets create --help`).
|
|
6
6
|
|
|
7
7
|
## When to Use
|
|
8
8
|
|
|
@@ -13,8 +13,8 @@ Create configuration assets, share them across folders, and manage credential ro
|
|
|
13
13
|
|
|
14
14
|
## Prerequisites
|
|
15
15
|
|
|
16
|
-
- Authenticated
|
|
17
|
-
- Target folder exists (see [setup-environment.md](
|
|
16
|
+
- Authenticated — verify with `uip login status`; if not logged in, ask the user to run `uip login` (it opens an interactive browser flow)
|
|
17
|
+
- Target folder exists (see [setup-environment.md](setup-environment.md))
|
|
18
18
|
- For Credential/Secret types: a credential store must exist (`uip or credential-stores list`)
|
|
19
19
|
|
|
20
20
|
## Flow
|
|
@@ -38,13 +38,13 @@ graph LR
|
|
|
38
38
|
Create a named configuration value in a folder. Type defaults to Text.
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
uip
|
|
41
|
+
uip or assets create "ApiBaseUrl" "https://api.example.com" \
|
|
42
42
|
--folder-path "Finance" --type Text --output json
|
|
43
43
|
|
|
44
|
-
uip
|
|
44
|
+
uip or assets create "MaxRetries" "3" \
|
|
45
45
|
--folder-path "Finance" --type Integer --output json
|
|
46
46
|
|
|
47
|
-
uip
|
|
47
|
+
uip or assets create "FeatureEnabled" "true" \
|
|
48
48
|
--folder-path "Finance" --type Bool --output json
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -62,11 +62,11 @@ Key options:
|
|
|
62
62
|
For Credential and Secret types, you must provide `--credential-store-key`:
|
|
63
63
|
|
|
64
64
|
```bash
|
|
65
|
-
uip
|
|
65
|
+
uip or assets create "DbPassword" "s3cret-value" \
|
|
66
66
|
--folder-path "Finance" --type Secret \
|
|
67
67
|
--credential-store-key <store-key> --output json
|
|
68
68
|
|
|
69
|
-
uip
|
|
69
|
+
uip or assets create "ServiceAccount" "svc-user:p@ssw0rd" \
|
|
70
70
|
--folder-path "Finance" --type Credential \
|
|
71
71
|
--credential-store-key <store-key> --output json
|
|
72
72
|
```
|
|
@@ -76,13 +76,16 @@ uip resource assets create "ServiceAccount" "svc-user:p@ssw0rd" \
|
|
|
76
76
|
List assets in a folder. Requires `--folder-path` or `--folder-key`.
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
|
-
uip
|
|
79
|
+
uip or assets list --folder-path "Finance" --output json
|
|
80
80
|
|
|
81
81
|
# Filter by name (contains match)
|
|
82
|
-
uip
|
|
82
|
+
uip or assets list --folder-path "Finance" --name "Api" --output json
|
|
83
83
|
|
|
84
84
|
# Filter by type
|
|
85
|
-
uip
|
|
85
|
+
uip or assets list --folder-path "Finance" --type Secret --output json
|
|
86
|
+
|
|
87
|
+
# List assets across all accessible folders
|
|
88
|
+
uip or assets list --all-folders --output json
|
|
86
89
|
```
|
|
87
90
|
|
|
88
91
|
If the user already gives a folder name or path, pass it directly as
|
|
@@ -95,7 +98,7 @@ the asset is not present.
|
|
|
95
98
|
Get full asset metadata by key. Cross-folder -- no `--folder-path` needed.
|
|
96
99
|
|
|
97
100
|
```bash
|
|
98
|
-
uip
|
|
101
|
+
uip or assets get <asset-key> --output json
|
|
99
102
|
```
|
|
100
103
|
|
|
101
104
|
**Note:** Credential and secret values are NOT returned by `get`. Use `get-asset-value` to retrieve decrypted values.
|
|
@@ -105,7 +108,7 @@ uip resource assets get <asset-key> --output json
|
|
|
105
108
|
Returns the decrypted asset value for the current user. Requires `--folder-path` or `--folder-key`.
|
|
106
109
|
|
|
107
110
|
```bash
|
|
108
|
-
uip
|
|
111
|
+
uip or assets get-asset-value <asset-key> \
|
|
109
112
|
--folder-path "Finance" --output json
|
|
110
113
|
```
|
|
111
114
|
|
|
@@ -117,14 +120,14 @@ Update an existing asset's value, type, scope, or metadata. Cross-folder -- no `
|
|
|
117
120
|
|
|
118
121
|
```bash
|
|
119
122
|
# Update value
|
|
120
|
-
uip
|
|
123
|
+
uip or assets update <asset-key> "https://api-v2.example.com" --output json
|
|
121
124
|
|
|
122
125
|
# Update description and tags
|
|
123
|
-
uip
|
|
126
|
+
uip or assets update <asset-key> --description "Updated endpoint" \
|
|
124
127
|
--tags "production,api" --output json
|
|
125
128
|
|
|
126
129
|
# Change scope
|
|
127
|
-
uip
|
|
130
|
+
uip or assets update <asset-key> --scope PerRobot --output json
|
|
128
131
|
```
|
|
129
132
|
|
|
130
133
|
Only provided fields are changed -- omitted fields keep their current values.
|
|
@@ -134,7 +137,7 @@ Only provided fields are changed -- omitted fields keep their current values.
|
|
|
134
137
|
Make an asset accessible in an additional folder:
|
|
135
138
|
|
|
136
139
|
```bash
|
|
137
|
-
uip
|
|
140
|
+
uip or assets share <asset-key> --folder-path "Production" --output json
|
|
138
141
|
```
|
|
139
142
|
|
|
140
143
|
## Step 7: Check Where Shared
|
|
@@ -142,7 +145,7 @@ uip resource assets share <asset-key> --folder-path "Production" --output json
|
|
|
142
145
|
List all folders where the asset is currently accessible:
|
|
143
146
|
|
|
144
147
|
```bash
|
|
145
|
-
uip
|
|
148
|
+
uip or assets get-folders <asset-key> --output json
|
|
146
149
|
```
|
|
147
150
|
|
|
148
151
|
Returns `accessibleFolders` (array of folders you can see) and `totalFoldersCount` (total, including folders you lack permission to view).
|
|
@@ -152,7 +155,7 @@ Returns `accessibleFolders` (array of folders you can see) and `totalFoldersCoun
|
|
|
152
155
|
Remove the asset from a folder:
|
|
153
156
|
|
|
154
157
|
```bash
|
|
155
|
-
uip
|
|
158
|
+
uip or assets unshare <asset-key> --folder-path "Production" --output json
|
|
156
159
|
```
|
|
157
160
|
|
|
158
161
|
## Step 9: Delete
|
|
@@ -160,7 +163,7 @@ uip resource assets unshare <asset-key> --folder-path "Production" --output json
|
|
|
160
163
|
Delete the asset entirely. Cross-folder -- no `--folder-path` needed.
|
|
161
164
|
|
|
162
165
|
```bash
|
|
163
|
-
uip
|
|
166
|
+
uip or assets delete <asset-key> --yes --output json
|
|
164
167
|
```
|
|
165
168
|
|
|
166
169
|
---
|
|
@@ -171,23 +174,23 @@ Rotate a secret without downtime:
|
|
|
171
174
|
|
|
172
175
|
```bash
|
|
173
176
|
# 1. Create the replacement secret
|
|
174
|
-
uip
|
|
177
|
+
uip or assets create "DbPassword-v2" "new-s3cret" \
|
|
175
178
|
--folder-path "Finance" --type Secret \
|
|
176
179
|
--credential-store-key <store-key> --output json
|
|
177
180
|
|
|
178
181
|
# 2. Share with all folders that use it
|
|
179
|
-
uip
|
|
182
|
+
uip or assets share <new-key> --folder-path "Production" --output json
|
|
180
183
|
|
|
181
184
|
# 3. Update consuming processes to reference the new asset name
|
|
182
185
|
# (or update the original asset in-place if the name must stay the same)
|
|
183
|
-
uip
|
|
186
|
+
uip or assets update <original-key> "new-s3cret" --output json
|
|
184
187
|
|
|
185
188
|
# 4. Verify the new value resolves correctly
|
|
186
|
-
uip
|
|
189
|
+
uip or assets get-asset-value <asset-key> \
|
|
187
190
|
--folder-path "Finance" --output json
|
|
188
191
|
|
|
189
192
|
# 5. Delete the old version (if you created a new asset instead of updating)
|
|
190
|
-
uip
|
|
193
|
+
uip or assets delete <old-key> --yes --output json
|
|
191
194
|
```
|
|
192
195
|
|
|
193
196
|
---
|
|
@@ -198,30 +201,30 @@ Set up environment configuration for a Finance folder with text, integer, and se
|
|
|
198
201
|
|
|
199
202
|
```bash
|
|
200
203
|
# Create text asset
|
|
201
|
-
uip
|
|
204
|
+
uip or assets create "ApiBaseUrl" "https://api.example.com" \
|
|
202
205
|
--folder-path "Finance" --type Text \
|
|
203
206
|
--description "Production API endpoint" --output json
|
|
204
207
|
|
|
205
208
|
# Create integer asset
|
|
206
|
-
uip
|
|
209
|
+
uip or assets create "MaxRetries" "5" \
|
|
207
210
|
--folder-path "Finance" --type Integer \
|
|
208
211
|
--description "Maximum retry attempts" --output json
|
|
209
212
|
|
|
210
213
|
# Create secret asset (requires credential store)
|
|
211
|
-
uip
|
|
214
|
+
uip or assets create "ApiKey" "sk-prod-abc123" \
|
|
212
215
|
--folder-path "Finance" --type Secret \
|
|
213
216
|
--credential-store-key <store-key> \
|
|
214
217
|
--description "Production API key" --output json
|
|
215
218
|
|
|
216
219
|
# Share secret with Production folder
|
|
217
|
-
uip
|
|
220
|
+
uip or assets share <api-key-asset-key> \
|
|
218
221
|
--folder-path "Production" --output json
|
|
219
222
|
|
|
220
223
|
# Verify sharing
|
|
221
|
-
uip
|
|
224
|
+
uip or assets get-folders <api-key-asset-key> --output json
|
|
222
225
|
|
|
223
226
|
# Confirm value is accessible from Production
|
|
224
|
-
uip
|
|
227
|
+
uip or assets get-asset-value <api-key-asset-key> \
|
|
225
228
|
--folder-path "Production" --output json
|
|
226
229
|
```
|
|
227
230
|
|
|
@@ -234,7 +237,7 @@ uip resource assets get-asset-value <api-key-asset-key> \
|
|
|
234
237
|
Credential type assets require `username:password` format. The colon separates the username from the password:
|
|
235
238
|
|
|
236
239
|
```bash
|
|
237
|
-
uip
|
|
240
|
+
uip or assets create "WinCred" "DOMAIN\\user:p@ssw0rd" \
|
|
238
241
|
--folder-path "Finance" --type Credential \
|
|
239
242
|
--credential-store-key <store-key> --output json
|
|
240
243
|
```
|
|
@@ -247,7 +250,7 @@ uip resource assets create "WinCred" "DOMAIN\\user:p@ssw0rd" \
|
|
|
247
250
|
|
|
248
251
|
| Command | Folder required? |
|
|
249
252
|
|---------|-----------------|
|
|
250
|
-
| `list` | Yes (`--folder-path` or `--folder-key`) |
|
|
253
|
+
| `list` | Yes (`--folder-path` or `--folder-key`), or pass `--all-folders` to list across all accessible folders |
|
|
251
254
|
| `create` | Yes |
|
|
252
255
|
| `get-asset-value` | Yes |
|
|
253
256
|
| `get` | No (cross-folder) |
|
|
@@ -274,4 +277,4 @@ Decimals and non-numeric strings are rejected.
|
|
|
274
277
|
## Related
|
|
275
278
|
|
|
276
279
|
- [resources.md](resources.md) -- Overview of all resource commands
|
|
277
|
-
- [setup-environment.md](
|
|
280
|
+
- [setup-environment.md](setup-environment.md) -- Create folders before creating assets
|
|
@@ -14,7 +14,7 @@ Monitor robot sessions, check runtime availability, toggle debug mode, and manag
|
|
|
14
14
|
|
|
15
15
|
## Prerequisites
|
|
16
16
|
|
|
17
|
-
- Authenticated
|
|
17
|
+
- Authenticated — verify with `uip login status`; if not logged in, ask the user to run `uip login` (it opens an interactive browser flow)
|
|
18
18
|
- Environment set up with folders and machines (see [setup-environment.md](setup-environment.md))
|
|
19
19
|
|
|
20
20
|
---
|
|
@@ -19,6 +19,7 @@ All `uip or` commands share a set of cross-cutting options:
|
|
|
19
19
|
| `--sort-by <field>` | List commands | OData-style sort (e.g., `'Name asc'`, `'Id desc'`). |
|
|
20
20
|
| `--all-fields` | Most get/list commands | Return the full API DTO instead of the curated summary. Use when you need a field the curated view drops. Note: curated keys are PascalCase, raw DTO keys are camelCase — the shapes do not share casing. |
|
|
21
21
|
| `--output-filter <expr>` | All commands | JMESPath expression to filter/reshape JSON output (e.g., `--output-filter "Data[].Key"`). |
|
|
22
|
+
| `-y, --yes` | Delete commands | Confirm the irreversible operation. Required — the CLI never prompts; without it the command fails with "Confirmation required". Where a command also has `--force` (e.g. non-empty `queues`/`buckets` delete), `--force` implies `--yes`. |
|
|
22
23
|
|
|
23
24
|
**Pagination pattern.** List responses include a `Pagination` block with `Returned`, `Limit`, `Offset`, and `HasMore`. When `HasMore` is `true`, increment `--offset` by `--limit` and fetch again. Continue until `HasMore` is `false` or `Returned < Limit`.
|
|
24
25
|
|
|
@@ -92,39 +93,11 @@ The CLI uses GUID keys for all entity references. Numeric IDs are never exposed
|
|
|
92
93
|
|
|
93
94
|
## REST API Fallback
|
|
94
95
|
|
|
95
|
-
When the CLI does not cover an operation,
|
|
96
|
-
|
|
97
|
-
**Base URL pattern:**
|
|
98
|
-
|
|
99
|
-
```
|
|
100
|
-
${UIPATH_URL}/${UIPATH_ORG_NAME}/${UIPATH_TENANT_NAME}/orchestrator_/odata/
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
**Auth header:**
|
|
104
|
-
|
|
105
|
-
```
|
|
106
|
-
Authorization: Bearer <UIPATH_ACCESS_TOKEN>
|
|
107
|
-
X-UIPATH-OrganizationUnitId: <FOLDER_ID>
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
Always check `uip or --help` and `uip resource --help` first -- most operations are covered by the CLI. Only fall back to REST when there is no CLI command for the operation you need.
|
|
111
|
-
|
|
112
|
-
**Example -- list triggers (no CLI command yet):**
|
|
113
|
-
|
|
114
|
-
```bash
|
|
115
|
-
ACCESS_TOKEN=$(cat ~/.uipath/.auth | jq -r '.access_token')
|
|
116
|
-
BASE_URL="https://cloud.uipath.com/myorg/mytenant/orchestrator_/odata"
|
|
117
|
-
|
|
118
|
-
curl -s -G "${BASE_URL}/ProcessSchedules" \
|
|
119
|
-
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
|
|
120
|
-
-H "X-UIPATH-OrganizationUnitId: <FOLDER_ID>" | jq .
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
Token expiry: re-run `uip login` if you get a 401.
|
|
96
|
+
When the CLI does not cover an operation, you can fall back to the Orchestrator REST API using the access token stored in `~/.uipath/.auth`. Always check `uip or --help` first — most operations are covered by the CLI, and a command is safer and more consistent than hand-rolled REST. Only reach for REST when there is genuinely no command for what you need (and consider reporting the gap so the CLI can cover it).
|
|
124
97
|
|
|
125
98
|
---
|
|
126
99
|
|
|
127
100
|
## Related
|
|
128
101
|
|
|
129
|
-
- **Resources** (`uip
|
|
130
|
-
- **Solutions** (`uip solution`) — pack, publish, deploy solution packages → [`uipath-solution`](
|
|
102
|
+
- **Resources** (`uip or`) — assets, queues, triggers, buckets, webhooks, libraries → [resources.md](resources.md)
|
|
103
|
+
- **Solutions** (`uip solution`) — pack, publish, deploy solution packages → [`uipath-solution`](/uipath:uipath-solution)
|