โ† API reference
Query / jobs

getMilestoneBy

Fetch a milestone by any of its external ids. Every supplied id must match; with none, returns null. Requires milestone:read permission.

Arguments

externalIdString

External system identifier

externalStartIdString

External id of the record marking the start

externalCompletionIdString

External id of the record marking the completion

Returns MilestoneState

Scalar fields at a glance

jobIdJobID!
componentIdComponentID
externalIdString
externalStartIdString
externalCompletionIdString
โ†— View the complete MilestoneState type

Explore in a view

Production Floor
View exact SDL
"""
Fetch a milestone by any of its external ids. Every supplied id must match; with none, returns null. Requires milestone:read permission.
"""
getMilestoneBy(
  """External system identifier"""
  externalId: String
  """External id of the record marking the start"""
  externalStartId: String
  """External id of the record marking the completion"""
  externalCompletionId: String
): MilestoneState @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.