SpiraPlan: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/incidents/statuses

Description

Creates a new incident status in the specified project 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):

https://api.inflectra.com/spira/services/v5_0/RestService.svc/projects/{project_id}/incidents/statuses

Request Parameters

Name Description
project_id The id of the project

Request Body

Property Description
IncidentStatusId The id of the incident status (integer)
Name The name of the incident status (string)
Active Whether this status is active or not (boolean)
Open Whether this status is considered an 'open' status or not (boolean)

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
IncidentStatusId The id of the incident status (integer)
Name The name of the incident status (string)
Active Whether this status is active or not (boolean)
Open Whether this status is considered an 'open' status or not (boolean)