SpiraPlan: REST Web Service (v7.0)

See all operations

PUT: project-templates/{project_template_id}/releases/workflows/{workflow_id}/fields/{release_status_id}


Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields

FieldStateId determines the state of a given field. Here are the potential values 0 = Default (No workflow restrictions) 1 = Disabled 2 = Required 3 = Hidden

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 template containing the relevant workflow
workflow_id Id of the workflow to be modified
release_status_id Id of the status the field states are being set for

Request Body

Property Description

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.