Automation Hub API について

Open API 機能を使用すると、UiPath Automation Hub ユーザーはプログラムを使用してテナント データにアクセスし、操作できます。受け取ったフィードバックとプラットフォームの構造に基づき、以下の例のように API 要求を提供することに注力しました。

注:

• API 呼び出しのリスト全体については、 Swagger および Postman のドキュメントをご覧ください。
• API 呼び出しを使用する方法の簡単な例については、「 API 呼び出しの例」を参照してください。 詳細を確認したり、特定の API レスポンスをテストしたりするには、「 API リファレンス」に記載されている Swagger または Postman 環境を使用してください。

カスタマイズされた評価

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

自動化のアイデア

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

自動化案件

• GET/automationpipeline

ユーザー

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

アプリケーション リスト

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

カテゴリ

• GET/hierarchy
• PUT/categories

コンポーネント

• GET/components

Automation Store

• GET/automation-store
• GET/automation-store/{automationId}/reviews

API 呼び出しには、ユーザーが Automation Hub のインターフェイスで実行できるアクションが反映されます。

以下の変数を使用して呼び出しを開始するには、Automation Hub プラットフォーム> [管理コンソール] > [プラットフォームの設定] > [OpenAPI] から OpenAPI のオプションにアクセスし、トークンを生成します。

変数	値 (Value)
トークン	Automation Hub UI から生成されるトークンです。
URL	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
遅延リリース URL	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
遅延リリース組織向けの GET all ideas の API 構造	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
アプリ キー	Automation Hub UI から生成されるアプリ キーです。

注: {orgName} と {tenantName} は、組織の名前とテナントの名前を参照する変数です。

次にこちらの手順に沿って利用可能な API を使用します。

API リファレンス

Automation Hub API の Swagger 定義に直接アクセスするには、認証の詳細を Header という名前の要求呼び出しの認可キーに追加します。

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

このガイドは Swagger のドキュメントの内容を補足する資料として作成され、関連する簡単な例を紹介するものです。

遅延リリース組織で Swagger のドキュメントを使用するには、次のリンクを使用します。

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Postman を使用したい場合は、Postman 環境を作成します。その後、 Postman で利用可能な API コレクションをご覧ください。 コレクションは、[ Run in Postman ] ボタンをクリックしてインポートできます。