See all operations
POST: programs/{program_id}/capabilities/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}
Description
Retrieves a sorted list of capabilities in a given program that match the provided filter
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}/capabilities/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 capabilities from
|
|
starting_row
|
What row to start retrieving from (starts at 1)
|
|
number_of_rows
|
Number of rows to retrieve
|
|
sort_field
|
What field to sort on (If left blank, the default is CapabilityId)
|
|
sort_direction
|
Whether or not to sort ascending
|
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.
<ArrayOfRemoteCapability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<RemoteCapability>
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyGuid i:nil="true" />
<CustomProperties i:nil="true" />
<CapabilityId i:nil="true" />
<CreationDate i:nil="true" />
<CreatorId i:nil="true" />
<CreatorName i:nil="true" />
<Description i:nil="true" />
<Guid i:nil="true" />
<IndentLevel i:nil="true" />
<IsSummary>false</IsSummary>
<LastUpdateDate i:nil="true" />
<MilestoneId i:nil="true" />
<MilestoneName i:nil="true" />
<Name i:nil="true" />
<OwnerId i:nil="true" />
<OwnerName i:nil="true" />
<PercentComplete>0</PercentComplete>
<PriorityId i:nil="true" />
<PriorityName i:nil="true" />
<ProjectGroupId>0</ProjectGroupId>
<RequirementCount>0</RequirementCount>
<StatusId>0</StatusId>
<StatusIsOpen i:nil="true" />
<StatusName i:nil="true" />
<TypeId>0</TypeId>
<TypeName i:nil="true" />
</RemoteCapability>
</ArrayOfRemoteCapability>
[{"CapabilityId":null,
"ProjectGroupId":0,
"MilestoneId":null,
"MilestoneName":null,
"StatusId":0,
"StatusName":null,
"StatusIsOpen":null,
"TypeId":0,
"TypeName":null,
"PriorityId":null,
"PriorityName":null,
"Name":null,
"Description":null,
"PercentComplete":0,
"RequirementCount":0,
"IndentLevel":null,
"Guid":null,
"CreatorId":null,
"CreatorName":null,
"OwnerId":null,
"OwnerName":null,
"CreationDate":null,
"LastUpdateDate":null,
"IsSummary":false,
"ArtifactTypeId":0,
"ConcurrencyGuid":null,
"CustomProperties":null}]