Build Summary Object

The build summary object is a child object to a $Configuration object with full properties as used some expandable server-side fields - see Configuration Object. This object describes the properties under $Configuration.LastBuild and $Configuration.LastFinishedBuild.

Name Description Type Usage Example
ArtifactCount The number of artifacts registered with the build Integer $Configuration.LastBuild.ArtifactCount$ 2
Branches A collection of repository branch names associated with the build String Collection $Configuration.LastBuild.Branches$ "master","f-super-fast-expression-parser"
BuildNumber A zero-based auto-incremented integer allocated to the build (the first build will be build 0, the second build 1, etc) Integer $Configuration.LastBuild.BuildNumber$ 42
ChangesetCount The number of repository changesets associated with the build Integer $Configuration.LastBuild.ChangesetCount$ 2
Created The date/time that the build was initiated DateTime $Configuration.LastBuild.Created$ "9/11/2018 9:52:40 AM"
Finished The date/time that the build finished DateTime $Configuration.LastBuild.Finished$ "9/11/2018 9:52:45 AM"
FirstTagName The name of the first user build tag (i.e. not changeset tag) associated with the build String $Configuration.LastBuild.FirstTagName$ "Tag1"
HasErroredStages True when an error has been logged in any of the build stages Boolean $Configuration.LastBuild.HasErroredStages$ False
HasFailedStages True when any of the build stages has failed Boolean $Configuration.LastBuild.HasFailedStages$ False
HasSuccessfulStages True when any of the build stages has been successful Boolean $Configuration.LastBuild.HasSuccessfulStages$ True
HasWarnings True when a warning has been logged in any of the build stages Boolean $Configuration.LastBuild.HasWarnings$ False
Id A unique integer allocated automatically to this build Integer $Configuration.LastBuild.Id$ 474
IsPinned True when the build has been pinned by a user Boolean $Configuration.LastBuild.IsPinned$ True
PinComment The contents of any pin comment String $Configuration.LastBuild.PinComment$ "This build is important"
Pinned The date/time when the build was pinned DateTime $Configuration.LastBuild.Pinned$ "9/11/2018 9:52:50 AM"
PinnedBy The user who pinned the build User $Configuration.LastBuild.PinnedBy$ "jbloggs"
Started The date/time when the first build stage started executing DateTime $Configuration.LastBuild.Started$ "9/11/2018 9:59:43 AM"
StartedBy A user who started the build User $Configuration.LastBuild.StartedBy$ "jbloggs"
State A value indicating the current status of the build String $Configuration.LastBuild.State$ "BuildCompleted"
SummaryState A value summarising the current status of the build String $Configuration.LastBuild.SummaryState$ "Finished"
TagCount The number of user build tags (i.e. not changeset tags) associated with the build Integer $Configuration.LastBuild.TagCount$ 2
TriggerName The name of any trigger that started the build String $Configuration.LastBuild.TriggerName$ "Trigger1"
Version A reference to the build version Version $Configuration.LastBuild.Version$ " 1.2.3.44"