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 field is:

{
  "createdAt": "2024-02-28T12:00:00Z",
  "lastModifiedAt": "2024-02-28T12:00:00Z"
}

JSON Schema

The JSON schema for this field is:

$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
description: System-managed metadata for records

TypeSpec

The TypeSpec code for this field is:

/** System-managed metadata for records */
model SystemMetadata {
  /** The timestamp (in UTC) at which the record was created */
  @visibility(Lifecycle.Read)
  createdAt: isoDatetime;

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

Python

The Python code for this field is:

from datetime import datetime, timezone
from common_grants_sdk.schemas.fields import SystemMetadata

metadata = SystemMetadata(
    created_at=datetime(2024, 2, 28, 12, 0, 0, tzinfo=timezone.utc),
    last_modified_at=datetime(2024, 2, 28, 12, 0, 0, tzinfo=timezone.utc)
)