Jump to

• Request
• Response

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

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : ActivityStream

Type: object

Show Source

• action_node: string
  Title: Action node

  Read Only: true

  Minimum Length: 1

  The cluster node the activity took place on.
• changes: string
  Title: Changes

  Read Only: true

  A summary of the new and changed values when an object is created, updated, or deleted
• id: integer
  Title: ID

  Read Only: true
• object1(required): string
  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.
• object2(required): string
  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.
• object_association: string
  Title: Object association

  Read Only: true

  When present, shows the field name of the role or relationship that changed.
• object_type: string
  Title: Object type

  Read Only: true

  When present, shows the model on which the role or relationship was defined.
• operation(required): string
  Title: Operation

  Allowed Values: [ "create", "update", "delete", "associate", "disassociate" ]

  The action taken with respect to the given object(s).
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• timestamp: string(date-time)
  Title: Timestamp

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "action_node":{
            "description":"The cluster node the activity took place on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Action node",
            "type":"string"
        },
        "changes":{
            "description":"A summary of the new and changed values when an object is created, updated, or deleted",
            "readOnly":true,
            "title":"Changes",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "object1":{
            "description":"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.",
            "minLength":"1",
            "title":"Object1",
            "type":"string",
            "x-nullable":true
        },
        "object2":{
            "description":"Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.",
            "minLength":"1",
            "title":"Object2",
            "type":"string",
            "x-nullable":true
        },
        "object_association":{
            "description":"When present, shows the field name of the role or relationship that changed.",
            "readOnly":true,
            "title":"Object association",
            "type":"string"
        },
        "object_type":{
            "description":"When present, shows the model on which the role or relationship was defined.",
            "readOnly":true,
            "title":"Object type",
            "type":"string"
        },
        "operation":{
            "description":"The action taken with respect to the given object(s).",
            "enum":[
                "create",
                "update",
                "delete",
                "associate",
                "disassociate"
            ],
            "title":"Operation",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timestamp":{
            "format":"date-time",
            "readOnly":true,
            "title":"Timestamp",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "operation",
        "object1",
        "object2"
    ],
    "type":"object"
}

Back to Top