See all operations
POST: projects/{project_id}/incidents/types
Description
Creates a new incident type 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/types
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the project
|
Request Body
|
Property
|
Description
|
|
IncidentTypeId
|
The id of the incident type (integer)
|
|
Name
|
The name of the incident type (string)
|
|
Active
|
Whether the incident type is active or not (boolean)
|
|
Issue
|
Should incidents of this type appear in the 'Top Open Issues' section (boolean)
|
|
Risk
|
Should incidents of this type appear in the 'Top Open Issues' section (boolean)
|
|
WorkflowId
|
The id of the workflow the incidents are associated with (integer)
|
<RemoteIncidentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<Active>false</Active>
<IncidentTypeId i:nil="true" />
<Issue>false</Issue>
<Name i:nil="true" />
<Risk>false</Risk>
<WorkflowId>0</WorkflowId>
</RemoteIncidentType>
{"Active":false,
"IncidentTypeId":null,
"Issue":false,
"Name":null,
"Risk":false,
"WorkflowId":0}��������������������������������������������������������������������������������������������������������������������������������������������������������������������
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
|
|
IncidentTypeId
|
The id of the incident type (integer)
|
|
Name
|
The name of the incident type (string)
|
|
Active
|
Whether the incident type is active or not (boolean)
|
|
Issue
|
Should incidents of this type appear in the 'Top Open Issues' section (boolean)
|
|
Risk
|
Should incidents of this type appear in the 'Top Open Issues' section (boolean)
|
|
WorkflowId
|
The id of the workflow the incidents are associated with (integer)
|
<RemoteIncidentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<Active>false</Active>
<IncidentTypeId i:nil="true" />
<Issue>false</Issue>
<Name i:nil="true" />
<Risk>false</Risk>
<WorkflowId>0</WorkflowId>
</RemoteIncidentType>
{"Active":false,
"IncidentTypeId":null,
"Issue":false,
"Name":null,
"Risk":false,
"WorkflowId":0}��������������������������������������������������������������������������������������������������������������������������������������������������������������������