Skip to main content

Log

A Log represents a meaningful record of something that happened during project execution. The log data model contains the information CTX uses to describe the event, record when it happened, classify it, and determine whether it belongs to a specific session or task.

Fields​

FieldTypeRequiredDescription
idIdentifierYesUnique identifier for the log.
noteStringYesThe content of the log.
timestampDateYesTimestamp at which the log was recorded.
tagEnumYesClassification of the log.
referenceTypeEnumNoType of execution record referenced by the log.
referenceIdIdentifierNoIdentifier of the referenced session or task.

Field Details​

id​

  • The log identifier uniquely identifies the log within the project context.
  • It is generated when the log is created and does not change during its lifetime.

note​

  • note contains the actual information recorded by the log.
  • A note should normally describe a single event, observation, idea, issue, or attempt.
  • It is required and limited to 300 characters.

timestamp​

  • timestamp records when the log was created.
  • The value is stored as UTC and is used to preserve the chronological order of project execution.

tag​

  • tag identifies the kind of information captured by the log.

  • Supported values are:

    ValueMeaning
    NOTEA general observation or useful piece of information.
    IDEAA possible improvement, approach, or thought worth preserving.
    ISSUEA problem or unexpected behavior encountered during work.
    ATTEMPTAn approach that was tried during execution.
  • The tag describes the nature of the message without changing its content.

referenceType​

  • referenceType identifies the kind of project record referenced by the log.

  • Supported values are:

    ValueMeaning
    SESSIONThe log references a project session.
    TASKThe log references a task.
  • The field is optional.

referenceId​

  • referenceId identifies the specific session or task referenced by the log.
  • It is used together with referenceType to indicate which record the log is associated with.