メインコンテンツまでスキップ

APIリソース

次の API エンドポイントとリソースは、適切な承認によってアクセスできるように公開されます。

1. GetRolePermission​

リソース権限コレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
名前弦真実役割名

応答

戻り値の種類: コレクション(リソース)

例：

http://botcenter.akabot.io/api/roles/{name} URL に GET リクエストを送信します。

image-20230307144502-1.png

ヘッダー:

image-20230307144502-2.png

応答：

image-20230307144502-3.png2。ユーザーの取得​

ユーザーコレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
組織単位ID整数間違い
検索ユーザー弦間違いログイン(ユーザー名)
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(ユーザー)

例：

http://botcenter.akabot.io/api/users URL に GET リクエストを送信します。

image-20230307144502-4.png

パラメータ:

image-20230307144502-5.png

ヘッダー:

image-20230307144502-6.png

応答：

image-20230307144502-7.png

3.ユーザーの作成​

新しいユーザーを追加します。 HTTPメソッド：ポスト

パラメータ

名前タイプ説明
ユーザーDTOユーザー

応答

戻り値の種類: ユーザー

例：

http://botcenter.akabot.io/api/users URL に POST リクエストを送信します。

image-20230307144502-8.png

ヘッダー:

image-20230307144502-9.png

リクエスト：

image-20230307144502-10.png

image-20230307144502-11.png

応答：

image-20230307144502-12.png

image-20230307144502-13.png

4.役割の追加​

ユーザーの役割を追加します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
ユーザーロールDTOユーザーロール

応答

戻り値の種類: ステータスコード

例：

http://botcenter.akabot.io/api/user-add-role URL に PUT リクエストを送信します。

image-20230307144502-14.png

ヘッダー:

image-20230307144502-15.png

リクエスト：

image-20230307144502-16.png

image-20230307144502-17.png

応答：

image-20230307144502-18.png

レスポンスコード: 200

5.役割の削除​

ユーザーから役割を削除します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
ユーザーロールDTOユーザーロール

応答

戻り値の種類: ステータスコード

例：

http://botcenter.akabot.io/api/user-remove-role URL に PUT リクエストを送信します。

image-20230307144502-19.png

ヘッダー:

image-20230307144502-20.png

リクエスト：

image-20230307144502-21.png

image-20230307144502-22.png

応答：

image-20230307144502-23.png

レスポンスコード: 200

6.組織単位の追加​

ユーザーの組織単位を追加します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
ユーザー組織単位DTOユーザーロール

応答

戻り値の種類: ステータスコード

例：

http://botcenter.akabot.io/api/user-add-organizationUnit URL に PUT リクエストを送信します。

image-20230307144502-24.png

ヘッダー:

image-20230307144502-25.png

リクエスト：

image-20230307144502-26.png

image-20230307144502-27.png

応答：

image-20230307144502-28.png

レスポンスコード: 200

7.組織単位の削除​

ユーザーから組織単位を削除します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
ユーザー組織単位DTOユーザーロール

応答

戻り値の種類: ステータスコード

例：

http://botcenter.akabot.io/api/user-remove-organizationUnit URL に PUT リクエストを送信します。

image-20230307144502-29.png

ヘッダー:

image-20230307144502-30.png

リクエスト：

image-20230307144502-31.png

image-20230307144502-32.png

応答：

image-20230307144502-33.png

レスポンスコード: 200

8.ユーザーの更新​

ユーザー情報を更新します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
ユーザーDTOユーザー

応答

戻り値の種類: ユーザー

例：

http://botcenter.akabot.io/api/users URL に PUT リクエストを送信します。

リクエスト：

image-20230307144502-34.png

image-20230307144502-35.png

応答：

image-20230307144502-36.png

image-20230307144502-37.png

9.アクティブ化されたユーザー​

ユーザーをアクティブ化または非アクティブ化します。 HTTPメソッド：Put

パラメータ

名前タイプ説明
DTOをアクティブにする活性化

応答

戻り値の種類: ステータスコード

例：

http://botcenter.akabot.io/api/user-activated URL に PUT リクエストを送信します。

image-20230307144502-38.png

ヘッダー:

image-20230307144502-39.png

