- Getting started
- Introduction
- About OData and references
- Enumerated types
- Authenticating
- Building API requests
- Permissions per endpoint
- Response codes
- Rate limits and large data field usage optimization
- Rate limits
- Swagger definition
- Read me
- Authorizing API calls in Swagger
- Managing logical resources
- 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
Orchestrator API guide
odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') endpoint enables you to retrieve all the Attended Robots that are licensed with a named user license.
GET
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
Request headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}The following example disables the Documentation machine so that the Robots connected to it do not consume NonProduction/Unattended licenses.
/odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled endpoint, by setting the enabled parameter to true.
POST
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabledRequest headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Request body
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}Response code
200 OK
The following request can only be performed on one tenant at a time. If you are using Swagger, this query is executed on the tenant you are logged into Orchestrator when making the request. If you are using an API testing tool, then the tenant you make this request for is the one used to generate the bearer token.
GET
https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
Request headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}{
"@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}