Garoon API ドキュメント

ワークフローAPIで使用するデータの構造

目次

WorkflowApplicationType

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

1 つの申請を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 申請ID
@version base:VersionType 1 申請のバージョン情報
@status workflow:StatusType 1 申請の状態（日本語）
@date xsd:dateTime 1 申請日時
@processing_step base:IDType 1 現在の経路
@name xsd:string 0 ～ 1 申請名
@number base:NonBlankStringType 0 ～ 1 申請番号
@urgent xsd:boolean 0 ～ 1 優先度
  • true：至急
  • false：通常
@status_type workflow:WorkflowStatusType 0 ～ 1 申請の状態
appilcant - 1 申請者
applicant/@id base:IDType 0 ～ 1 申請者のユーザーID
applicant/@name base:NonBlankStringType 1 申請者名
applicant/プロキシ - 0 ～ 1 代理申請者
applicant/プロキシ/@id base:IDType 0 ～ 1 代理申請者のユーザーID
applicant/プロキシ/@name base:NonBlankStringType 1 代理申請者名
items - 1 申請の項目一覧
items/item workflow:ItemType 0 ～ 無制限 単一の項目
items/files_item workflow:FileItemType 0 ～ 無制限 ファイル添付の項目
items/blank_item - 0 ～ 無制限 空行
steps - 1 承認経路の情報
steps/step - 1 ～ 無制限 経路ステップ
steps/step/@id base:IDType 1 経路ステップID
steps/step/@name base:NonBlankStringType 1 経路ステップ名
steps/step/@type workflow:StepTypeType 1 経路ステップの種別
steps/step/@is_approval_step xsd:integer 1 -1の場合に承認ステップを表す
steps/step/processor - 1 ～ 無制限 処理者
steps/step/processor/@id base:IDType 0 ～ 1 処理者のユーザーID
steps/step/processor/@processor_name xsd:string 0 ～ 1 処理者名
steps/step/processor/@date xsd:dateTime 0 ～ 1 処理日時
steps/step/processor/@comment xsd:string 0 ～ 1 処理者コメント
steps/step/processor/@result base:NonBlankStringType 0 ～ 1 処理結果
steps/step/processor/プロキシ - 0 ～ 1 代理承認者
steps/step/processor/プロキシ/@id base:IDType 0 ～ 1 代理承認者のユーザーID
steps/step/processor/プロキシ/@processor_name xsd:string 1 代理承認者名
operation workflow:OperationType 0 ～ 無制限 操作情報。API実行ユーザーがこの申請に対して操作可能なオペレーション一覧を示す。
folder - 0 ～ 無制限 フォルダー
folder/@id base:IDType 1 フォルダーID
folder_type/text() workflow:WorkflowFolderType 0 ～ 無制限 フォルダーの種別

OperationType

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

申請への操作を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明 変更履歴
sent_back - 0 ～ 1 差し戻し
sent_back/applicant - 0 ～ 1 差し戻したユーザー
sent_back/step - 0 ～ 1 経路ステップ
sent_back/step@step_id base:IDType 1 差し戻された時点での経路ステップID
approve - 0 ～ 1 承認
reject - 0 ～ 1 却下
withdraw - 0 ～ 1 取り消し
cancel - 0 ～ 1 取り消し
confirm - 0 ～ 1 回覧の確認
acknowledge - 0 ～ 1 申請処理済の通知の確認 パッケージバージョン 3.7.3 で追加

ItemType

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

申請に含まれる項目の内の 1 つの項目を表します。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 項目名
@value xsd:string 1 入力された値
@right_align xsd:boolean 0 ～ 1
  • true：右寄せ
  • false：通常

FileItemType

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

ファイル添付項目を表します。

使用可能なGaroonのバージョン

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 項目名
@inline xsd:boolean 0 ～ 1
  • true：インライン表示
  • false：通常
