Assets

Service for managing UiPath Assets.

Assets are key-value pairs that can be used to store configuration data, credentials, and other settings used by automation processes. UiPath Assets Guide

Methods¶

getAll()¶

getAll<T>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AssetGetResponse> : NonPaginatedResponse<AssetGetResponse>>;

Gets all assets across folders with optional filtering

Type Parameters¶

Type Parameter	Default type
`T` extends `AssetGetAllOptions`	`AssetGetAllOptions`

Parameters¶

Parameter	Type	Description
`options?`	`T`	Query options including optional folderId and pagination options

Returns¶

Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<AssetGetResponse> : NonPaginatedResponse<AssetGetResponse>>

Promise resolving to either an array of assets NonPaginatedResponse or a PaginatedResponse when pagination options are used. AssetGetResponse

Example¶

// Standard array return
const assets = await sdk.assets.getAll();

// With folder
const folderAssets = await sdk.assets.getAll({ folderId: <folderId> });

// First page with pagination
const page1 = await sdk.assets.getAll({ pageSize: 10 });

// Navigate using cursor
if (page1.hasNextPage) {
  const page2 = await sdk.assets.getAll({ cursor: page1.nextCursor });
}

// Jump to specific page
const page5 = await sdk.assets.getAll({
  jumpToPage: 5,
  pageSize: 10
});

getById()¶

getById(
   id: number, 
   folderId: number, 
   options?: BaseOptions): Promise<AssetGetResponse>;

Gets a single asset by ID

Parameters¶

Parameter	Type	Description
`id`	`number`	Asset ID
`folderId`	`number`	Required folder ID
`options?`	`BaseOptions`	Optional query parameters (expand, select)

Returns¶

Promise<AssetGetResponse>

Promise resolving to a single asset AssetGetResponse

Example¶

// Get asset by ID
const asset = await sdk.assets.getById(<assetId>, <folderId>);