 |
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 FunctionalSpecs object represents a requirement in QAComplete. Using QAComplete SOAP API, you can add, enumerate, update, and delete requirements.
To manage requirements, you need a user account that belongs to a security group that has the corresponding privileges – Read, Add, Update, or Delete – for Requirements. You can view or set these privileges in > Setup > Security > Security Groups > Manage Security Rights > select group.
Some string property values are based on choice lists defined in your QAComplete project. You can find these values in Requirements > Show Requirements > Tools > Manage Choice Lists.
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.
FunctSpecId : integer
Unique identifier of the requirement. Same as FunctionalSpecId.
Title : string (max 255 chars)
The requirement title (name).
XML entities in the title are double encoded:
& – &
< – &#60;
> – &#62;
StatusCode : string (max 100 chars)
The requirement status based on a choice list.
Keywords : string (max 200 chars)
Keywords of the requirement.
Grouping : string (max 50 chars)
The group that contains the requirement.
SubGrouping : string (max 50 chars)
The sub group that contains the requirement.
Description : string
Long description of the requirement. Can include HTML markup. Default value: empty string.
BusinesRule : string
Business rule associated with the requirement. Can include HTML markup. Default value: empty string.
EstHrs : decimal
Estimated hours to finish the requirement. Default: 0.
ActHrs : decimal
Actual hours spent working on the requirement. Default: 0.
EstFinish : dateTime
The estimate date of the finishing the requirement.
ActFinish : dateTime
The actual date when the requirement was completed.
Comments : string (max 8000 chars)
Comments to the requirement. Can include HTML markup. Default value: empty string.
OwnerUserId : integer
The ID of the user who owns the requirement.
AssigneeUserId : integer
The ID of the user the requirement is assigned to, or 0 if the requirement is not assigned to anyone.
FolderId : integer
The ID of the folder containing the requirement, or 0 if the requirement is not in any folder.
EstStart : dateTime
Estimated start date for working on the requirement.
ActStart : dateTime
Actual start date for working on the requirement.
PctComplete : integer
Percentage complete of requirement completing. Default: 0.
EstHrsRemaining : decimal
Estimated remaining hours for finishing the requirement. Default: 0.
AssignedToName : string (max 78 chars)
The name of the user the requirement assigned to, in the Lastname, Firstname format.
DateCreated : dateTime
The date and time the requirement was created.
DateUpdated : dateTime
The date and time the requirement was last updated.
FolderName : string (max 511 chars)
The name of the folder containing the requirement, in the format ParentFolder/Subfolder/Subfolder.
null if the requirement is not in a folder.
FunctionalSpecId : integer
Unique identifier of the requirement. Same as FunctSpecId.
ImportId : integer
The ID of the import session, in which the requirement was imported. If the requirement was created in the QAComplete, the ImportId property is equal to 0.
NbrEvents : integer
The number of scheduled events associated with the requirement.
NbrFiles : integer
The number of files attached to the requirement. Default: 0.
NbrNotes : integer
The number of notes attached to the requirement. Default: 0.
NbrTasks : integer
The number of tasks linked to the requirement.
NotesDescription : string
The latest note attached to the requirement. Can include HTML markup.
OriginalId : integer
QAComplete sets new ID automatically to the imported requirement. You can assign the original identifier to this property when you import the requirement.
OwnerName : string (max 78 chars)
The name of the user who owns the requirement, in the Lastname, Firstname format.
ProjId : integer
The ID of the QAComplete project that contains the requirement.
UpdateUserId : integer
The ID of the last user who updated the requirement.
UserName : string (max 78 chars)
The name of the last user who updated the requirement, in the Lastname, Firstname format.
ActFinish : dateTime
The actual date when the requirement was completed.
ActHrs : decimal
Actual hours spent working on the requirement. Default: 0.
ActStart : dateTime
Actual start date for working on the requirement.
AssignedToName : string (max 78 chars)
The name of the user the requirement assigned to, in the Lastname, Firstname format.
AssigneeUserId : integer
The ID of the user the requirement is assigned to, or 0 if the requirement is not assigned to anyone.
BusinesRule : string
Business rule associated with the requirement. Can include HTML markup. Default value: empty string.
Comments : string (max 8000 chars)
Comments to the requirement. Can include HTML markup. Default value: empty string.
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.
DateCreated : dateTime
The date and time the requirement was created.
DateUpdated : dateTime
The date and time the requirement was last updated.
Description : string
Long description of the requirement. Can include HTML markup. Default value: empty string.
EstFinish : dateTime
The estimate date of the finishing the requirement.
EstHrs : decimal
Estimated hours to finish the requirement. Default: 0.
EstHrsRemaining : decimal
Estimated remaining hours for finishing the requirement. Default: 0.
EstStart : dateTime
Estimated start date for working on the requirement.
FolderId : integer
The ID of the folder containing the requirement, or 0 if the requirement is not in any folder.
FolderName : string (max 511 chars)
The name of the folder containing the requirement, in the format ParentFolder/Subfolder/Subfolder.
null if the requirement is not in a folder.
FunctionalSpecId : integer
Unique identifier of the requirement. Same as FunctSpecId.
FunctSpecId : integer
Unique identifier of the requirement. Same as FunctionalSpecId.
Grouping : string (max 50 chars)
The group that contains the requirement.
ImportId : integer
The ID of the import session, in which the requirement was imported. If the requirement was created in the QAComplete, the ImportId property is equal to 0.
Keywords : string (max 200 chars)
Keywords of the requirement.
NbrEvents : integer
The number of scheduled events associated with the requirement.
NbrFiles : integer
The number of files attached to the requirement. Default: 0.
NbrNotes : integer
The number of notes attached to the requirement. Default: 0.
NbrTasks : integer
The number of tasks linked to the requirement.
NotesDescription : string
The latest note attached to the requirement. Can include HTML markup.
OriginalId : integer
QAComplete sets new ID automatically to the imported requirement. You can assign the original identifier to this property when you import the requirement.
OwnerName : string (max 78 chars)
The name of the user who owns the requirement, in the Lastname, Firstname format.
OwnerUserId : integer
The ID of the user who owns the requirement.
PctComplete : integer
Percentage complete of requirement completing. Default: 0.
ProjId : integer
The ID of the QAComplete project that contains the requirement.
StatusCode : string (max 100 chars)
The requirement status based on a choice list.
SubGrouping : string (max 50 chars)
The sub group that contains the requirement.
Title : string (max 255 chars)
The requirement title (name).
XML entities in the title are double encoded:
& – &#38;
< – &#60;
> – &#62;
UpdateUserId : integer
The ID of the last user who updated the requirement.
UserName : string (max 78 chars)
The name of the last user who updated the requirement, in the Lastname, Firstname format.
Relevant Operations
Example
XML
<FunctionalSpec>
<CustomFields>
<string>UI</string>
...
</CustomFields>
<CustomFieldNames>
<string>Area</string>
...
</CustomFieldNames>
<FunctSpecId>8</FunctSpecId>
<Title>WEB-0014 Implement search feature</Title>
<StatusCode>Active</StatusCode>
<Keywords>search</Keywords>
<Grouping/>
<SubGrouping/>
<Description>There is need to allow users to search the desired information.</Description>
<BusinessRule/>
<EstHrs>10</EstHrs>
<ActHrs>0</ActHrs>
<EstFinish>2014-07-20T17:00:00</EstFinish>
<ActFinish>0001-01-01T00:00:00</ActFinish>
<Comments/>
<OwnerUserId>25135</OwnerUserId>
<AssigneeUserId>25667</AssigneeUserId>
<FolderId/>
<EstStart>2014-07-20T07:00:00</EstStart>
<ActStart>2014-07-21T10:00:00</ActStart>
<PctComplete>20</PctComplete>
<EstHrsRemaining>6</EstHrsRemaining>
<AssignedToName>Smith, John</AssignedToName>
<DateCreated>2014-07-12T14:23:54</DateCreated>
<DateUpdated>2014-07-14T16:04:23</DateUpdated>
<FolderName/>
<FunctionalSpecId>8</FunctionalSpecId>
<ImportId>0</ImportId>
<NbrEvents>0</NbrEvents>
<NbrFiles>0</NbrFiles>
<NbrNotes>0</NbrNotes>
<NbrTasks>0</NbrTasks>
<NotesDescription>0</NotesDescription>
<OriginalId>0</OriginalId>
<OwnerName>Doe, John</OwnerName>
<ProjId>10372</ProjId>
<UpdateUserId>27534</UpdateUserId>
<UserName>Fry, Alex</UserName>
</FunctionalSpec>
See Also
FunctionalSpecs_Add Operation
FunctionalSpecs_Load Operation
Requirements Operations