UiPath Documentation
integration-service
latest
false
Integration Service API ガイド
  • スタート アップ ガイド
    • ベース URL
  • コネクション API
    • コネクションを取得
    • ID で接続を取得
  • コネクタ API
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 Integration Service で提供されるコネクタ パッケージの一部は機械翻訳で処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

ID で接続を取得

単一の Integration Service コネクションを ID で取得するための API リファレンスと、エンドポイント URL、パス パラメーター、応答の例付き

単一の接続を ID で取得します。

API エンドポイント​

GET BaseURL/v1/Connections/{connectionId}

  • 使用しているクラウド プラットフォームの Connections API ベース URL を使用します。

要求ヘッダー​

ヘッダー値 (Value)
認可Bearer <your-access-token>
X-UIPATH-アカウント ID<tenant>
X-UIPATH-FolderKeyコネクションを保持するフォルダーのキーです

角括弧で囲まれた値 <...> をすべて、対応するユース ケース値に置き換えます。

トークンとは、外部アプリケーションを認証したときに受け取ったトークンです。この機能は 1 時間利用可能なので、新しいプールを生成するか、更新トークンをリクエストする必要があります。外部アプリケーションを登録してトークンを取得する方法については、「 API アクセス 」をご覧ください。

重要:

外部アプリケーションの対象は、 X-UIPATH-FolderKey ヘッダーで識別される 1 つのフォルダーである必要があります。ヘッダーを省略した要求は、 を返 400 Bad Request。

Path 変数​

Path 変数データ型説明既定値
connectionId (必須)string取得するコネクションの ID です。NA

クエリ パラメーター​

クエリ パラメーターデータ型説明既定値
includeConfigsboolean接続の設定を返します。構成の読み取りスコープを保持している呼び出し元のみ使用できます。API キーや OAuth トークンなどのシークレット値は返されません。false

応答​

200 OK​

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Salesforce connection",
  "connector": {
    "key": "uipath-salesforce-sfdc",
    "name": "Salesforce"
  },
  "folder": {
    "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "state": "Enabled",
  "isDefault": true,
  "createTime": "2026-09-10T10:20:24.485Z",
  "updateTime": "2026-09-10T10:20:24.485Z"
}
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Salesforce connection",
  "connector": {
    "key": "uipath-salesforce-sfdc",
    "name": "Salesforce"
  },
  "folder": {
    "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "state": "Enabled",
  "isDefault": true,
  "createTime": "2026-09-10T10:20:24.485Z",
  "updateTime": "2026-09-10T10:20:24.485Z"
}

フィールド名はキャメルケースです。列挙型の値は大文字と小文字 state 保持されます (例: Enabled または Failed)。値のないフィールドは、 nullとして返されず、応答から除外されます。

要求が includeConfigs を trueに設定する場合、応答には connectionType フィールドが含まれます。includeConfigs が指定されていない場合、フィールドは応答に含められません。値は次のいずれかです。

  • Public: 既定のパブリック コネクタ API を使用する 標準 接続です。
  • Private: UiPath Relay またはプライベート リンク経由でトラフィックをルーティングするプライベート接続。詳しくは、「 オンプレミス システムに接続する」をご覧ください。

connectionType 接続について説明します。コネクタ自体がプライベート (カスタム) コネクタであるかどうかを示す connector.isPrivateとは異なります。

400 Bad Request​

要求で X-UIPATH-FolderKey ヘッダーが指定されていませんでした。

401 未承認​

アクセス トークンが見つからないか、期限切れであるか、無効です。

403 Forbidden​

外部アプリケーションが必要なスコープを保持していないか、要求されたフォルダーで Connections.View 権限がありません。

404 見つかりません​

コネクションが存在しないか、要求の対象のフォルダー以外のフォルダーにあります。要求されたフォルダーの外部にある接続の場合は、 ではなく 404を返 403。

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

接続

ヘルプ リソース サポート(opens in new window)

学習する UiPath アカデミー(opens in new window)

質問する UiPath フォーラム(opens in new window)

最新情報を取得