See all operations

GET: programs/{program_id}/capabilities/{capability_id}

Description

Retrieves a single program capability from the 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}/capabilities/{capability_id}

Request Parameters

Name	Description
program_id	ID of the program containing this capability
capability_id	ID of the capability 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
CapabilityId	ID of the program capability
ProjectGroupId	ID of the project group which this capability belongs to
MilestoneId	The ID of the Program Milestone this capability belongs to
MilestoneName	The name of the Program Milestone this capability belongs to
StatusId	ID of the capability status this capability has
StatusName	Name of the capability status this capability has
StatusIsOpen	Whether or not this status makes this capability "Open"
TypeId	ID of the capability type this capability has
TypeName	Name of the capability type this capability has
PriorityId	ID of the capability priority this capability has
PriorityName	Name of the capability priority this capability has
Name	Name of this capability
Description	Description of the capability
PercentComplete	Percent Completion of the capability
RequirementCount	Number of requirements associated with this capability
IndentLevel	Indent level of this capability in the hierarchy
Guid	Artifact guid for avoiding concurrency interactions
CreatorId	UserId of the creator of this capability
CreatorName	Full name of the creator of this capability
OwnerId	UserId of the owner of this capability
OwnerName	Full name of the owner of this capability
CreationDate
LastUpdateDate
IsSummary	This Capability represents a summary in the program?
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

<RemoteCapability 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" />
  <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>

{"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}