StarterTemplate ASP.NET Host

<back to all web services

RequestDefectsAll

Defect Service

The following routes are available for this service:
GET/service/api/v1/projects/{ProjectId}/defectsReturns the list of defects in a projectThe authenticating user must have the Read privilege for Defects.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains defects
OffsetqueryintNoThe number of defects to skip before counting the returned defects
LimitqueryintNoThe maximum number of defects to return
FilterquerystringNoThe filter expression to apply to the list of defects

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestDefectsAll HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestDefectsAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Defects">
  <Filter>String</Filter>
  <Limit>0</Limit>
  <Offset>0</Offset>
  <ProjectId>0</ProjectId>
</RequestDefectsAll>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseDefectsCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Defects">
  <Metadata i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common" />
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Defects" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseSingleDefect>
      <d2p1:ActFinish>0001-01-01T00:00:00</d2p1:ActFinish>
      <d2p1:ActHrs>0</d2p1:ActHrs>
      <d2p1:ActStart>0001-01-01T00:00:00</d2p1:ActStart>
      <d2p1:ActualResults>String</d2p1:ActualResults>
      <d2p1:AssignedToName>String</d2p1:AssignedToName>
      <d2p1:AssigneeUserId>0</d2p1:AssigneeUserId>
      <d2p1:ClosedBy>0</d2p1:ClosedBy>
      <d2p1:ClosedByName>String</d2p1:ClosedByName>
      <d2p1:CustomFields i:nil="true" />
      <d2p1:DateClosed>0001-01-01T00:00:00</d2p1:DateClosed>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateOpened>0001-01-01T00:00:00</d2p1:DateOpened>
      <d2p1:DateResolved>0001-01-01T00:00:00</d2p1:DateResolved>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EstFinish>0001-01-01T00:00:00</d2p1:EstFinish>
      <d2p1:EstHrs>0</d2p1:EstHrs>
      <d2p1:EstHrsRemaining>0</d2p1:EstHrsRemaining>
      <d2p1:EstStart>0001-01-01T00:00:00</d2p1:EstStart>
      <d2p1:ExpectedResults>String</d2p1:ExpectedResults>
      <d2p1:FolderId>0</d2p1:FolderId>
      <d2p1:FolderName>String</d2p1:FolderName>
      <d2p1:FunctionalAreaCode>String</d2p1:FunctionalAreaCode>
      <d2p1:HowFoundCode>String</d2p1:HowFoundCode>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ImportId>0</d2p1:ImportId>
      <d2p1:IssueCode>String</d2p1:IssueCode>
      <d2p1:ModuleCode>String</d2p1:ModuleCode>
      <d2p1:NbrEvents>0</d2p1:NbrEvents>
      <d2p1:NbrFiles>0</d2p1:NbrFiles>
      <d2p1:NbrNotes>0</d2p1:NbrNotes>
      <d2p1:NbrTasks>0</d2p1:NbrTasks>
      <d2p1:NotesDescription>String</d2p1:NotesDescription>
      <d2p1:OpenedBy>0</d2p1:OpenedBy>
      <d2p1:OpenedByCompany>String</d2p1:OpenedByCompany>
      <d2p1:OpenedByEmail>String</d2p1:OpenedByEmail>
      <d2p1:OpenedByName>String</d2p1:OpenedByName>
      <d2p1:OriginCode>String</d2p1:OriginCode>
      <d2p1:OriginalId>0</d2p1:OriginalId>
      <d2p1:OwnerName>String</d2p1:OwnerName>
      <d2p1:OwnerUserId>0</d2p1:OwnerUserId>
      <d2p1:PctComplete>0</d2p1:PctComplete>
      <d2p1:PriorityCode>String</d2p1:PriorityCode>
      <d2p1:ProjectId>0</d2p1:ProjectId>
      <d2p1:Resolution>String</d2p1:Resolution>
      <d2p1:ResolutionCode>String</d2p1:ResolutionCode>
      <d2p1:ResolvedBy>0</d2p1:ResolvedBy>
      <d2p1:ResolvedByName>String</d2p1:ResolvedByName>
      <d2p1:SeverityCode>String</d2p1:SeverityCode>
      <d2p1:SoftwareVersionCode>String</d2p1:SoftwareVersionCode>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:StepsToRepro>String</d2p1:StepsToRepro>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:__permissions>
        <Acl>0</Acl>
      </d2p1:__permissions>
    </d2p1:ResponseSingleDefect>
  </Results>
</ResponseDefectsCollection>