file - 0 ～ 無制限 添付ファイル
file/@name base:NonBlankStringType 1 ファイル名
file/@file_id base:IDType 1 ファイルID
file/@size xsd:unsignedLong 0 ～ 1 ファイルサイズ
file/@mime_type xsd:string 0 ～ 1 ファイルのMIMEタイプ

FolderType

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

フォルダー情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 フォルダーID
@name base:NonBlankStringType 1 フォルダー名
application - 0 ～ 無制限 フォルダー内に存在する申請
application/@id base:IDType 1 申請ID

WorkflowFolderType

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

ワークフローのフォルダーの種類を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
unprocessed 未処理一覧
sent 送信一覧
received 受信一覧
draft 下書き
finish 結果一覧

StatusType

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

申請の状態を表す文字列です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

  • 進行中
  • 承認
  • 却下
  • 取消
  • 完了
  • 下書き

WorkflowStatusType

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

ワークフロー状態の種類を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
unprocessing 未処理
inprogress 進行中
sent_back 差し戻し
approved 承認
rejected 却下
withdrawn 取り消し
cancelled 取り消し
completed 完了

StepTypeType

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

経路ステップのタイプを表す文字列です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
承認（全員） 全員の承認が必要であることを表します。
承認（誰か1人） 誰か一人でも承認すればその経路は承認されることを表します。
回覧 その経路は回覧のみで承認プロセスがないことを表します。

WorkflowGetManageRequestFilter

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

ワークフローの検索対象状況を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
All すべて
In progress 進行中
Approved 承認
Rejected 却下
Cancel 取り消し
Complete 完了

WorkflowAvailabilityUserType

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

ユーザーのアプリケーションの利用許可を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 ユーザーID
@workflow xsd:boolean 1 ワークフローの利用許可
  • true：可
  • false：不可
@keitai xsd:boolean 1 ワークフローケータイの利用許可
  • true：可
  • false：不可
2019年6月以降のクラウド版Garoonでは、「Garoonケータイ」機能廃止により、存在しません。

WorkflowGetRequestType

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

取得したい申請データの条件を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@request_form_id base:IDType 1 取得するフォームのID
@filter workflow:WorkflowGetManageRequestFilter 0 ～ 1 検索対象状況
@start_request_date xsd:dateTime 0 ～ 1 申請日時の検索先頭
@end_request_date xsd:dateTime 0 ～ 1 申請日時の検索末尾
@start_approval_date xsd:dateTime 0 ～ 1 承認日時の検索先頭
承認日時が @start_approval_date に指定した日時より後のワークフローが検索対象です。
@end_approval_date xsd:dateTime 0 ～ 1 承認日時の検索末尾
@appilcant base:IDType 0 ～ 1 申請者のユーザーID
@last_approval base:IDType 0 ～ 1 最終承認者
@start_to_get_information_from base:IDType 0 ～ 1 検索結果の表示の開始点
@maximum_request_amount_to_get xsd:string 0 ～ 1 検索結果の表示の最大数

WorkflowGetAttachedFileBodyType

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

取得したい添付ファイルの情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@request_form_id base:IDType 1 申請フォームID
@file_id base:IDType 1 ファイルID

RequestManageFormType

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

フォームなどの条件を指定した申請リストを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明 変更履歴
manage_request_form - 0 ～ 1 申請フォームの情報
manage_request_form/manage_item_detail - 0 ～ 1 申請データの詳細情報
manage_request_form/manage_item_detail/@pid base:IDType 1 申請データID
manage_request_form/manage_item_detail/@number base:IDType 1 申請番号
manage_request_form/manage_item_detail/@priority xsd:string 1 優先度
  • 1：至急
  • 0：指定なし
manage_request_form/manage_item_detail/@subject xsd:string 1 標題
manage_request_form/manage_item_detail/@status workflow:StatusType 1 申請の状態
manage_request_form/manage_item_detail/@applicant base:IDType 1 申請者のユーザーID
manage_request_form/manage_item_detail/@last_approver workflow:ApproverType
 1 最終承認者 パッケージバージョン 4.0 以前の型は base:IDType
