はじめに
前回、JavaでUiPathの認証APIを叩いてみました。
今回はトリガーの一覧を取得するAPIの使い方を解説します。
トリガーを取得するAPI
トリガーの取得は [GET] /odata/ProcessSchedules を実行することで取得できます。
しかし、APIのマニュアルを見ると、X-UIPATH-OrganizationUnitIdなるものを指定する必要があるようです。
X-UIPATH-OrganizationUnitIdってなに？
すごく簡単に説明すると、「テナントとかフォルダーとかに、一意にふられている番号」です。
今回は、モダンフォルダーで構成されているフォルダーにあるトリガーを取得しますが、「フォルダーのID」みたいなものだと思ってください。
トリガーを取得する流れ
取得対象フォルダーのX-UIPATH-OrganizationUnitIdがわからないと、トリガーが取得できません。
なので、以下のような流れでトリガーを取得します。
- 認証
- フォルダーの情報を取得する
- トリガーの情報を取得する
順番に解説します。
1. 認証
認証については、前回説明しているので割愛します。
認証結果のBearerトークンが取得できればOKです。
2. フォルダーの情報を取得する
フォルダーは、[GET] /odata/Folders を実行することによって取得できます。
ここで重要なのは、X-UIPATH-OrganizationUnitIdに渡すフォルダーのIDですね。
APIの結果をもう少し詳しく見てみます。（一部省略しています。）
{
"@odata.context":"~~",
"@odata.count":4,
"value":[
{
"Key":"~~",
"DisplayName":"TEST_FOLDER",
"FullyQualifiedName":"TEST_FOLDER",
"Id":3
}
]
}
はい、いましたね。Idです。
この値を X-UIPATH-OrganizationUnitId に指定します。
3. トリガーの情報を取得する
あらためて[GET] /odata/ProcessSchedulesを実行してみましょう。
トリガーが取得できました！
トリガー一覧の内容について
詳細については、マニュアルに戻り値DTOの内容が記載されていますが（英語）、以下に一部を抜粋します。
| 項目 | 内容 |
|---|---|
| Enabled | トリガー自体が有効かどうか（有効ならtrue） |
| Name | トリガーの名前 |
| ReleaseName | トリガーに紐づくプロセスの名前 |
| PackageName | トリガーに紐づくパッケージの名前 |
| JobPriority | 優先度 |
| StartProcessCron | 実際に動作するcron式 |
| StartProcessNextOccurrence | 次回の実行時刻 |
次回
Javaでツールを作ってみます！