See all operations
POST: project-templates/{project_template_id}/document-statuses
Description
Adds a new document status to the current project template
Only the Name field is required, but to make the new type active you should also include "Active": true
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/v6_0/RestService.svc/project-templates/{project_template_id}/document-statuses
Request Parameters
|
Name
|
Description
|
|
project_template_id
|
The id of the 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
|
<RemoteDocumentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<Active>false</Active>
<Default>false</Default>
<DocumentStatusId i:nil="true" />
<Name i:nil="true" />
<Open>false</Open>
<Position i:nil="true" />
<ProjectTemplateId>0</ProjectTemplateId>
</RemoteDocumentStatus>
{"DocumentStatusId":null,
"ProjectTemplateId":0,
"Name":null,
"Active":false,
"Default":false,
"Open":false,
"Position":null}
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
|
|
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
|
<RemoteDocumentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<Active>false</Active>
<Default>false</Default>
<DocumentStatusId i:nil="true" />
<Name i:nil="true" />
<Open>false</Open>
<Position i:nil="true" />
<ProjectTemplateId>0</ProjectTemplateId>
</RemoteDocumentStatus>
{"DocumentStatusId":null,
"ProjectTemplateId":0,
"Name":null,
"Active":false,
"Default":false,
"Open":false,
"Position":null}