manage_request_form/manage_item_detail/@request_date xsd:dateTime 1 申請日時
manage_request_form/@id_request_form base:IDType 0 ～ 1 申請フォームのID
manage_request_form/@name_request_form xsd:string 0 ～ 1 申請フォーム名
@id_category base:IDType 0 ～ 1 カテゴリID
@name_category xsd:string 0 ～ 1 カテゴリ名

CategoriesType

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

ワークフローのカテゴリ一覧を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
child_cagtegory workflow:CategoryType 1 子カテゴリ
@id base:IDType 1 カテゴリID
@code base:NonBlankStringType 1 カテゴリコード
@name base:NonBlankStringType 1 カテゴリ名
@parenet_category base:IDType 0 ～ 1 親カテゴリID
@memo base:NonBlankStringType 0 ～ 1 カテゴリの説明

CategoryType

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

カテゴリの情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
child_cagtegory workflow:CategoryType 1 子カテゴリ
@id base:IDType 1 カテゴリID
@code base:NonBlankStringType 1 カテゴリコード
@name base:NonBlankStringType 1 カテゴリ名
@parenet_category base:IDType 0 ～ 1 親カテゴリID
@memo base:NonBlankStringType 0 ～ 1 カテゴリの説明
@created xsd:integer 0 ～ 1 カテゴリ作成時刻（Timestamp）
@last_update xsd:integer 0 ～ 1 カテゴリ更新時刻（Timestamp）

ChildCategoriesType

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

子カテゴリ一覧を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
child_cagtegory workflow:CategoryType 1 子カテゴリ
@id base:IDType 1 カテゴリID
@code base:NonBlankStringType 1 カテゴリコード
@name base:NonBlankStringType 1 カテゴリ名
@parenet_category base:IDType 0 ～ 1 親カテゴリID
@memo base:NonBlankStringType 0 ～ 1 カテゴリの説明

RequestFormType

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

カテゴリ内のフォーム情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
requestForm - 1 ～ 無制限 フォーム情報
requestForm/@fid base:IDType 1 フォームID
requestForm/@type base:NonBlankStringType 1
  • 0：申請フォーム
  • 1：区切り線
requestForm/@name base:NonBlankStringType 1 フォーム名
requestForm/@active base:IDType 0 ～ 1
  • 0：無効
  • 1：有効
requestForm/@icon_type base:NonBlankStringType 0 ～ 1
  • 0：標準アイコン
  • 1：URL指定アイコン
requestForm/@icon_id base:IDType 0 ～ 1 アイコンID
requestForm/@icon_url base:IDType 0 ～ 1 URL指定アイコンのURL
@category_id base:IDType 1 カテゴリID

FileAttachedDetail

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

添付ファイルの詳細情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
file_header - 1 添付ファイル情報
file_header/@file_id base:IDType 1 ファイルID
file_header/@request_form_id base:IDType 1 フォームID
file_header/@name base:NonBlankStringType 1 ファイル名
file_header/@size base:NonBlankStringType 1 ファイルサイズ
file_information - 1 添付ファイル情報
file_information/@subject base:NonBlankStringType 1 タイトル
file_information/@versioning base:NonBlankStringType 1 バージョン管理
file_information/@create_time base:IDType 0 ～ 1 作成日時
file_information/@modify_time base:IDType 0 ～ 1 更新日時
file_information/@description base:NonBlankStringType 0 ～ 1 ファイルの説明

WorkflowHandleApplicationOperationType

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

申請に対して操作する際に使用する型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@application_id base:IDType 1 申請ID
@delegator_id base:IDType 0 ～ 1 代理人ID
@comment xsd:string 0 ～ 1 コメント
operation workflow:OperationType 1 操作

ApproverType

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

承認者を表す型です。このタイプは、xsd:string、もしくは base:IDType と同じです。

使用可能なGaroonのバージョン

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

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