6.1.9.8.4. 一括確認可能完了案件確認情報リスト取得¶
完了案件の一括確認情報リストを取得します。
このAPIは CnfmCplMatterList#getLumpCnfmList の動作に基づきます。
6.1.9.8.4.1. HTTP リクエスト¶
POST /api/workflow/completed-matters-confirm/lump-confirmable
6.1.9.8.4.2. リクエストボディ¶
6.1.9.8.4.2.1. JSON¶
{
"advancedSearchCondition": [
{
"columnId": "string",
"matterProperty": true,
"value1": "string",
"value2": "string"
}
],
"count": 0,
"index": 0,
"orders": [
{
"asc": true,
"columnId": "string",
"matterProperty": true
}
],
"detailSearchCondition": {
"applyAuthUserCd": "string",
"applyBaseDateFrom": "string",
"applyBaseDateTo": "string",
"applyDateFrom": "string",
"applyDateTo": "string",
"arriveDateFrom": "string",
"arriveDateTo": "string",
"confirmed": true,
"matterEndDateFrom": "string",
"matterEndDateTo": "string",
"matterEndStatus": "string",
"matterName": "string",
"matterNumber": "string",
"priority": "string",
"unconfirmed": true
},
"flowGroupId": "string",
"flowId": "string",
"ignoreDisplayPattern": true
}
6.1.9.8.4.2.2. 詳細¶
この章では当API独自の仕様についてのみ記載します。
以下を併せて参照してください。
6.1.9.8.4.2.2.1. advancedSearchCondition プロパティ¶
一括確認情報リスト取得用の特殊な条件をセットする必要があります。
matterProperty プロパティには false をセットしてください。
権限会社コード、権限組織セットコード、権限組織コードは、組織が設定されている確認情報を取得するための条件として利用します。
値がセットされていない場合は 組織なし の条件（組織が指定されていない情報を対象とする条件）として処理します。
| 指定可能なカラムID | 論理名 | 説明 |
|---|---|---|
| authCompanyCd | 権限会社コード | 必須です。
value1 に対して会社コードを指定してください。
|
| authDepartmentSetCd | 権限組織セットコード | 必須です。
value1 に対して組織セットコードを指定してください。
|
| authDepartmentCd | 権限組織コード | 必須です。
value1 に対して組織コードを指定してください。
|
コラム
設定例
{
"advancedSearchCondition": [
{
"columnId": "authCompanyCd",
"matterProperty": false,
"value1": "comp_sample_01"
},
{
"columnId": "authDepartmentSetCd",
"matterProperty": false,
"value1": "comp_sample_01"
},
{
"columnId": "authDepartmentCd",
"matterProperty": false,
"value1": "dept_sample_11"
}
]
}
6.1.9.8.4.3. レスポンスデータ¶
6.1.9.8.4.3.1. JSON¶
以下は取得可能な全データを示すJSON情報です。
{
"data": {
"records": [
{
"applyAuthUserName": "string",
"applyBaseDate": "string",
"applyDate": "string",
"arriveDate": "string",
"confirmStatus": "string",
"defaultFormatApplyBaseDate": "string",
"defaultFormatApplyDate": "string",
"defaultFormatArriveDate": "string",
"defaultFormatMatterEndDate": "string",
"displayConfirmDirectProcessLink": true,
"displayConfirmLink": true,
"displayConfirmModalLink": true,
"displayCopyNewLink": true,
"displayDetailLink": true,
"displayFlowLink": true,
"displayHistoryLink": true,
"flowName": "string",
"matterEndDate": "string",
"matterEndStatus": "string",
"matterName": "string",
"matterNumber": "string",
"matterProperty": {},
"nodeId": "string",
"priority": "string",
"systemMatterId": "string",
"userDataId": "string"
}
]
}
}
6.1.9.8.4.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 5065 | 一括確認可能完了案件確認一覧情報取得パラメータが未指定です。 | リクエストボディ が未指定の場合 |
| 6231 | 完了案件確認一覧情報の取得に失敗しました。 | 一覧情報の取得に失敗した場合 |
| 6205 | 標準カラムとして存在しないカラムがソートに指定されました。 | リクエスト情報に含まれるカラムIDに一致する標準のカラムが存在しない場合 |
| 6206 | 日付文字列のパースに失敗しました。項目：%項目名%（開始） | 日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
|
| 6211 | 日付文字列のパースに失敗しました。項目：%項目名%（終了） | 日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
|
| 8811 | フローグループIDおよびフローIDが未指定です。 | リクエスト情報に含まれるフローグループIDおよび、フローIDが未指定の場合 |