5.13.1　前回実行履歴取得

機能

指定したIM管理ノード，または提案IDに応じた対処アクションを，前回いつ実行したかの履歴情報を取得します。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

POST /application/component/apivVersion/nodes/suggestions/history httpVersion

リクエストのメッセージボディー

{
    "sid": IM管理ノードのツリーSID,
    "suggestionIds": 提案IDのリスト
}

レスポンスのメッセージボディー

{
    "histories":[
        {
            "suggestionId": 提案ID,
            "label": 提案表示名,
            "jp1UserName": 対処アクションを実行したJP1ユーザー名,
            "startTime": 対処アクションの実行開始日時,
            "endTime": 対処アクションの実行終了日時,
            "status" : 対処アクションの実行状態
        },
        ...    
    ]
}

パラメーター

sid

IM管理ノードのツリーSIDを指定します。このパラメーターは省略できません。

suggestionIds

提案IDのリストを指定します。1〜1,000件まで指定できます。空のリストを指定した場合，エラーメッセージKAJY22019-Eを出力し，対処アクションの前回実行履歴の取得を中断します。

このパラメーターの指定を省略した場合は，指定したIM管理ノードにマッピングされた提案定義のうち，ログインユーザーが表示条件を満たしている提案定義について，対処アクションの前回実行履歴を取得します。

指定されたIM管理ノードのツリーSIDにマッピングされていない提案定義，またはログインユーザーが表示できない提案定義の提案IDを指定した場合，エラーメッセージKAJY22021-Eを出力し，対処アクションの前回実行履歴の取得を中断します。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	なし	前回実行履歴の取得に成功しました。
400	KAJY22019-E	REST APIのリクエストが不正です。 IM管理ノードのツリーSIDの形式が不正，提案IDが不正，提案IDのリスト数が不正，などの原因が考えられます。
	KAJY22022-E	REST APIのリクエストが不正です。提案IDが重複しています。
	KAJY22011-E	存在しないSIDを指定しているか，指定したIM管理ノードの参照権限がログインユーザーにありません。
	KAJY22021-E	指定されたIM管理ノードにマッピングされていない提案，またはログインユーザーが表示できない提案の提案IDを指定しています。
403	KAJY01000-E	REST APIの実行権限がありません。

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

項番	メンバー名	データ型	説明
1	`histories`	object[]	対処アクションの前回実行履歴を配列として返却します。指定されたIM管理ノードのツリーSIDにマッピングされている提案定義が存在しない，またはマッピングされている提案定義の中に，ログインユーザーが表示できる提案定義が存在しない場合は，空の配列が返却されます。
2	`suggestionId`	string	提案IDが設定されます。
3	`label`	string	提案表示名が設定されます。
4	`jp1UserName`	string	対処アクションを実行したJP1ユーザー名です。前回実行履歴が存在しない場合，このメンバーは返却されません。
5	`startTime`	string	対処アクションの実行開始年月，日時をISO 8601形式のUTC時刻で返却します。前回実行履歴が存在しない場合，このメンバーは返却されません。
6	`endTime`	string	対処アクションの実行終了年月，日時をISO 8601形式のUTC時刻で返却します。対処アクションが実行中，または失敗した場合は，空文字が返却されます。前回実行履歴が存在しない場合，このメンバーは返却されません。
7	`status`	int	対処アクションの実行状態です。次のどれかを返却します。 0：実行中 1：成功 2：失敗前回実行履歴が存在しない場合，このメンバーは返却されません。

使用例

APIの使用例を次に示します。

リクエスト：

POST http://hostname:20703/im/api/v1/nodes/suggestions/history
{
    "sid":"_ROOT_AllSystems/_HOST_HOSTA/_CATEGORY_managementApplications/_OBJECT_JP1IMMGR"
}

レスポンス：

{
    "histories":[
        {
            "suggestionId":"exec_jim_log",
            "label":"JP1/IMの資料採取ツールの実行",
            "jp1UserName":"jp1admin",
            "startTime":"2020-03-01T00:00:00Z",
            "endTime":"",
            "status" :0
        },
        {
            "suggestionId":"reg_ticket",
            "label":"Redmineへチケットを登録する",
            "jp1UserName":"jp1admin",
            "startTime":"2020-03-01T00:00:00Z",
            "endTime":"2020-03-01T00:00:10Z",
            "status" :1
        }
    ]
}

ページの先頭へ

5.13.1 前回実行履歴取得

5.13.1　前回実行履歴取得