Blue Prism APIユーザー許可

さまざまなBlue Prism APIエンドポイントにリクエストを問題なく渡すために必要なBlue Prismユーザー許可を示します。Hub内のControl RoomプラグインはAPIを利用するため、同じ許可セットを備えています。この表は、使用可能なエンドポイント、リクエスト、必要な許可の概要と、Blue Prismリファレンスで利用可能な完全な詳細を示します。APIリファレンスにアクセスするには、「Blue Prism API」を参照してください。

ユーザー許可の設定方法については、「Blue Prismユーザーの役割」を参照してください。

許可

リクエストは次のカテゴリー別にグループ化されます。

ダッシュボード

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/dashboards
/workQueueCompositions

このエンドポイントはユーザー許可によって制限されていません。

ワークキュー構成の詳細のリストを返します。

GET

/api/v7/dashboards
/resourceUtilization

このエンドポイントはユーザー許可によって制限されていません。

使用状況のリストを返します。

GET

/api/v7/dashboards/
resourcesSummaryUtilization

このエンドポイントはユーザー許可によって制限されていません。

指定した日付範囲のリソース使用状況詳細のリストを返します。

暗号化方式

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/encryptionschemes

このエンドポイントはユーザー許可によって制限されていません。

暗号化方式のリストを返します。

リソース

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/resources

次のリソース許可のうち少なくとも1つが必要です。

  • リソースを表示
  • リソーススクリーンキャプチャを表示
  • リソースを構成
  • リソースをコントロール
  • リソースアクセス権を管理
  • リソースの詳細を表示

環境内のリソース一覧を返します。

PUT

/api/v7/resources/{resourceId}

次のリソース許可が必要です。

指定されたリソースを返します。

スケジュール

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/schedules

次のスケジューラー許可のうち少なくとも1つが必要です。

  • スケジュールを表示
  • スケジュールを編集
  • スケジュールを削除
  • スケジュールを作成
  • スケジュールを廃止
  • システム - スケジューラー

環境内のスケジュールのリストを返します。

GET

/api/v7/schedules/logs

次のスケジューラー許可のうち少なくとも1つが必要です。

  • スケジュールを表示
  • スケジュールを編集
  • スケジュールを削除
  • スケジュールを作成
  • スケジュールを廃止
  • システム - スケジューラー

すべてのスケジュールログを返します。

PUT

/api/v7/schedules/{scheduleId}

スケジュールを廃止するには、以下のすべてのスケジューラー許可が必要です。

  • スケジュールを編集
  • スケジュールを廃止

スケジュールの公開を解除するには、以下のすべてのスケジューラー許可が必要です。

  • スケジュールを編集
  • スケジュールを廃止
  • スケジュールを作成

指定されたスケジュールを更新します。

GET

/api/v7/schedules/
{scheduleId}/logs

次のスケジューラー許可のうち少なくとも1つが必要です。

  • スケジュールを表示
  • スケジュールを編集
  • スケジュールを削除
  • スケジュールを作成
  • スケジュールを廃止
  • システム - スケジューラー

指定したスケジュールのすべてのログを返します。

GET

/api/v7/schedules
/{scheduleId}/tasks

次のスケジューラー許可のうち少なくとも1つが必要です。

  • スケジュールを表示
  • スケジュールを編集
  • スケジュールを削除
  • スケジュールを作成
  • スケジュールを廃止
  • システム - スケジューラー

指定されたスケジュール内のタスクのリストを返します。

GET

/api/v7/schedules/tasks/
{taskId}/セッション

次のスケジューラー許可のうち少なくとも1つが必要です。

  • スケジュールを表示
  • スケジュールを編集
  • スケジュールを削除
  • スケジュールを作成
  • スケジュールを廃止
  • システム - スケジューラー

特定のタスクに対してスケジュールされているセッションのリストを返します。

スケジュールセッション

リクエスト

エンドポイント

必要なユーザー許可

応答

POST

/api/v7/schedules/{scheduleId}
/セッション

次のスケジューラー許可が必要です。

  • スケジュールを編集

特定の日時に実行するスケジュールを設定します。

セッションログ

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/sessions
/{sessionId}/logs

次のProcess Studio許可のうち少なくとも1つが必要です。

  • プロセスを作成
  • プロセスを削除
  • プロセスを編集
  • プロセスグループを編集
  • エクスポートプロセス
  • プロセスを実行
  • Webサービスとしてプロセスを実行
  • プロセス定義を表示
  • プロセスアクセス権を管理

