6.1.9.4.4. 過去案件の年単位の月別案件数情報リスト取得¶
過去案件の指定された年度の月別案件数情報リストを取得します。
ワークフローパラメータ 「 archive-year-start-month (過去案件一覧の設定) 」 で指定した年度開始月から1年分の月別案件数を取得します。
このAPIは各月の案件数取得にあたり、リクエストパラメータによって内部的に利用するAPIを切り替えています。
- 権限範囲に archive-all , archive-management を指定している場合
- 権限範囲に archive-individual を指定している場合
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が有効な場合
- ArcMatterList#getProcessedListWithAuthCount の動作に基づきます。
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が無効な場合
- ArcMatterList#getProcessedListCount の動作に基づきます。
- ワークフローパラメータ 「 use-department-filtering (組織フィルタリング設定) 」が有効な場合
archive-all, archive-management, archive-individual は 権限範囲について を参照してください。
6.1.9.4.4.1. HTTP リクエスト¶
GET /api/workflow/archived-matters/{archiveYear}/months
6.1.9.4.4.2. パスパラメータ¶
プロパティ名 | 論理名 | 説明 |
---|---|---|
archiveYear | アーカイブ年 | 取得対象のアーカイブ年を yyyy 形式で指定してください。 |
6.1.9.4.4.3. クエリパラメータ¶
プロパティ名 | 論理名 | 説明 |
---|---|---|
authScope | 権限範囲 | 過去案件権限判定 REST APIで取得した値をセットしてください。 |
6.1.9.4.4.4. レスポンスデータ¶
6.1.9.4.4.4.1. JSON¶
以下は取得可能な全データを示すJSON情報です。
{
"data": {
"yearMonthsInfo": [
{
"count": 0,
"month": "string",
"yearMonth": "string"
}
]
}
}
6.1.9.4.4.4.2. 詳細¶
プロパティ名 | 論理名 | 型 | 説明 |
---|---|---|---|
yearMonthsInfo | array<object> | 月別案件数情報 | |
- count | int | 案件数 | |
- month | string | 月 | 月(1~12) |
- yearMonth | string | 年月 | yyyyMM形式 |
6.1.9.4.4.5. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
5070 | 指定されたアーカイブ年のフォーマットが不正です。 | archiveYear のフォーマットが yyyy 形式ではない場合 |
6103 | 過去案件の年単位の月別案件数情報の取得に失敗しました。 | 情報の取得に失敗した場合 |
8806 | 処理権限者の組織情報の取得に失敗しました。 | 処理権限者の組織情報の取得処理に失敗した場合 |
8839 | 不正な過去案件権限が指定されています。 | 指定した権限範囲が存在しない場合、指定した権限範囲をログインユーザが所持していない場合、など |