feat(jobs): onboard getOutput method [PLT-100430] by ninja-shreyash · Pull Request #320 · UiPath/uipath-typescript

ninja-shreyash · 2026-03-24T11:13:16Z

Method Added

Layer	Method	Signature
Service	`jobs.getOutput()`	`getOutput(options: JobGetOutputOptions): Promise<Record<string, unknown> \| null>`

Endpoint Called

Method	HTTP	Endpoint	OAuth Scope
`getOutput()`	GET	`/orchestrator_/odata/Jobs` (with `$filter=Key eq <jobKey>`)	`OR.Jobs` or `OR.Jobs.Read`
`getOutput()`	GET	`/orchestrator_/odata/Attachments({key})` (for file-based output)	`OR.Jobs` or `OR.Jobs.Read`

Extends FolderScopedService — sets X-UIPATH-OrganizationUnitId header when folderId is provided
getOutput() is a composite method: fetches job by Key filter → resolves output via inline OutputArguments JSON or blob download from Attachments API
folderId is optional (verified against Orchestrator Swagger)

Example Usage

import { UiPath } from '@uipath/uipath-typescript/core';
import { Jobs } from '@uipath/uipath-typescript/jobs';

const sdk = new UiPath(config);
const jobs = new Jobs(sdk);

// Get output from a completed job
const output = await jobs.getOutput({ jobKey: '<jobKey>' });

if (output) {
  console.log('Job output:', output);
}

// With folder context
const output2 = await jobs.getOutput({ jobKey: '<jobKey>', folderId: 123 });

API Response vs SDK Response

Composition flow

1. Fetch job by Key filter → GET /odata/Jobs?$filter=Key eq <key>&$select=OutputArguments,OutputFile&$top=1
2. If OutputArguments exists → JSON.parse → return parsed object
3. If OutputFile exists → GET /odata/Attachments({key}) → fetch blob from presigned URI → JSON.parse → return
4. Otherwise → return null

Internal types (not exported)

Type	Purpose
`RawBlobFileAccess`	Presigned URI + headers for blob download
`RawAttachmentResponse`	Raw response from Attachments API

Files

Area	Files
Endpoint	`src/utils/constants/endpoints/orchestrator.ts`
Types	`src/models/orchestrator/jobs.types.ts`
Internal Types	`src/models/orchestrator/jobs.internal-types.ts`
Models	`src/models/orchestrator/jobs.models.ts`
Service	`src/services/orchestrator/jobs/jobs.ts`
Unit tests	`tests/unit/services/orchestrator/jobs.test.ts` (16 tests)
Integration tests	`tests/integration/shared/orchestrator/jobs.integration.test.ts` (6 tests)
Test utils	`tests/utils/constants/jobs.ts`
Docs	`docs/oauth-scopes.md`
Agent docs	`agent_docs/rules.md` (v0/v1 rule clarification)
Skills	`.claude/skills/sdk-verify/SKILL.md`, `.claude/skills/onboard-api/references/e2e-testing.md` (cleanup policy fix)

Refs PLT-100430

🤖 Auto-generated using onboarding skills

ninja-shreyash · 2026-03-27T08:39:00Z

@claude review

src/services/orchestrator/jobs/jobs.ts

ninja-shreyash · 2026-03-30T08:41:26Z

Resolved all AI review comments

ninja-shreyash · 2026-03-30T11:32:54Z

@claude review. Dont repeat the previous comments since I have already resolved what needed to be resolved.

src/models/orchestrator/jobs.models.ts

src/models/orchestrator/jobs.types.ts

src/services/orchestrator/jobs/jobs.ts

src/utils/constants/endpoints/orchestrator.ts

tests/integration/shared/orchestrator/jobs.integration.test.ts

src/models/orchestrator/jobs.internal-types.ts

src/services/orchestrator/jobs/jobs.ts

ninja-shreyash · 2026-03-31T05:29:22Z

Review

All CI checks pass and the overall structure is solid. A few issues to address before merge:

