未処理申請の更新情報を取得する
固定リンクがコピーされました
未処理申請のIDとversionをリクエストのパラメーターとして受け取り、申請の更新情報を返すAPIです。
WorkflowGetUnprocessedApplicationVersions
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
例
1
2
3
4
5
|
<parameters>
<application_item id="1" version="11" />
<application_item id="2" version="22" />
<application_item id="3" version="33" />
</parameters>
|
APIを実行した時点の経路ステップに対し、アクセス権の設定で編集可に設定された項目がある場合、その申請の更新情報は取得できません。
アクセス権の設定は、申請を提出した時点のアクセス権が適用されます。
パラメーター名 |
型 |
パラメーター数 |
説明 |
application_item |
base:ItemVersionResultType
|
0~ 無制限 |
取得した未処理申請の更新情報modify :リクエストで受け取ったversionとGaroon上のversionが異なるadd :リクエストで受け取らなかった申請が存在するremove :存在しない申請をリクエストで受け取った
|
例
1
2
3
4
5
6
|
<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です。
WorkflowGetUnprocessedApplicationsById
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
application_id/text() |
base:IDType
|
1~ 無制限 |
取得する未処理申請のID |
例
1
2
3
|
<parameters>
<application_id>5</application_id>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
<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です。
WorkflowGetSentApplicationVersions
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
@start |
xsd:dateTime |
1 |
取得期間の開始日時 |
@end |
xsd:dateTime |
0~1 |
取得期間の終了日時 |
application_item |
base:ItemVersionType
|
0~ 無制限 |
更新情報を取得する送信済み申請のIDとバージョン |
例
1
2
3
4
5
|
<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~ 無制限 |
取得した送信済み申請の情報modify :リクエストで受け取ったversionとGaroon上のversionが異なるadd :リクエストで受け取らなかった申請が存在するremove :存在しない申請をリクエストで受け取った
|
例
1
2
3
4
5
6
|
<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です。
WorkflowGetSentApplicationsById
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
application_id/text() |
base:IDType
|
1~ 無制限 |
取得する送信済み申請のID |
例
1
2
3
|
<parameters>
<application_id>5</application_id>
</parameters>
|
存在しない申請IDやアクセス権のない申請IDを指定した場合、空のレスポンスが返されます。
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
<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です。
WorkflowGetReceivedApplicationVersions
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
@start |
xsd:dateTime |
1 |
取得期間の開始日時 |
@end |
xsd:dateTime |
0~1 |
取得期間の終了日時 |
application_item |
base:ItemVersionType
|
0~ 無制限 |
更新情報を取得する受信した申請のIDとバージョン |
例
1
2
3
4
5
|
<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~ 無制限 |
取得した申請の情報modify :リクエストで受け取ったversionとGaroon上のversionが異なるadd :リクエストで受け取らなかった申請が存在するremove :存在しない申請をリクエストで受け取った
|
例
1
2
3
4
5
6
|
<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です。
WorkflowGetReceivedApplicationsById
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
application_id/text() |
base:IDType
|
1~ 無制限 |
取得する受信した申請のID |
例
1
2
3
|
<parameters>
<application_id>5</application_id>
</parameters>
|
存在しない申請IDやアクセス権のない申請IDを指定した場合、空のレスポンスが返されます。
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
<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を実行するユーザーが代理承認者となっているGaroonユーザーIDおよび取得期間をリクエストのパラメーターとして受け取り、指定したユーザーが期間内に取得した申請の情報をレスポンスとして返すAPIです。
WorkflowGetProxyApprovalsByDelegatorId
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
@delegator_id/text() |
base:IDType
|
1 |
API実行ユーザーが代理承認するGaroonユーザーID |
@start |
xsd:dateTime |
1 |
取得期間の開始日時 |
@end |
xsd:dateTime |
0~1 |
取得期間の終了日時 |
例
1
2
|
<parameters delegator_id=3 start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z">
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
<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 |
代理承認者でないGaroonユーザーIDを指定した場合 |
承認予定の申請を取得する
固定リンクがコピーされました
取得期間をリクエストのパラメーターとして受け取り、指定した期間内に申請された申請のうち、ログインユーザーの承認予定一覧にある申請の情報をレスポンスとして返すAPIです。
WorkflowGetPendingApprovals
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
@start |
xsd:dateTime |
1 |
取得期間の開始日時 |
@end |
xsd:dateTime |
0~1 |
取得期間の終了日時 |
例
1
2
|
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z">
</parameters>
|
Garoonの「システム管理(各アプリケーション)→ワークフロー→一般設定」で、「承認予定の使用許可」を「許可する」にしていないと、このAPIは空のレスポンスを返します。
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
<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の実行にはシステム管理者権限が必要です。
WorkflowGetRequests
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
例
1
2
3
|
<parameters>
<manage_request_parameter xmlns="" request_form_id="4"></manage_request_parameter>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
<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の実行にはシステム管理者権限が必要です。
WorkflowGetRequestById
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
request_id |
base:IDType
|
1~ 無制限 |
取得する申請のID |
例
1
|
<parameters><request_id xmlns="">1</request_id></parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
<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を実行するユーザーにシステム管理権限がない場合 |