← API reference
CANONICAL TYPE REFERENCE

MilestoneState

A milestone within a job (optionally scoped to a component)

Unique identifier

Parent job ID

Component scope (null if the milestone is job-wide)

External system identifier

External id of the record marking this milestone's start, for systems that track start and completion as separate records. Unique per tenant.

External id of the record marking this milestone's completion, for systems that track start and completion as separate records. Unique per tenant.

nameString!

Milestone name

Milestone description

Date the milestone is due to start (ISO8601)

Start date (ISO8601). Independent of completedAt: neither implies the other.

Due date (ISO8601)

Completion date (ISO8601)

Cancellation date (ISO8601)

Operator-supplied reason for cancellation

isStartedBoolean!

Whether the milestone has been started

isCompletedBoolean!

Whether the milestone has been completed

isCancelledBoolean!

Whether the milestone has been cancelled

Sort order within the job

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

Parent job. Requires job:read permission.

Scoping component (null when the milestone is job-wide). Requires component:read permission.

View exact SDL
"""A milestone within a job (optionally scoped to a component)"""
type MilestoneState {
  """Unique identifier"""
  id: MilestoneID!
  """Parent job ID"""
  jobId: JobID!
  """Component scope (null if the milestone is job-wide)"""
  componentId: ComponentID
  """External system identifier"""
  externalId: String
  """
  External id of the record marking this milestone's start, for systems that track start and completion as separate records. Unique per tenant.
  """
  externalStartId: String
  """
  External id of the record marking this milestone's completion, for systems that track start and completion as separate records. Unique per tenant.
  """
  externalCompletionId: String
  """Milestone name"""
  name: String!
  """Milestone description"""
  description: String
  """Date the milestone is due to start (ISO8601)"""
  startDueAt: ISO8601
  """
  Start date (ISO8601). Independent of completedAt: neither implies the other.
  """
  startedAt: ISO8601
  """Due date (ISO8601)"""
  dueAt: ISO8601
  """Completion date (ISO8601)"""
  completedAt: ISO8601
  """Cancellation date (ISO8601)"""
  cancelledAt: ISO8601
  """Operator-supplied reason for cancellation"""
  cancelReason: String
  """Whether the milestone has been started"""
  isStarted: Boolean!
  """Whether the milestone has been completed"""
  isCompleted: Boolean!
  """Whether the milestone has been cancelled"""
  isCancelled: Boolean!
  """Sort order within the job"""
  sortOrder: Int!
  """Creation timestamp (ISO8601)"""
  createdAt: String!
  """Last update timestamp (ISO8601)"""
  updatedAt: String!
  """Parent job. Requires job:read permission."""
  job: JobState
  """
  Scoping component (null when the milestone is job-wide). Requires component:read permission.
  """
  component: ComponentState
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.