intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

目次

案件情報一覧系API共通リクエストボディ情報

案件情報一覧取得、案件情報一覧件数取得系APIで共通するリクエストボディ情報の説明です。

一覧取得条件共通リクエストボディ

プロパティ名 論理名 型 デフォルト値 説明
advancedSearchCondition 高度な検索条件 array<object> null 案件プロパティや、各API独自の取得条件（条件コード）を指定できます。
- columnId カラムID string null
案件プロパティID、または各APIで指定可能な条件コードを指定してください。
条件コードの詳細は各APIを参照してください。
- matterProperty 案件プロパティであるか boolean false カラムIDが案件プロパティである場合に true を指定してください。
- value1 値1 string null 単一検索の場合の値、または範囲検索の場合の1つめの値を指定してください。
- value2 値2 string null 範囲検索の場合の2つめの値を指定してください。
count 取得件数 number 0
取得件数を指定します。 0 の場合、全件取得します。
件数取得APIではこのパラメータは無視されます。
index 取得開始位置 number 0
取得開始位置を指定します。 0 の場合、先頭から取得します。
件数取得APIではこのパラメータは無視されます。
orders ソート条件 array<object> null
各一覧ごとに指定可能な項目に対する取得条件を指定できます。
件数取得APIではこのパラメータは無視されます。
- asc 昇順ソートフラグ boolean false 昇順ソートする場合に true を指定してください。
- columnId カラムID string null レスポンス情報に含まれる、ソート指定可であるプロパティ名、または案件プロパティIDを指定してください。
- matterProperty 案件プロパティであるか boolean false カラムIDが案件プロパティである場合に true を指定してください。
detailSearchCondition 詳細検索条件 object null
各一覧ごとに指定可能な項目に対する取得条件を指定できます。
詳細は detailSearchCondition プロパティ を参照してください。
flowGroupId フローグループID string null 指定したフローグループに属するフローの案件を取得対象とします。
flowId フローID string null 指定したフローの案件を取得対象とします。
ignoreDisplayPattern 一覧表示パターン定義無視フラグ boolean false
一覧表示パターンを無視し全てのカラムを取得したい場合に true を指定してください。
フローIDまたはフローグループIDをどちらも指定せずにデータが取得できます。
案件プロパティは取得できません。案件プロパティの検索条件は無視されます。
このプロパティは省略が可能です。省略した場合は false です。
件数取得APIではこのパラメータは無視されます。

detailSearchCondition プロパティ

各APIごとに指定可能なプロパティを記載します。
指定不可能なプロパティを指定した場合、エラーが発生するため、注意してください。

凡例

  • 指定可能： [1] 等

    • 未指定の場合、条件なしとして処理を進める情報と、処理内で値が補完される情報があります。
      詳細は下記表の各パラメータのリンク先を参照してください。

  • 指定不可： -

    • 指定した場合、エラーが発生します。
  未完了案件確認 未完了処理済み 未完了案件参照 未完了案件ノード 過去案件 完了案件確認 完了処理済み 完了案件参照 一時保存情報 未処理タスク情報
applyAuthUserCd [1] [1] [1] [1] [1] [1] [1] [1] [1] -
applyBaseDateFrom [2] [2] [2] [2] [2] [2] [2] [2] [2] [2]
applyBaseDateTo [2] [2] [2] [2] [2] [2] [2] [2] [2] [2]
applyDateFrom [3] [3] [3] [3] [3] [3] [3] [3] - [3]
applyDateTo [3] [3] [3] [3] [3] [3] [3] [3] - [3]
arriveDateFrom [4] - - [4] - [4] - - - [4]
arriveDateTo [4] - - [4] - [4] - - - [4]
coment - - - - - - - - [5] -
confirmed [6] - - - - [6] - - - -
lastProcessDateFrom - [7] - - - - - - - -
lastProcessDateTo - [7] - - - - - - - -
matterEndDateFrom - - - - [8] [8] [8] [8] - -
matterEndDateTo - - - - [8] [8] [8] [8] - -
matterEndStatus - - - - [9] [9] [9] [9] - -
matterName [10] [10] [10] [10] [10] [10] [10] [10] [10] [10]
matterNumber [11] [11] [11] [11] [11] [11] [11] [11] - [11]
nodeName - - - [12] - - - - - [12]
priorityLevel [13] [13] [13] [13] [13] [13] [13] [13] - [13]
processLimitDate - - - [14] - - - - - -
status - - - [15] - - - - - [15]
unconfirmed [16] - - - - [16] - - - -

[1] applyAuthUserCd

論理名 型 説明
申請権限者コード string （比較方式）完全一致

[2] applyBaseDateFrom / applyBaseDateTo

論理名 型 説明
申請基準日（開始日/終了日） string
（比較方式）大なりイコール/小なりイコール
yyyy/MM/dd 形式で指定してください。

[3] applyDateFrom / applyDateTo

論理名 型 説明
申請日（開始日/終了日） string
（比較方式）大なりイコール/小なりイコール
yyyy/MM/dd 形式で指定してください。

[4] arriveDateFrom / arriveDateTo

論理名 型 説明
到達日（開始日/終了日） string
（比較方式）大なりイコール/小なりイコール
yyyy/MM/dd 形式で指定してください。

[5] comment

論理名 型 説明
コメント string （比較方式）部分一致

[6] confirmed

論理名 型 説明
確認済み boolean  

[7] lastProcessDateFrom / lastProcessDateTo

論理名 型 説明
最終処理日（開始日/終了日） string
（比較方式）大なりイコール/小なりイコール
yyyy/MM/dd 形式で指定してください。

[8] matterEndDateFrom / matterEndDateTo

論理名 型 説明
案件終了日（開始日/終了日） string
（比較方式）大なりイコール/小なりイコール
yyyy/MM/dd 形式で指定してください。

[9] matterEndStatus

論理名 型 説明
案件完了状態 string
（比較方式）完全一致
「 CodeList 」の コード値 を指定してください。

[10] matterName

論理名 型 説明
案件名 string （比較方式）部分一致

[11] matterNumber

論理名 型 説明
案件番号 string （比較方式）部分一致

[12] nodeName

論理名 型 説明
ノード名 string （比較方式）部分一致

[13] priorityLevel

論理名 型 説明
優先度 string
（比較方式）完全一致
「 CodeList 」の コード値 を指定してください。

[14] processLimitDate

論理名 型 説明
処理期限 string （比較方式）小なりイコール

[15] status

論理名 型 説明
ノード状態 string
（比較方式）完全一致
「 CodeList 」の コード値 を指定してください。

[16] unconfirmed

論理名 型 説明
未確認 boolean  

目次

Copyright © 2012 NTT DATA INTRAMART CORPORATION

⇄ Sidebar ↑Top