Perforce · Schema

Activity

An entry in the Helix Swarm activity stream recording an action performed by a user.

Properties

Name	Type	Description
id	integer	The unique activity entry identifier.
action	string	A past-tense description of the action performed.
change	integer	The related changelist ID, if applicable.
date	string	The date and time the activity occurred.
description	string	Contextual information about the activity.
link	string	A URL linking to the activity target.
streams	array	The activity streams this entry appears in.
target	string	The object that received the action.
topic	string	An associated comment thread topic.
type	string	The activity type classification.
user	string	The username of the user who performed the action.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Activity",
  "title": "Activity",
  "type": "object",
  "description": "An entry in the Helix Swarm activity stream recording an action performed by a user.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique activity entry identifier.",
      "example": "abc123"
    },
    "action": {
      "type": "string",
      "description": "A past-tense description of the action performed.",
      "example": "example_value"
    },
    "change": {
      "type": "integer",
      "description": "The related changelist ID, if applicable.",
      "example": 10
    },
    "date": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the activity occurred.",
      "example": "2026-01-15T10:30:00Z"
    },
    "description": {
      "type": "string",
      "description": "Contextual information about the activity.",
      "example": "A sample description."
    },
    "link": {
      "type": "string",
      "format": "uri",
      "description": "A URL linking to the activity target.",
      "example": "https://www.example.com"
    },
    "streams": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The activity streams this entry appears in.",
      "example": []
    },
    "target": {
      "type": "string",
      "description": "The object that received the action.",
      "example": "example_value"
    },
    "topic": {
      "type": "string",
      "description": "An associated comment thread topic.",
      "example": "example_value"
    },
    "type": {
      "type": "string",
      "description": "The activity type classification.",
      "example": "example_value"
    },
    "user": {
      "type": "string",
      "description": "The username of the user who performed the action.",
      "example": "example_value"
    }
  }
}