System metadata

Standard system-level metadata about a record.

SystemMetadata

Standard system-level metadata about a given record.

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

Example

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

JSON Schema

$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
examples:
  - createdAt: 2025-01-01T17:01:01
    lastModifiedAt: 2025-01-02T17:30:00
description: Standard system-level metadata about a given record.

TypeSpec

/** Standard system-level metadata about a given record.
 *
 * @example How to spread the SystemMetadata props into another record
 *
 * ```typespec
 * model Application {
 *   id: uuid;
 *   title: string;
 *
 *   // Includes SystemMetadata props in the root of the Application model
 *   ...SystemMetadata;
 * }
 * ```
 */
@example(Examples.Metadata.system)
@Versioning.added(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;
}