以下のAPIエンドポイントとリソースは、適切な承認によってアクセスできます。
1.GetRolePermisson
リソース権限コレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| name | 文字列 | true | ロール名 |
レスポンス
ReturnType：Collection(Resource)
例）
http://botcenter.akabot.io/api/roles/{name}のURLにGETリクエストを送信します。
ヘッダー：
レスポンス：
2.GetUsers
ユーザーコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| organizationUnitId | 整数 | False | |
| searchuser | 文字列 | False | ログイン（ユーザ名） |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：login,asc |
レスポンス
ReturnType：Collection(User)
例）
http://botcenter.akabot.io/api/usersのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
3.CreateUser
新しいユーザを作成します。HTTPメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| userDTO | ユーザ |
レスポンス
ReturnType：User
例）
http://botcenter.akabot.io/api/usersのURLにPOSTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
4.AddRole
ユーザーのロールを追加します。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| userRoleDTO | UserRole |
レスポンス
ReturnType：StatusCode
例）
http://botcenter.akabot.io/api/user-add-roleのURLにPUTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
レスポンスコード：200
5.RemoveRole
ユーザーのロールを削除します。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| userRoleDTO | UserRole |
レスポンス
ReturnType：StatusCode
例）
http://botcenter.akabot.io/api/user-remove-roleのURLにPUTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
レスポンスコード：200
6.AddOrganizationUnits
ユーザーの組織を追加します。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| UserOrganizationUnitDTO | UserRole |
レスポンス
ReturnType：StatusCode
例）
http://botcenter.akabot.io/api/user-add-organizationUnitのURLにPUTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
レスポンスコード：200
7.RemoveOrganizationUnits
ユーザーの組織を削除します。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| UserOrganizationUnitDTO | UserRole |
レスポンス
ReturnType：StatusCode
例）
http://botcenter.akabot.io/api/user-remove-organizationUnitのURLにPUTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
レスポンスコード：200
8.UpdateUser
ユーザー情報を更新します。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| userDTO | ユーザ |
レスポンス
ReturnType：User
例）
http://botcenter.akabot.io/api/usersのURLにPUTリクエストを送信します。
リクエスト：
レスポンス：
9.ActivatedUser
ユーザーを有効／無効にします。HTTPメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| activateDTO | Activate |
レスポンス
ReturnType：StatusCode
例）
http://botcenter.akabot.io/api/user-activatedのURLにPUTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
レスポンスコード：200
10.GetAssociatedProcesses
Agentに関するすべての使用可能なプロセスのコレクションを返します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 説明 |
| robotKey | 文字列 |
レスポンス
ReturnType: Collection(WorkFlow)
例）
http://botcenter.akabot.io/api/robotsservice/GetAssociatedProcessesのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
11.Workflows
ワークフローコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| organizationUnitId | 整数 | False | |
| environmentId | 整数 | False | AgentグループID |
| environmentName | 文字列 | False | Agentグループ名 |
| workflowId | 整数 | False | |
| workflowName | 文字列 | False | |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：name,asc |
レスポンス
ReturnType: Collection(WorkFlow)
例）
http://botcenter.akabot.io/api/work-flowsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
12.WorkFlowVersion
ワークフローバージョンを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| workflowId | Long | True |
レスポンス
ReturnType：String
例）
http://botcenter.akabot.io/api/workflowversionのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
1.0.12380.19828
13.UpdateWorkFlowVersion
ワークフローバージョンを更新します。サポートされているメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| id | 整数 | workflowId |
| version | 文字列 |
レスポンス
ReturnType：Workflow
例）
http://botcenter.akabot.io/api/work-flows/{id}/versionのURLにPUTリクエストを送信します。
ヘッダー：
レスポンス
14.UploadPackage
パッケージをパッケージ リポジトリにアップロードします。サポートされているメソッド：Post
パラメータ
| 名称 | パラメータータイプ | 形式 | コンテンツタイプ |
| package | form-data | File | multipart/form-data |
| environmentIds | form-data | Array[long] | application/json |
レスポンス
ReturnType：Packages
例）
http://botcenter.akabot.io/api/packageuploadのURLにPOSTリクエストを送信します。
パラメーター
ヘッダー：
レスポンス
15.Environments
Agentグループを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| organizationUnitId | 整数 | False | |
| environmentname | 文字列 | False | Agentグループ名 |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：name,asc |
レスポンス
ReturnType：Collection(Environment)
例）
Make a GET request to the http://botcenter.akabot.io/api/environmentsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
16.StartJob
各Agentに対して新しいジョブを入力パラメータに基づいて追加し、このジョブを｢Pending｣状態に設定し、保留中のジョブについてAgentに通知します。HTTPメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| jobDTO | Job |
レスポンス
ReturnType：Job
例）
http://botcenter.akabot.io/api/jobs-processingのURLにPOSTリクエストを送信します。
ヘッダー：
リクエスト：
レスポンス：
StopJob
指定したジョブをキャンセルし、または停止させます。サポートされているメソッド：Put
パラメータ
| 名称 | 形式 | 説明 |
| id | 整数 | jobId |
| value | String(STOP, KILL) |
レスポンス
ReturnType：Job
例）
http://botcenter.akabot.io/api/jobs-processing/{id}/{value}のURLにPUTリクエストを送信します。
ヘッダー：
レスポンス
17.GetJob
ジョブの情報を取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 説明 |
| id | 整数 | jobId |
レスポンス
ReturnType：Job
例）
http://botcenter.akabot.io/api/jobs/{id}のURLにGETリクエストを送信します。
ヘッダー：
レスポンス
18.GetJobs
ジョブコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| organizationUnitId | 整数 | False | |
| environmentId | 整数 | False | AgentグループID |
| robotId | 整数 | False | |
| scheduleId | 整数 | False | |
| state | 文字列 | False | （PENDING、RUNNING、STOPPED、FAULTED、SUCCESSFUL）。 カンマで区切っている複数の状態をサポートします。 |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：startTime,desc |
レスポンス
ReturnType：Collection(Job)
例）
http://botcenter.akabot.io/api/jobsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
19.GetRobotMapping
ロボットマッピングの情報を取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 説明 |
| licenseKey | 文字列 | Agentキー |
| machineName | 文字列 |
レスポンス
ReturnType：RobotMappingVM
例）
http://botcenter.akabot.io/api/robotsservice/GetRobotMappingsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
20.GetRobots
ロボットコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| organizationUnitId | 整数 | False | |
| environmentId | 整数 | False | AgentグループID |
| robotId | 整数 | False | |
| robot_type | 整数 | False | DEVELOPMENT(0)、 ASSITANT(1)、STAGING(2)、PRODUCTION(3) |
| robot_status | 整数 | False | AVAILABLE(0)、BUSY(1)、DISCONNECTED(2)、UNRESPONSIVE(3) |
| search | 文字列 | False | Agent名（ロボット名） |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：name,asc |
レスポンス
ReturnType：Collection(Robot)
例）
http://botcenter.akabot.io/api/robotsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
21.SubmitHeartbeat
Agentのステータスを送信し、タスクコマンドのリストを取得します。サポートされているメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| heartbeatDTO | HeartbeatDTO |
レスポンス
ReturnType：HeartbeatData
例）
http://botcenter.akabot.io/api/robotsservice/SubmitHeartbeatのURLにPOSTリクエストを送信します。
リクエスト：
ヘッダー：
レスポンス：
22.SubmitJobState
Agentからタスクのステータスを送信します。サポートされているメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| heartbeatDTO | HeartbeatDTO |
レスポンス
例）
http://botcenter.akabot.io/api/robotsservice/SubmitJobStateのURLにPOSTリクエストを送信します。
リクエスト：
ヘッダー：
レスポンス：
23.PushLogs
ログをCenterにプッシュします。サポートされているメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| robotName | 文字列 | |
| messages | Array(String) |
レスポンス
ReturnType：Bool
例）
http://botcenter.akabot.io/api/logs/v1のURLにPOSTリクエストを送信します。
リクエスト：
ヘッダー：
レスポンス：
True
24.GetLogs
ログコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| robotName | 文字列 | False | |
| workflowId | 整数 | False | |
| level | 整数 | False | OFF(0)、FATAL(1)、 ERROR(2)、WARNING(3)、INFORMATION(4)、DEBUG(5)、VERBOSE(6) |
| jobId | 文字列 | False | |
| queryString | 文字列 | False | ログメッセージをクエリするキーワード |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：timeStamp,desc |
レスポンス
ReturnType：Collection(Job)
例）
http://botcenter.akabot.io/api/logsのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
25.GetAsset
アセットの情報を取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 説明 |
| assetName | 文字列 | |
| robotKey | 文字列 |
レスポンス
ReturnType：AssetVM
例）
http://botcenter.akabot.io/api/studioservice/GetAssetのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
26.SetAsset
アセットの値を更新します。サポートされているメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| assetVM | AssetVM |
レスポンス
ReturnType：Bool
例）
http://botcenter.akabot.io/api/studioservice/SetAssetのURLにPOSTリクエストを送信します。
リクエスト：
ヘッダー：
レスポンス：
True
27.GetQueue
キューコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| name | Long | False | キューID |
| queueName | 文字列 | False | キュー名 |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：timeStamp,desc |
レスポンス
ReturnType：Collection(Queue)
例）
http://botcenter.akabot.io/api/queueのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
28.GetQueuItems
キュー項目のコレクションを取得します。サポートされているメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| queueName | 文字列 | |
| reference | 文字列 | |
| filterStrategy | String (STARTSWITH, EQUALS) | reference用 |
| status | String(New, InProgress, Failed, Successful, Abandoned, Retried, Deleted, Expired) | キュー項目のステータス。 複数の値のフィルタリングがサポートされている |
| From | DateTime | 作成日 |
| To | DateTime | 作成日 |
| Top | Int | 戻り項目の数を制限 |
| Skip | Int | オフセット |
レスポンス
ReturnType：Collection(QueueItem)
例）
http://botcenter.akabot.io/api/queue/getQueueItemsのURLにPOSTリクエストを送信します。
リクエスト：
ヘッダー：
レスポンス：
29.GetQueueDetails
キュー項目のコレクションを取得します。サポートされているメソッド：Get
パラメータ
| 名称 | 形式 | 必須 | 説明 |
| id | Long | true | キューID |
| reference | 文字列 | False | |
| exception | Integer | False | Application(0)、Business(1) |
| priority | 整数 | False | High(3)、Normal(2)、Low(1) |
| status | 整数 | False | New(0)、InProgress(1)、Failed(2)、Successful(3)、Abandoned(4)、Retried(5)、Deleted(6)、Expired(7) |
| specificData | 文字列 | False | specificDataをクエリするキーワード |
| startFrom | DateTime | False | starttimeをクエリする |
| startTo | DateTime | False | starttimeをクエリする |
| page | 整数 | False | リクエストされたページのページ番号 |
| size | 整数 | False | ページのサイズ（上部） |
| sort | 文字列 | False | プロパティ(,asc|desc)形式でのソート基準 例：timeStamp,desc |
レスポンス
ReturnType：Collection(QueueItems)
例）
http://botcenter.akabot.io/api/queue/{id}/detailのURLにGETリクエストを送信します。
パラメーター
ヘッダー：
レスポンス：
30.AddQueueItem
キュー項目を追加します。HTTPメソッド：Post
パラメータ
| 名称 | 形式 | 説明 |
| queueName | 文字列 | |
| priority | String(High, Normal, Low) | |
| reference | 文字列 | |
| robotName | 文字列 | |
| specificData | 文字列 | |
| deadline | DataTime | |
| postpone | DateTime |
レスポンス
ReturnType：HttpStatus
例）
http://botcenter.akabot.io/api/queue/addQueueItemのURLにPOSTリクエストを送信します。
ヘッダー：
リクエスト：
