SpiraPlan: REST Web Service (v7.0)

See all operations

PUT: project-templates/{project_template_id}/document-statuses


Updates a document status in the system

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 The id of the current project template

Request Body

Property Description
DocumentStatusId The id of the incident status (integer)
ProjectTemplateId The id of the project template that the status belongs to
Name The name of the incident status (string)
Active Whether this status is active or not (boolean)
Default Whether this status is default or not (boolean)
Open Whether this status is considered an 'open' status or not (boolean)
Position The display position of this status
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

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.