 |
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. |
Returns a requirement by ID.
Requirements
The authenticating user must belong to a security group that has the Read privilege for Requirements.
To specify a project that contains the requirements, use the ProjId value in the AuthenticationData object in the request body. To search for the requirements in several projects, use the ProjIds value to specify the list of projects IDs in the AuthenticationData object.
Parameters
The operation uses the following parameters:
AuthenticationData : AuthenticationData, required
An AuthenticationData object with the login information and the ID of the project (or the list of project IDs) that contains the requirement.
FunctionalSpecId : integer, required
The ID of the desired requirement.
Result
A FunctionalSpec object that contains the requirement information.
Example
Sample Code
C#
string login = "[email protected]";
string password = "p@ssword";
int projId = 10372;
// Specifying the ID of the desired requirement
int Id = 3;
ServiceSoapClient service = new ServiceSoapClient();
// Preparing AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = projId;
// Getting the requirement
FunctionalSpec requirement = service.FunctionalSpecs_Load(authData, Id);
Console.WriteLine("{0}: {1}", requirement.FunctSpecId, requirement.Title);
Java
String login = "[email protected]";
String password = "p@ssword";
int projId = 10372;
// Specifying the ID of the desired requirement
int Id = 3;
ServiceSoap service = new Service().getServiceSoap12();
// Preparing AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(projId);
// Getting the requirement
FunctionalSpec requirement = service.functionalSpecsLoad(authData, Id);
System.out.format("%d: %s%n", requirement.getFunctSpecId(), requirement.getTitle());
Sample Request XML
POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 522 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/FunctionalSpecs_Load"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<FunctionalSpecs_Load xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>7154</DeptId>
<ProjId>1032</ProjId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<FunctionalSpecId>3</FunctionalSpecId>
</FunctionalSpecs_Load>
</soap:Body>
</soap:Envelope>
SOAP 1.2
POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 530 {Insert an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<FunctionalSpecs_Load xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>7154</DeptId>
<ProjId>1032</ProjId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<FunctionalSpecId>3</FunctionalSpecId>
</FunctionalSpecs_Load>
</soap12:Body>
</soap12:Envelope>
Sample Response XML
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1364 {The server returns an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<FunctionalSpecs_LoadResponse xmlns="http://www.pragmaticsw.com/">
<FunctionalSpecs_LoadResult>
<FunctSpecId>3</FunctSpecId>
<Title>API-0014 - Add Visual Studio Support</Title>
<StatusCode>Closed</StatusCode>
<EstHrs>20.000</EstHrs>
<ActHrs>36.100</ActHrs>
<EstFinish>2014-07-14T17:00:00</EstFinish>
<ActFinish>2014-07-17T17:00:00</ActFinish>
<OwnerUserId>25315</OwnerUserId>
<AssigneeUserId>27572</AssigneeUserId>
<FolderId>0</FolderId>
<EstStart>2014-07-12T15:00:00</EstStart>
<ActStart>2014-07-13T12:15:00</ActStart>
<PctComplete>100</PctComplete>
<EstHrsRemaining>0.000</EstHrsRemaining>
<AssignedToName>Davis, Eugeny</AssignedToName>
<DateCreated>2014-07-05T04:58:35.747</DateCreated>
<DateUpdated>2014-07-17T17:10:08.747</DateUpdated>
<FunctionalSpecId>3</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>27572</UpdateUserId>
<UserName>Davis, Eugeny</UserName>
</FunctionalSpecs_LoadResult>
</FunctionalSpecs_LoadResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1374 {The server returns an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<FunctionalSpecs_LoadResponse xmlns="http://www.pragmaticsw.com/">
<FunctionalSpecs_LoadResult>
<FunctSpecId>3</FunctSpecId>
<Title>API-0014 - Add Visual Studio Support</Title>
<StatusCode>Closed</StatusCode>
<EstHrs>20.000</EstHrs>
<ActHrs>36.100</ActHrs>
<EstFinish>2014-07-14T17:00:00</EstFinish>
<ActFinish>2014-07-17T17:00:00</ActFinish>
<OwnerUserId>25315</OwnerUserId>
<AssigneeUserId>27572</AssigneeUserId>
<FolderId>0</FolderId>
<EstStart>2014-07-12T15:00:00</EstStart>
<ActStart>2014-07-13T12:15:00</ActStart>
<PctComplete>100</PctComplete>
<EstHrsRemaining>0.000</EstHrsRemaining>
<AssignedToName>Davis, Eugeny</AssignedToName>
<DateCreated>2014-07-05T04:58:35.747</DateCreated>
<DateUpdated>2014-07-17T17:10:08.747</DateUpdated>
<FunctionalSpecId>3</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>27572</UpdateUserId>
<UserName>Davis, Eugeny</UserName>
</FunctionalSpecs_LoadResult>
</FunctionalSpecs_LoadResponse>
</soap12:Body>
</soap12:Envelope>
See Also
FunctionalSpecs_Add
FunctionalSpecs_Delete
FunctionalSpecs_LoadByCriteria
FunctionalSpecs_Update
Requirements Operations
SOAP API Reference