UiPath Documentation
orchestrator
2021.10
false
  • 基本情報
    • OData と参照について
    • 列挙型
    • 認証
    • API リクエストを構築する
    • エンドポイントごとの権限
    • 応答コード
    • 健全性チェックのエンドポイント
  • 認証
    • 認証方法
    • 外部アプリケーション (OAuth)
    • ROPC (非推奨)
  • Swagger の定義
    • はじめに
    • Swagger での API 呼び出しを認可する
    • 論理リソースを管理する
  • Orchestrator API
    • アラートの要求
    • アセットの要求
    • カレンダーの要求
    • ロボット グループの要求
    • フォルダーの要求
    • 一般的なタスクの要求
    • ジョブの要求
    • ライブラリの要求
    • ライセンスの要求
    • パッケージの要求
    • 権限の要求
    • プロセスの要求
    • ロボットの要求
    • ロールの要求
    • スケジュールの要求
    • 設定の要求
    • タスクの要求
    • タスク カタログの要求
    • タスク フォームの要求
    • テナントの要求
    • トランザクションの要求
    • ユーザーの要求
    • Webhook の要求
  • プラットフォーム管理 API
    • 基本情報
      • このガイドについて
      • 利用可能なリソース
      • API エンドポイント URL の構造
      • 列挙のリスト
    • 範囲と権限
      • 範囲と権限について
      • プラットフォーム管理の範囲と権限
    • プラットフォーム管理 API
      • 監査ログ
        • 監査ログを取得する
        • 監査ログをダウンロードする
      • [プレビュー] グループ
        • [プレビュー] すべてのグループを取得する
        • [プレビュー] グループを削除する
        • [プレビュー] 特定のグループを取得する
        • [プレビュー] 特定のグループを削除する
        • [プレビュー] 新しいローカル グループを作成する
        • [プレビュー] グループを更新する
      • [プレビュー] ロボット アカウント
        • [プレビュー] すべてのロボット アカウントを取得する
        • [プレビュー] ロボット アカウントを削除する
        • [プレビュー] 特定のロボット アカウントを取得する
        • [プレビュー] 特定のロボット アカウントを削除する
        • [プレビュー] 新しいロボット アカウントを作成する
        • [プレビュー] ロボット アカウントを更新する
      • [プレビュー] ユーザー
        • [プレビュー] ユーザーを更新する
        • [プレビュー] 特定のユーザーを削除する
        • [プレビュー] ユーザーを削除する
        • [プレビュー] ユーザー パスワードを更新する
      • [プレビュー] 設定
        • [プレビュー] 設定を更新する
      • メッセージ テンプレート
        • メッセージ テンプレートを取得する
        • メッセージ テンプレートを更新する
        • メッセージ テンプレートを名前で取得する
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。
UiPath logo, featuring letters U and I in white
サポート対象外

Orchestrator API ガイド

最終更新日時 2024年10月31日

設定の要求

ロボットが使用するサービス設定を取得する

以下の要求では、ロボットが使用するすべてのサービス設定を表示できます。

注: この要求を送信する際には、ロボットのライセンス キーをヘッダーとして含める必要があります。ヘッダーの名前は、以下の例に示すように X-ROBOT-LICENSE にする必要があります。

GET

{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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

{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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 ロボットをオフラインで実行できる時間数を設定する

以下の要求では、Attended ロボットがオフライン環境でライセンスを保持する時間数を 24 時間に変更できます。

この設定は、ロボットを初めて Orchestrator に接続するとき、または UiPath Robot サービスを再起動した後に適用されます。Community バージョンを実行している場合は、変更を有効化するためにトレイを再起動する必要があります。

POST

{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk

要求ヘッダー

キー

値 (Value)

認可

Bearer

要求本文

{
    "settings": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}{
    "settings": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}

応答コード

200 OK

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得