High — likely silent bug

OData $filter GUID missing quotes (jobs.ts:135)
// current
$filter: `Key eq ${jobKey}`,

// OData requires guid literal syntax
$filter: `Key eq guid'${jobKey}'`,
The commit message says "fix: filter by guid key for job" but the filter has no quoting. OData GUID literals require guid'' prefix — without it, Orchestrator will likely return 0 results, causing getOutput to silently return null for every call. Please validate this against the live API.

Medium — breaks JSDoc example

JobState not exported from the jobs subpath (jobs.models.ts:88)
// This example uses JobState.Successful, but JobState is not re-exported
// from @uipath/uipath-typescript/jobs — users will get a runtime error
const completedJob = allJobs.items.find(j => j.state === JobState.Successful);
Either re-export JobState from src/services/orchestrator/jobs/index.ts, or replace with the string literal 'Successful' in the example.

Low — test quality

Weak integration test assertion (jobs.integration.test.ts:514)
// This is always true — doesn't verify anything
expect(output === null || typeof output === 'object').toBe(true);
Consider renaming this test to "should handle job with or without output" to reflect that it's a smoke test, or remove it since the first getOutput test already covers the success path.

Missing unit test for NetworkError path — the downloadOutputFile branch that throws NetworkError when blobResponse.ok is false has no unit test coverage.

This was flagged by claude review as well. I was validated and it works fine.
Fixed for better visibility of JobState enum.
Fixed

- Add blobResponse.ok check before JSON.parse in downloadOutputFile - Wrap JSON.parse in try/catch for both inline and file output paths - Make folderId optional in JobGetOutputOptions (verified against Swagger) - Remove folderId validation block (createHeaders filters undefined) - Fix JSDoc: .data → .items, add JobState enum, fix param descriptions - Replace (job: any) with Record<string, unknown> in transform - Remove unused JOB_ENDPOINTS.GET_BY_ID constant - Integration tests: console.warn+return → throw/continue pattern - Unit tests: move vi.unstubAllGlobals() to afterEach - Add blobResponse.ok to fetch mocks, add folderId-optional test - Clarify v0/v1 init mode rule in rules.md - Fix e2e-testing.md cleanup policy precedence Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

sonarqubecloud · 2026-04-01T11:32:34Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

swati354 · 2026-04-01T11:41:23Z

src/models/orchestrator/jobs.models.ts

+ * Methods available on job response objects.
+ * These are bound to the job data and delegate to the service.
+ */
+export interface JobMethods {


nit : put JobMethods after all methods are defined and above createJobMethods

swati354 · 2026-04-01T11:46:58Z

src/models/orchestrator/jobs.models.ts

+   * }
+   * ```
+   */
+  getOutput(options: JobGetOutputOptions): Promise<Record<string, unknown> | null>;


JobGetOutputOptions only contains one field which is jobKey.
jobKey itself is not an optional parameter. Shouldn't it be : getOutput(jobKey: string)
with no options?

swati354 · 2026-04-01T12:00:31Z

src/services/orchestrator/jobs/jobs.ts

+   */
+  private async fetchJobByKey(
+    jobKey: string
+  ): Promise<{ OutputArguments: string | null; OutputFile: string | null } | null> {


create an interface for the return type in internal-types

swati354 · 2026-04-01T12:04:35Z

src/services/orchestrator/jobs/jobs.ts

 * Service for interacting with UiPath Orchestrator Jobs API
 */
 export class JobService extends FolderScopedService implements JobServiceModel {
+  private attachmentService: AttachmentService;


nit : add comments like this -

uipath-typescript/src/services/maestro/cases/case-instances.ts

Line 48 in 0900e2d

* Creates an instance of the Case Instances service.

swati354 · 2026-04-01T12:09:06Z

src/services/orchestrator/jobs/jobs.ts

+      try {
+        return JSON.parse(job.OutputArguments) as Record<string, unknown>;
+      } catch {
+        throw new ValidationError({ message: `Failed to parse job output arguments as JSON` });


this isn't really a validation error. Validation errors are on user inputs.

Raina451 · 2026-04-01T12:13:51Z

src/models/orchestrator/jobs.types.ts

+  /**
+   * The unique key (GUID) of the job to retrieve output from
+   */
+  jobKey: string;


if jobkey is not optional and required then it doesnt needs to be in options.
we should have getOutput(jobKey: string)

update the skill as well

swati354 · 2026-04-01T12:20:21Z

src/services/orchestrator/jobs/jobs.ts

+    const blobHeaders: Record<string, string> =
+      blobAccess.headers && 'keys' in blobAccess.headers
+        ? arrayDictionaryToRecord(blobAccess.headers as unknown as { keys: string[]; values: string[] })
+        : (blobAccess.headers as Record<string, string>) ?? {};


why is this needed here? isn't blobAccess.headers, already typed to be Record<string, string> in the attachment service?

Raina451 · 2026-04-01T12:56:15Z

src/models/orchestrator/jobs.models.ts

+   *
+   * @example
+   * ```typescript
+   * const allJobs = await jobs.getAll({ folderId: <folderId> });


