Documentation

アクティビティーストリームリストの API エンドポイント

このリソースに GET リクエストを実行して、アクティビティーストリームのリストを取得します。

GET /api/v2/activity_stream/
HTTP 402 PAYMENT REQUIRED
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.044s

返されるデータ構造には以下のものが含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかったアクティビティーストリームの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはアクティビティーストリームのレコードが一覧表示されますが、ゼロの場合もあります。

結果

各アクティビティーストリームのデータ構造には以下のフィールドが含まれます。

  • id: アクティビティーストリームのデータベース ID (整数)
  • type: アクティビティーストリームのデータタイプ (複数選択)
    • activity_stream: アクティビティーストリーム
  • url: アクティビティーストリームの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • timestamp: (日時)
  • operation: 指定されたオブジェクトについて実行されたアクション (複数選択)
    • create: エンティティーの作成
    • update: エンティティーの更新
    • delete: エンティティーの削除
    • associate: エンティティーを別のエンティティーへ関連付け
    • disassociate: エンティティーの別のエンティティーへの関連付けを解除
    • changes: オブジェクトの作成、更新または削除時の新規および変更された値の概要 (フィールド)
    • object1: create、update、および delete イベントの場合、これが影響を受けるオブジェクトタイプになります。associate および disassociate イベントの場合、これが object2 と関連付けられる、もしくは関連付けが解除されるオブジェクトタイプになります (文字列)
    • object2: create、update、および delete イベントの場合は、これは事前設定されません。associate および disassociate イベントの場合、これが object1 と関連付けられるオブジェクトタイプになります (文字列)

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name Activity Stream List
description # List Activity Streams: Make a GET request to this resource to retrieve the list of activity streams.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.4.5
types
0 activity_stream
actions
GET
id
type integer
label ID
help_text Database ID for this activity stream.
type
type multiple choice
help_text Data type for this activity stream.
choices
0
0 activity_stream
1 Activity Stream
url
type string
help_text URL for this activity stream.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
timestamp
type datetime
label timestamp
operation
type multiple choice
label operation
help_text The action taken with respect to the given object(s).
choices
0
0 create
1 Entity Created
1
0 update
1 Entity Updated
2
0 delete
1 Entity Deleted
3
0 associate
1 Entity Associated with another Entity
4
0 disassociate
1 Entity was Disassociated with another Entity
changes
type field
help_text A summary of the new and changed values when an object is created, updated, or deleted
object1
type string
label object1
help_text For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2
object2
type string
label object2
help_text Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with