SpiraPlan: REST Web Service (v7.0)

See all operations

POST: programs/{program_id}/milestones

Description

Creates a new program milestone

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

Request Parameters

Name Description
program_id ID of the program to create this milestone in

Request Body

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
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

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