i cant see folderid in options

uipath-typescript/src/models/orchestrator/jobs.types.ts

Line 162 in 04c3557

export type JobGetAllOptions = RequestOptions & PaginationOptions & {

Raina451 · 2026-04-01T12:58:19Z

src/models/orchestrator/jobs.models.ts

+   * @example
+   * ```typescript
+   * // Get output using bound method
+   * const allJobs = await jobs.getAll({ folderId: <folderId> });


remove fro, here also

Raina451 · 2026-04-01T12:59:50Z

src/models/orchestrator/jobs.models.ts

+   * const completedJob = allJobs.items.find(j => j.state === JobState.Successful);
+   *
+   * if (completedJob) {
+   *   const output = await completedJob.getOutput();


these dont get reflected in doc, instead in job getall method add this comment

Raina451 · 2026-04-01T13:06:12Z

i can see that outputarguments are coming as null in job getall call , but the outputarguments do exisit for that job, if you call get job by key.

you can reproduce the same with jobkey 4d75a122-ab90-4f6e-b64f-9e6daa610b1d for this job:
https://staging.uipath.com/devcon25/Default/orchestrator_/jobs(sidepanel:sidepanel/jobs/4d75a122-ab90-4f6e-b64f-9e6daa610b1d/details)?tid=639453&fid=2042297&isExpanded=true

can you please check this?

swati354 · 2026-04-01T12:46:11Z

tests/integration/shared/orchestrator/jobs.integration.test.ts

+      }
+    });
+
+    it('should handle job with or without output', async () => {


does this test add any value over the one above?

swati354 · 2026-04-01T12:53:18Z

tests/unit/services/orchestrator/jobs.test.ts

shouldn't there be tests/unit/models/orchestrator/jobs.test.ts to test the bound method as well.

swati354 · 2026-04-01T13:00:49Z

tests/unit/services/orchestrator/jobs.test.ts

+      const rawJob = {
+        Id: 123,
+        Key: JOB_TEST_CONSTANTS.JOB_KEY,
+        State: 'Successful',
+        CreationTime: '2026-01-01T00:00:00Z',
+      };


const rawJob = createMockRawJob(); ?

swati354 · 2026-04-01T13:03:19Z

tests/unit/services/orchestrator/jobs.test.ts

+    const getOutputOptions = {
+      jobKey: JOB_TEST_CONSTANTS.JOB_KEY,
+    };


Type request objects in tests.

swati354 · 2026-04-01T13:04:04Z

tests/unit/services/orchestrator/jobs.test.ts

+      });
+
+      // Mock getValidToken on the ApiClient
+      mockApiClient.getValidToken = vi.fn().mockResolvedValue(TEST_CONSTANTS.DEFAULT_ACCESS_TOKEN);


why is this inline and not part of setup?

vnaren23 · 2026-04-01T13:16:25Z

i can see that outputarguments are coming as null in job getall call , but the outputarguments do exisit for that job, if you call get job by key.

you can reproduce the same with jobkey 4d75a122-ab90-4f6e-b64f-9e6daa610b1d for this job:
https://staging.uipath.com/devcon25/Default/orchestrator_/jobs(sidepanel:sidepanel/jobs/4d75a122-ab90-4f6e-b64f-9e6daa610b1d/details)?tid=639453&fid=2042297&isExpanded=true

can you please check this?

Output arguments won't be returned in getAll call. That's intentional. Each job can have huge outputs and returning that in a getAll call is not performant/not needed.
We are explicitly adding getOutput as a separate method to address this

ninja-shreyash closed this Mar 24, 2026

ninja-shreyash mentioned this pull request Mar 24, 2026

feat: add onboarding skills #302

Merged

6 tasks

ninja-shreyash reopened this Mar 24, 2026

ninja-shreyash force-pushed the feat/sdk-plt-100430 branch from b808850 to 7826b36 Compare March 24, 2026 11:29

ninja-shreyash changed the base branch from sv/onboard-claude-files to main March 24, 2026 11:29

ninja-shreyash requested a review from a team March 24, 2026 11:29

ninja-shreyash force-pushed the feat/sdk-plt-100430 branch from 7826b36 to a25b635 Compare March 25, 2026 11:14

ninja-shreyash marked this pull request as draft March 25, 2026 11:42

ninja-shreyash marked this pull request as ready for review March 26, 2026 08:43

ninja-shreyash force-pushed the feat/sdk-plt-100430 branch from fbb8164 to 84476d4 Compare March 26, 2026 12:16

This comment was marked as resolved.

Sign in to view

ninja-shreyash commented Mar 27, 2026

View reviewed changes

src/services/orchestrator/jobs/jobs.ts Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

UiPath deleted a comment from claude bot Mar 30, 2026

ninja-shreyash closed this Mar 30, 2026

ninja-shreyash reopened this Mar 30, 2026

swati354 reviewed Mar 31, 2026

View reviewed changes

This comment was marked as resolved.

Sign in to view

UiPath deleted a comment from claude bot Mar 31, 2026

ninja-shreyash and others added 6 commits April 1, 2026 14:51

feat: onboard getOutput method

d49fb31

fix: filter by guid key for job

0d205d2

fix: reduce duplication

b98e13d

chore: address comments

db101dc

fix: address comments

5340053

ninja-shreyash force-pushed the feat/sdk-plt-100430 branch from a5a48c0 to 5340053 Compare April 1, 2026 09:21

ninja-shreyash added 2 commits April 1, 2026 16:09

fix: use attachment service

ed41929

fix: add CreateTaskMethods

04c3557

swati354 reviewed Apr 1, 2026

View reviewed changes

Raina451 reviewed Apr 1, 2026

View reviewed changes

swati354 reviewed Apr 1, 2026

View reviewed changes

Raina451 reviewed Apr 1, 2026

View reviewed changes

swati354 reviewed Apr 1, 2026

View reviewed changes

Sarath1018 approved these changes Apr 1, 2026

View reviewed changes

Conversation

ninja-shreyash commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Method Added

Endpoint Called

Example Usage

API Response vs SDK Response

Composition flow

Internal types (not exported)

Files

Uh oh!

ninja-shreyash commented Mar 27, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

ninja-shreyash commented Mar 30, 2026

Uh oh!

ninja-shreyash commented Mar 30, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

ninja-shreyash commented Mar 31, 2026

Review

High — likely silent bug

Medium — breaks JSDoc example

Low — test quality

Uh oh!

sonarqubecloud bot commented Apr 1, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Raina451 commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vnaren23 commented Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

ninja-shreyash commented Mar 24, 2026 •

edited

Loading

Raina451 commented Apr 1, 2026 •

edited

Loading