 |
Since release 10.2, this functionality is obsolete and is supported for backward compatibility only. We recommend that you use QAComplete REST API to access and manage data in QAComplete. |
A Bug object represents a defect in QAComplete. Using QAComplete SOAP API, you can add, enumerate, update and delete defects.
Some string property values (for example, StatusCode) are based on choice lists defined in your QAComplete project. You can find these values in Defects > Show Defects > Actions > Manage Choice Lists.
Requirements
To manage defects, the web service user must be in a security group that has the corresponding privileges – Read, Add, Update, or Delete– for Defects. You can view or set these privileges in > Setup > Security > Security Groups > Manage Security Rights > select user group.
Properties
Custom1 … Custom10 : string (max 8000 chars)
Values of custom fields 1 to 10.
Custom11 … Custom90 : string (max 100 chars)
Values of custom fields 11 to 90.
CustomFieldName1 … CustomFieldName90 : string (max 30 chars)
The names of custom fields.
CustomFields : array of strings
An array of custom field values.
CustomFieldNames : array of strings
An array of custom field names.
BugId : integer
Unique identifier of the defect.
Title : string (max 255 chars)
The defect title (subject).
XML entities in the title are double encoded:
& – &
< – &#60;
> – &#62;
StatusCode : string (max 100 chars)
The defect status based on a choice list.
SeverityCode : string (max 100 chars)
The defect severity based on a choice list. Default value: empty string.
PriorityCode : string (max 100 chars)
The defect severity based on a choice list. Default value: empty string.
SoftwareVersionCode : string (max 100 chars)
The project version that the defect affects. This value is based on a choice list.
HowFoundCode : string (max 100 chars)
How the defect was found. This value is based on a choice list.
ModuleCode : string (max 100 chars)
The module where the defect was found. This value is based on a choice list.
FunctionalAreaCode : string (max 100 chars)
The functional area where the defect was found. This value is based on a choice list.
IssueCode : string (max 100 chars)
The defect type based on a choice list.
ResolutionCode : string (max 100 chars)
The defect’s resolution status based on a choice list.
AssigneeUserId : integer
The ID of the user the defect is assigned to, or 0 if the defect is not assigned to anyone.
OpenedBy : integer
The ID of the user who created the defect.
ClosedBy : integer
The ID of the user who closed the defect, or 0 if the defect is not closed.
ResolvedBy : integer
The ID of the user who marked the defect as resolved, or 0 if the defect is not resolved.
Description : string
Long description of the defect. Can include HTML markup. Default value: empty string.
StepsToRepro : string
Steps to reproduce the defect. Can include HTML markup. Default value: empty string.
ExpectedResults : string
Expected results of the software if it did not have this defect. Can include HTML markup. Default value: empty string.
Resolution : string
The defect’s resolution details. Can include HTML markup. Default value: empty string.
OwnerUserId : integer
The ID of the user who owns the defect.
TypeCode : string
Reserved.
OriginCode : string
Reserved.
TestCaseId : integer
The ID of the test case attached to the defect. Default is 0, meaning no attached test case.
FolderId : integer
The ID of the folder containing the defect, or 0 if the defect is not in any folder.
EstHrs : decimal
Estimated hours to fix the defect. Default: 0.
EstStart : dateTime
Estimated start date for working on the defect.
EstFinish : dateTime
Estimated finish date for defect fixing.
PctComplete : integer
Percentage complete of defect fixing. Default: 0.
ActHrs : decimal
Actual hours spent fixing the defect. Default: 0.
ActualStart : dateTime
Actual start date for defect fixing.
ActFinish : dateTime
Actual date when the defect was fixed.
EstHrsRemaining : decimal
Estimated remaining hours for defect fixing. Default: 0.
ActualResults : string
Actual results of the defect as compared to the expected results. Can include HTML markup. Default value: empty string.
DateOpened : dateTime
The date and time the defect was opened.
DateResolved : dateTime
The date and time the defect status was set to a status containing the resolved word (Resolved, Item Resolved, Resolved Item, and so on).
DateClosed : dateTime
The date and time the defect status was set to a status containing the closed word (Closed, Item Closed, Closed Item, and so on).
DateUpdated : dateTime
The date and time the defect was last updated.
ProjId : integer
The ID of the QAComplete project that contains the defect.
DateCreated : dateTime
The date and time the record about the defect was created.
UpdateUserId : integer
The ID of the user who last updated the defect.
OriginalId : integer
For importing: to retain the original key that was imported. Default: 0.
ImportId : integer
For importing: the import batch number. Default: 0.
AssignedToName : string (max 78 chars)
The name of the user assigned to the defect, in the Lastname, Firstname format.
OpenedByName : string (max 78 chars)
The name of the user who created the defect, in the Lastname, Firstname format.
OpenedByEmail : string (max 255 chars)
The email address of the user who created the defect.
OpenedByCompany : string (max 50 chars)
The company name of the user who created the defect.
ClosedByName : string (max 78 chars)
The name of the user who closed the defect, in the Lastname, Firstname format.
ResolvedByName : string (max 78 chars)
The name of the user who marked the defect as resolved, in the Lastname, Firstname format.
UserName : string (max 78 chars)
The name of the user who last updated the defect, in the Lastname, Firstname format.
OwnerName : string (max 78 chars)
The name of the user who created the defect, in the Lastname, Firstname format.
NotesDescription : string (max 255 chars)
The latest note attached to the defect. Can include HTML markup.
NbrFiles : integer
The number of files attached to the defect. Default: 0.
NbrNotes : integer
The number of notes attached to the defect. Default: 0.
NbrEvents : integer
The number of calendar events attached to the defect. Default: 0.
NbrTasks : integer
The number of tasks attached to the defect. Default: 0.
FolderName : string (max 511 chars)
The name of the folder containing the defect, in the ParentFolder/Subfolder/Subfolder format.
null if the defect is not in a folder.
ActFinish : dateTime
Actual date when the defect was fixed.
ActHrs : decimal
Actual hours spent fixing the defect. Default: 0.
ActualResults : string
Actual results of the defect as compared to the expected results. Can include HTML markup. Default value: empty string.
ActualStart : dateTime
Actual start date for defect fixing.
AssignedToName : string (max 78 chars)
The name of the user assigned to the defect, in the Lastname, Firstname format.
AssigneeUserId : integer
The ID of the user the defect is assigned to, or 0 if the defect is not assigned to anyone.
BugId : integer
Unique identifier of the defect.
ClosedBy : integer
The ID of the user who closed the defect, or 0 if the defect is not closed.
ClosedByName : string (max 78 chars)
The name of the user who closed the defect, in the Lastname, Firstname format.
Custom1 … Custom10 : string (max 8000 chars)
Values of custom fields 1 to 10.
Custom11 … Custom90 : string (max 100 chars)
Values of custom fields 11 to 90.
CustomFieldName1 … CustomFieldName90 : string (max 30 chars)
The names of custom fields.
CustomFieldNames : array of strings
An array of custom field names.
CustomFields : array of strings
An array of custom field values.
DateClosed : dateTime
The date and time the defect status was set to a status containing the closed word (Closed, Item Closed, Closed Item, and so on).
DateCreated : dateTime
The date and time the record about the defect was created.
DateOpened : dateTime
The date and time the defect was opened.
DateResolved : dateTime
The date and time the defect status was set to a status containing the resolved word (Resolved, Item Resolved, Resolved Item, and so on).
DateUpdated : dateTime
The date and time the defect was last updated.
Description : string
Long description of the defect. Can include HTML markup. Default value: empty string.
EstFinish : dateTime
Estimated finish date for defect fixing.
EstHrs : decimal
Estimated hours to fix the defect. Default: 0.
EstHrsRemaining : decimal
Estimated remaining hours for defect fixing. Default: 0.
EstStart : dateTime
Estimated start date for working on the defect.
ExpectedResults : string
Expected results of the software if it did not have this defect. Can include HTML markup. Default value: empty string.
FolderId : integer
The ID of the folder containing the defect, or 0 if the defect is not in any folder.
FolderName : string (max 511 chars)
The name of the folder containing the defect, in the ParentFolder/Subfolder/Subfolder format.
null if the defect is not in a folder.
FunctionalAreaCode : string (max 100 chars)
The functional area where the defect was found. This value is based on a choice list.
HowFoundCode : string (max 100 chars)
How the defect was found. This value is based on a choice list.
ImportId : integer
For importing: the import batch number. Default: 0.
IssueCode : string (max 100 chars)
The defect type based on a choice list.
ModuleCode : string (max 100 chars)
The module where the defect was found. This value is based on a choice list.
NbrEvents : integer
The number of calendar events attached to the defect. Default: 0.
NbrFiles : integer
The number of files attached to the defect. Default: 0.
NbrNotes : integer
The number of notes attached to the defect. Default: 0.
NbrTasks : integer
The number of tasks attached to the defect. Default: 0.
NotesDescription : string (max 255 chars)
The latest note attached to the defect. Can include HTML markup.
OpenedBy : integer
The ID of the user who created the defect.
OpenedByCompany : string (max 50 chars)
The company name of the user who created the defect.
OpenedByEmail : string (max 255 chars)
The email address of the user who created the defect.
OpenedByName : string (max 78 chars)
The name of the user who created the defect, in the Lastname, Firstname format.
OriginalId : integer
For importing: to retain the original key that was imported. Default: 0.
OriginCode : string
Reserved.
OwnerName : string (max 78 chars)
The name of the user who created the defect, in the Lastname, Firstname format.
OwnerUserId : integer
The ID of the user who owns the defect.
PctComplete : integer
Percentage complete of defect fixing. Default: 0.
PriorityCode : string (max 100 chars)
The defect severity based on a choice list. Default value: empty string.
ProjId : integer
The ID of the QAComplete project that contains the defect.
Resolution : string
The defect’s resolution details. Can include HTML markup. Default value: empty string.
ResolutionCode : string (max 100 chars)
The defect’s resolution status based on a choice list.
ResolvedBy : integer
The ID of the user who marked the defect as resolved, or 0 if the defect is not resolved.
ResolvedByName : string (max 78 chars)
The name of the user who marked the defect as resolved, in the Lastname, Firstname format.
SeverityCode : string (max 100 chars)
The defect severity based on a choice list. Default value: empty string.
SoftwareVersionCode : string (max 100 chars)
The project version that the defect affects. This value is based on a choice list.
StatusCode : string (max 100 chars)
The defect status based on a choice list.
StepsToRepro : string
Steps to reproduce the defect. Can include HTML markup. Default value: empty string.
TestCaseId : integer
The ID of the test case attached to the defect. Default is 0, meaning no attached test case.
Title : string (max 255 chars)
The defect title (subject).
XML entities in the title are double encoded:
& – &#38;
< – &#60;
> – &#62;
TypeCode : string
Reserved.
UpdateUserId : integer
The ID of the user who last updated the defect.
UserName : string (max 78 chars)
The name of the user who last updated the defect, in the Lastname, Firstname format.
Relevant Operations
Example
XML
<Bug>
<CustomFields>
<string>0.9.19<string>
<string>1.0.24<string>
</CustomFields>
<CustomFieldNames>
<string>Found in build</string>
<string>Fixed in build</string>
</CustomFieldNames>
<Custom1>0.9.19</Custom1>
<Custom2>1.0.24</Custom2>
<CustomFieldName1>Found in build</CustomFieldName1>
<CustomFieldName2>Fixed in build</CustomFieldName2>
<BugId>13254</BugId>
<Title>Floating toolbar improvements</Title>
<StatusCode>Resolved</StatusCode>
<SeverityCode/>
<PriorityCode>2-Fix Soon</PriorityCode>
<HowFoundCode>Test-Ad hoc</HowFoundCode>
<ResolutionCode>Fixed</ResolutionCode>
<AssigneeUserId>27942</AssigneeUserId>
<OpenedBy>27568</OpenedBy>
<ClosedBy>0</ClosedBy>
<ResolvedBy>27568</ResolvedBy>
<Description><![CDATA[The design of the floating toolbar needs improvement so that it’s clearer what the user needs to do.]]></Description>
<Resolution>Resolved by Susan McLaren on 24-Jun-2014 at 03:55 PM</Resolution>
<OwnerUserId>27572</OwnerUserId>
<TestCaseId>0</TestCaseId>
<FolderId>52359</FolderId>
<EstHrs>0.000</EstHrs>
<EstStart>2014-06-10T10:00:00</EstStart>
<EstFinish>2014-06-13T10:00:00</EstFinish>
<PctComplete>100</PctComplete>
<ActHrs>0.000</ActHrs>
<ActStart>2014-06-17T00:00:00</ActStart>
<ActFinish>2014-06-31T00:00:00</ActFinish>
<EstHrsRemaining>0.000</EstHrsRemaining>
<DateOpened>2014-05-26T15:54:21.093</DateOpened>
<DateResolved>2014-06-24T15:55:25</DateResolved>
<DateClosed>0001-01-01T00:00:00</DateClosed>
<DateUpdated>2014-06-31T05:54:22</DateUpdated>
<ProjId>17823</ProjId>
<DateCreated>2014-05-26T15:54:21.093</DateCreated>
<UpdateUserId>27534</UpdateUserId>
<OriginalId>0</OriginalId>
<ImportId>0</ImportId>
<AssignedToName>John Doe</AssignedToName>
<OpenedByName>McLaren, Susan</OpenedByName>
<OpenedByEmail>[email protected]</OpenedByEmail>
<OpenedByCompany>Edgar Solutions</OpenedByCompany>
<ResolvedByName>McLaren, Susan</ResolvedByName>
<UserName>Fry, Alex</UserName>
<OwnerName>Davis, Eugeny</OwnerName>
<NbrFiles>0</NbrFiles>
<NbrNotes>1</NbrNotes>
<NbrEvents>0</NbrEvents>
<NbrTasks>2</NbrTasks>
<FolderName>FamilyAlbum/Release 1.1/Iteration 1</FolderName>
</Bug>