リクエスト：

image-20230307144502-40.png

image-20230307144502-41.png

応答：

image-20230307144502-42.png

レスポンスコード: 200

10.関連プロセスの取得​

エージェントの使用可能なすべての関連プロセスのコレクションを返します。サポートされているメソッド: Get

パラメータ

名前タイプ説明
ロボットキー弦

応答

戻り値の種類: コレクション(ワークフロー)

例：

http://botcenter.akabot.io/api/robotsservice/GetAssociatedProcesses URL に GET リクエストを送信します。

image-20230307144502-43.png

パラメータ:

image-20230307144502-44.png

ヘッダー:

image-20230307144502-45.png

応答：

image-20230307144502-46.png

11.ワークフロー​

WorkFlow コレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
組織単位ID整数間違い
環境ID整数間違いエージェントグループID
環境名弦間違いエージェントグループ名
ワークフローID整数間違い
ワークフロー名弦間違い
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(ワークフロー)

例：

http://botcenter.akabot.io/api/work-flows URL に GET リクエストを送信します。

image-20230307144502-47.png

パラメータ:

image-20230307144502-48.png

ヘッダー:

image-20230307144502-49.png

応答：

image-20230307144502-50.png

12.ワークフローバージョン​

Get WorkFlow version.サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
ワークフローID長さ真実

応答

戻り値の種類: 文字列

例：

http://botcenter.akabot.io/api/workflowversion URL に GET リクエストを送信します。

image-20230307144502-51.png

パラメータ:

image-20230307144502-52.png

ヘッダー:

image-20230307144502-53.png

応答：

1.0.12380.19828

13.ワークフローバージョンの更新​

ワークフローのバージョンを更新します。サポートされているメソッド: Put

パラメータ

名前タイプ説明
ID整数ワークフローID
バージョン弦

応答

戻り値の種類: ワークフロー

例：

http://botcenter.akabot.io/api/work-flows/{id}/version URL に PUT リクエストを送信します。

image-20230307144502-54.png

ヘッダー:

image-20230307144502-55.png

応答

image-20230307144502-56.png

14.パッケージのアップロード​

パッケージをパッケージ リポジトリにアップロードします。サポートされているメソッド: 投稿

パラメータ

名前パラメータの種類タイプコンテンツタイプ
パッケージフォームデータファイルマルチパート/フォームデータ
環境IDフォームデータ配列[長い]アプリケーション/json

応答

戻り値の種類: パッケージ

例：

http://botcenter.akabot.io/api/packageupload URL に POST リクエストを送信します。

image-20230307144502-57.png

パラメータ:

image-20230307144502-58.png

ヘッダー:

image-20230307144502-59.png

応答

image-20230307144502-60.png15。環境​

エージェントグループを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
組織単位ID整数間違い
環境名弦間違いエージェントグループ名
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(環境)

例：

http://botcenter.akabot.io/api/environments URL に GET リクエストを送信します。

image-20230307144502-61.png

パラメータ:

image-20230307144502-62.png

ヘッダー:

image-20230307144502-63.png

応答：

image-20230307144502-64.png

16.ジョブの開始​

新しいジョブを追加し、入力パラメータに基づいて各エージェントのジョブを保留状態に設定し、保留中のジョブについて各エージェントに通知します。 HTTPメソッド：ポスト

パラメータ

名前タイプ説明
仕事DTO仕事

応答

戻り値の種類: ジョブ

例：

http://botcenter.akabot.io/api/jobs-processing URL に POST リクエストを送信します。

image-20230307144502-65.png

ヘッダー:

image-20230307144502-66.png

リクエスト：

image-20230307144502-67.png

image-20230307144502-68.png

応答：

image-20230307144502-69.png

image-20230307144502-70.pngStopJob

指定したジョブをキャンセルまたは終了します。サポートされているメソッド: Put

パラメータ

名前タイプ説明
ID整数ジョブID
価値文字列(STOP、KILL)

応答

戻り値の種類: ジョブ

例：

http://botcenter.akabot.io/api/jobs-processing/{id}/{value} URL に PUT リクエストを送信します。

image-20230307144502-71.png

ヘッダー:

image-20230307144502-72.png

