申請情報を取得する
未処理申請の更新情報を取得する
未処理申請のIDとversionをリクエストのパラメーターとして受け取り、申請の更新情報を返すAPIです。
API名
WorkflowGetUnprocessedApplicationVersions
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_item | base:ItemVersionType | 0~ 無制限
|
更新情報を取得する未処理申請のIDとバージョン |
例
|
|
レスポンス
APIを実行した時点の経路ステップに対し、アクセス権の設定で編集可に設定された項目がある場合、その申請の更新情報は取得できません。
アクセス権の設定は、申請を提出した時点のアクセス権が適用されます。
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_item | base:ItemVersionResultType | 0~ 無制限
|
取得した未処理申請の更新情報
|
例
|
|
未処理申請を取得する
未処理申請のIDをリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返すAPIです。
API名
WorkflowGetUnprocessedApplicationsById
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_id/text() | base:IDType | 1~ 無制限 | 取得する未処理申請のID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 0~ 無制限 | 取得した未処理申請の情報 |
例
|
|
送信済み申請の更新情報を取得する
送信した申請のIDとversion、取得期間をリクエストのパラメーターとして受け取り、指定した期間内の申請の更新情報を返すAPIです。
API名
WorkflowGetSentApplicationVersions
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @start | xsd:dateTime | 1 | 取得期間の開始日時 |
| @end | xsd:dateTime | 0~1
|
取得期間の終了日時 |
| application_item | base:ItemVersionType | 0~ 無制限
|
更新情報を取得する送信済み申請のIDとバージョン |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_item | base:ItemVersionResultType | 0~ 無制限
|
取得した送信済み申請の情報
|
例
|
|
送信済み申請を取得する
送信した申請のIDをリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返すAPIです。
API名
WorkflowGetSentApplicationsById
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_id/text() | base:IDType | 1~ 無制限 | 取得する送信済み申請のID |
例
|
|
レスポンス
存在しない申請IDやアクセス権のない申請IDを指定した場合、空のレスポンスが返されます。
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 0~ 無制限 | 取得した確認済み申請の情報 |
例
|
|
受信した申請の更新情報を取得する
受信した申請のIDとversion、取得期間をリクエストのパラメーターとして受け取り、指定した期間内の申請の更新情報を返すAPIです。
API名
WorkflowGetReceivedApplicationVersions
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @start | xsd:dateTime | 1 | 取得期間の開始日時 |
| @end | xsd:dateTime | 0~1
|
取得期間の終了日時 |
| application_item | base:ItemVersionType | 0~ 無制限
|
更新情報を取得する受信した申請のIDとバージョン |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_item | base:ItemVersionResultType | 0~ 無制限
|
取得した申請の情報
|
例
|
|
受信した申請を取得する
受信した申請のIDをリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返すAPIです。
API名
WorkflowGetReceivedApplicationsById
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application_id/text() | base:IDType | 1~ 無制限 | 取得する受信した申請のID |
例
|
|
レスポンス
存在しない申請IDやアクセス権のない申請IDを指定した場合、空のレスポンスが返されます。
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 0~ 無制限 | 取得した申請の情報 |
例
|
|
代理承認の申請を取得する
APIを実行するユーザーが代理承認者となっているGaroonユーザーIDおよび取得期間をリクエストのパラメーターとして受け取り、指定したユーザーが期間内に取得した申請の情報をレスポンスとして返すAPIです。
API名
WorkflowGetProxyApprovalsByDelegatorId
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @delegator_id/text() | base:IDType | 1 | API実行ユーザーが代理承認するGaroonユーザーID |
| @start | xsd:dateTime | 1 | 取得期間の開始日時 |
| @end | xsd:dateTime | 0~1
|
取得期間の終了日時 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 0~ 無制限
|
取得した申請の情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_WRKF_25307 | 代理承認者でないGaroonユーザーIDを指定した場合 |
承認予定の申請を取得する
取得期間をリクエストのパラメーターとして受け取り、指定した期間内に申請された申請のうち、ログインユーザーの承認予定一覧にある申請の情報をレスポンスとして返すAPIです。
API名
WorkflowGetPendingApprovals
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @start | xsd:dateTime | 1 | 取得期間の開始日時 |
| @end | xsd:dateTime | 0~1
|
取得期間の終了日時 |
例
|
|
レスポンス
Garoonの「システム管理(各アプリケーション)→ワークフロー→一般設定」で、「承認予定の使用許可」を「許可する」にしていないと、このAPIは空のレスポンスを返します。
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 0~ 無制限
|
取得した申請の情報 |
例
|
|
管理者として申請情報を取得する
申請フォームIDと条件をリクエストとして受け取り、条件に該当する申請データの情報をレスポンスとして返すAPIです。 このAPIの実行にはシステム管理者権限が必要です。
API名
WorkflowGetRequests
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| manage_request_parmeter | workflow:WorkflowGetRequestType | 0~1 | 取得したい申請の条件 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| category | workflow:RequestManagerFormType | 0~ 無制限 | 取得した申請情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_WRKF_25305 | 開始日時と終了日時が不正な場合 |
| GRN_CMMN_00005 | APIを実行するユーザーにシステム管理権限がない場合 |
管理者として申請情報を取得する(ID指定)
申請データのIDをリクエストとして受け取り、申請データの情報をレスポンスとして返すAPIです。 このAPIの実行にはシステム管理者権限が必要です。
API名
WorkflowGetRequestById
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| request_id | base:IDType | 1~ 無制限 | 取得する申請のID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| application | workflow:WorkflowApplicationType | 1~ 無制限 | 取得した申請情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_WRKF_25302 | 指定した申請IDが存在しない場合 |
| GRN_CMMN_00005 | APIを実行するユーザーにシステム管理権限がない場合 |
