{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-audit-pkg-v-activity-schema.json",
  "title": "FinanceKey.Entity.AuditPkg.v_Activity",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-audits-api-openapi.yml#/components/schemas/FinanceKey.Entity.AuditPkg.v_Activity",
  "required": [
    "activityId",
    "badgeCaption",
    "badgeImage",
    "description"
  ],
  "type": "object",
  "properties": {
    "createdById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that created the initial record.",
      "format": "int32",
      "readOnly": true
    },
    "createdOn": {
      "type": "string",
      "description": "The date and time the record was initially created.",
      "format": "date-time",
      "readOnly": true
    },
    "updatedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that last modified the record.",
      "format": "int32",
      "readOnly": true
    },
    "updateOn": {
      "type": "string",
      "description": "The date and time the record was last modified.",
      "format": "date-time",
      "readOnly": true
    },
    "closedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that deactivated and closed the record.",
      "format": "int32",
      "readOnly": true
    },
    "closedOn": {
      "type": "string",
      "description": "The date and time the record is to be considered as inactive and closed.",
      "format": "date-time",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "description": "A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date.",
      "readOnly": true
    },
    "rowVersion": {
      "type": [
        "string",
        "null"
      ],
      "description": "A unique version stamp of the record.",
      "format": "byte",
      "readOnly": true
    },
    "sessionId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The identity of the session that last modified the record.",
      "readOnly": true
    },
    "activityId": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string",
      "description": "The **ActivityId** field is a primary key in the **Activity** table, designed to uniquely identify each activity record. It has a data type of **nvarchar** with a maximum length of 32 characters, allowing for the storage of alphanumeric identifiers. This ensures that each activity can be distinctly referenced and efficiently retrieved within the database. The use of nvarchar accommodates a wide range of character sets, providing flexibility for internationalization and special characters."
    },
    "name": {
      "maxLength": 32,
      "type": [
        "string",
        "null"
      ],
      "description": "The 'Name' field in the 'Activity' table is of the data type `nvarchar` with a maximum length of 32 characters. This field is designed to store textual identifiers for activities, allowing for the inclusion of Unicode characters to support a wide range of languages and symbols."
    },
    "description": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string",
      "description": "A brief textual overview of the activity, allowing for up to 128 characters of alphanumeric input, providing context and details about the specific activity recorded in the database."
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    },
    "badgeId": {
      "maxLength": 32,
      "type": [
        "string",
        "null"
      ],
      "description": "The `BadgeId` field in the `Activity` table is an `nvarchar` data type designed to store a unique identifier for badges, with a maximum length of 32 characters. This field is intended to facilitate tracking and referencing specific badges associated with activities, ensuring efficient data management and retrieval."
    },
    "badgeCaption": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string",
      "description": "The `BadgeCaption` field is an `nvarchar` data type with a maximum length of 32 characters in the `Activity` table. This field is designed to store a brief descriptive label or caption for a badge associated with a specific activity, providing a concise identification that enhances user engagement and recognition."
    },
    "badgeImage": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "Stores the Image of the Badge that should be displayed for the Activity."
    },
    "categoryId": {
      "maxLength": 450,
      "type": [
        "string",
        "null"
      ],
      "description": "**Description:** The `CategoryId` field in the `Activity` table is an nvarchar data type, allowing for alphanumeric characters with a maximum length of 450. This field is used to store unique identifiers for different categories associated with each activity entry, enabling efficient grouping and retrieval of related activities based on category classifications."
    },
    "categorySelectStringValueId": {
      "maxLength": 450,
      "type": [
        "string",
        "null"
      ],
      "description": "The `CategorySelectStringValueId` field in the `Activity` table is designed to store a string identifier that links an activity to a specific category within a defined selection framework. This field utilizes the `nvarchar` data type, allowing for the storage of Unicode characters, accommodating a diverse range of category names and identifiers. With a maximum length of 450 characters, the `CategorySelectStringValueId` can capture detailed category descriptions or identifiers, ensuring flexibility for various applications and localization needs while maintaining data integrity and structure within the activity categorization system."
    },
    "categoryBadgeImage": {
      "maxLength": 256,
      "type": [
        "string",
        "null"
      ],
      "description": "**CategoryBadgeImage:** A string field that holds the URL or file path of an image representing the category badge associated with the activity. The field supports Unicode characters and has a maximum length of 256 characters. This image visually distinguishes the category of the activity in user interfaces and reports."
    },
    "categoryDescription": {
      "maxLength": 256,
      "type": [
        "string",
        "null"
      ],
      "description": "The `CategoryDescription` field is intended to store a brief textual description of the category associated with an activity. It is of data type `nvarchar` to accommodate Unicode characters, allowing for the inclusion of various languages and special characters. The maximum length is set to 256 characters, providing sufficient space to convey meaningful information while ensuring concise and clear categorization of activities within the `Activity` table."
    }
  },
  "additionalProperties": false
}