SpiraPlan: REST Web Service (v7.0)

See all operations

POST: programs/{program_id}/capabilities

Description

Creates a new program 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

Request Parameters

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

Request Body

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