Index
未処理申請の更新情報を取得する
未処理申請の ID と version をリクエストのパラメーターとして受け取り、申請の更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでその申請のoperation は、”modify”となります。 リクエストで受け取らなかった申請が存在する場合、レスポンスでその申請の operation は、”add”となります。 存在しない申請をリクエストで受け取った場合、レスポンスでその申請の operation は、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
WorkflowGetUnprocessedApplicationVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
application_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得する未処理申請のIDとバージョン |
例
<parameters> <application_item id="1" version="11" /> <application_item id="2" version="22" /> <application_item id="3" version="33" /> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application_item | base:ItemVersionResultType | 0 ~ 無制限
|
取得した未処理申請の更新情報 |
例
<returns> <application_item id="1" version="1245376338" operation="remove" /> <application_item id="2" version="1245327097" operation="modify" /> <application_item id="3" version="1245327110" operation="modify" /> <application_item id="4" version="1245715417" operation="add" /> </returns>
未処理申請を取得する
未処理申請の ID をリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返す API です。
API名
WorkflowGetUnprocessedApplicationsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
application_id/text() | base:IDType | 1 ~ 無制限 | 取得する未処理申請のID |
例
<parameters> <application_id>5</application_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowApplicationType | 0 ~ 無制限 | 取得した未処理申請の情報 |
例
<returns> <application id="5" name="フォーム 1( 申請の標題 )" processing_step="7" status="進行中" urgent="false" version="1281338167" number="5" date="2010-08-09T07:16:07Z" status_type="unprocessing"> <applicant id="1" name="Administrator"></applicant> <items> <item name="標題" value="申請の標題" right_align="false" /> <item name="文字列 1 行" value="文字列 1 行の内容" right_align="false" /> <item name="文字列複数行" value="文字列複数行の内容" right_align="false" /> <item name="メニュー" value="メニュー1" right_align="false" /> <item name="ラジオ" value="ラジオ 2" right_align="false" /> <item name="チェックボックス" value="チェックあり" right_align="false" /> <item name="数値" value="12345" right_align="false" /> <item name="日付" value="2010 年 8 月 9 日" right_align="false" /> <files_item name="ファイル添付" inline="false"> <file file_id="2" name="eclipse.txt" size="0" mime_type="text/plain" /> </files_item> </items> <steps> <step id="7" name="承認 1" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" ></processor> </step> <step id="8" name="承認 2" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator"></processor> </step> </steps> <operation><approve /></operation> <operation><reject /></operation> <operation><sent_back><applicant/></sent_back></operation> <operation><withdraw /></operation> <folder id="3" /> <folder_type>received</folder_type> <folder id="4" /> <folder_type>sent</folder_type> <folder id="6" /> <folder_type>unprocessed</folder_type> </application> </returns>
送信済み申請の更新情報を取得する
送信した申請のIDとversion、取得期間をリクエストのパラメーターとして受け取り、指定した期間内の申請の更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでその申請のoperation は、”modify”となります。 リクエストで受け取らなかった申請が存在する場合、レスポンスでその申請の operation は、”add”となります。 存在しない申請をリクエストで受け取った場合、レスポンスでその申請の operation は、”remove”となります。
API名
WorkflowGetSentApplicationVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@start | xsd:dateTime | 1 | 取得期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1
|
取得期間の終了日時 |
application_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得する送信済み申請のIDとバージョン |
例
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> <application_item id="1" version="11" /> <application_item id="2" version="22" /> <application_item id="3" version="33" /> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application_item | base:ItemVersionResultType | 0 ~ 無制限
|
取得した送信済み申請の情報 |
例
<returns> <application_item id="1" version="1245376338" operation="remove" /> <application_item id="2" version="1245327097" operation="modify" /> <application_item id="3" version="1245327110" operation="modify" /> <application_item id="4" version="1245715417" operation="add" /> </returns>
送信済み申請を取得する
送信した申請のIDをリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返す API です。 存在しない申請 ID やアクセス権のない申請 ID を指定した場合、空のレスポンスが返されます。
API名
WorkflowGetSentApplicationsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
application_id/text() | base:IDType | 1 ~ 無制限 | 取得する送信済み申請のID |
例
<parameters> <application_id>5</application_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowApplicationType | 0 ~ 無制限 | 取得した確認済み申請の情報 |
例
<returns> <application id="5" name="フォーム 1( 申請の標題 )" processing_step="7" status="進行中" urgent="false" version="1281338167" number="5" date="2010-08-09T07:16:07Z" status_type="unprocessing"> <applicant id="1" name="Administrator"></applicant> <items> <item name="標題" value="申請の標題" right_align="false" /> <item name="文字列 1 行" value="文字列 1 行の内容" right_align="false" /> <item name="文字列複数行" value="文字列複数行の内容" right_align="false" /> <item name="メニュー" value="メニュー1" right_align="false" /> <item name="ラジオ" value="ラジオ 2" right_align="false" /> <item name="チェックボックス" value="チェックあり" right_align="false" /> <item name="数値" value="12345" right_align="false" /> <item name="日付" value="2010 年 8 月 9 日" right_align="false" /> <files_item name="ファイル添付" inline="false"> <file file_id="2" name="eclipse.txt" size="0" mime_type="text/plain" /> </files_item> </items> <steps> <step id="7" name="承認 1" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" ></processor> </step> <step id="8" name="承認 2" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator"></processor> </step> </steps> <operation><approve /></operation> <operation><reject /></operation> <operation><sent_back><applicant/></sent_back></operation> <operation><withdraw /></operation> <folder id="3" /> <folder_type>received</folder_type> <folder id="4" /> <folder_type>sent</folder_type> <folder id="6" /> <folder_type>unprocessed</folder_type> </application> </returns>
受信した申請の更新情報を取得する
受信した申請のIDとversion、取得期間をリクエストのパラメーターとして受け取り、指定した期間内の申請の更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでその申請のoperation は、”modify”となります。 リクエストで受け取らなかった申請が存在する場合、レスポンスでその申請の operation は、”add”となります。 存在しない申請をリクエストで受け取った場合、レスポンスでその申請の operation は、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
WorkflowGetReceivedApplicationVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@start | xsd:dateTime | 1 | 取得期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1
|
取得期間の終了日時 |
application_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得する受信した申請のIDとバージョン |
例
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> <application_item id="1" version="11" /> <application_item id="2" version="22" /> <application_item id="3" version="33" /> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application_item | base:ItemVersionResultType | 0 ~ 無制限
|
取得した申請の情報 |
例
<returns> <application_item id="1" version="1245376338" operation="remove" /> <application_item id="2" version="1245327097" operation="modify" /> <application_item id="3" version="1245327110" operation="modify" /> <application_item id="4" version="1245715417" operation="add" /> </returns>
受信した申請を取得する
受信した申請のIDをリクエストのパラメーターとして受け取り、指定した申請の情報をレスポンスとして返す API です。 存在しない申請 ID やアクセス権のない申請 ID を指定した場合、空のレスポンスが返されます。
API名
WorkflowGetReceivedApplicationsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
application_id/text() | base:IDType | 1 ~ 無制限 | 取得する受信した申請のID |
例
<parameters> <application_id>5</application_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowApplicationType | 0 ~ 無制限 | 取得した申請の情報 |
例
<returns> <application id="5" name="フォーム 1( 申請の標題 )" processing_step="7" status="進行中" urgent="false" version="1281338167" number="5" date="2010-08-09T07:16:07Z" status_type="unprocessing"> <applicant id="1" name="Administrator"></applicant> <items> <item name="標題" value="申請の標題" right_align="false" /> <item name="文字列 1 行" value="文字列 1 行の内容" right_align="false" /> <item name="文字列複数行" value="文字列複数行の内容" right_align="false" /> <item name="メニュー" value="メニュー1" right_align="false" /> <item name="ラジオ" value="ラジオ 2" right_align="false" /> <item name="チェックボックス" value="チェックあり" right_align="false" /> <item name="数値" value="12345" right_align="false" /> <item name="日付" value="2010 年 8 月 9 日" right_align="false" /> <files_item name="ファイル添付" inline="false"> <file file_id="2" name="eclipse.txt" size="0" mime_type="text/plain" /> </files_item> </items> <steps> <step id="7" name="承認 1" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" ></processor> </step> <step id="8" name="承認 2" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator"></processor> </step> </steps> <operation> <approve /> </operation> <operation> <reject /> </operation> <operation> <sent_back> <applicant/> </sent_back> </operation> <operation> <withdraw /> </operation> <folder id="3" /> <folder_type>received</folder_type> <folder id="4" /> <folder_type>sent</folder_type> <folder id="6" /> <folder_type>unprocessed</folder_type> </application> </returns>
代理承認の申請を取得する
API実行ユーザーが代理承認者となっているユーザーの ID と取得期間をリクエストのパラメーターとして受け取り、指定したユーザーが期間内に取得した申請の情報をレスポンスとして返す API です。
API名
WorkflowGetProxyApprovalsByDelegatorId
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@delegator_id/text() | base:IDType | 1 | API実行ユーザーが代理承認するユーザーのID |
@start | xsd:dateTime | 1 | 取得期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1
|
取得期間の終了日時 |
例
<parameters delegator_id=3 start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowApplicationType | 0 ~ 無制限
|
取得した申請の情報 |
例
<returns> <application id="6" name="フォーム 1( 申請の標題 )" processing_step="7" status="進行中" urgent="false" version="1281338167" number="6" date="2010-08-09T07:16:07Z" status_type="unprocessing"> <applicant id="1" name="Administrator"></applicant> <items> <item name="標題" value="申請の標題" right_align="false" /> <item name="文字列 1 行" value="文字列 1 行の内容" right_align="false" /> <item name="文字列複数行" value="文字列複数行の内容" right_align="false" /> <item name="メニュー" value="メニュー1" right_align="false" /> <item name="ラジオ" value="ラジオ 2" right_align="false" /> <item name="チェックボックス" value="チェックあり" right_align="false" /> <item name="数値" value="12345" right_align="false" /> <item name="日付" value="2010 年 8 月 9 日" right_align="false" /> <files_item name="ファイル添付" inline="false"> <file file_id="2" name="eclipse.txt" size="0" mime_type="text/plain" /> </files_item> </items> <steps> <step id="7" name="承認 1" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" ></processor> </step> <step id="8" name="承認 2" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator"></processor> </step> </steps> <operation> <approve /> </operation> <operation> <reject /> </operation> <operation> <sent_back> <applicant/> </sent_back> </operation> <operation> <withdraw /> </operation> <folder id="3" /> <folder_type>received</folder_type> <folder id="4" /> <folder_type>sent</folder_type> <folder id="6" /> <folder_type>unprocessed</folder_type> </application> </returns>
エラー
エラー番号 | 説明 |
GRN_WRKF_25307 | 代理承認者でないユーザーのIDを指定した場合 |
承認予定の申請を取得する
取得期間をリクエストのパラメーターとして受け取り、指定した期間内に申請されたログインユーザーの承認予定一覧にある申請の情報をレスポンスとして返す API です。 ガルーンの「システム管理(各アプリケーション)→ワークフロー→一般設定」で、「承認予定の使用許可」を「許可する」にしていないと、この API は空のレスポンスを返します。
API名
WorkflowGetPendingApprovals
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@start | xsd:dateTime | 1 | 取得期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1
|
取得期間の終了日時 |
例
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowApplicationType | 0 ~ 無制限
|
取得した申請の情報 |
例
<returns> <application id="6" name="フォーム 1( 申請の標題 )" processing_step="7" status="進行中" urgent="false" version="1281338167" number="6" date="2010-08-09T07:16:07Z" status_type="unprocessing"> <applicant id="1" name="Administrator"></applicant> <items> <item name="標題" value="申請の標題" right_align="false" /> <item name="文字列 1 行" value="文字列 1 行の内容" right_align="false" /> <item name="文字列複数行" value="文字列複数行の内容" right_align="false" /> <item name="メニュー" value="メニュー1" right_align="false" /> <item name="ラジオ" value="ラジオ 2" right_align="false" /> <item name="チェックボックス" value="チェックあり" right_align="false" /> <item name="数値" value="12345" right_align="false" /> <item name="日付" value="2010 年 8 月 9 日" right_align="false" /> <files_item name="ファイル添付" inline="false"> <file file_id="2" name="eclipse.txt" size="0" mime_type="text/plain" /> </files_item> </items> <steps> <step id="7" name="承認 1" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" ></processor> </step> <step id="8" name="承認 2" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator"></processor> </step> </steps> <operation> <approve /> </operation> <operation> <reject /> </operation> <operation> <sent_back> <applicant/> </sent_back> </operation> <operation> <withdraw /> </operation> <folder id="3" /> <folder_type>received</folder_type> <folder id="4" /> <folder_type>sent</folder_type> <folder id="6" /> <folder_type>unprocessed</folder_type> </application> </returns>
管理者として申請情報を取得する
申請フォーム ID と条件をリクエストとして受け取り、条件に該当する申請データの情報をレスポンスとして返す API です。 このAPIの実行にはシステム管理者権限が必要です。
API名
WorkflowGetRequests
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.1.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
manage_request_parmeter | workflow:WorkflowGetRequestType | 0 ~ 1 | 取得したい申請の条件 |
例
<parameters> <manage_request_parameter xmlns="" request_form_id="4"></manage_request_parameter> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
category | workflow:RequestManagerFormType | 0 ~ 無制限 | 取得した申請情報 |
例
<returns> <category id_category="-1" name_category="Uncategory" > <manage_request_form id_request_form="4" name_request_form="4 step" > <manage_item_detail pid="2" number="2" priority="0" subject="Test 1" status="進行中" applicant="1" last_approver="2" request_date="Thu, 09 December"> </manage_item_detail> </manage_request_form> </category> <category id_category="-1" name_category="Uncategory"> <manage_request_form id_request_form="4" name_request_form="4 step"> <manage_item_detail pid="3" number="3" priority="0" subject="test 2" status="承認" applicant="1" last_approver="1" request_date="Thu, 09 December"> </manage_item_detail> </manage_request_form> </category> </returns>
エラー
エラー番号 | 説明 |
GRN_WRKF_25305 | 開始日時と終了日時が不正な場合 |
GRN_CMMN_00005 | API実行ユーザーにシステム管理権限が無い場合 |
管理者として申請情報を取得する(ID指定)
申請データの ID をリクエストとして受け取り、申請データの情報をレスポンスとして返す API です。 このAPIの実行にはシステム管理者権限が必要です。
API名
WorkflowGetRequestById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.1.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
request_id | base:IDType | 1 ~ 無制限 | 取得する申請のID |
例
<parameters><request_id xmlns="">1</request_id></parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
application | workflow:WorkflowAppilcationType | 1 ~ 無制限 | 取得した申請情報 |
例
<returns> <application id="1" name="item 1( 1 Approval )" processing_step="0" status="完了" urgent="false" version="1291962092" number="1" date="2010-12-08T02:06:39Z" status_type="completed"> <applicant xmlns="http://schemas.cybozu.co.jp/workflow/2008" id="1" name="Administrator"></applicant> <items xmlns="http://schemas.cybozu.co.jp/workflow/2008"> <item name="Subject" value="1 Approval" right_align="false"/> </items> <steps xmlns="http://schemas.cybozu.co.jp/workflow/2008"> <step id="1" name="Approval" type="承認(全員)" is_approval_step="1"> <processor id="1" processor_name="Administrator" result="承認" date="2010-12-10T06:21:32Z" ></processor> </step> </steps> <folder xmlns="http://schemas.cybozu.co.jp/workflow/2008" id="3" /> <folder_type>received</folder_type> <folder xmlns="http://schemas.cybozu.co.jp/workflow/2008" id="4" /> <folder_type>sent</folder_type> <folder xmlns="http://schemas.cybozu.co.jp/workflow/2008" id="5" /> <folder_type>finish</folder_type> </application> </returns>
エラー
エラー番号 | 説明 |
GRN_WRKF_25302 | 指定した申請IDが存在しない場合 |
GRN_CMMN_00005 | API実行ユーザーにシステム管理権限が無い場合 |
コメントを削除しました。