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

6.1.9.14.3. 履歴取得

履歴を取得します。
案件の状態(未完了、完了、過去)に関わらず取得できます。

6.1.9.14.3.1. HTTP リクエスト

GET /api/workflow/matters/{systemMatterId}/histories

6.1.9.14.3.2. パスパラメータ

プロパティ名 論理名 説明
systemMatterId システム案件ID  

6.1.9.14.3.3. レスポンスデータ

6.1.9.14.3.3.1. JSON

"data": {
  "histories": [
    {
      "attribute": {},
      "authUserCd": "string",
      "authUserName": "string",
      "comment": "string",
      "defaultFormatExecuteDate": "string",
      "delegation": true,
      "departmentInfo": {
        "companyCd": "string",
        "companyName": "string",
        "departmentCd": "string",
        "departmentName": "string",
        "departmentSetCd": "string"
      },
      "executeDateTime": "string",
      "executeDateInEpochMillis": 0,
      "executeUserCd": "string",
      "executeUserName": "string",
      "historyId": "string",
      "historyStatus": "string",
      "historyStatusName": "string",
      "nodeId": "string",
      "nodeName": "string",
      "nodeType": "string",
      "taskInfo": {
        "actionId": "string",
        "defaultFormatEndDate": "string",
        "defaultFormatStartDate": "string",
        "endDateTime": "string",
        "startDateTime": "string",
        "taskId": "string"
      }
    }
  ]
}

6.1.9.14.3.3.2. 詳細

プロパティ名 論理名 説明
histories 履歴情報 array<object>  
- attribute 属性情報 object attribute を参照してください。
- authUserCd 処理権限者コード string  
- authUserName 処理権限者名 string  
- comment   string  
- defaultFormatExecuteDate 実行日(デフォルトフォーマット) string yyyy/MM/dd HH:mm:ss.SSS 形式の値
- delegation 代理フラグ boolean この処理履歴が代理者による実行であれば true
- departmentInfo 組織情報 object プロパティ詳細は 組織情報 を参照してください。
- executeDateTime 実行日時刻 string
アカウントコンテキストの日付時刻表示形式の値
アカウントのタイムゾーンへ変換しています。
- executeDateInEpochMillis 実行日(エポックミリ秒) string  
- executeUserCd 実行者コード string  
- executeUserName 実行者名 string  
- historyId 履歴ID string この履歴情報リストを一意に識別するID
- historyStatus 履歴用ステータス string  
- historyStatusName 履歴用ステータス名称 string  
- nodeId ノードID string  
- nodeName ノード名 string  
- nodeType ノード種別 string CodeList 」 のコード値がセットされます。
- taskInfo タスク情報 object  
 - actionId アクションID string  
 - defaultFormatEndDate 終了日時 string yyyy/MM/dd HH:mm:ss.SSS 形式の値
 - defaultFormatStartDate 開始日時 string yyyy/MM/dd HH:mm:ss.SSS 形式の値
 - endDateTime 終了日時 string
アカウントコンテキストの日付時刻表示形式の値
アカウントのタイムゾーンへ変換しています。
 - startDateTime 開始日時 string
アカウントコンテキストの日付時刻表示形式の値
アカウントのタイムゾーンへ変換しています。
 - taskId タスクID string  
組織情報
プロパティ名 論理名 説明
companyCd 会社コード string  
companyName 会社名 string  
departmentCd 組織コード string  
departmentName 組織名 string  
departmentSetCd 組織セットコード string  

6.1.9.14.3.3.2.1. attribute

attribute には利用しているモジュールに応じた追加情報がセットされます。
2020 Summer(Zephirine) では以下の通りです。
6.1.9.14.3.3.2.1.1. BIS を利用している場合
"attribute": {
  "history": {
    "userDataId": "string",
    "historyId": "string",
    "imfrTransitionId": "string",
    "authUserCode": "string",
    "imfrFormId": "string",
    "taskId": "string"
  },
  "bam": {
    "waitingTimeTotal": "string",
    "measurementStartDate": "string",
    "processEndDate": "string",
    "processTimeTotal": "string",
    "waitingTime": "string",
    "processStartDate": "string",
    "processTime": "string"
  }
}
6.1.9.14.3.3.2.1.1.1. 詳細
プロパティ名 論理名 説明
history BIS履歴情報 object  
- userDataId ユーザデータID    
- historyId BIS履歴ID string  
- imfrTransitionId Forma遷移ID string  
- authUserCode 処理権限者コード string  
- imfrFormId FormaフォームID string  
- taskId タスクID string  
bam BIS BAM情報 object  
- waitingTimeTotal 待ち時間合計 string
日数-hh:MM:ss の形式です。
例) 000-00:00:00
- measurementStartDate 計測開始日 string
アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
- processEndDate 処理終了日 string
アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
- processTimeTotal 処理時間合計 string
日数-hh:MM:ss の形式です。
例) 000-00:00:00
- waitingTime 待ち時間 string
日数-hh:MM:ss の形式です。
例) 000-00:00:00
- processStartDate 処理開始日 string
アカウントコンテキストの日付表示形式の値
アカウントのタイムゾーンへ変換しています。
- processTime 処理時間 string
日数-hh:MM:ss の形式です。
例) 000-00:00:00

6.1.9.14.3.4. エラーコード

エラーコード エラーメッセージ 備考
6070 案件の状態が不正です。  
6071 処理対象者変更情報の取得に失敗しました。  
6072 確認情報の取得に失敗しました。  
6069 アプリケーション毎の履歴解決に失敗しました。  
6073 処理情報の取得にしました。  
6051 案件が見つかりませんでした。  
6052 案件情報が取得できません。  
6059 API利用権限が判定できません。  
6053 権限がありません。  
6058 案件のフロー情報が取得できません。  
6068 案件のフロー情報がありません。