See all operations
POST: programs/{program_id}/milestones/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}
Description
Retrieves pages of the milestones within a program
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/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}
Request Parameters
|
Name
|
Description
|
|
program_id
|
ID of the program to retrieve milestones from
|
|
starting_row
|
What row to start retrieving from
|
|
number_of_rows
|
Number of rows to retrieve
|
|
sort_field
|
What field to sort on (If left blank, the default is MilestoneId)
|
|
sort_direction
|
What direction to sort in (ASC/DESC) (Default ASC)
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"PropertyName":null,
"IntValue":null,
"StringValue":null,
"MultiValue":null,
"DateRangeValue":null}]
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.
<ArrayOfRemoteProgramMilestone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<RemoteProgramMilestone>
<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>
</ArrayOfRemoteProgramMilestone>
[{"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}]