Skip to content

ActivityResponseDto

Endpoints · All schemas

FieldRequiredDescription
assetIdYesAsset ID (if activity is for an asset)
commentNoComment text (for comment activities)
createdAtYesCreation date
idYesActivity ID
typeYesSee definition below
userYesSee definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: ReactionType, UserResponseDto

{
  "properties": {
    "assetId": {
      "description": "Asset ID (if activity is for an asset)",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "comment": {
      "description": "Comment text (for comment activities)",
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "description": "Creation date",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "id": {
      "description": "Activity ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/ReactionType"
    },
    "user": {
      "$ref": "#/components/schemas/UserResponseDto"
    }
  },
  "required": [
    "assetId",
    "createdAt",
    "id",
    "type",
    "user"
  ],
  "type": "object"
}