@uipath/delegate-sdk 1.203.1 → 1.203.3
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/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +729 -0
- package/dist/skills/business-analysis/as-is-capture.md +444 -0
- package/dist/skills/business-analysis/assets/progress.yaml +19 -0
- package/dist/skills/business-analysis/assets/task-list.md +34 -0
- package/dist/skills/business-analysis/automation-hub-publishing.md +47 -0
- package/dist/skills/business-analysis/bpmn-to-be-design.md +274 -0
- package/dist/skills/business-analysis/case-to-be-design.md +223 -0
- package/dist/skills/business-analysis/diagram-authoring.md +224 -0
- package/dist/skills/business-analysis/industry-gaps.md +134 -0
- package/dist/skills/business-analysis/interview-spine.md +297 -0
- package/dist/skills/business-analysis/locales/de.json +54 -0
- package/dist/skills/business-analysis/locales/en.json +54 -0
- package/dist/skills/business-analysis/locales/es-MX.json +54 -0
- package/dist/skills/business-analysis/locales/es.json +54 -0
- package/dist/skills/business-analysis/locales/fr.json +54 -0
- package/dist/skills/business-analysis/locales/ja.json +54 -0
- package/dist/skills/business-analysis/locales/ko.json +54 -0
- package/dist/skills/business-analysis/locales/pt-BR.json +54 -0
- package/dist/skills/business-analysis/locales/pt.json +54 -0
- package/dist/skills/business-analysis/locales/ro.json +54 -0
- package/dist/skills/business-analysis/locales/tr.json +54 -0
- package/dist/skills/business-analysis/locales/zh-CN.json +54 -0
- package/dist/skills/business-analysis/locales/zh-TW.json +54 -0
- package/dist/skills/business-analysis/pdd-generation.md +204 -0
- package/dist/skills/business-analysis/pdd-template.md +562 -0
- package/dist/skills/business-analysis/progress-presentation.json +13 -0
- package/dist/skills/business-analysis/recording-first.md +19 -0
- package/dist/skills/business-analysis/recording-processing.md +152 -0
- package/dist/skills/business-analysis/references/automation-hub-open-api.md +57 -0
- package/dist/skills/business-analysis/references/case-definition-spec.md +90 -0
- package/dist/skills/business-analysis/references/case-design-patterns/loan-origination-spec.md +86 -0
- package/dist/skills/business-analysis/references/component-type-mapping.md +52 -0
- package/dist/skills/business-analysis/references/uipath-products/case-management-schema.md +62 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-framework.md +65 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-management.md +49 -0
- package/dist/skills/business-analysis/research-offer.md +104 -0
- package/dist/skills/business-analysis/research-pass.md +149 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.ps1 +294 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.sh +453 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.ps1 +72 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.sh +98 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.ps1 +524 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.sh +519 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.ps1 +363 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.sh +360 -0
- package/dist/skills/business-analysis/to-be-design.md +199 -0
- package/dist/skills/confluence/SKILL.md +386 -0
- package/dist/skills/doc-coauthoring/SKILL.md +295 -0
- package/dist/skills/excel-architect/SKILL.macos.md +161 -0
- package/dist/skills/excel-architect/SKILL.md +180 -0
- package/dist/skills/excel-architect/SKILL.windows.md +61 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model-advanced.md +332 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model.md +248 -0
- package/dist/skills/excel-architect/archetypes/02-data-analysis.md +171 -0
- package/dist/skills/excel-architect/archetypes/03-tracking-dashboard.md +160 -0
- package/dist/skills/excel-architect/archetypes/04-project-planning.md +193 -0
- package/dist/skills/excel-architect/archetypes/05-simple-table.md +111 -0
- package/dist/skills/excel-architect/building.md +279 -0
- package/dist/skills/excel-architect/create.md +64 -0
- package/dist/skills/excel-architect/data-and-formulas.md +186 -0
- package/dist/skills/excel-architect/generator.md +272 -0
- package/dist/skills/excel-architect/macos/scripts/add-data-validation.applescript +242 -0
- package/dist/skills/excel-architect/macos/scripts/append-rows.applescript +310 -0
- package/dist/skills/excel-architect/macos/scripts/apply-conditional-format.applescript +565 -0
- package/dist/skills/excel-architect/macos/scripts/autofit-columns.applescript +79 -0
- package/dist/skills/excel-architect/macos/scripts/benchmark.sh +135 -0
- package/dist/skills/excel-architect/macos/scripts/check-compile.sh +30 -0
- package/dist/skills/excel-architect/macos/scripts/clear-range.applescript +152 -0
- package/dist/skills/excel-architect/macos/scripts/copy-paste.applescript +179 -0
- package/dist/skills/excel-architect/macos/scripts/create-chart.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/create-pivot.applescript +443 -0
- package/dist/skills/excel-architect/macos/scripts/create-sheets.applescript +264 -0
- package/dist/skills/excel-architect/macos/scripts/create-workbook.applescript +92 -0
- package/dist/skills/excel-architect/macos/scripts/delete-chart.applescript +105 -0
- package/dist/skills/excel-architect/macos/scripts/delete-sheet.applescript +127 -0
- package/dist/skills/excel-architect/macos/scripts/filter-data.applescript +213 -0
- package/dist/skills/excel-architect/macos/scripts/find-replace.applescript +238 -0
- package/dist/skills/excel-architect/macos/scripts/format-range.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/freeze-panes.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/get-current-file.applescript +24 -0
- package/dist/skills/excel-architect/macos/scripts/get-sheet-dimensions.applescript +115 -0
- package/dist/skills/excel-architect/macos/scripts/health-check.applescript +704 -0
- package/dist/skills/excel-architect/macos/scripts/list-open-workbooks.applescript +80 -0
- package/dist/skills/excel-architect/macos/scripts/maximize-window.applescript +47 -0
- package/dist/skills/excel-architect/macos/scripts/merge-cells.applescript +227 -0
- package/dist/skills/excel-architect/macos/scripts/open-workbook.applescript +139 -0
- package/dist/skills/excel-architect/macos/scripts/read-range.applescript +267 -0
- package/dist/skills/excel-architect/macos/scripts/rename-sheet.applescript +231 -0
- package/dist/skills/excel-architect/macos/scripts/select-sheet.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/set-tab-color.applescript +109 -0
- package/dist/skills/excel-architect/macos/scripts/sort-data.applescript +136 -0
- package/dist/skills/excel-architect/macos/scripts/undo.applescript +59 -0
- package/dist/skills/excel-architect/macos/scripts/workbook-lifecycle.applescript +149 -0
- package/dist/skills/excel-architect/macos/scripts/write-formula.applescript +225 -0
- package/dist/skills/excel-architect/macos/scripts/write-range.applescript +351 -0
- package/dist/skills/excel-architect/reference/api/advanced.md +381 -0
- package/dist/skills/excel-architect/reference/api/basic.md +747 -0
- package/dist/skills/excel-architect/reference/guides.md +348 -0
- package/dist/skills/excel-architect/reference/repair.md +174 -0
- package/dist/skills/excel-architect/reference/troubleshooting.md +46 -0
- package/dist/skills/excel-architect/scripting.md +266 -0
- package/dist/skills/excel-architect/styling-and-features.md +433 -0
- package/dist/skills/excel-architect/windows/api/composites.md +337 -0
- package/dist/skills/excel-architect/windows/api/scripting.md +139 -0
- package/dist/skills/excel-architect/windows/examples/level-1-workflows.md +485 -0
- package/dist/skills/excel-architect/windows/examples/level-2-advanced.md +690 -0
- package/dist/skills/excel-architect/windows/examples/level-3-scripting.md +337 -0
- package/dist/skills/github/SKILL.md +446 -0
- package/dist/skills/github/recipes/add-comment.md +85 -0
- package/dist/skills/github/recipes/check-pr-status.md +122 -0
- package/dist/skills/github/recipes/compare-branches.md +79 -0
- package/dist/skills/github/recipes/create-issue.md +103 -0
- package/dist/skills/github/recipes/create-pr.md +97 -0
- package/dist/skills/github/recipes/get-file-contents.md +76 -0
- package/dist/skills/github/recipes/get-last-commit.md +128 -0
- package/dist/skills/github/recipes/list-my-open-prs.md +105 -0
- package/dist/skills/github/recipes/list-recent-commits.md +84 -0
- package/dist/skills/github/recipes/search-issues.md +115 -0
- package/dist/skills/google-workspace/SKILL.md +217 -0
- package/dist/skills/google-workspace/services/calendar.md +311 -0
- package/dist/skills/google-workspace/services/docs.md +426 -0
- package/dist/skills/google-workspace/services/drive.md +504 -0
- package/dist/skills/google-workspace/services/gmail.md +466 -0
- package/dist/skills/google-workspace/services/sheets.md +370 -0
- package/dist/skills/internal-comms/SKILL.md +35 -0
- package/dist/skills/internal-comms/examples/3p-updates.md +47 -0
- package/dist/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/dist/skills/internal-comms/examples/faq-answers.md +30 -0
- package/dist/skills/internal-comms/examples/general-comms.md +15 -0
- package/dist/skills/jira/SKILL.md +397 -0
- package/dist/skills/jira/recipes/add-comment.md +123 -0
- package/dist/skills/jira/recipes/assign-issue.md +157 -0
- package/dist/skills/jira/recipes/create-issue.md +274 -0
- package/dist/skills/jira/recipes/get-issue-details.md +154 -0
- package/dist/skills/jira/recipes/list-projects.md +151 -0
- package/dist/skills/jira/recipes/my-issues.md +180 -0
- package/dist/skills/jira/recipes/search-issues.md +215 -0
- package/dist/skills/jira/recipes/transition-issue.md +154 -0
- package/dist/skills/jira/recipes/troubleshooting.md +387 -0
- package/dist/skills/knowledge-base/SKILL.md +289 -0
- package/dist/skills/media-tools/SKILL.md +204 -0
- package/dist/skills/media-tools/references/encode-runbook.md +24 -0
- package/dist/skills/media-tools/references/resolve-binaries.md +88 -0
- package/dist/skills/media-tools/scripts/macos/ff-launch.sh +22 -0
- package/dist/skills/media-tools/scripts/macos/ff-poll.sh +10 -0
- package/dist/skills/media-tools/scripts/windows/ff-launch.ps1 +34 -0
- package/dist/skills/media-tools/scripts/windows/ff-poll.ps1 +20 -0
- package/dist/skills/office-download/SKILL.md +161 -0
- package/dist/skills/outlook-365/SKILL.macos.md +331 -0
- package/dist/skills/outlook-365/SKILL.md +171 -0
- package/dist/skills/outlook-365/SKILL.windows.md +124 -0
- package/dist/skills/outlook-365/api/bulk-email-operations.md +178 -0
- package/dist/skills/outlook-365/api/check-availability.md +87 -0
- package/dist/skills/outlook-365/api/create-inbox-rule.md +182 -0
- package/dist/skills/outlook-365/api/download-attachments.md +149 -0
- package/dist/skills/outlook-365/api/find-and-email-contact.md +185 -0
- package/dist/skills/outlook-365/api/manage-calendar-events.md +189 -0
- package/dist/skills/outlook-365/api/organize-with-folders.md +178 -0
- package/dist/skills/outlook-365/api/reply-to-conversation.md +68 -0
- package/dist/skills/outlook-365/api/schedule-meeting.md +73 -0
- package/dist/skills/outlook-365/api/search-and-read-email.md +93 -0
- package/dist/skills/outlook-365/api/send-email-with-attachments.md +94 -0
- package/dist/skills/outlook-365/api/send-email.md +396 -0
- package/dist/skills/outlook-365/api/set-out-of-office.md +196 -0
- package/dist/skills/outlook-365/macos/scripts/bulk-operations.applescript +429 -0
- package/dist/skills/outlook-365/macos/scripts/calendar.applescript +642 -0
- package/dist/skills/outlook-365/macos/scripts/contacts.applescript +635 -0
- package/dist/skills/outlook-365/macos/scripts/helpers.applescript +227 -0
- package/dist/skills/outlook-365/macos/scripts/read-emails.applescript +299 -0
- package/dist/skills/outlook-365/macos/scripts/search-emails.applescript +339 -0
- package/dist/skills/outlook-365/macos/scripts/send-email.applescript +245 -0
- package/dist/skills/outlook-365/uia/BASIC_OPERATIONS.md +278 -0
- package/dist/skills/outlook-365/uia/CALENDAR_OPERATIONS.md +386 -0
- package/dist/skills/outlook-365/uia/COMPOSE_EMAIL.md +426 -0
- package/dist/skills/outlook-365/uia/README.md +75 -0
- package/dist/skills/outlook-365/windows/com/bulk-operations.ps1 +241 -0
- package/dist/skills/outlook-365/windows/com/calendar.ps1 +227 -0
- package/dist/skills/outlook-365/windows/com/contacts.ps1 +270 -0
- package/dist/skills/outlook-365/windows/com/helpers.ps1 +158 -0
- package/dist/skills/outlook-365/windows/com/read-emails.ps1 +115 -0
- package/dist/skills/outlook-365/windows/com/search-emails.ps1 +141 -0
- package/dist/skills/outlook-365/windows/com/send-email.ps1 +121 -0
- package/dist/skills/pdf-architect/SKILL.md +640 -0
- package/dist/skills/powerpoint-architect/SKILL.macos.md +271 -0
- package/dist/skills/powerpoint-architect/SKILL.md +853 -0
- package/dist/skills/powerpoint-architect/SKILL.windows.md +458 -0
- package/dist/skills/powerpoint-architect/custom_themes.md +141 -0
- package/dist/skills/powerpoint-architect/editing-guide.md +424 -0
- package/dist/skills/powerpoint-architect/generator-reference.md +668 -0
- package/dist/skills/powerpoint-architect/images-guide.md +207 -0
- package/dist/skills/powerpoint-architect/issue-fix-mapping.md +768 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-html-to-slide.applescript +389 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-slide.applescript +255 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-speaker-notes.applescript +132 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-text.applescript +245 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-slide-layout.applescript +80 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-theme.applescript +122 -0
- package/dist/skills/powerpoint-architect/macos/scripts/autofit-placeholders.applescript +62 -0
- package/dist/skills/powerpoint-architect/macos/scripts/close-presentation.applescript +24 -0
- package/dist/skills/powerpoint-architect/macos/scripts/copy-slides.applescript +303 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-chart-with-data.applescript +305 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-with-theme.applescript +56 -0
- package/dist/skills/powerpoint-architect/macos/scripts/delete-slides.applescript +137 -0
- package/dist/skills/powerpoint-architect/macos/scripts/export-presentation.applescript +100 -0
- package/dist/skills/powerpoint-architect/macos/scripts/extract-slide-data.applescript +138 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-shape.applescript +192 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-slide-content.applescript +336 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-current-slide-number.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-file-path.applescript +94 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layout-elements.applescript +141 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layouts.applescript +58 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-opened-files.applescript +50 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-presentation-info.applescript +150 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-recent-files.applescript +68 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-count.applescript +37 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-info.applescript +105 -0
- package/dist/skills/powerpoint-architect/macos/scripts/health-check.applescript +690 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-shape.applescript +188 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-table.applescript +112 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-text-box.applescript +225 -0
- package/dist/skills/powerpoint-architect/macos/scripts/manage-image.applescript +486 -0
- package/dist/skills/powerpoint-architect/macos/scripts/maximize-window.applescript +48 -0
- package/dist/skills/powerpoint-architect/macos/scripts/navigate-to-slide.applescript +84 -0
- package/dist/skills/powerpoint-architect/macos/scripts/open-presentation.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/reorder-slides.applescript +106 -0
- package/dist/skills/powerpoint-architect/macos/scripts/replace-text.applescript +193 -0
- package/dist/skills/powerpoint-architect/macos/scripts/save-presentation.applescript +54 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-animation.applescript +203 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-transition.applescript +130 -0
- package/dist/skills/powerpoint-architect/visual-styling-guide.md +206 -0
- package/dist/skills/powerpoint-architect/windows/api/advanced.md +317 -0
- package/dist/skills/powerpoint-architect/windows/api/basic.md +392 -0
- package/dist/skills/powerpoint-architect/windows/examples/10-slide-presentation.md +140 -0
- package/dist/skills/powerpoint-architect/windows/examples/custom-theme-workflow.md +219 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-1-workflows.md +531 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-2-scripting.md +239 -0
- package/dist/skills/powerpoint-architect/windows/scripts/create-with-theme.ps1 +81 -0
- package/dist/skills/project-task-list/SKILL.md +174 -0
- package/dist/skills/slack-operation/SKILL.md +97 -0
- package/dist/skills/slack-operation/api/advanced-api/GUIDE.md +277 -0
- package/dist/skills/slack-operation/api/search-and-read/EXAMPLE.md +75 -0
- package/dist/skills/slack-operation/api/search-and-read/GUIDE.md +108 -0
- package/dist/skills/slack-operation/api/send-message/EXAMPLE.md +112 -0
- package/dist/skills/slack-operation/api/send-message/GUIDE.md +63 -0
- package/dist/skills/slack-operation/api/share-files/EXAMPLE.md +94 -0
- package/dist/skills/slack-operation/api/share-files/GUIDE.md +63 -0
- package/dist/skills/slack-operation/ui/desktop-automation/GUIDE.md +55 -0
- package/dist/skills/system-diagnostics/SKILL.md +263 -0
- package/dist/skills/teams-operation/SKILL.md +79 -0
- package/dist/skills/teams-operation/api/advanced-api/GUIDE.md +234 -0
- package/dist/skills/teams-operation/api/meetings/EXAMPLE.md +63 -0
- package/dist/skills/teams-operation/api/meetings/GUIDE.md +52 -0
- package/dist/skills/teams-operation/api/search-and-read/EXAMPLE.md +72 -0
- package/dist/skills/teams-operation/api/search-and-read/GUIDE.md +54 -0
- package/dist/skills/teams-operation/api/send-message/EXAMPLE.md +92 -0
- package/dist/skills/teams-operation/api/send-message/GUIDE.md +60 -0
- package/dist/skills/teams-operation/ui/desktop-automation/GUIDE.md +66 -0
- package/dist/skills/transcribe-media/SKILL.md +142 -0
- package/dist/skills/uipath-integrations/SKILL.md +370 -0
- package/dist/skills/uipath-integrations/reference/connectors.md +331 -0
- package/dist/skills/uipath-integrations/reference/endpoints.md +220 -0
- package/dist/skills/uipath-integrations/reference/errors.md +211 -0
- package/dist/skills/uipath-integrations/reference/metadata.md +317 -0
- package/dist/skills/uipath-integrations/reference/operations.md +297 -0
- package/dist/skills/uipath-orchestrator/SKILL.md +312 -0
- package/dist/skills/uipath-orchestrator/recipes/assets.md +282 -0
- package/dist/skills/uipath-orchestrator/recipes/audit-logs.md +215 -0
- package/dist/skills/uipath-orchestrator/recipes/buckets.md +205 -0
- package/dist/skills/uipath-orchestrator/recipes/jobs.md +286 -0
- package/dist/skills/uipath-orchestrator/recipes/list-folders.md +207 -0
- package/dist/skills/uipath-orchestrator/recipes/queue-items.md +292 -0
- package/dist/skills/uipath-orchestrator/recipes/queues.md +232 -0
- package/dist/skills/uipath-orchestrator/recipes/releases.md +212 -0
- package/dist/skills/uipath-orchestrator/recipes/robots-sessions.md +274 -0
- package/dist/skills/uipath-orchestrator/recipes/schedules.md +280 -0
- package/dist/skills/uipath-orchestrator/reference/endpoints.md +85 -0
- package/dist/skills/uipath-orchestrator/reference/schemas.md +153 -0
- package/dist/skills/uipath-taskautomation/SKILL.md +310 -0
- package/dist/skills/uipath-taskautomation/assets/CodedWorkflow.template.cs +98 -0
- package/dist/skills/uipath-taskautomation/assets/ExampleWorkflow.cs +146 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.json +32 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.md +44 -0
- package/dist/skills/uipath-taskautomation/references/app-profiles.md +63 -0
- package/dist/skills/uipath-taskautomation/references/automation-spec.md +88 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/before-after-hooks-template.md +115 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/codedworkflow-template.md +186 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/helper-utility-template.md +22 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/json-template.md +91 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md +92 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/cli-reference.md +249 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/codedworkflow-reference.md +275 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/coding-guidelines.md +229 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/inspect-package-guide.md +81 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/integration-service-guide.md +507 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/operations-guide.md +410 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/third-party-packages-guide.md +67 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/data-manipulation-guide.md +110 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/environment-setup.md +194 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/error-handling-guide.md +195 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md +57 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md +114 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure.md +126 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/uia-elements-interaction-guide.md +109 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/validation-guide.md +147 -0
- package/dist/skills/uipath-taskautomation/references/coded-workflow-authoring.md +219 -0
- package/dist/skills/uipath-taskautomation/references/profiling-output.md +80 -0
- package/dist/skills/uipath-taskautomation/references/reliability-guide.md +83 -0
- package/dist/skills/uipath-taskautomation/references/task-automation-cheatsheet.md +272 -0
- package/dist/skills/uipath-taskautomation/references/template-preflight.md +17 -0
- package/dist/skills/uipath-workflow-documenter/SKILL.md +430 -0
- package/dist/skills/uipath-workflow-documenter/layouts/pdd-template.md +265 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-orchestrator.md +11 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-workflow.md +11 -0
- package/dist/skills/word-architect/SKILL.macos.md +147 -0
- package/dist/skills/word-architect/SKILL.md +502 -0
- package/dist/skills/word-architect/SKILL.windows.md +55 -0
- package/dist/skills/word-architect/api/advanced.md +522 -0
- package/dist/skills/word-architect/api/basic.md +378 -0
- package/dist/skills/word-architect/api/expert.md +302 -0
- package/dist/skills/word-architect/generation.md +308 -0
- package/dist/skills/word-architect/layouts/01-professional.md +168 -0
- package/dist/skills/word-architect/layouts/02-educational-kids.md +354 -0
- package/dist/skills/word-architect/layouts/03-academic.md +83 -0
- package/dist/skills/word-architect/layouts/04-creative.md +242 -0
- package/dist/skills/word-architect/layouts/05-operational.md +94 -0
- package/dist/skills/word-architect/macos/scripts/apply-heading-style.applescript +215 -0
- package/dist/skills/word-architect/macos/scripts/apply-style.applescript +272 -0
- package/dist/skills/word-architect/macos/scripts/autofit-tables.applescript +53 -0
- package/dist/skills/word-architect/macos/scripts/close-document.applescript +287 -0
- package/dist/skills/word-architect/macos/scripts/create-chart-with-data.applescript +379 -0
- package/dist/skills/word-architect/macos/scripts/create-chart.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/delete-selection.applescript +223 -0
- package/dist/skills/word-architect/macos/scripts/export-document.applescript +167 -0
- package/dist/skills/word-architect/macos/scripts/extract-table.applescript +168 -0
- package/dist/skills/word-architect/macos/scripts/find-by-style.applescript +173 -0
- package/dist/skills/word-architect/macos/scripts/find-text.applescript +199 -0
- package/dist/skills/word-architect/macos/scripts/format-table.applescript +234 -0
- package/dist/skills/word-architect/macos/scripts/format-text.applescript +431 -0
- package/dist/skills/word-architect/macos/scripts/get-document-properties.applescript +95 -0
- package/dist/skills/word-architect/macos/scripts/get-document-structure.applescript +371 -0
- package/dist/skills/word-architect/macos/scripts/get-header-footer-text.applescript +106 -0
- package/dist/skills/word-architect/macos/scripts/get-images.applescript +166 -0
- package/dist/skills/word-architect/macos/scripts/get-opened-files.applescript +103 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-bounds.applescript +133 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-format.applescript +134 -0
- package/dist/skills/word-architect/macos/scripts/get-recent-files.applescript +82 -0
- package/dist/skills/word-architect/macos/scripts/get-styled-text.applescript +256 -0
- package/dist/skills/word-architect/macos/scripts/get-tables.applescript +126 -0
- package/dist/skills/word-architect/macos/scripts/get-text-formatting.applescript +224 -0
- package/dist/skills/word-architect/macos/scripts/get-text.applescript +383 -0
- package/dist/skills/word-architect/macos/scripts/get-theme-colors.applescript +123 -0
- package/dist/skills/word-architect/macos/scripts/health-check.applescript +606 -0
- package/dist/skills/word-architect/macos/scripts/insert-cover-page.applescript +77 -0
- package/dist/skills/word-architect/macos/scripts/insert-header-footer.applescript +87 -0
- package/dist/skills/word-architect/macos/scripts/insert-horizontal-line.applescript +112 -0
- package/dist/skills/word-architect/macos/scripts/insert-html.applescript +440 -0
- package/dist/skills/word-architect/macos/scripts/insert-hyperlink.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/insert-image.applescript +320 -0
- package/dist/skills/word-architect/macos/scripts/insert-list.applescript +317 -0
- package/dist/skills/word-architect/macos/scripts/insert-pagebreak.applescript +181 -0
- package/dist/skills/word-architect/macos/scripts/insert-smartart.applescript +104 -0
- package/dist/skills/word-architect/macos/scripts/insert-table.applescript +238 -0
- package/dist/skills/word-architect/macos/scripts/insert-text.applescript +677 -0
- package/dist/skills/word-architect/macos/scripts/insert-textbox.applescript +261 -0
- package/dist/skills/word-architect/macos/scripts/maximize-window.applescript +67 -0
- package/dist/skills/word-architect/macos/scripts/normalize-formatting.applescript +56 -0
- package/dist/skills/word-architect/macos/scripts/open-document.applescript +222 -0
- package/dist/skills/word-architect/macos/scripts/replace-text.applescript +390 -0
- package/dist/skills/word-architect/macos/scripts/save-document.applescript +230 -0
- package/dist/skills/word-architect/macos/scripts/select-range.applescript +142 -0
- package/dist/skills/word-architect/macos/scripts/set-document-properties.applescript +195 -0
- package/dist/skills/word-architect/macos/scripts/set-page-layout.applescript +273 -0
- package/dist/skills/word-architect/macos/scripts/set-theme-colors.applescript +264 -0
- package/dist/skills/word-architect/macos/scripts/undo-redo.applescript +61 -0
- package/dist/skills/word-architect/macos/scripts/update-toc.applescript +112 -0
- package/dist/skills/word-architect/reference/formatting.md +119 -0
- package/dist/skills/word-architect/reference/html-layouts/01-executive-summary-box.md +36 -0
- package/dist/skills/word-architect/reference/html-layouts/02-kpi-summary-table.md +68 -0
- package/dist/skills/word-architect/reference/html-layouts/03-comparison-table.md +63 -0
- package/dist/skills/word-architect/reference/html-layouts/04-pros-cons-table.md +86 -0
- package/dist/skills/word-architect/reference/html-layouts/05-timeline-table.md +114 -0
- package/dist/skills/word-architect/reference/html-layouts/06-raci-matrix.md +95 -0
- package/dist/skills/word-architect/reference/html-layouts/07-data-table-alternating.md +84 -0
- package/dist/skills/word-architect/reference/html-layouts/08-callout-box.md +102 -0
- package/dist/skills/word-architect/reference/html-layouts/09-vertical-milestone.md +100 -0
- package/dist/skills/word-architect/reference/quality-assurance.md +102 -0
- package/dist/skills/word-architect/reference/tables.md +62 -0
- package/dist/skills/word-architect/reference/tracked-changes.md +34 -0
- package/dist/skills/word-architect/reference/uia-fallback.md +231 -0
- package/dist/skills/word-architect/reference/visual-elements.md +82 -0
- package/dist/skills/word-architect/windows/scripts/apply-heading-style.ps1 +190 -0
- package/dist/skills/word-architect/windows/scripts/autofit-tables.ps1 +64 -0
- package/dist/skills/word-architect/windows/scripts/create-chart-with-data.ps1 +133 -0
- package/dist/skills/word-architect/windows/scripts/create-chart.ps1 +73 -0
- package/dist/skills/word-architect/windows/scripts/export-document.ps1 +86 -0
- package/dist/skills/word-architect/windows/scripts/get-current-file.ps1 +27 -0
- package/dist/skills/word-architect/windows/scripts/insert-cover-page.ps1 +79 -0
- package/dist/skills/word-architect/windows/scripts/insert-horizontal-line.ps1 +74 -0
- package/dist/skills/word-architect/windows/scripts/insert-image.ps1 +98 -0
- package/dist/skills/word-architect/windows/scripts/insert-smartart.ps1 +118 -0
- package/dist/skills/word-architect/windows/scripts/insert-text-box.ps1 +90 -0
- package/dist/skills/word-architect/windows/scripts/normalize-formatting.ps1 +63 -0
- package/package.json +5 -4
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
# Jobs
|
|
2
|
+
|
|
3
|
+
List, monitor, and start automation jobs in Orchestrator.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
### List Jobs
|
|
8
|
+
```
|
|
9
|
+
Method: GET
|
|
10
|
+
Path: orchestrator_/odata/Jobs?X-UIPATH-OrganizationUnitId={folderId}&$top=10&$orderby=CreationTime desc
|
|
11
|
+
Headers: None (folder ID in query param)
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### Start Job ⚠️
|
|
15
|
+
```
|
|
16
|
+
Method: POST
|
|
17
|
+
Path: orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
|
|
18
|
+
Headers: { "X-UIPATH-OrganizationUnitId": "{folderId}" }
|
|
19
|
+
Body: { "startInfo": { "ReleaseKey": "{release-key}", "Strategy": "ModernJobsCount", "JobsCount": 1 } }
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
> ⚠️ **Write Operation**: Starting jobs requires explicit user permission.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Use Cases
|
|
27
|
+
|
|
28
|
+
- **Execute automations** - Run processes on-demand
|
|
29
|
+
- **Monitor job status** - Track running and completed jobs
|
|
30
|
+
- **View job results** - Check output arguments and logs
|
|
31
|
+
- **Troubleshoot failures** - Investigate failed job details
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## List Jobs
|
|
36
|
+
|
|
37
|
+
### Request
|
|
38
|
+
|
|
39
|
+
```javascript
|
|
40
|
+
SendUiPathRequest({
|
|
41
|
+
method: "GET",
|
|
42
|
+
path: "orchestrator_/odata/Jobs?X-UIPATH-OrganizationUnitId=2504193&$top=10&$orderby=CreationTime desc",
|
|
43
|
+
toolName: "List Jobs",
|
|
44
|
+
description: "Getting recent jobs from folder"
|
|
45
|
+
})
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Response Structure
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"@odata.context": ".../$metadata#Jobs",
|
|
53
|
+
"@odata.count": 1,
|
|
54
|
+
"value": [
|
|
55
|
+
{
|
|
56
|
+
"Key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
57
|
+
"StartTime": "2026-01-23T10:00:00.000Z",
|
|
58
|
+
"EndTime": "2026-01-23T10:05:00.000Z",
|
|
59
|
+
"State": "Successful",
|
|
60
|
+
"JobPriority": "Normal",
|
|
61
|
+
"Source": "Manual",
|
|
62
|
+
"SourceType": "Manual",
|
|
63
|
+
"BatchExecutionKey": "...",
|
|
64
|
+
"Info": "Job completed successfully",
|
|
65
|
+
"CreationTime": "2026-01-23T09:59:50.000Z",
|
|
66
|
+
"StartingScheduleId": null,
|
|
67
|
+
"ReleaseName": "MyProcess",
|
|
68
|
+
"Type": "Unattended",
|
|
69
|
+
"InputArguments": "{}",
|
|
70
|
+
"OutputArguments": "{\"result\": \"success\"}",
|
|
71
|
+
"HostMachineName": "ROBOT-01",
|
|
72
|
+
"HasMediaRecorded": false,
|
|
73
|
+
"RuntimeType": "Unattended",
|
|
74
|
+
"RequiresUserInteraction": false,
|
|
75
|
+
"ReleaseVersionId": 12345,
|
|
76
|
+
"EntryPointPath": "Main.xaml",
|
|
77
|
+
"OrganizationUnitId": 2504193,
|
|
78
|
+
"Reference": null,
|
|
79
|
+
"ProcessType": "Process",
|
|
80
|
+
"Id": 123456
|
|
81
|
+
}
|
|
82
|
+
]
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Response Fields
|
|
89
|
+
|
|
90
|
+
| Field | Type | Description |
|
|
91
|
+
|-------|------|-------------|
|
|
92
|
+
| `Id` | integer | Job ID |
|
|
93
|
+
| `Key` | string | GUID identifier |
|
|
94
|
+
| `State` | string | Current state (see below) |
|
|
95
|
+
| `StartTime` | datetime | When job started executing |
|
|
96
|
+
| `EndTime` | datetime | When job completed |
|
|
97
|
+
| `CreationTime` | datetime | When job was created/scheduled |
|
|
98
|
+
| `ReleaseName` | string | Process/release name |
|
|
99
|
+
| `Type` | string | `Unattended`, `Attended` |
|
|
100
|
+
| `Source` | string | How job was triggered |
|
|
101
|
+
| `SourceType` | string | Trigger type |
|
|
102
|
+
| `JobPriority` | string | Priority level |
|
|
103
|
+
| `Info` | string | Status message |
|
|
104
|
+
| `InputArguments` | string | JSON input parameters |
|
|
105
|
+
| `OutputArguments` | string | JSON output values |
|
|
106
|
+
| `HostMachineName` | string | Robot machine name |
|
|
107
|
+
| `RuntimeType` | string | Runtime environment |
|
|
108
|
+
| `OrganizationUnitId` | integer | Folder ID |
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Job States
|
|
113
|
+
|
|
114
|
+
| State | Description |
|
|
115
|
+
|-------|-------------|
|
|
116
|
+
| `Pending` | Job queued, waiting for robot |
|
|
117
|
+
| `Running` | Currently executing |
|
|
118
|
+
| `Stopping` | Stop requested, shutting down |
|
|
119
|
+
| `Terminating` | Force termination in progress |
|
|
120
|
+
| `Faulted` | Failed with error |
|
|
121
|
+
| `Successful` | Completed successfully |
|
|
122
|
+
| `Stopped` | Manually stopped |
|
|
123
|
+
| `Suspended` | Paused (for attended) |
|
|
124
|
+
| `Resumed` | Resumed from suspended |
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Start Job ⚠️
|
|
129
|
+
|
|
130
|
+
### Step 1: Get Release Key
|
|
131
|
+
|
|
132
|
+
First, find the release (process) you want to run:
|
|
133
|
+
|
|
134
|
+
```javascript
|
|
135
|
+
SendUiPathRequest({
|
|
136
|
+
method: "GET",
|
|
137
|
+
path: "orchestrator_/odata/Releases?$filter=Name eq 'MyProcess'&X-UIPATH-OrganizationUnitId=2504193",
|
|
138
|
+
toolName: "Find Release",
|
|
139
|
+
description: "Getting release key for MyProcess"
|
|
140
|
+
})
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Step 2: Start the Job
|
|
144
|
+
|
|
145
|
+
```javascript
|
|
146
|
+
SendUiPathRequest({
|
|
147
|
+
method: "POST",
|
|
148
|
+
path: "orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
|
|
149
|
+
headers: { "X-UIPATH-OrganizationUnitId": "2504193" },
|
|
150
|
+
body: {
|
|
151
|
+
"startInfo": {
|
|
152
|
+
"ReleaseKey": "7339d10c-7328-44e5-8afc-a819de825427",
|
|
153
|
+
"Strategy": "ModernJobsCount",
|
|
154
|
+
"JobsCount": 1,
|
|
155
|
+
"InputArguments": "{}"
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
toolName: "Start Job",
|
|
159
|
+
description: "Starting MyProcess job"
|
|
160
|
+
})
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Start Job Request Schema
|
|
166
|
+
|
|
167
|
+
| Field | Type | Required | Description |
|
|
168
|
+
|-------|------|----------|-------------|
|
|
169
|
+
| `ReleaseKey` | string | ✅ Yes | GUID of the release to run |
|
|
170
|
+
| `Strategy` | string | ✅ Yes | Execution strategy (see below) |
|
|
171
|
+
| `JobsCount` | integer | For ModernJobsCount | Number of jobs to start |
|
|
172
|
+
| `RobotIds` | array | For Specific | Robot IDs to run on |
|
|
173
|
+
| `MachineSessionIds` | array | For RobotGroup | Session IDs |
|
|
174
|
+
| `InputArguments` | string | No | JSON input parameters |
|
|
175
|
+
| `JobPriority` | string | No | `Low`, `Normal`, `High` |
|
|
176
|
+
| `ResumeOnSameContext` | boolean | No | Resume on same robot |
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Execution Strategies
|
|
181
|
+
|
|
182
|
+
| Strategy | Description |
|
|
183
|
+
|----------|-------------|
|
|
184
|
+
| `ModernJobsCount` | Run N jobs on available robots (recommended) |
|
|
185
|
+
| `Specific` | Run on specific robot(s) by ID |
|
|
186
|
+
| `RobotGroup` | Run on machine group sessions |
|
|
187
|
+
| `JobsCount` | Legacy - deprecated |
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## Start Job with Input Arguments ⚠️
|
|
192
|
+
|
|
193
|
+
Pass parameters to the process:
|
|
194
|
+
|
|
195
|
+
```javascript
|
|
196
|
+
SendUiPathRequest({
|
|
197
|
+
method: "POST",
|
|
198
|
+
path: "orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
|
|
199
|
+
headers: { "X-UIPATH-OrganizationUnitId": "2504193" },
|
|
200
|
+
body: {
|
|
201
|
+
"startInfo": {
|
|
202
|
+
"ReleaseKey": "7339d10c-7328-44e5-8afc-a819de825427",
|
|
203
|
+
"Strategy": "ModernJobsCount",
|
|
204
|
+
"JobsCount": 1,
|
|
205
|
+
"InputArguments": "{\"in_CustomerName\": \"Acme Corp\", \"in_OrderId\": \"12345\"}"
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
})
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## Common Queries
|
|
214
|
+
|
|
215
|
+
### Filter by State
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
GET orchestrator_/odata/Jobs?$filter=State eq 'Running'&X-UIPATH-OrganizationUnitId=2504193
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Filter by Process Name
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
GET orchestrator_/odata/Jobs?$filter=ReleaseName eq 'MyProcess'&X-UIPATH-OrganizationUnitId=2504193
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Recent Failed Jobs
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
GET orchestrator_/odata/Jobs?$filter=State eq 'Faulted'&$orderby=EndTime desc&$top=10&X-UIPATH-OrganizationUnitId=2504193
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Jobs in Date Range
|
|
234
|
+
|
|
235
|
+
```
|
|
236
|
+
GET orchestrator_/odata/Jobs?$filter=CreationTime ge 2026-01-01T00:00:00Z and CreationTime lt 2026-01-24T00:00:00Z&X-UIPATH-OrganizationUnitId=2504193
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
### Expand Robot Details
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
GET orchestrator_/odata/Jobs?$expand=Robot&X-UIPATH-OrganizationUnitId=2504193
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
|
|
247
|
+
## Stop Job ⚠️
|
|
248
|
+
|
|
249
|
+
```javascript
|
|
250
|
+
SendUiPathRequest({
|
|
251
|
+
method: "POST",
|
|
252
|
+
path: "orchestrator_/odata/Jobs({jobId})/UiPath.Server.Configuration.OData.StopJob",
|
|
253
|
+
headers: { "X-UIPATH-OrganizationUnitId": "2504193" },
|
|
254
|
+
body: {
|
|
255
|
+
"strategy": "SoftStop"
|
|
256
|
+
}
|
|
257
|
+
})
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
**Stop Strategies:**
|
|
261
|
+
- `SoftStop` - Graceful shutdown (recommended)
|
|
262
|
+
- `Kill` - Force terminate immediately
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
## Error Handling
|
|
267
|
+
|
|
268
|
+
| Status | Cause | Solution |
|
|
269
|
+
|--------|-------|----------|
|
|
270
|
+
| 200/201 | Success | Process response |
|
|
271
|
+
| 400 | Invalid ReleaseKey or Strategy | Verify release exists |
|
|
272
|
+
| 401 | Unauthorized | Token expired |
|
|
273
|
+
| 403 | Forbidden | User lacks job permissions |
|
|
274
|
+
| 404 | Release not found | Check ReleaseKey GUID |
|
|
275
|
+
| 409 | No available robots | Wait or check robot status |
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## Tips
|
|
280
|
+
|
|
281
|
+
1. **Get ReleaseKey first** - Always fetch the release to get its Key (GUID)
|
|
282
|
+
2. **Use ModernJobsCount** - Most flexible strategy for unattended robots
|
|
283
|
+
3. **Input arguments as JSON string** - Must be valid JSON in a string field
|
|
284
|
+
4. **Monitor job status** - Poll the job endpoint to track progress
|
|
285
|
+
5. **Check robot availability** - Jobs will queue if no robots available
|
|
286
|
+
6. **Output arguments** - Check `OutputArguments` field after job completes
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# List Folders
|
|
2
|
+
|
|
3
|
+
Retrieve all folders in the Orchestrator tenant. This is the **most fundamental operation** - folder IDs are required for most other Orchestrator API calls.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Method: GET
|
|
9
|
+
Path: orchestrator_/odata/Folders
|
|
10
|
+
Headers: None required
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
**Personal workspaces ("My Workspace") are NOT returned by `odata/Folders`.** See [Personal Workspace](#personal-workspace) below.
|
|
14
|
+
|
|
15
|
+
## Use Cases
|
|
16
|
+
|
|
17
|
+
- **Get folder ID** for subsequent API calls (Assets, Jobs, Queues, etc.)
|
|
18
|
+
- **Discover tenant structure** - see all available folders
|
|
19
|
+
- **Find subfolders** - identify parent-child relationships
|
|
20
|
+
- **Filter by folder type** - Standard, Solution, Personal Workspace
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Basic Example
|
|
25
|
+
|
|
26
|
+
### Request
|
|
27
|
+
|
|
28
|
+
```javascript
|
|
29
|
+
SendUiPathRequest({
|
|
30
|
+
method: "GET",
|
|
31
|
+
path: "orchestrator_/odata/Folders",
|
|
32
|
+
toolName: "List Folders",
|
|
33
|
+
description: "Getting all Orchestrator folders"
|
|
34
|
+
})
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Response
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"@odata.context": ".../$metadata#Folders",
|
|
42
|
+
"@odata.count": 7,
|
|
43
|
+
"value": [
|
|
44
|
+
{
|
|
45
|
+
"Key": "2704b757-9c2c-41a9-8b4f-bfc5eb6538fe",
|
|
46
|
+
"DisplayName": "Shared",
|
|
47
|
+
"FullyQualifiedName": "Shared",
|
|
48
|
+
"Description": null,
|
|
49
|
+
"FolderType": "Standard",
|
|
50
|
+
"ProvisionType": "Automatic",
|
|
51
|
+
"PermissionModel": "FineGrained",
|
|
52
|
+
"ParentId": null,
|
|
53
|
+
"ParentKey": null,
|
|
54
|
+
"IsActive": true,
|
|
55
|
+
"FeedType": "Processes",
|
|
56
|
+
"Id": 1393820
|
|
57
|
+
}
|
|
58
|
+
]
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Response Fields
|
|
65
|
+
|
|
66
|
+
| Field | Type | Description |
|
|
67
|
+
|-------|------|-------------|
|
|
68
|
+
| `Id` | integer | **Folder ID** - Use this for `X-UIPATH-OrganizationUnitId` |
|
|
69
|
+
| `Key` | string | GUID identifier |
|
|
70
|
+
| `DisplayName` | string | Human-readable folder name |
|
|
71
|
+
| `FullyQualifiedName` | string | Full path including parent folders |
|
|
72
|
+
| `Description` | string | Optional description |
|
|
73
|
+
| `FolderType` | string | `Standard`, `Solution`, `DebugSolution` |
|
|
74
|
+
| `ProvisionType` | string | `Automatic` or `Manual` |
|
|
75
|
+
| `PermissionModel` | string | `FineGrained` or `InheritFromTenant` |
|
|
76
|
+
| `ParentId` | integer | Parent folder ID (null if root) |
|
|
77
|
+
| `ParentKey` | string | Parent folder GUID |
|
|
78
|
+
| `IsActive` | boolean | Whether folder is active |
|
|
79
|
+
| `FeedType` | string | `Processes` or `PersonalWorkspace` |
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Common Queries
|
|
84
|
+
|
|
85
|
+
### Get Only Top-Level Folders
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
GET orchestrator_/odata/Folders?$filter=ParentId eq null
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Find Folder by Name
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
GET orchestrator_/odata/Folders?$filter=DisplayName eq 'Shared'
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Get Subfolders of a Parent
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
GET orchestrator_/odata/Folders?$filter=ParentId eq 1393820
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Get Only Standard Folders
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
GET orchestrator_/odata/Folders?$filter=FolderType eq 'Standard'
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Select Specific Fields Only
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
GET orchestrator_/odata/Folders?$select=Id,DisplayName,FolderType
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Order by Name
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
GET orchestrator_/odata/Folders?$orderby=DisplayName asc
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Pagination
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
GET orchestrator_/odata/Folders?$top=10&$skip=0
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Personal Workspace
|
|
130
|
+
|
|
131
|
+
`odata/Folders` excludes personal workspaces. Get the signed-in user's personal workspace folder ID:
|
|
132
|
+
|
|
133
|
+
```javascript
|
|
134
|
+
SendUiPathRequest({
|
|
135
|
+
method: "GET",
|
|
136
|
+
path: "orchestrator_/odata/PersonalWorkspaces/UiPath.Server.Configuration.OData.GetPersonalWorkspace",
|
|
137
|
+
toolName: "Get Personal Workspace",
|
|
138
|
+
description: "Getting the user's personal workspace folder ID"
|
|
139
|
+
})
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Use the returned `Id` as `X-UIPATH-OrganizationUnitId` for assets, jobs, queues in the personal workspace.
|
|
143
|
+
|
|
144
|
+
Alternative — one call for shared folders AND personal workspace (the endpoint Delegate's own credential features use):
|
|
145
|
+
|
|
146
|
+
```javascript
|
|
147
|
+
SendUiPathRequest({
|
|
148
|
+
method: "GET",
|
|
149
|
+
path: "orchestrator_/api/FoldersNavigation/GetFolderContext?includePersonalWorkspace=true&relativeSkip=0&take=1000",
|
|
150
|
+
toolName: "List Folders",
|
|
151
|
+
description: "Getting all folders including personal workspace"
|
|
152
|
+
})
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Response: `{ "PageItems": [...] }`. Personal workspace entries have `IsPersonal: true` (or `FeedType: "PersonalWorkspace"` / `FolderType: "Personal"` depending on tenant version); use `Id` as the folder ID.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Folder Types Explained
|
|
160
|
+
|
|
161
|
+
| FolderType | Description |
|
|
162
|
+
|------------|-------------|
|
|
163
|
+
| `Standard` | Regular folder for organizing processes |
|
|
164
|
+
| `Solution` | Folder created by deploying a Solution package |
|
|
165
|
+
| `DebugSolution` | Temporary folder for debugging Solutions |
|
|
166
|
+
| `Personal` | Personal workspace — not listed by `odata/Folders`, see above |
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## Common Workflow Pattern
|
|
171
|
+
|
|
172
|
+
Most Orchestrator operations require a folder ID. Here's the typical pattern:
|
|
173
|
+
|
|
174
|
+
```javascript
|
|
175
|
+
// Step 1: Get folder ID
|
|
176
|
+
const foldersResponse = await SendUiPathRequest({
|
|
177
|
+
method: "GET",
|
|
178
|
+
path: "orchestrator_/odata/Folders?$filter=DisplayName eq 'Shared'"
|
|
179
|
+
});
|
|
180
|
+
const folderId = foldersResponse.value[0].Id;
|
|
181
|
+
|
|
182
|
+
// Step 2: Use folder ID in subsequent calls
|
|
183
|
+
const assetsResponse = await SendUiPathRequest({
|
|
184
|
+
method: "GET",
|
|
185
|
+
path: "orchestrator_/odata/Assets",
|
|
186
|
+
headers: { "X-UIPATH-OrganizationUnitId": folderId.toString() }
|
|
187
|
+
});
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Error Handling
|
|
193
|
+
|
|
194
|
+
| Status | Cause | Solution |
|
|
195
|
+
|--------|-------|----------|
|
|
196
|
+
| 200 | Success | Process the folder list |
|
|
197
|
+
| 401 | Unauthorized | Token expired - re-authenticate |
|
|
198
|
+
| 403 | Forbidden | User lacks folder view permissions |
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## Tips
|
|
203
|
+
|
|
204
|
+
1. **Cache folder IDs** - Folder IDs rarely change, so you can cache them
|
|
205
|
+
2. **Use `Shared` folder** - Most tenants have a "Shared" folder that's accessible to all
|
|
206
|
+
3. **Check `IsActive`** - Some folders may be deactivated
|
|
207
|
+
4. **Personal Workspaces** - NOT in `odata/Folders`; use `GetPersonalWorkspace` or `FoldersNavigation/GetFolderContext?includePersonalWorkspace=true` (see above)
|