See all operations
POST: programs/{program_id}/capabilities/{capability_id}/requirements?current_page={current_page}&page_size={page_size}
Description
Retrieves a paginated list of requirement associations for a given capability
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/{capability_id}/requirements?current_page={current_page}&page_size={page_size}
Request Parameters
|
Name
|
Description
|
|
program_id
|
Program containing the relevant capability
|
|
capability_id
|
Capability to get requirement associations for
|
|
page_size
|
Number of associations to retrieve per API call
|
|
current_page
|
What page you want to retrieve
|
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.
<ArrayOfRemoteAssociation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<RemoteAssociation>
<ConcurrencyGuid i:nil="true" />
<Guid i:nil="true" />
<LastUpdateDate i:nil="true" />
<ArtifactLinkId i:nil="true" />
<ArtifactLinkTypeId>0</ArtifactLinkTypeId>
<ArtifactLinkTypeName i:nil="true" />
<Comment i:nil="true" />
<CreationDate i:nil="true" />
<CreatorId i:nil="true" />
<CreatorName i:nil="true" />
<DestArtifactGuid i:nil="true" />
<DestArtifactId>0</DestArtifactId>
<DestArtifactName i:nil="true" />
<DestArtifactTypeId>0</DestArtifactTypeId>
<DestArtifactTypeName i:nil="true" />
<SourceArtifactGuid i:nil="true" />
<SourceArtifactId>0</SourceArtifactId>
<SourceArtifactTypeId>0</SourceArtifactTypeId>
</RemoteAssociation>
</ArrayOfRemoteAssociation>
[{"ArtifactLinkId":null,
"SourceArtifactId":0,
"SourceArtifactTypeId":0,
"SourceArtifactGuid":null,
"DestArtifactId":0,
"DestArtifactTypeId":0,
"DestArtifactGuid":null,
"ArtifactLinkTypeId":0,
"CreatorId":null,
"Comment":null,
"CreationDate":null,
"DestArtifactName":null,
"DestArtifactTypeName":null,
"CreatorName":null,
"ArtifactLinkTypeName":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}]