応答

image-20230307144502-73.png

17.ジョブを取得​

求人情報を取得します。サポートされているメソッド: Get

パラメータ

名前タイプ説明
ID整数ジョブID

応答

戻り値の種類: ジョブ

例：

http://botcenter.akabot.io/api/jobs/{id} URL に GET リクエストを送信します。

image-20230307144502-74.png

ヘッダー:

image-20230307144502-75.png

応答

image-20230307144502-76.png

18.ジョブを取得​

ジョブ コレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
組織単位ID整数間違い
環境ID整数間違いエージェントグループID
ロボットID整数間違い
スケジュールID整数間違い
州弦間違い(保留中、実行中、停止、失敗、成功)。 複数の状態をカンマで区切ってサポート
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(ジョブ)

例：

http://botcenter.akabot.io/api/jobs URL に GET リクエストを送信します。

image-20230307144502-77.png

パラメータ:

image-20230307144502-78.png

ヘッダー:

image-20230307144502-79.png

応答：

image-20230307144502-80.png

19. GetRobotMapping​

ロボットのマッピング情報を取得します。サポートされているメソッド: Get

パラメータ

名前タイプ説明
ライセンスキー弦エージェントキー
マシン名弦

応答

戻り値の種類: RobotMappingVM

例：

http://botcenter.akabot.io/api/robotsservice/GetRobotMappings URL に GET リクエストを送信します。

image-20230307144502-81.png

パラメータ:

image-20230307144502-82.png

ヘッダー:

image-20230307144502-83.png

応答：

image-20230307144502-84.png

20.ロボットを入手​

ロボットのコレクションを入手します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
組織単位ID整数間違い
環境ID整数間違いエージェントグループID
ロボットID整数間違い
ロボット_タイプ整数間違い開発(0)、アシスタント(1)、ステージング(2)、プロダクション(3)
ロボット_ステータス整数間違い利用可能(0)、ビジー(1)、切断(2)、応答なし(3)
検索弦間違いエージェント名(ロボット名)
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(ロボット)

例：

http://botcenter.akabot.io/api/robots URL に GET リクエストを送信します。

image-20230307144502-85.png

パラメータ:

image-20230307144502-86.png

ヘッダー:

image-20230307144502-87.png

応答：

image-20230307144502-88.png

21.送信ハートビート​

エージェントのステータスを送信し、タスクのリストを取得するコマンド。サポートされているメソッド: 投稿

パラメータ

名前タイプ説明
心拍DTOハートビートDTO

応答

戻り値の種類: ハートビートデータ

例：

http://botcenter.akabot.io/api/robotsservice/SubmitHeartbeat URL に POST リクエストを送信します。

image-20230307144502-89.png

リクエスト：

image-20230307144502-90.png

image-20230307144502-91.png

ヘッダー:

image-20230307144502-92.png

応答：

image-20230307144502-93.png

22.ジョブ状態の送信​

エージェントからタスクのステータスを送信します。サポートされているメソッド: 投稿

パラメータ

名前タイプ説明
心拍DTOハートビートDTO

応答

例：

http://botcenter.akabot.io/api/robotsservice/SubmitJobState URL に POST リクエストを送信します。

image-20230307144502-94.png

リクエスト：

image-20230307144502-95.png

image-20230307144502-96.png

ヘッダー:

image-20230307144502-97.png

応答：

23.プッシュログ​

ログを中央にプッシュします。サポートされているメソッド: 投稿

パラメータ

名前タイプ説明
ロボット名弦
メッセージ配列(文字列)

応答

戻り値の型: ブール値

例：

http://botcenter.akabot.io/api/logs/v1 URL に POST リクエストを送信します。

image-20230307144502-98.png

リクエスト：

image-20230307144502-99.png

image-20230307144502-100.png

ヘッダー:

image-20230307144502-101.png

応答：

真実

24.ログの取得​

ログコレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
ロボット名弦間違い
ワークフローID整数間違い
レベル整数間違いオフ(0)、致命的(1)、エラー(2)、警告(3)、情報(4)、デバッグ(5)、詳細(6)
ジョブID弦間違い
クエリ文字列弦間違いログメッセージからクエリするキーワード
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(ジョブ)

