処理待ちとなっている申請情報の取得(API)

処理待ちとなっている申請情報の取得(API)

目次

できること

mitocoワークフローで表示しているデータを取得することができます。独自のレイアウトで一覧を表示したい場合に有効です。


処理待ちとなっている申請情報の取得

自分宛に承認依頼された申請情報のうち、現在処理待ちとなっている申請情報を取得します。(上限は10,000件です。)

メソッド

TSMNTBS.CMN_ResultResponse TSMNTWF.WF_ConnectApi.getApproveList(String param)

リクエストパラメータ

パラメータはJSON型で指定します。
key
必須
説明
dateOrderAsc
Boolean
承認依頼日に対して、昇順か降順か決定します。
・true:依頼日が古いもの順
・false:依頼日が新しいもの順
※上記以外の文字列がinputに渡された場合は、falseとして動作します。

レスポンス

レスポンスはCMN_ResultResponse型で返されます。

key

説明

data

Object

取得結果。

List<TSMNTWF.WF_ConnectApi.ApplyInfo>:取得した申請情報のリスト

エラー時は、null

errorMessage

String

エラーメッセージ

成功の場合は、null

errorCode

String

エラーコード

成功の場合は、null

errorStackTraceString

String

例外発生時のスタックトレース情報

成功の場合は、null

errorTypeName

String

例外発生時のWFの例外クラス、Salesforceの例外クラス

成功の場合は、null

errorLineNumber

Integer

例外発生時、例外が発生した箇所の行番号

成功の場合は、null

status

String

実行結果。以下のいずれかが設定されている

success:成功
error:失敗


TSMNTWF.WF_ConnectApi.ApplyInfo : 承認情報詳細

処理待ちになっている承認に関する情報が格納されています。

key

説明

processInstanceId

String

申請情報のレコードID

applyId

String

申請ID

submitterId

Id

申請者のユーザID

submitterName

String

申請者の氏名(スナップショット項目)

status

String

申請情報のステータス

「Pending」:未承認

createDate

DateTime

依頼日

approvalProcessId

Id

承認プロセスID

approvalProcessName

String

承認プロセス名

targetObjectName

String

種別(対象レコードのオブジェクト名)

targetId

Id

申請対象レコードID

targetName

String

申請対象レコードのName項目の値

isData

Boolean

申請データか否か

circulatorId

Id

ブランク

stepName

String

ステップ名

※カスタム設定の一覧追加項目表示可否の値に関わらず取得されます。

ワークフローの画面表示制御

actorInstanceId Id操作者の申請情報ID
recordTypeNameString レコードタイプのラベル


エラーコード

エラーコード

説明

WF_ERR_InvalidArguments

パラメータが不正です。パラメータを再確認してください。

WF_ERR_NoAccess

権限がありません。ワークフローの権限を確認してください。

WF_ERR_SystemErrorTitle

システムエラーが発生しています。


サンプル

クラスに以下のように記述することで、承認待ちとなっている申請情報が取得できます。(依頼日の新しい順)
TSMNTBS.CMN_ResultResponse result = TSMNTWF.WF_ConnectApi.getApproveList('{"dateOrderAsc" : "false"}');