orchestrator
2024.10
true
- 基本情報
- Swagger の定義
- Orchestrator API
Orchestrator API ガイド
Last updated 2024年11月11日
設定の要求
以下の要求では、ロボットが使用するすべてのサービス設定を表示できます。
注: この要求を送信する際には、ロボットのライセンス キーをヘッダーとして含める必要があります。ヘッダーの名前は、以下の例に示すように X-ROBOT-LICENSE にする必要があります。
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
以下の例では、Robot の実行時の設定を取得できます。
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
以下の要求では、Attended ロボットがオフライン環境でライセンスを保持する時間数を 24 時間に変更できます。
この設定は、ロボットを初めて Orchestrator に接続するとき、または UiPath Robot サービスを再起動した後に適用されます。Community バージョンを実行している場合は、変更を有効化するためにトレイを再起動する必要があります。
POST
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
{
"settings": [{
"Name@odata.type": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}
{
"settings": [{
"Name@odata.type": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}