See all operations

GET: programs/{program_id}

Description

Retrieves a particular program by its ID

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}

Request Parameters

Name	Description
program_id	ID of the program 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
WorkspaceTypeId
ProgramId	ID of the program
Name	Name of the program
Description	Description of the program
Website	Website associated with this program
PortfolioId	ID of the portfolio this program belongs to
ProjectTemplateId	Project template ID associated with this program
isActive	Whether or not this program is active
isDefault	Whether or not this program is the default
WorkspaceTypeId	The type of workspace that we have
Guid	The unique identifier for the workspace
LastUpdatedDate	Last time this item was updated
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

<RemoteProgram 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" />
  <Guid i:nil="true" />
  <LastUpdatedDate i:nil="true" />
  <WorkspaceTypeId>0</WorkspaceTypeId>
  <Description i:nil="true" />
  <Name i:nil="true" />
  <PortfolioId i:nil="true" />
  <ProgramId i:nil="true" />
  <ProjectTemplateId i:nil="true" />
  <Website i:nil="true" />
  <WorkspaceTypeId>2</WorkspaceTypeId>
  <isActive>false</isActive>
  <isDefault>false</isDefault>
</RemoteProgram>

{"WorkspaceTypeId":2,
"ProgramId":null,
"Name":null,
"Description":null,
"Website":null,
"PortfolioId":null,
"ProjectTemplateId":null,
"isActive":false,
"isDefault":false,
"Guid":null,
"LastUpdatedDate":null,
"ArtifactTypeId":0,
"ConcurrencyGuid":null,
"CustomProperties":null}