Automation Suite
2021.10
偽
- 基本情報
- 認証
- 範囲と権限
- プラットフォーム管理 API
UiPath Automation Suite API ガイド
最終更新日 2023年11月22日
リソース
プラットフォーム管理 API により、アプリケーションで以下のリソースを制御できます。
監査
GET BaseURL/identity_/api/AuditQuery/{organizationId}
- 指定した組織 ID の監査ログを取得します。GET BaseURL/identity_/api/AuditQuery/{organizationId}/download
— 指定した組織 ID の監査ログをダウンロードします。
グループ
GET BaseURL/identity_/api/Group/{partitionGlobalId}
- 指定したパーティション ID (組織またはテナント) からすべてのローカル グループと組み込みグループを取得します。GET BaseURL/identity_/api/Group/{partitionGlobalId}/{groupId}
- 指定したパーティション ID 内の指定したローカル グループまたは組み込みグループを取得します。POST BaseURL/identity_/api/Group
— 新しいローカル グループを作成します。PUT BaseURL/identity_/api/Group/{groupId}
- ローカル グループの情報を更新します。DELETE BaseURL/identity_/api/Group/{partitionGlobalId}
— 指定したパーティション ID (組織またはテナント) からすべてのローカル グループを削除します。DELETE BaseURL/identity_/api/Group/{partitionGlobalId}/{groupId}
— 指定したローカル グループを削除します。
メッセージ テンプレート
GET BaseURL/identity_/api/MessageTemplate
- 指定したフィルターを使用してメッセージ テンプレートを取得します。GET BaseURL/identity_/api/MessageTemplate/{templateId}
- 指定したメッセージ テンプレートを取得します。PUT BaseURL/identity_/api/MessageTemplate/{templateId}
— 指定したメッセージ テンプレートを更新します。
ロボット アカウント
GET BaseURL/identity_/api/RobotAccount/{partitionGlobalId}
— 指定したパーティション ID (組織またはテナント) 内のすべてのロボット アカウントを取得します。GET BaseURL/identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}
— 指定したパーティション ID 内の指定したロボット アカウントを取得します。POST BaseURL/identity_/api/RobotAccount
— 新しいロボット アカウントを作成します。PUT BaseURL/identity_/api/RobotAccount/{robotAccountId}
- 指定したロボット アカウントの情報を更新します。DELETE BaseURL/identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}
— 指定したロボット アカウントを削除します。DELETE BaseURL/identity_/api/RobotAccount/{partitionGlobalId}
- 指定したパーティション ID 内のすべてのロボット アカウントを削除します。
設定
GET BaseURL/identity_/api/Setting
- 特定のテナントのキーのリストに基づいてアプリケーション設定を取得します。PUT BaseURL/identity_/api/Setting
- 特定のテナントで設定を更新するか、新しい設定を作成します。
ユーザー (User)
GET BaseURL/identity_/api/User/{userId}
— 指定したユーザーの情報を取得します。POST BaseURL/identity_/api/User
- 新規ユーザーを作成します。このエンドポイントはべき等です。ユーザーを上書きしようとすると、既存のユーザーは削除されます。POST BaseURL/identity_/api/User/BulkCreate
- ユーザーを一括作成します。POST BaseURL/identity_/api/User/{userId}/changepassword
— 指定したユーザーのパスワードを更新します。PUT BaseURL/identity_/api/User/{userId}
- 指定したユーザーの情報を更新します。DELETE BaseURL/identity_/api/User
- すべてのユーザーを削除します。DELETE BaseURL/identity_/api/User/{userId}
- 指定したユーザーを削除します。
UserLoginAttempt
GET BaseURL/identity_/api/User/{userId}/loginAttempts
— 指定したユーザーのログイン試行回数を取得します。
ホスト
PUT BaseURL/lrm/api/host/{hostAccountId}/organization/{organizationId}/license
- ホスト ライセンスから組織にライセンスを割り当てます。
サービス ライセンス
- PUT BaseURL/
lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}
- アカウント ライセンスからサービス ライセンスを割り当てます。
ユーザー ライセンス
PUT BaseURL/la/api/account/{accountId}/user-license
- アカウント ライセンスからユーザー ライセンスを割り当てます。PUT BaseURL/la/api/account/{accountId}/user-license/group/{groupId}
- グループ ライセンスを割り当てるか、更新します。
OData 固有の句を適用することにより、GET 要求内の特定のリソースに関する詳細を要求できます。情報のクエリ、フィルター処理、並べ替え、選択、展開が可能です。
$top
取得するデータの量を制限できます。
この句には上限があり、リソース コレクション内のエンティティの数によって決まります。渡される値は Int32 型である必要があります。
たとえば、
BaseURL/api/{resource_name}?$top=3
はリソースの最初の 3
つのエンティティを返します。
$filter
特定のリソースをそのプロパティに従ってフィルター処理する場合に使用します。渡される値は次のとおりです。
- 数値:
BaseURL/api/{resource_name}?$filter=Id%20eq%123
- エンティティ ID =123
でリソースをフィルター処理します。 - String:
BaseURL/api/{resource_name}?$filter=contains(name,'N')
- 名前に文字N
が含まれるエンティティを返します。 - Boolean:
BaseURL/api/{resource_name}$filter={flag}%20eq%20true
- 指定したフラグ値が True であるエンティティでリソースをフィルター処理します。 - Enum:
BaseURL/api/{resource_name}?$filter=UserType%20eq%robot
- ユーザーの種類がrobot
であるエンティティを返します。
ヒント:
論理演算子 (
AND
、OR
、NOT
) を使用して複数のフィルター パラメーターを組み合わせたり、括弧「( )
」でグループ化したりできます。
$expand
指定したリソースのナビゲーション プロパティを完全に読み込む場合に使用します。
リソース |
展開可能なプロパティ |
---|---|
グループ |
メンバー |
ロボット アカウント |
グループ ID |
ユーザー (User) |
グループ ID |
たとえば、
BaseURL/api/Group/123/?$expand=members
は Group リソース内の ID=123
であるエンティティの members
プロパティを展開します。
$select
返す必要があるリソース プロパティのサブセットを指定する場合に使用します。
複数のプロパティを抽出する場合は、各プロパティをコンマで区切ります。
たとえば、
BaseURL/api/{resource_name}?$select=id,name
はリソース エンティティの ID と名前のみを返します。
$orderby
取得したリソースを指定したプロパティで並べ替える場合に使用します。
並べ替え条件のプロパティが複数ある場合は、各プロパティをコンマで区切ります。
$orderby
句に並べ替え順序を追加すると、昇順 (asc
) または降順 (desc
) でエンティティが返されます。既定では、昇順でエンティティが並べ替えられます。
たとえば、
BaseURL/api/{resource_name}?$orderby=id asc
は ID の昇順で並べ替えられたエンティティを返します。
$skip
リソースの最初の
N
個のエンティティをスキップする場合に使用します。
たとえば、
BaseURL/api/{resource_name}?$skip=2
は最初の 2 つのエンティティをスキップして、リソースの 3 番目のエンティティから始まるリストを返します。