journals
SIDfmVMサーバに登録されている履歴一覧を取得するためのエンドポイントです。
履歴情報画面のサマリー表に相当するデータを取得します。
エンドポイント | journals |
機能 | 履歴一覧取得 |
実装バージョン | 2.7.0 |
認証 | 有り |
HTTPメソッド | GET/POST |
パラメータ
入力値 | 機能 | 入力値の型 | デフォルト値 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし | ||||||||||||||||
q[offset] | 取得するデータの先頭位置を指定します。 | Number | 0 | ||||||||||||||||
q[per_page] |
1~200の値で、1度に取得するデータの数を指定します。指定した値が1~200を超えている場合は10として扱われます。 ※全データ数の指定は不可です。 |
Number | 10 | ||||||||||||||||
q[order] |
一覧データのソート順を指定します。
下記の文字列に_ascを付けると昇順、_descを付けると降順となります。(例: created_on_asc)
|
String | created_on_desc | ||||||||||||||||
q[filters][roles][names] |
ユーザの権限名で、取得する履歴を絞り込みます。 指定したいずれかの権限のユーザの履歴に絞り込みます。 絞り込み可能な権限名は、下記の通りです。
|
Array<String> | なし | ||||||||||||||||
q[filters][roles][is_except] | trueを指定すると、q[filters][roles][names]での絞り込み時に、指定したユーザ権限が設定されていないユーザの履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][users][logins] |
ユーザのログイン名で、取得する履歴を絞り込みます。 指定したいずれかのログイン名のユーザの履歴に絞り込みます。 この絞り込みは、q[filters][users][mail_addresses]及びq[filters][users][names]、 q[filters][users][is_except_anonymous]に限りOR条件で絞り込みを行います。 |
Array<String> | なし | ||||||||||||||||
q[filters][users][mail_addresses] |
ユーザのメールアドレスで、取得する履歴を絞り込みます。 指定したいずれかのメールアドレスのユーザの履歴に絞り込みます。 この絞り込みは、q[filters][users][logins]及びq[filters][users][names]、q[filters][users][is_except_anonymous]に限りOR条件で絞り込みを行います。 |
Array<String> | なし | ||||||||||||||||
q[filters][users][names] |
ユーザの氏名で、取得する履歴を絞り込みます。 指定したいずれかの氏名のユーザの履歴に絞り込みます。 この絞り込みは、q[filters][users][logins]及びq[filters][users][mail_addresses]、q[filters][users][is_except_anonymous]に限りOR条件で絞り込みを行います。 |
Array<String> | なし | ||||||||||||||||
q[filters][users][is_except_anonymous] |
trueを指定すると、取得する履歴を削除済みユーザ以外のユーザの履歴に絞り込みます。 この絞り込みは、q[filters][users][logins]及びq[filters][users][mail_addresses]、q[filters][users][names]に限りOR条件で絞り込みを行います。 |
Boolean | なし | ||||||||||||||||
q[filters][users][is_except] | trueを指定すると、取得する履歴をq[filters][users][logins]及びq[filters][users][mail_addresses]、q[filters][users][names]で指定したユーザ以外のユーザの履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][hosts][hostnames] |
ホスト名で、取得する履歴を絞り込みます。 指定したいずれかのホストの履歴に絞り込みます。 この絞り込みは、q[filters][hosts][display_names]に限りOR条件で絞り込みを行います。 |
Array<String> | なし | ||||||||||||||||
q[filters][hosts][display_names] |
ホストの表示名で、取得する履歴を絞り込みます。 指定したいずれかのホストの履歴に絞り込みます。 この絞り込みは、q[filters][hosts][hostnames]に限りOR条件で絞り込みを行います。 |
Array<String> | なし | ||||||||||||||||
q[filters][hosts][is_except] | trueを指定すると、取得する履歴をq[filters][hosts][hostnames]及びq[filters][hosts][display_names]で指定したホスト以外のホストの履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][categories][names] |
カテゴリ名で、取得する履歴を絞り込みます。 指定したカテゴリのいずれかが設定されているホストの履歴に絞り込みます。 q[filters][categories][ids]と併用して絞り込みすることはできません。 |
Array<String> | なし | ||||||||||||||||
q[filters][categories][ids] |
カテゴリIDで、取得する履歴を絞り込みます。 指定したカテゴリのいずれかが設定されているホストの履歴に絞り込みます。 q[filters][categories][names]と併用して絞り込みすることはできません。 |
Array<Number> | なし | ||||||||||||||||
q[filters][categories][is_and] | trueを指定すると、q[filters][categories][names]またはq[filters][categories][ids]での絞り込み時に、指定したカテゴリが全て設定されているホストの履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][categories][is_except] | trueを指定すると、q[filters][categories][names]またはq[filters][categories][ids]での絞り込み時に、指定したカテゴリが設定されていないホストの履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][date_begin] |
履歴の作成日で、取得する履歴を絞り込みます。 作成日が指定した日付以降の履歴に絞り込みます。(例: 2022/11/01) |
String | なし | ||||||||||||||||
q[filters][date_end] |
履歴の作成日で、取得する履歴を絞り込みます。 作成日が指定した日付以前の履歴に絞り込みます。(例: 2022/11/01) |
String | なし | ||||||||||||||||
q[filters][date_outside_period] | trueを指定すると、取得する履歴をq[filters][date_begin]またはq[filters][date_end]あるいはその両方で指定した期間外の履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][operations][items] |
取得する履歴を、指定したいずれかの操作に関連する履歴に絞り込みます。 指定可能な操作は、下記の通りです。
|
Array<String> | なし | ||||||||||||||||
q[filters][operations][is_except] | trueを指定すると、取得する履歴をq[filters][operations][items]で指定した操作に関連しない履歴に絞り込みます。 | Boolean | なし | ||||||||||||||||
q[filters][status] |
対応状況で、取得する履歴を絞り込みます。 配列で複数指定すると、指定したいずれかの対応状況の脆弱性の履歴に絞り込みます。 1つ指定する場合は、文字列でも指定可能です。 絞り込み可能な対応状況は、下記の通りです。
|
String/Array<String> | なし | ||||||||||||||||
q[filters][comment][text] | 取得する履歴を、指定した文字列がコメントに部分一致する履歴に絞り込みます。 | String | なし | ||||||||||||||||
q[filters][comment][is_except] | trueを指定すると、取得する履歴をq[filters][comment][text]で指定した文字列がコメントに部分一致しない履歴に絞り込みます。 | String | なし | ||||||||||||||||
q[filters][vulnerabilities] |
取得する履歴を、指定した文字列が部分一致する脆弱性の履歴に絞り込みます。 指定する文字列によって、絞り込みする対象が変わります。
※ CVE IDに部分一致する場合は、そのCVE IDに関連する脆弱性の履歴が一致するデータの対象に含まれます。
|
String | なし | ||||||||||||||||
q[filters][ctags] | 取得する履歴を、指定したカスタムタグのいずれかが設定されている脆弱性の履歴に絞り込みます。 | Array<String> | なし |
レスポンス
key | value の内容 | value の型 |
---|---|---|
success | 認証の成否 | Boolean |
response | エラー等の補足情報 | Hash |
total_size | 取得した履歴の数 | Number |
journals | 履歴一覧 | Array<Hash> |
journal_id | 履歴ID | Number |
created_on | 作成日時 | String |
user | ユーザ | Hash |
id | ユーザID | Number |
login | ログイン名 | String |
fullname | 氏名 | String |
mail_address | メールアドレス | String |
operation | 操作 | Hash |
title | タイトル | String |
content | 変更内容 | String |
vulnerability | 脆弱性 | Hash |
html_id | SIDfm ID | Number |
titie | 脆弱性名 | String |
short_description | 簡易説明 | String/Null |
url | 脆弱性詳細画面のURL | String |
create_date | 登録日 | String |
update_date | 更新日 | String |
host | ホスト | Hash |
id | ホストID | Number |
hostname | ホスト名 | String |
ext_name | 表示名 | String/Null |
display_name | 実際に表示に使用される名称 | String |
url | ホスト詳細画面のURL | String |
status | 対応状況 | String |
due_date | 対策予定日 | String |
ctags | カスタムタグ | Array<Hash> |
id | カスタムタグID | Number |
keyword | カスタムタグ名 | String |
category_id | カテゴリID | Number/Null |
color | 文字色コード | String |
background_color | 背景色コード | String |
priority | 優先度 | Number |
レスポンス例
{ "success": true, "response": {}, "total_size": 143330, "journals": [ { "journal_id": 383997, "created_on": "2022/11/05 06:24:19", "user": { "id": 238, "login": "rireki_admin", "fullname": "履歴 管理者", "mail_address": "sidfm@example.com" }, "operation": { "title": "ステータス変更", "content": "影響無 から 未対策へ" }, "comment": "ステータス変更", "vulnerability": { "html_id": 90000054, "title": "[90000054] SAMPLE脆弱性", "short_description": "サンプル", "url": "http://example.com/redmine/sidfm/vulnerability/90000054?form%5Bhistory%5D=%5B88%2C90000054%5D", "create_date": "2001/10/26", "update_date": "2002/03/20" }, "host": { "id": 88, "hostname": "sample-host", "ext_name": null, "display_name": "sample-host", "url": "http://example.com/redmine/sidfm/host/88?form%5Bhistory%5D=%5B90000054%2C88%5D" }, "status": "未対策", "due_date": "2022/06/01", "ctags": [ { "id": 62, "keyword": "tag15", "category_id": 341, "color": "#e3e628", "background_color": "#000000", "priority": 2 } ] } ] }
サンプルコード
※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM
APIキー設定画面で登録済みのAPIキーを設定する必要があります。