TraceabilityLinks_Load Operation

Applies to QAComplete 12.70 SaaS, last modified on January 11, 2021

Returns an array of TraceabilityLink objects that contain data about all linked items to the specified item.

To specify a project that contains the link item, use the ProjId value in the AuthenticationData object in the request body. To search for the link item in several projects, use the ProjIds value to specify the list of projects IDs in the AuthenticationData object.

Requirements

The authenticating user must belong to a security group that has access to the Manage and view traceability and Read, Add, and Update privileges for the linked items.

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 linked item.

EntityCode  :  string, required

The entity class of the item links to which you want to get. Possible values:

  • Bugs (defects)
  • Contacts
  • FileExchanges (shared documents)
  • FunctionalSpecs (requirements)
  • ProjectPlans
  • ProjectPlanTasks
  • ProjectTasks (agile tasks)
  • Releases
  • TestCases (legacy test cases used in release 9.6.0 and earlier)
  • TestConfigurations
  • Tests
  • TestSets

FKId  :  integer, required

The ID of the item links to which you want to get.

Result

An array of TraceabilityLink objects that contains the requirement information.

Example

Sample Code

C#

string login = "john.doe@example.com";
string password = "p@ssword";
int projID = 10372;
// Specifying the desired item
string entityCode = "Bugs";
int fkid = 23;

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;

// Loading traceability links
TraceabilityLink[] links = service.TraceabilityLinks_Load(authData, entityCode, fkid);
foreach (TraceabilityLink link in links)
{
  Console.WriteLine("Link to {0} ({1}): {2}", link.LinkedEntityCode, link.LinkedFKId, link.Title);
}

Java

String login = "john.doe@example.com";
String password = "p@ssword";
int projID = 10372;
// Specifying the desired item
String entityCode = "Bugs";
int fkid = 23;

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);

// Loading traceability links
List<TraceabilityLink> links = service.traceabilityLinksLoad(authData, entityCode, fkid).getTraceabilityLink();
for (TraceabilityLink link : links)
{
  System.out.format("Link to %s (%d) - %s%n", link.getLinkedEntityCode(), link.getLinkedFKId(), link.getTitle() );
}

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 536 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/TraceabilityLinks_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>
    <TraceabilityLinks_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityCode>Releases</EntityCode>
      <FKId>23</FKId>
    </TraceabilityLinks_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: 544 {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>
    <TraceabilityLinks_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityCode>Releases</EntityCode>
      <FKId>23</FKId>
    </TraceabilityLinks_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1087 {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>
    <TraceabilityLinks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <TraceabilityLinks_LoadResult>
        <TraceabilityLink>
          <LinkId>34</LinkId>
          <ProjId>10372</ProjId>
          <EntityCode>Bugs</EntityCode>
          <FKId>33</FKId>
          <LinkedEntityCode>Releases</LinkedEntityCode>
          <LinkedFKId>23</LinkedFKId>
          <Status>In Progress</Status>
          <Title>FamilyAlbum: Release 1.0/Alfa/0.4.86</Title>
          <LinkType>Found in build</LinkType>
          <DateUpdated>2014-07-15T23:11:12.237</DateUpdated>
        </TraceabilityLink>
        <TraceabilityLink>
          <LinkId>35</LinkId>
          <ProjId>10372</ProjId>
          <EntityCode>Bugs</EntityCode>
          <FKId>33</FKId>
          <LinkedEntityCode>TestSets</LinkedEntityCode>
          <LinkedFKId>42</LinkedFKId>
          <Status>Active</Status>
          <Title>Flash plug-in test</Title>
          <LinkType></LinkType>
          <DateUpdated>2014-07-18T23:11:13.397</DateUpdated>
        </TraceabilityLink>
      </TraceabilityLinks_LoadResult>
    </TraceabilityLinks_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1097 {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>
    <TraceabilityLinks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <TraceabilityLinks_LoadResult>
        <TraceabilityLink>
          <LinkId>34</LinkId>
          <ProjId>10372</ProjId>
          <EntityCode>Bugs</EntityCode>
          <FKId>33</FKId>
          <LinkedEntityCode>Releases</LinkedEntityCode>
          <LinkedFKId>23</LinkedFKId>
          <Status>In Progress</Status>
          <Title>FamilyAlbum: Release 1.0/Alfa/0.4.86</Title>
          <LinkType>Found in build</LinkType>
          <DateUpdated>2014-07-15T23:11:12.237</DateUpdated>
        </TraceabilityLink>
        <TraceabilityLink>
          <LinkId>35</LinkId>
          <ProjId>10372</ProjId>
          <EntityCode>Bugs</EntityCode>
          <FKId>33</FKId>
          <LinkedEntityCode>TestSets</LinkedEntityCode>
          <LinkedFKId>42</LinkedFKId>
          <Status>Active</Status>
          <Title>Flash plug-in test</Title>
          <LinkType></LinkType>
          <DateUpdated>2014-07-18T23:11:13.397</DateUpdated>
        </TraceabilityLink>
      </TraceabilityLinks_LoadResult>
    </TraceabilityLinks_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

TraceabilityLinks_Add
TraceabilityLinks_Delete
TraceabilityLinks_LoadByCriteria
Traceability Operations
SOAP API Reference

Highlight search results