Skip to main content

Session

A Session represents a continuous period of active work on a project. The session data model contains the information CTX uses to identify the session, describe its purpose, track its lifecycle, and determine whether it is currently active.

Fields​

FieldTypeRequiredDescription
idIdentifierYesUnique identifier for the session.
notesStringNoShort notes describing the purpose or context of the session.
createdAtDateYesTimestamp at which the session started.
endedAtDateNoTimestamp at which the session ended. null while the session is active.
statusEnumYesCurrent state of the session: ACTIVE or INACTIVE.

Field Details​

id​

  • The session identifier uniquely identifies a session within the project context.
  • The identifier is generated when the session is created and does not change during the session's lifetime.

notes​

  • Session notes provide a short description of what the session is about.
  • They are optional and limited to 300 characters.

createdAt​

  • createdAt records when the session starts. It is always present for a valid session.
  • The timestamp is stored in UTC. CTX uses the configured time representation when displaying the timestamp.

endedAt​

  • endedAt records when the session ends.
  • The field remains null while the session is active.
  • The timestamp is stored in UTC. CTX uses the configured time representation when displaying the timestamp.

status​

  • The session status indicates whether the session is currently active.

  • Supported values are:

    ValueMeaning
    ACTIVEThe session is currently active.
    INACTIVEThe session has ended.
  • A project can have at most one ACTIVE session at a time.