orchestrator
latest
false
- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Process Data Retention Policy Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Assets Requests
Orchestrator API Guide
Assets Requests
Note: Global and Per Robot text assets support up to 1,000,000 characters.
Important:
-
$filter
queries return the result of a custom filter that uses Name and Description parameters in acontains
function. -
Asset requests that expand robot values (
GET "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered?%24expand=UserValues"
) first retrieveUserValues
, which they then turn intoRobotValues
.
The call below enables you to display all the available information for the asset with the
DocAPITest
name and 455
Id.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "DocAPITest",
"ValueType": "Text",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": ""
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "DocAPITest",
"ValueType": "Text",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": ""
}
To perform a GET request to the
/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId()
endpoint, you need to provide the robotId
and assetName
in the URL. Please note that only the username is returned for Per Robot credential assets, as you can see in the example
below.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}
The following example enables you to create a new global asset, of type text.
POST
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets
{
"Name": "DocAPITest",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "An asset added through an API call"
}
{
"Name": "DocAPITest",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "An asset added through an API call"
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Assets/$entity",
"Name": "DocAPITest",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "An asset added through an API call",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": "",
"Id": 455,
"KeyValueList": []
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Assets/$entity",
"Name": "DocAPITest",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "An asset added through an API call",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": "",
"Id": 455,
"KeyValueList": []
}