Skip to main content

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.

Flags

--ss-id: (string)

--limit: (integer)

--offset: (integer)

--tags: (array)

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.

FieldTypeDescription
[]._idstringActivity group ID.
[].statussheetstringLayer ID this group belongs to.
[].timestampstring (date-time)Timestamp of the activity group.
[].tagsarray of stringTags associated with the group.
[].snapshotstringID of the associated snapshot (equal to the group ID).
[].itemsarray of objectIndividual activity records within this group.
[].items[]._idstringActivity record ID.
[].items[].groupstringID of the activity group this record belongs to.
[].items[].activitystringActivity 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[].metadataobjectActivity-specific payload (structure varies by activity type).
[].items[].timestampstring (date-time)Timestamp of the activity.
[].items[].service_typestringCloud service type the activity applies to.
[].items[].group_typestringActivity group sub-type.
[].items[].tagsarray of stringTags 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 statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.

Aliases: listclouddiagramactivitygroups