6.1.9.4.1. 過去案件情報リスト取得¶
過去案件情報リストを取得します。
このAPIはリクエストパラメータによって内部的に利用するAPIを切り替えています。
- 権限範囲に archive-all , archive-management を指定している場合
- 権限範囲に archive-individual を指定している場合
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が有効な場合
- フローIDが指定されている場合
- ArcMatterList#getProcessedListWithAuthFlow の動作に基づきます。
- フローグループIDが指定されている場合
- フローIDが指定されている場合
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が無効な場合
- フローIDが指定されている場合
- ArcMatterList#getProcessedListWithFlow の動作に基づきます。
- フローグループIDが指定されている場合
- ArcMatterList#getProcessedListWithFlowGroup の動作に基づきます。
- フローIDが指定されている場合
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が有効な場合
archive-all, archive-management, archive-individual は 権限範囲について を参照してください。
6.1.9.4.1.1. HTTP リクエスト¶
POST /api/workflow/archived-matters
6.1.9.4.1.2. リクエストボディ¶
6.1.9.4.1.2.1. JSON¶
{
"advancedSearchCondition": [
{
"columnId": "string",
"matterProperty": true,
"value1": "string",
"value2": "string"
}
],
"count": 0,
"index": 0,
"orders": [
{
"asc": true,
"columnId": "string",
"matterProperty": true
}
],
"archiveYearMonth": "string",
"authCondition": {
"scope": "string"
},
"detailSearchCondition": {
"applyAuthUserCd": "string",
"applyBaseDateFrom": "string",
"applyBaseDateTo": "string",
"applyDateFrom": "string",
"applyDateTo": "string",
"matterEndDateFrom": "string",
"matterEndDateTo": "string",
"matterEndStatus": "string",
"matterName": "string",
"matterNumber": "string",
"priority": "string"
},
"flowGroupId": "string",
"flowId": "string",
"ignoreDisplayPattern": true
}
6.1.9.4.1.2.2. 詳細¶
この章では当API独自の仕様についてのみ記載します。
以下を併せて参照してください。
プロパティ名 | 論理名 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
archiveYearMonth | アーカイブ年月 | string | null | 過去案件情報リスト取得対象のアーカイブ年月を yyyyMM 形式で指定してください。 |
authCondition | 参照権限条件 | object | null | 権限範囲を指定できます。
|
- scope | スコープ | string | null | 過去案件権限判定 REST APIで取得した値をセットしてください。 |
6.1.9.4.1.3. レスポンスデータ¶
6.1.9.4.1.3.1. JSON¶
以下は取得可能な全データを示すJSON情報です。
{
"data": {
"records": [
{
"applyAuthUserName": "string",
"applyBaseDate": "string",
"applyDate": "string",
"defaultFormatApplyBaseDate": "string",
"defaultFormatApplyDate": "string",
"defaultFormatMatterEndDate": "string",
"displayCopyNewLink": true,
"displayDeleteLink": true,
"displayDetailLink": true,
"displayFlowLink": true,
"displayHistoryLink": true,
"flowName": "string",
"matterEndDate": "string",
"matterEndStatus": "string",
"matterName": "string",
"matterNumber": "string",
"matterProperty": {},
"priority": "string",
"systemMatterId": "string",
"userDataId": "string"
}
]
}
}
6.1.9.4.1.4. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
5039 | 過去案件一覧情報取得パラメータが未指定です。 | リクエストボディ が未指定の場合 |
5047 | アーカイブ年月が未指定です。 | リクエストボディ - archiveYearMonth が未指定の場合 |
5071 | 指定されたアーカイブ年月のフォーマットが不正です。 | リクエストボディ - archiveYearMonth のフォーマットが yyyyMM 形式ではない場合 |
6101 | 過去案件一覧情報の取得に失敗しました。 | 一覧の取得に失敗した場合 |
6205 | 標準カラムとして存在しないカラムがソートに指定されました。 | リクエスト情報に含まれるカラムIDに一致する標準のカラムが存在しない場合 |
6206 | 日付文字列のパースに失敗しました。項目:%項目名%(開始) | 日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
|
6211 | 日付文字列のパースに失敗しました。項目:%項目名%(終了) | 日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
|
8811 | フローグループIDおよびフローIDが未指定です。 | リクエスト情報に含まれるフローグループIDおよび、フローIDが未指定の場合 |
8806 | 処理権限者の組織情報の取得に失敗しました。 | 処理権限者の組織情報の取得処理に失敗した場合 |
8839 | 不正な過去案件権限が指定されています。 | 指定した権限範囲が存在しない場合、指定した権限範囲をログインユーザが所持していない場合、など |