Garoon API ドキュメント

フォーム情報を取得する

目次

フォーム情報を取得する

固定リンクがコピーされました

カテゴリ ID を受け取り、そのカテゴリに所属するフォームの一覧を返す API です。 API を実行するユーザーにシステム管理権限が必要です。

API名

固定リンクがコピーされました

WorkflowGetRequestFormByCategoryIds

利用できるバージョン

固定リンクがコピーされました

  • クラウド版 Garoon
  • パッケージ版 Garoon 3.1 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
category_id base:IDType 1 ～ 無制限 取得するフォームのカテゴリID
例
1
2
3

<parameters> 
  <category_id xmlns="">2</category_id> 
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
category workflow:RequestFormType 1 ～ 無制限 フォームの情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

<returns> 
  <category category_id="2"> 
    <requestForm 
     fid="1" 
     type="0" 
     name="Request Form" 
     active="1" 
     icon_type="0" 
     icon_id="0" 
     icon_url=""> 
    </requestForm> 
    <requestForm 
     fid="2" 
     type="0" 
     name="Attach file" 
     active="1" 
     icon_type="0" 
     icon_id="0" 
     icon_url="" > 
    </requestForm> 
  </category> 
</returns>

エラー

固定リンクがコピーされました

エラー番号 説明
GRN_CMMN_00005 API実行ユーザーにシステム管理権限がない場合