Retrieve an Activity Stream

get

/api/v2/activity_stream/{id}/

Make GET request to this resource to retrieve a single activity stream record containing the following fields:

  • id: Database ID for this activity stream. (integer)
  • type: Data type for this activity stream. (choice)
  • url: URL for this activity stream. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • timestamp: (datetime)
  • operation: The action taken with respect to the given object(s). (choice)
    • create: Entity Created
    • update: Entity Updated
    • delete: Entity Deleted
    • associate: Entity Associated with another Entity
    • disassociate: Entity was Disassociated with another Entity
  • changes: A summary of the new and changed values when an object is created, updated, or deleted (json)
  • object1: 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. (string)
  • object2: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)
  • object_association: When present, shows the field name of the role or relationship that changed. (field)
  • action_node: The cluster node the activity took place on. (string)
  • object_type: When present, shows the model on which the role or relationship was defined. (field)

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : ActivityStream
Type: object
Show Source
  • Title: Action node
    Read Only: true
    Minimum Length: 1
    The cluster node the activity took place on.
  • Title: Changes
    Read Only: true
    A summary of the new and changed values when an object is created, updated, or deleted
  • Title: ID
    Read Only: true
  • Title: Object1
    Minimum Length: 1
    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.
  • Title: Object2
    Minimum Length: 1
    Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.
  • Title: Object association
    Read Only: true
    When present, shows the field name of the role or relationship that changed.
  • Title: Object type
    Read Only: true
    When present, shows the model on which the role or relationship was defined.
  • Title: Operation
    Allowed Values: [ "create", "update", "delete", "associate", "disassociate" ]
    The action taken with respect to the given object(s).
  • Title: Summary fields
    Read Only: true
  • Title: Timestamp
    Read Only: true
  • Title: Type
    Read Only: true
  • Title: Url
    Read Only: true
Back to Top