list-cloud-diagram-activity-groups

dci list-cloud-diagram-activity-groups [flags]

Returns snapshot activity groups for the specified diagram layer, ordered by timestamp descending. Each group contains a snapshot reference and the individual activity records that belong to it.

Paging

This endpoint pages with --limit and --offset, not page tokens, so --all does not apply.

Examples

# The latest ten snapshot activity groups of a layer, newest first.
dci list-cloud-diagram-activity-groups --ss-id <layer-id>

# The next ten.
dci list-cloud-diagram-activity-groups --ss-id <layer-id> --limit 10 --offset 10

# Only groups carrying a tag, as JSON.
dci list-cloud-diagram-activity-groups --ss-id <layer-id> --tags <tag> --output json

Flags

Flag	Type	Default	Example	Description
--ss-id	string			Layer ID.
--limit	integer			Maximum number of groups to return (default 10).
--offset	integer			Number of groups to skip (default 0).
--tags	array of string			Filter by tags.

Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.

Output

OK - Activity groups returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
[]._id	string	Activity group ID.
[].statussheet	string	Layer ID this group belongs to.
[].timestamp	string (date-time)	Timestamp of the activity group.
[].tags	array of string	Tags associated with the group.
[].snapshot	string	ID of the associated snapshot (equal to the group ID).
[].items	array of object	Individual activity records within this group.
[].items[]._id	string	Activity record ID.
[].items[].group	string	ID of the activity group this record belongs to.
[].items[].activity	string	Activity type. One of: "NODE_CREATE", "NODE_UPDATE", "NODE_DELETE", "LINK_CREATE", "LINK_UPDATE", "LINK_DELETE", "GROUP_CREATE", "GROUP_UPDATE", "GROUP_DELETE", "ATTACHMENT_CREATE", "ATTACHMENT_UPDATE", "ATTACHMENT_DELETE".
[].items[].metadata	object	Activity-specific payload (structure varies by activity type).
[].items[].timestamp	string (date-time)	Timestamp of the activity.
[].items[].service_type	string	Cloud service type the activity applies to.
[].items[].group_type	string	Activity group sub-type.
[].items[].tags	array of string	Tags associated with the activity.

Raw JSON schema

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "_id",
      "statussheet",
      "timestamp",
      "snapshot"
    ],
    "description": "A snapshot activity group containing the individual activity records that produced it.",
    "properties": {
      "_id": {
        "type": "string",
        "description": "Activity group ID."
      },
      "statussheet": {
        "type": "string",
        "description": "Layer ID this group belongs to."
      },
      "timestamp": {
        "type": "string",
        "format": "date-time",
        "description": "Timestamp of the activity group."
      },
      "tags": {
        "type": "array",
        "description": "Tags associated with the group.",
        "items": {
          "type": "string"
        }
      },
      "snapshot": {
        "type": "string",
        "description": "ID of the associated snapshot (equal to the group ID)."
      },
      "items": {
        "type": "array",
        "description": "Individual activity records within this group.",
        "items": {
          "type": "object",
          "required": [
            "_id",
            "group",
            "activity",
            "timestamp"
          ],
          "description": "An individual activity record within an activity group.",
          "properties": {
            "_id": {
              "type": "string",
              "description": "Activity record ID."
            },
            "group": {
              "type": "string",
              "description": "ID of the activity group this record belongs to."
            },
            "activity": {
              "type": "string",
              "enum": [
                "NODE_CREATE",
                "NODE_UPDATE",
                "NODE_DELETE",
                "LINK_CREATE",
                "LINK_UPDATE",
                "LINK_DELETE",
                "GROUP_CREATE",
                "GROUP_UPDATE",
                "GROUP_DELETE",
                "ATTACHMENT_CREATE",
                "ATTACHMENT_UPDATE",
                "ATTACHMENT_DELETE"
              ],
              "description": "Activity type."
            },
            "metadata": {
              "type": "object",
              "additionalProperties": true,
              "description": "Activity-specific payload (structure varies by activity type)."
            },
            "timestamp": {
              "type": "string",
              "format": "date-time",
              "description": "Timestamp of the activity."
            },
            "service_type": {
              "type": "string",
              "description": "Cloud service type the activity applies to."
            },
            "group_type": {
              "type": "string",
              "description": "Activity group sub-type."
            },
            "tags": {
              "type": "array",
              "description": "Tags associated with the activity.",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.

Related

• list-cloud-diagram-node-activities — List node activities
• list-cloud-diagram-layer-snapshots — List layer snapshots
• get-cloud-diagram-layer-snapshot — Get a layer snapshot
• API reference: GET /clouddiagrams/v1/activity

Aliases: listclouddiagramactivitygroups