See all operations

GET: project-templates/{project_template_id}/test-cases/workflows/{workflow_id}

Description

Retrieves a single workflow object 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/project-templates/{project_template_id}/test-cases/workflows/{workflow_id}

Request Parameters

Name	Description
project_template_id	Id of the Project template to retrieve workflows from
workflow_id	Id of the workflow 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
WorkflowId	Id of the workflow being retrieved / updated / deleted
Name	Name of the workflow this object represents
IsActive	Is this workflow active in this template
IsDefault	Is this workflow the default for this template
NotifyForTransitions	Incidents Only: Should transitions within this workflow notify (send emails) to relevant users
Guid	The unique identifier for the artifact
ConcurrencyGuid	GUID for representing the concurrency state of a given artifact
LastUpdateDate	Last time the artifact was updated

<RemoteWorkflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ConcurrencyGuid i:nil="true" />
  <Guid i:nil="true" />
  <LastUpdateDate i:nil="true" />
  <IsActive>false</IsActive>
  <IsDefault>false</IsDefault>
  <Name i:nil="true" />
  <NotifyForTransitions i:nil="true" />
  <WorkflowId>0</WorkflowId>
</RemoteWorkflow>

{"WorkflowId":0,
"Name":null,
"IsActive":false,
"IsDefault":false,
"NotifyForTransitions":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}