案件情報一覧系API共通レスポンスデータ仕様¶
案件情報一覧取得、案件情報一覧件数取得系APIで共通するレスポンスデータの説明です。
項目
- records プロパティ
- [1] applyAuthUserCd
- [2] applyAuthUserName
- [3] applyBaseDate
- [4] applyDate
- [5] arriveDate
- [6] comment
- [7] confirmStatus
- [8] defaultFormatApplyBaseDate
- [9] defaultFormatApplyDate
- [10] defaultFormatArriveDate
- [11] defaultFormatFinalProcessDate
- [12] defaultFormatMatterEndDate
- [13] defaultFormatProcessLimitDate
- [14] displayApplyLink
- [15] displayApproveDirectProcessLink
- [16] displayConfirmDirectProcessLink
- [17] displayConfirmLink
- [18] displayConfirmModalLink
- [19] displayCopyNewLink
- [20] displayDeleteLink
- [21] displayDenyDirectProcessLink
- [22] displayDetailLink
- [23] displayDiscontinueDirectProcessLink
- [24] displayFlowLink
- [25] displayHandleLink
- [26] displayHistoryLink
- [27] displayProcessModalLink
- [28] displayProcLink
- [29] displayPullBackLink
- [30] displayTransferLink
- [31] finalProcessDate
- [32] flowId
- [33] flowName
- [34] handleLevel
- [35] matterEndDate
- [36] matterEndStatus
- [37] matterName
- [38] matterNumber
- [39] matterProperty
- [40] nodeId
- [41] nodeName
- [42] pageType
- [43] priority
- [44] processAuth
- [45] processLimitDate
- [46] status
- [47] systemMatterId
- [48] userDataId
records プロパティ¶
records プロパティは各APIごとの情報モデルを配列として内包します。
以下の表に、各APIで取得可能な情報を記載します。
凡例
取得可能: [1] 等
- 各APIで取得可能な情報です。さらにその中で、一覧表示パターン定義で選択した一覧表示項目に一致する情報のみがレスポンスに含まれます。一覧表示パターン定義は、リクエストで指定したフローグループID、またはフローIDによって決定します。詳細は以下のドキュメントを参照してください。ただし、 マークがついている情報は一覧表示パターン定義に依存せず、必ず含まれます。詳細は下記表の各パラメータのリンク先を参照してください。
取得不可: -
- 当該APIのレスポンスデータには含まれません。
未完了案件確認 | 未完了処理済み | 未完了案件参照 | 未完了案件ノード | 過去案件 | 完了案件確認 | 完了処理済み | 完了案件参照 | 一時保存情報 | 未処理タスク情報 | |
---|---|---|---|---|---|---|---|---|---|---|
applyAuthUserCd | - | - | - | - | - | - | - | - | [1] | [1] |
applyAuthUserName | [2] | [2] | [2] | [2] | [2] | [2] | [2] | [2] | [2] | [2] |
applyBaseDate | [3] | [3] | [3] | [3] | [3] | [3] | [3] | [3] | [3] | [3] |
applyDate | [4] | [4] | [4] | [4] | [4] | [4] | [4] | [4] | - | [4] |
arriveDate | [5] | - | - | [5] | - | [5] | - | - | - | [5] |
comment | - | - | - | - | - | - | - | - | [6] | - |
confirmStatus | [7] | - | - | - | - | [7] | - | - | - | - |
defaultFormatApplyBaseDate | [8] | [8] | [8] | [8] | [8] | [8] | [8] | [8] | [8] | [8] |
defaultFormatApplyDate | [9] | [9] | [9] | [9] | [9] | [9] | [9] | [9] | - | [9] |
defaultFormatArriveDate | [10] | - | - | [10] | - | [10] | - | - | - | [10] |
defaultFormatFinalProcessDate | - | [11] | - | - | - | - | - | - | - | - |
defaultFormatMatterEndDate | - | - | - | - | [12] | [12] | [12] | [12] | - | - |
defaultFormatProcessLimitDate | - | - | - | [13] | - | - | - | - | - | - |
displayApplyLink | - | - | - | - | - | - | - | - | [14] | - |
displayApproveDirectProcessLink | - | - | - | [15] | - | - | - | - | - | - |
displayConfirmDirectProcessLink | [16] | - | - | - | - | [16] | - | - | - | - |
displayConfirmLink | [17] | - | - | - | - | [17] | - | - | - | - |
displayConfirmModalLink | [18] | - | - | - | - | [18] | - | - | - | - |
displayCopyNewLink | [19] | [19] | [19] | [19] | [19] | [19] | [19] | [19] | - | - |
displayDeleteLink | - | - | [20] | - | [20] | - | - | [20] | [20] | - |
displayDenyDirectProcessLink | - | - | - | [21] | - | - | - | - | - | - |
displayDetailLink | [22] | [22] | [22] | [22] | [22] | [22] | [22] | [22] | - | - |
displayDiscontinueDirectProcessLink | - | - | - | [23] | - | - | - | - | - | - |
displayFlowLink | [24] | [24] | [24] | [24] | [24] | [24] | [24] | [24] | [24] | - |
displayHandleLink | - | - | [25] | - | - | - | - | [25] | - | - |
displayHistoryLink | [26] | [26] | [26] | [26] | [26] | [26] | [26] | [26] | - | - |
displayProcessModalLink | - | - | - | [27] | - | - | - | - | - | - |
displayProcLink | - | - | - | [28] | - | - | - | - | - | - |
displayPullBackLink | - | [29] | - | - | - | - | - | - | - | - |
displayTransferLink | - | - | - | [30] | - | - | - | - | - | - |
finalProcessDate | - | [31] | - | - | - | - | - | - | - | - |
flowId | - | [32] | - | - | - | - | - | - | [32] | [32] |
flowName | [33] | [33] | [33] | [33] | [33] | [33] | [33] | [33] | [33] | [33] |
handleLevel | - | - | [34] | - | - | - | - | [34] | - | - |
matterEndDate | - | - | - | - | [35] | [35] | [35] | [35] | - | - |
matterEndStatus | - | - | - | - | [36] | [36] | [36] | [36] | - | - |
matterName | [37] | [37] | [37] | [37] | [37] | [37] | [37] | [37] | [37] | [37] |
matterNumber | [38] | [38] | [38] | [38] | [38] | [38] | [38] | [38] | - | [38] |
matterProperty | [39] | [39] | [39] | [39] | [39] | [39] | [39] | [39] | [39] | - |
nodeId | [40] | - | - | [40] | - | [40] | - | - | [40] | [40] |
nodeName | - | - | - | [41] | - | - | - | - | - | [41] |
pageType | - | - | - | [42] | - | - | - | - | - | - |
priority | [43] | [43] | [43] | [43] | [43] | [43] | [43] | [43] | - | [43] |
processAuth | - | - | - | [44] | - | - | - | - | - | - |
processLimitDate | - | - | - | [45] | - | - | - | - | - | - |
status | - | - | - | [46] | - | - | - | - | - | [46] |
systemMatterId | [47] | [47] | [47] | [47] | [47] | [47] | [47] | [47] | - | [47] |
userDataId | [48] | [48] | [48] | [48] | [48] | [48] | [48] | [48] | [48] | [48] |
[1] applyAuthUserCd¶
論理名 | 型 | 説明 |
---|---|---|
申請権限者コード | string |
[2] applyAuthUserName¶
論理名 | 型 | 説明 |
---|---|---|
申請権限者名 | string |
[3] applyBaseDate¶
論理名 | 型 | 説明 |
---|---|---|
申請基準日 | string | アカウントコンテキストの日付表示形式の値 |
[4] applyDate¶
論理名 | 型 | 説明 |
---|---|---|
申請日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
[5] arriveDate¶
論理名 | 型 | 説明 |
---|---|---|
到達日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
[6] comment¶
論理名 | 型 | 説明 |
---|---|---|
コメント | string |
[7] confirmStatus¶
論理名 | 型 | 説明 |
---|---|---|
確認状況 | string | 確認済みの場合: 1
未確認の場合: 0
|
[8] defaultFormatApplyBaseDate¶
論理名 | 型 | 説明 |
---|---|---|
申請基準日(デフォルトフォーマット) | string | yyyy/MM/dd 形式の値 |
[9] defaultFormatApplyDate¶
論理名 | 型 | 説明 |
---|---|---|
申請日(デフォルトフォーマット) | string | yyyy/MM/dd HH:mm:ss.SSS 形式の値 |
[10] defaultFormatArriveDate¶
論理名 | 型 | 説明 |
---|---|---|
到達日(デフォルトフォーマット) | string | yyyy/MM/dd HH:mm:ss.SSS 形式の値 |
[11] defaultFormatFinalProcessDate¶
論理名 | 型 | 説明 |
---|---|---|
最終処理日(デフォルトフォーマット) | string | yyyy/MM/dd HH:mm:ss.SSS 形式の値 |
[12] defaultFormatMatterEndDate¶
論理名 | 型 | 説明 |
---|---|---|
案件終了日(デフォルトフォーマット) | string | yyyy/MM/dd HH:mm:ss.SSS 形式の値 |
[13] defaultFormatProcessLimitDate¶
論理名 | 型 | 説明 |
---|---|---|
処理期限(デフォルトフォーマット) | string | yyyy/MM/dd HH:mm:ss.SSS 形式の値 |
[14] displayApplyLink¶
論理名 | 型 | 説明 |
---|---|---|
申請リンク表示フラグ | boolean | 申請の実行可能なことを示すフラグ |
[15] displayApproveDirectProcessLink¶
論理名 | 型 | 説明 |
---|---|---|
承認(直接処理)リンク表示フラグ | boolean | 承認(直接処理)の実行可能なことを示すフラグ |
[16] displayConfirmDirectProcessLink¶
論理名 | 型 | 説明 |
---|---|---|
確認(直接処理)リンク表示フラグ | boolean | 確認(直接処理)の実行可能なことを示すフラグ |
[17] displayConfirmLink¶
論理名 | 型 | 説明 |
---|---|---|
確認リンク表示フラグ | boolean | 確認の実行可能なことを示すフラグ |
[18] displayConfirmModalLink¶
論理名 | 型 | 説明 |
---|---|---|
確認モーダルリンク表示フラグ | boolean | 確認モーダルを表示可能なことを示すフラグ |
[19] displayCopyNewLink¶
論理名 | 型 | 説明 |
---|---|---|
コピー新規リンク表示フラグ | boolean | コピー新規の実行可能なことを示すフラグ |
[20] displayDeleteLink¶
論理名 | 型 | 説明 |
---|---|---|
削除リンク表示フラグ | boolean | 案件削除の実行可能なことを示すフラグ |
[21] displayDenyDirectProcessLink¶
論理名 | 型 | 説明 |
---|---|---|
否認(直接処理)リンク表示フラグ | boolean | 否認(直接処理)の実行可能なことを示すフラグ |
[22] displayDetailLink¶
論理名 | 型 | 説明 |
---|---|---|
詳細リンク表示フラグ | boolean | 「詳細」画面を表示可能なことを示すフラグ |
[23] displayDiscontinueDirectProcessLink¶
論理名 | 型 | 説明 |
---|---|---|
取止め(直接処理)リンク表示フラグ | boolean | 取止め(直接処理)の実行可能なことを示すフラグ |
[24] displayFlowLink¶
論理名 | 型 | 説明 |
---|---|---|
フローリンク表示フラグ | boolean | 「フロー情報」画面を表示可能なことを示すフラグ |
[25] displayHandleLink¶
論理名 | 型 | 説明 |
---|---|---|
案件操作リンク表示フラグ | boolean | 「案件操作」画面を表示可能なことを示すフラグ |
[26] displayHistoryLink¶
論理名 | 型 | 説明 |
---|---|---|
履歴リンク表示フラグ | boolean | 「履歴情報」画面を表示可能なことを示すフラグ |
[27] displayProcessModalLink¶
論理名 | 型 | 説明 |
---|---|---|
処理モーダルリンク表示フラグ | boolean | 処理モーダルを表示可能なことを示すフラグ |
[28] displayProcLink¶
論理名 | 型 | 説明 |
---|---|---|
処理リンク表示フラグ | boolean | 処理の実行可能なことを示すフラグ |
[29] displayPullBackLink¶
論理名 | 型 | 説明 |
---|---|---|
引戻しリンク表示フラグ | boolean | 「引戻し」画面を表示可能なことを示すフラグ |
[30] displayTransferLink¶
論理名 | 型 | 説明 |
---|---|---|
振替リンク表示フラグ | boolean | 「振替」画面を表示可能なことを示すフラグ |
[31] finalProcessDate¶
論理名 | 型 | 説明 |
---|---|---|
最終処理日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
[32] flowId¶
論理名 | 型 | 説明 |
---|---|---|
フローID | string |
[33] flowName¶
論理名 | 型 | 説明 |
---|---|---|
フロー名 | string |
[34] handleLevel¶
論理名 | 型 | 説明 |
---|---|---|
操作権限 | string | 「 CodeList 」のコード値がセットされます。 |
[35] matterEndDate¶
論理名 | 型 | 説明 |
---|---|---|
案件終了日 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
[36] matterEndStatus¶
論理名 | 型 | 説明 |
---|---|---|
案件完了状態 | string | 「 CodeList 」のコード値がセットされます。 |
[37] matterName¶
論理名 | 型 | 説明 |
---|---|---|
案件名 | string |
[38] matterNumber¶
論理名 | 型 | 説明 |
---|---|---|
案件番号 | string |
[39] matterProperty¶
論理名 | 型 | 説明 |
---|---|---|
案件プロパティ | object | matterProperty プロパティは、案件プロパティを設定していない場合でも必ず存在します。
その際の値は空のオブジェクトです。
|
内包プロパティ¶
プロパティ名 | 論理名 | 型 | 説明 |
---|---|---|---|
%案件プロパティキー% | 案件プロパティ情報 | string | 当該案件プロパティキーに対する値がセットされます。
案件プロパティの型の設定(文字列、数値)に関わらず、この値の型は string です。
|
コラム
例)案件プロパティキーが item_total 、対する値が 5000
以下のようにセットされます。
{ "matterProperty": { "item_total": "5000" } }
[40] nodeId¶
論理名 | 型 | 説明 |
---|---|---|
ノードID | string | 一覧APIに対応するアクティブなノードのノードIDがセットされます。
|
[41] nodeName¶
論理名 | 型 | 説明 |
---|---|---|
ノード名 | string | 一覧APIに対応するアクティブなノードのノード名がセットされます。
|
[42] pageType¶
論理名 | 型 | 説明 |
---|---|---|
画面種別 | string | 「 CodeList 」のコード値がセットされます。 |
[43] priority¶
論理名 | 型 | 説明 |
---|---|---|
優先度 | string | 「 CodeList 」のコード値がセットされます。 |
[44] processAuth¶
論理名 | 型 | 説明 |
---|---|---|
処理権限 | string | 「 CodeList 」のコード値がセットされます。 |
[45] processLimitDate¶
論理名 | 型 | 説明 |
---|---|---|
処理期限 | string | アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
|
[46] status¶
論理名 | 型 | 説明 |
---|---|---|
ノード状態 | string | 「 CodeList 」のコード値がセットされます。 |
[47] systemMatterId¶
論理名 | 型 | 説明 |
---|---|---|
システム案件ID | string |
[48] userDataId¶
論理名 | 型 | 説明 |
---|---|---|
ユーザデータID | string |