See all operations

GET: project-templates/{project_template_id}/document-types/default

Description

Retrieves the default document type for the current project template

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-types/default

Request Parameters

Name	Description
project_template_id	The project template id

Request Body

Nothing Expected

Nothing Expected

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
DocumentTypeId	The id of the document type
ProjectTemplateId	The id of the project template that the type belongs to
Name	The name of the document type.
Description	The description of the document type. Optional
Active	Is this type active
Default	Is this the default type for the project

<RemoteDocumentType 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>
  <Description i:nil="true" />
  <DocumentTypeId i:nil="true" />
  <Name i:nil="true" />
  <ProjectTemplateId>0</ProjectTemplateId>
</RemoteDocumentType>

{"DocumentTypeId":null,
"ProjectTemplateId":0,
"Name":null,
"Description":null,
"Active":false,
"Default":false}