SpiraPlan: REST Web Service (v7.0)

See all operations

GET: project-templates/{project_template_id}/documents/workflows/{workflow_id}


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):


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

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