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

6.1.9.4.2. 過去案件情報リスト件数取得

過去案件情報リスト件数を取得します。
このAPIはリクエストパラメータによって内部的に利用するAPIを切り替えています。

archive-all, archive-management, archive-individual権限範囲について を参照してください。

6.1.9.4.2.1. HTTP リクエスト

POST /api/workflow/archived-matters/count

6.1.9.4.2.2. リクエストボディ

6.1.9.4.2.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"
}

6.1.9.4.2.2.2. 詳細

この章では当API独自の仕様についてのみ記載します。
以下を併せて参照してください。
プロパティ名 論理名 デフォルト値 説明
archiveYearMonth アーカイブ年月 string null 過去案件情報リスト件数取得対象のアーカイブ年月を yyyyMM 形式で指定してください。
authCondition 参照権限条件 object null
権限範囲を指定できます。
- scope スコープ string null 過去案件権限判定 REST APIで取得した値をセットしてください。

6.1.9.4.2.3. レスポンスデータ

6.1.9.4.2.3.1. JSON

"data": 0

data プロパティには過去案件情報リスト件数がセットされます。

6.1.9.4.2.4. エラーコード

エラーコード エラーメッセージ 備考
5046 過去案件一覧件数取得パラメータが未指定です。 リクエストボディ が未指定の場合
5047 アーカイブ年月が未指定です。 リクエストボディ - archiveYearMonth が未指定の場合
5071 指定されたアーカイブ年月のフォーマットが不正です。 リクエストボディ - archiveYearMonth のフォーマットが yyyyMM 形式ではない場合
6102 過去案件情報の件数の取得に失敗しました。 一覧件数の取得に失敗した場合
6206 日付文字列のパースに失敗しました。項目:%項目名%(開始)
日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
6211 日付文字列のパースに失敗しました。項目:%項目名%(終了)
日付系パラメータに対して yyyy/MM/dd 以外のフォーマットが指定されていた場合
%項目名% には 申請基準日、申請日、到達日 等の名称が入ります。
8811 フローグループIDおよびフローIDが未指定です。 リクエスト情報に含まれるフローグループIDおよび、フローIDが未指定の場合
8806 処理権限者の組織情報の取得に失敗しました。 処理権限者の組織情報の取得処理に失敗した場合
8839 不正な過去案件権限が指定されています。 指定した権限範囲が存在しない場合、指定した権限範囲をログインユーザが所持していない場合、など