例：

http://botcenter.akabot.io/api/logs URL に GET リクエストを送信します。

image-20230307144502-102.png

パラメータ:

image-20230307144502-103.png

ヘッダー:

image-20230307144502-104.png

応答：

image-20230307144502-105.png

25.アセットの取得​

資産情報を取得します。サポートされているメソッド: Get

パラメータ

名前タイプ説明
資産名弦
ロボットキー弦

応答

戻り値の種類: AssetVM

例：

http://botcenter.akabot.io/api/studioservice/GetAsset URL に GET リクエストを送信します。

image-20230307144502-106.png

パラメータ:

image-20230307144502-107.png

ヘッダー:

image-20230307144502-108.png

応答：

image-20230307144502-109.png

26.資産を設定​

資産の価値を更新します。サポートされているメソッド: 投稿

パラメータ

名前タイプ説明
アセットVMアセットVM

応答

戻り値の型: ブール値

例：

http://botcenter.akabot.io/api/studioservice/SetAssetURL に POST リクエストを送信します。

image-20230307144502-110.png

リクエスト：

image-20230307144502-111.png

image-20230307144502-112.png

ヘッダー:

image-20230307144502-113.png

応答：

真実

27. GetQueue​

キューのコレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
名前長さ間違いキューID
キュー名弦間違いキュー名
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(キュー)

例：

http://botcenter.akabot.io/api/queue URL に GET リクエストを送信します。

image-20230307144502-114.png

パラメータ:

image-20230307144502-115.png

ヘッダー:

image-20230307144502-116.png

応答：

画像-20230307144502-117.png28。 GetQueuItems​

QueueItem コレクションを取得します。サポートされているメソッド: 投稿

パラメータ

名前タイプ説明
キュー名弦
参照弦
フィルター戦略文字列 (STARTSWITH、EQUALS)参考までに
状態文字列(新規、進行中、失敗、成功、放棄、再試行、削除、期限切れ)キュー項目のステータス、フィルターの複数値のサポート
から日時日付の作成
に日時日付の作成
トップ内部アイテムの返品を制限する
スキップ内部オフセット

応答

戻り値の種類: コレクション(QueueItem)

例：

http://botcenter.akabot.io/api/queue/getQueueItems URL に POST リクエストを送信します。

image-20230307144502-118.png

リクエスト：

image-20230307144502-119.png

image-20230307144502-120.png

ヘッダー:

image-20230307144502-121.png

応答：

image-20230307144502-122.png

29. GetQueueDetails​

QueueItem コレクションを取得します。サポートされているメソッド: Get

パラメータ

名前タイプ必須説明
ID長さ真実キューID
参照弦間違い
例外整数間違いアプリケーション(0)、ビジネス(1)
優先度整数間違い高(3)、標準(2)、低(1)
状態整数間違い新規(0)、進行中(1)、失敗(2)、成功(3)、放棄(4)、再試行(5)、削除(6)、期限切れ(7)
特定のデータ弦間違い特定のデータからクエリするキーワード
開始から日時間違い開始時刻からのクエリ
開始まで日時間違い開始時刻からのクエリ
ページ整数間違い要求されたページのページ番号
サイズ整数間違いページのサイズ(上部)
選別弦間違い形式の並べ替え基準: property(,asc

応答

戻り値の種類: コレクション(QueueItems)

例：

http://botcenter.akabot.io/api/queue/{id}/detail URL に GET リクエストを送信します。

image-20230307144502-123.png

パラメータ:

image-20230307144502-124.png

ヘッダー:

image-20230307144502-125.png

応答：

image-20230307144502-126.png

30.キューアイテムの追加​

キューアイテムを追加します。 HTTPメソッド：ポスト

パラメータ

名前タイプ説明
キュー名弦
優先度文字列(高、標準、低)
参照弦
ロボット名弦
特定のデータ弦
締め切りデータ時間
延期日時

応答

戻り値の種類: HttpStatus

例：

http://botcenter.akabot.io/api/queue/addQueueItem URL に POST リクエストを送信します。

image-20230307144502-127.png

ヘッダー:

image-20230307144502-128.png

リクエスト：

image-20230307144502-129.png