SpiraPlan: REST Web Service (v7.0)

See all operations

PUT: project-templates/{project_template_id}/documents/workflows/{workflow_id}/custom-properties/{document_status_id}


Updates workflow custom property states for a given artifact status + workflow

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 Product template containing the workflow

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.