SystemMetadata

System-managed metadata that is automatically added to records.

Table

Property	Type	Required	Description
createdAt	utcDateTime	Yes	The timestamp (in UTC) at which the record was created.
lastModifiedAt	utcDateTime	Yes	The timestamp (in UTC) at which the record was last modified.

Formats

Example

A JSON example of this model.

{
  "createdAt": "2025-01-01T17:01:01",
  "lastModifiedAt": "2025-01-02T17:30:00"
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: SystemMetadata.yaml
type: object
properties:
  createdAt:
    type: string
    format: date-time
    description: The timestamp (in UTC) at which the record was created.
  lastModifiedAt:
    type: string
    format: date-time
    description: The timestamp (in UTC) at which the record was last modified.
required:
  - createdAt
  - lastModifiedAt
unevaluatedProperties:
  not: {}
examples:
  - createdAt: 2025-01-01T17:01:01
    lastModifiedAt: 2025-01-02T17:30:00
description: Standard system-level metadata about a given record.

TypeSpec

The TypeSpec code for this model.

@example(Examples.Metadata.system)
@Versioning.added(CommonGrants.Versions.v0_1)
model SystemMetadata {
  /** The timestamp (in UTC) at which the record was created. */
  @visibility(Lifecycle.Read)
  createdAt: utcDateTime;

  /** The timestamp (in UTC) at which the record was last modified. */
  @visibility(Lifecycle.Read)
  lastModifiedAt: utcDateTime;
}

Python

The Python code for this model.

class SystemMetadata(CommonGrantsBaseModel):
    """System-managed metadata fields for tracking record creation and modification."""

    created_at: UTCDateTime = Field(
        ...,
        alias="createdAt",
        description="The timestamp (in UTC) at which the record was created.",
    )
    last_modified_at: UTCDateTime = Field(
        ...,
        alias="lastModifiedAt",
        description="The timestamp (in UTC) at which the record was last modified.",
    )

TypeScript

The TypeScript code for this model.

export const SystemMetadataSchema = z.object({
  /** The timestamp (in UTC) at which the record was created */
  createdAt: UTCDateTimeSchema,

  /** The timestamp (in UTC) at which the record was last modified */
  lastModifiedAt: UTCDateTimeSchema,
});

Changelog

Version	Changes	Schema
0.1.0	Added SystemMetadata model	SystemMetadata.yaml