See all operations

GET: programs/{program_id}/milestones/{milestone_id}

Description

Retrieves 1 program milestone by ID

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/Spira/Services/v7_0/RestService.svc/programs/{program_id}/milestones/{milestone_id}

Request Parameters

Name	Description
program_id	ID of the program containing this milestone
milestone_id	ID of the milestone to be retrieved

Request Body

Nothing Expected

Nothing Expected

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property	Description
MilestoneId	ID of the program milestone
Guid	Artifact guid for unique identification of an artifact
CreatorId	UserId of the creator of this milestone
CreatorName	Full name of the creator of this milestone
OwnerId	UserId of the owner of this milestone
OwnerName	Full name of the owner of this milestone
StatusId	ID of the program milestone status this milestone has
StatusIsOpen	Whether or not this status makes this milestone "Open"
StatusName	Name of the milestone status this milestone has
TypeId	ID of the program milestone type this milestone has
TypeName	Name of the program milestone type this milestone has
Name	Name of this milestone
Description	Description of the milestone
ProjectGroupId	ID of the project group which this milestone belongs to
ProjectGroupName	Name of the project group this milestone belongs to
StartDate	Start date of this milestone
ChildrenStartDate	Earliest start date of this milestone's children releases
EndDate	End date of this milestone
ChildrenEndDate	Earliest end date of this milestone's children releases
CreationDate
LastUpdateDate
PercentComplete	Percent of the associated capabilities which are completed
ReleaseCount	Number of releases associated with this milestone
RequirementCount	Number of requirements which are within the child releases
ArtifactTypeId	The type of artifact that we have
ConcurrencyGuid	The field used to track optimistic concurrency to prevent edit conflicts It's a GUID, but we use the string representation to make compatibility easier
CustomProperties	The list of associated custom properties/fields for this workspace

<RemoteProgramMilestone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyGuid i:nil="true" />
  <CustomProperties i:nil="true" />
  <ChildrenEndDate i:nil="true" />
  <ChildrenStartDate i:nil="true" />
  <CreationDate i:nil="true" />
  <CreatorId i:nil="true" />
  <CreatorName i:nil="true" />
  <Description i:nil="true" />
  <EndDate i:nil="true" />
  <Guid i:nil="true" />
  <LastUpdateDate i:nil="true" />
  <MilestoneId i:nil="true" />
  <Name i:nil="true" />
  <OwnerId i:nil="true" />
  <OwnerName i:nil="true" />
  <PercentComplete>0</PercentComplete>
  <ProjectGroupId>0</ProjectGroupId>
  <ProjectGroupName i:nil="true" />
  <ReleaseCount>0</ReleaseCount>
  <RequirementCount>0</RequirementCount>
  <StartDate i:nil="true" />
  <StatusId i:nil="true" />
  <StatusIsOpen i:nil="true" />
  <StatusName i:nil="true" />
  <TypeId i:nil="true" />
  <TypeName i:nil="true" />
</RemoteProgramMilestone>

{"MilestoneId":null,
"Guid":null,
"CreatorId":null,
"CreatorName":null,
"OwnerId":null,
"OwnerName":null,
"StatusId":null,
"StatusIsOpen":null,
"StatusName":null,
"TypeId":null,
"TypeName":null,
"Name":null,
"Description":null,
"ProjectGroupId":0,
"ProjectGroupName":null,
"StartDate":null,
"ChildrenStartDate":null,
"EndDate":null,
"ChildrenEndDate":null,
"CreationDate":null,
"LastUpdateDate":null,
"PercentComplete":0,
"ReleaseCount":0,
"RequirementCount":0,
"ArtifactTypeId":0,
"ConcurrencyGuid":null,
"CustomProperties":null}