Skip to main content

DesAnnotation

Annotation is like a sticky note you can place in the design, attaching it to design entities (e.g. schematic document, BOM line, design review, etc.). Annotation is a high-level concept that represents different facets of collaboration on the platform - comment threads, tasks to be completed, links or references to other related entities.

type DesAnnotation {
  bindings: [DesAnnotationBinding!]!
  createdAt: DateTime
  createdBy: DesAnnotationUser
  id: String!
  requirements: DesAnnotationRequirements
  updatedAt: DateTime
  updatedBy: DesAnnotationUser
  url: String
}

Fields​

DesAnnotation.bindings ● [DesAnnotationBinding!]! non-null union​

Bindings define the 'location' of the annotation, its 'address' in context of the design.

DesAnnotation.createdAt ● DateTime scalar​

DesAnnotation.createdBy ● DesAnnotationUser object​

DesAnnotation.id ● String! non-null scalar​

DesAnnotation.requirements ● DesAnnotationRequirements object​

Requirements, associated with the annotation.

DesAnnotation.updatedAt ● DateTime scalar​

DesAnnotation.updatedBy ● DesAnnotationUser object​

DesAnnotation.url ● String scalar​

Deep link to the annotation - can be used to navigate to the annotation in the context of its placement.