AnnotationTP

Operators, automated processes, and other members of the organization may use the MachineMetrics Operator Dashboard or Timeline in product to identify periods of downtime, label it, and provide additional context through comments. A Annotation is the data model backing a Categorized Downtime.

type AnnotationTP {
  annotationRef: Int
  annotationType: AnnotationTypeTP
  companyId: String
  description: String
  endAt: timestamptz
  isPlanned: Boolean
  machine: MachineTP
  machineRef: Int
  startAt: timestamptz
}

Fields

AnnotationTP.annotationRef ● Int scalar

A unique, numeric identifier for the annotation.

AnnotationTP.annotationType ● AnnotationTypeTP object

AnnotationTP.companyId ● String scalar

A globally unique identifier (UUID) for the company.

AnnotationTP.description ● String scalar

AnnotationTP.endAt ● timestamptz scalar

The end of an interval. Intervals are right-exclusive.

AnnotationTP.isPlanned ● Boolean scalar

AnnotationTP.machine ● MachineTP object

The machine the event originates from.

AnnotationTP.machineRef ● Int scalar

A unique, numeric identifier for the machine.

AnnotationTP.startAt ● timestamptz scalar

The start of an interval.

Returned By

annotations query

Member Of

AnnotationTypeTP object ● business_machine object ● MachineTP object