そして次のリソース許可のうち少なくとも1つが必要です。

  • リソースを表示
  • リソーススクリーンキャプチャを表示
  • リソースを構成
  • リソースをコントロール
  • リソースアクセス権を管理
  • リソースの詳細を表示

また、次のシステムマネージャー許可があります。

  • 監査 - プロセスログ

特定の日時に実行するスケジュールを設定します。

GET

/api/v7/sessions/
{sessionId}/logs/
{logId}/parameters

次のProcess Studio許可のうち少なくとも1つが必要です。

  • プロセスを作成
  • プロセスを削除
  • プロセスを編集
  • プロセスグループを編集
  • エクスポートプロセス
  • プロセスを実行
  • Webサービスとしてプロセスを実行
  • プロセス定義を表示
  • プロセスアクセス権を管理

そして次のリソース許可のうち少なくとも1つが必要です。

  • リソースを表示
  • リソーススクリーンキャプチャを表示
  • リソースを構成
  • リソースをコントロール
  • リソースアクセス権を管理
  • リソースの詳細を表示

また、次のシステムマネージャー許可があります。

  • 監査 - プロセスログ

指定されたセッションログのすべてのパラメーターを返します。

セッション

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/sessions

次のリソース許可の少なくとも1つが必要です。

  • リソースを表示
  • リソーススクリーンキャプチャを表示
  • リソースを構成
  • リソースをコントロール
  • リソースアクセス権を管理

また、次のProcess Studio許可のうち少なくとも1つが必要です。

  • プロセスを作成
  • プロセスを削除
  • プロセスを編集
  • プロセスグループを編集
  • エクスポートプロセス
  • プロセスを実行
  • Webサービスとしてプロセスを実行
  • プロセス定義を表示
  • プロセスアクセス権を管理

環境内のセッションのリストを返します。

GET

/api/v7/sessions/{sessionId}

次のリソース許可の少なくとも1つが必要です。

  • リソースを表示
  • リソーススクリーンキャプチャを表示
  • リソースを構成
  • リソースをコントロール
  • リソースアクセス権を管理

また、次のProcess Studio許可のうち少なくとも1つが必要です。

  • プロセスを作成
  • プロセスを削除
  • プロセスを編集
  • プロセスグループを編集
  • エクスポートプロセス
  • プロセスを実行
  • Webサービスとしてプロセスを実行
  • プロセス定義を表示
  • プロセスアクセス権を管理

指定されたセッションの詳細を返します。

ワークキュー

リクエスト

エンドポイント

必要なユーザー許可

応答

GET

/api/v7/workqueues

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

環境内のワークキューのリストを返します。

POST

/api/v7/workqueues

次のシステムマネージャー許可が必要です。

  • ワークフロー - ワークキューの構成

新しいワークキューを作成します。

GET

/api/v7/workqueues/
{workQueueId}

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

指定されたワークキューの詳細を返します。

DELETE

/api/v7/workqueues/
{workQueueId}

次のシステムマネージャー許可が必要です。

  • ワークフロー - ワークキューの構成

指定されたワークキューを削除します。

PATCH

/api/v7/workqueues/
{workQueueId}

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

また、次のシステムマネージャー許可があります。

  • ワークフロー - ワークキューの構成

パッチドキュメントの説明に従って、指定したワークキューを変更します。

GET

/api/v7/workqueues/
{workQueueId}/items

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

指定したワークキューのアイテムを返します。

POST

/api/v7/workqueues/
{workQueueId}/items

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

アクティブなキュー項目にアクセスする場合、次のProcess Studio許可のうち少なくとも1つも必要です。

  • プロセスを作成
  • プロセスを編集
  • プロセスを実行

ワークキューにアイテムを追加します。

GET

/api/v7/workqueues/items/
{workQueueItemId}

次のControl Room許可のうち少なくとも1つが必要です。

  • キュー管理への読み取りアクセス
  • キュー管理へのフルアクセス

アクティブなキュー項目にアクセスする場合、次のProcess Studio許可のうち少なくとも1つも必要です。

  • プロセスを作成
  • プロセスを編集
  • プロセスを実行

ワークキュー内の指定されたアイテムの詳細を返します。