履歴の表示 (テクニカルプレビュー)

history_logsリソースを使用して、単一のエンティティの履歴、または複数のエンティティにわたる履歴 (エンティティ間の履歴) を表示します。このリソースを使用すると、ALM Octaneユーザーインターフェイスの [履歴] タブで利用できるよりも多くの監査情報を取得できます。

注: テクニカルプレビューとして、このリソースは変更される可能性があります。

概要

REST APIを使用すると、ALM Octaneユーザーインターフェイスを使用して利用できる履歴のサブセットとは対照的に、任意のエンティティに加えられたすべての変更の履歴を表示できます。

エンティティ間の履歴を表示するには、スペース管理者であるか、データアクセス制限のないユーザーである必要があります。ただし、データアクセスに制限がある場合は、単一のエンティティの履歴を表示できます。

履歴を表示できるエンティティを決定するには、エンティティメタデータリファレンスのhistoryフィーチャーを参照してください。

トップに戻る

履歴リクエストへのクエリの追加

history_logsリソースによって返される情報をフィルタリングするクエリを追加します。

エンティティに加えられた変更についてクエリを実行できます。変更された値を照会することはできません。たとえば、フェーズが変更された不具合の数を照会することはできますが、どの不具合のフェーズがClosedに変更されたかを照会することはできません。

次の句を使用できます。

返されたデータがどのようにページングされるか。ページデータ (limit、offset、total_count)を参照してください。
fields句を使用して、必要なフィールドのみを取得します。フィールドの選択を参照してください
クエリ句を使用して返されるインスタンスをフィルタリングします。クエリを参照してください。

セミコロンを使用して、クエリ内の句を区切ります。これは、AND関係演算子を表します。

次の項目についてクエリを実行できます。

クエリ項目	説明
entity_type	チーム、フィーチャー、パイプラインなどのエンティティタイプごとに履歴を表示できます。履歴を表示できるエンティティを確認するには、エンティティメタデータリファレンスの下のhistoryフィーチャーを参照してください。データアクセス制限のあるユーザーには必須です。
entity_id	エンティティのIDで履歴を表示できます。データアクセス制限のあるユーザーには必須です。
field_name	エンティティの特定のフィールドに加えられた変更を表示できます。使用可能なエンティティを確認するには、エンティティメタデータリファレンスのhistoryフィーチャーを参照してください。
action	次のアクションの履歴を表示できます。 create update delete
user_id	特定のユーザーによる変更をリクエストできます。ユーザーIDは整数であるため、ユーザーIDは引用符なしで入力してください。注: ALM Octaneのすべてのユーザーは2つのIDを持っています。サイトレベルで閲覧履歴を表示している場合は、サイトのユーザーIDを指定します。スペースまたはワークスペース・レベルで履歴を表示している場合は、必ずスペースのユーザーIDを指定してください。

トップに戻る

例

history_logsリソースを操作するためのいくつかの例を次に示します。

注: entity_idを指定すると、応答には同じIDを持つすべてのエンティティが含まれます。たとえば、エンティティIDを3001に指定すると、IDが3001のユーザーストーリー、不具合、エピック、フィーチャーの履歴を取得できます。IDに加えてエンティティのタイプを指定して、関連するエンティティの履歴のみを取得できるようにします。

不具合の履歴を表示する例

この例は、IDが1005である特定の不具合の履歴を表示する方法を示しています。

リクエスト

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/history_logs?query="entity_type EQ ^defect^;entity_id EQ 1005"

応答

{
  "total_count": 10,
  "data": [
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "estimated_hours",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": null,
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "new_value": "<html><body>\n0\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "remaining_hours",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": null,
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "new_value": "<html><body>\n0\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "invested_hours",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": null,
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "new_value": "<html><body>\n0\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "name",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": null,
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "new_value": "<html><body>\nDefect2\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "new_entity_id_es": "2002",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "author",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "2002",
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "old_entity_id_es": null,
      "new_value": "<html><body>\nMarta Santora\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "new_entity_id_es": "2002",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "detected_by",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "2002",
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "old_entity_id_es": null,
      "new_value": "<html><body>\nMarta Santora\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "new_entity_id_es": "1001",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "release",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "1001",
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "old_entity_id_es": null,
      "new_value": "<html><body>\nRelease1\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "new_entity_id_es": "1001",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "phase",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "1001",
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "old_entity_id_es": null,
      "new_value": "<html><body>\nNew\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:48:47Z",
      "new_entity_id_es": "1002",
      "audit_action": "CREATE",
      "session_id": "64bfa46b-ff6a-48a2-95f2-bd0091db10d6",
      "old_entity_id": null,
      "entity_id": "1005",
      "property_name": "parent",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "1002",
      "action": "Created",
      "old_value": null,
      "user": "Marta Santora",
      "old_entity_id_es": null,
      "new_value": "<html><body>\nFeature1\n</body></html>"
    },
    {
      "type": "history",
      "creation_time": "2018-12-16T12:49:47Z",
      "new_entity_id_es": "2001",
      "audit_action": "DELETE",
      "session_id": "93d57993-2560-423b-bfd8-7f8eb0ca4991",
      "old_entity_id": "1001",
      "entity_id": "1005",
      "property_name": "release",
      "workspace_id": 1002,
      "entity_type": "defect",
      "user_id": 2002,
      "new_entity_id": "2001",
      "action": "Deleted",
      "old_value": "<html><body>\nRelease1\n</body></html>",
      "user": "Marta Santora",
      "old_entity_id_es": "1001",
      "new_value": "<html><body>\nRelease2\n</body></html>"
    }
  ],
  "exceeds_total_count": false,
  "total_error_count": 0
}

特定のユーザーが変更した不具合の履歴を表示する

この例は、ユーザーID2002、Marta Santoraが作成、変更、または削除した不具合の履歴を表示する方法を示しています。

リクエスト:

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/history_logs?query="entity_type EQ ^defect^;user EQ ^marta@thecompany.com^"

特定のユーザーが特定の期間に削除したクロスエンティティ

この例は、ユーザーID2002、Marta Santoraが2019年の初めから削除したエンティティの履歴を表示する方法を示しています。

リクエスト:

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/history_logs?query="user EQ ^marta@thecompany.com^;action EQ ^delete^;timestamp GE ^2019-01-01T20:59:59Z^"

削除されたスペースの履歴を表示する

この例は、削除されたすべてのスペースを表示する方法を示しています。

GET .../admin/history_logs?query="action EQ ^delete^;entity_type EQ ^shared_space^"

トップに戻る

参照情報:

履歴の表示 (テクニカルプレビュー)

概要

履歴リクエストへのクエリの追加

例

ヘルプセンターのフィードバックを送信する