Folders_Load Operation

Applies to QAComplete 12.92 SaaS, last modified on October 13, 2021

Returns a folder by ID.

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 web service user must belong to a security group that has the Read privilege for Folder Maintenance in the appropriate area (Defects, Agile Tasks and so on).

Parameters

The operation uses the following parameters:

AuthenticationData  :  , required

An AuthenticationData object with the login information and the ID of the project (or the list of project IDs) that contains the folder.

FolderId  :  integer, required

The folder ID.

Result

A Folder object represents the specified folder.

Example

Sample Code

The following example prints the name of the folder with ID 4.

C#

string login = "john.doe@example.com";
string password = "p@ssword";

// Specifying the desired folder
int folderId = 4;

ServiceSoapClient service = new ServiceSoapClient();

// Prepare 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 = loginInfo.ProjId;

// Loading the folder
Folder folder = service.Folders_Load(authData, folderId);
Console.WriteLine(folder.FolderName);

Java

String login = "john.doe@example.com";
String password = "p@ssword";

// Specifying the desired folder
int folderId = 4;

ServiceSoap service = new Service().getServiceSoap12();

// Prepare 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(loginInfo.getProjId());

// Loading the folder
Folder folder = service.foldersLoad(authData, folderId);
System.out.println(folder.getFolderName());

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 491 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/Folders_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>
    <Folders_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <FolderId>4</FolderId>
    </Folders_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: 499 {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>
    <Folders_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <FolderId>4</FolderId>
    </Folders_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 940 {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>
    <Folders_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <Folders_LoadResult>
        <FolderId>4</FolderId>
        <ProjId>11873</ProjId>
        <FolderName>Product Backlogs</FolderName>
        <Description>Recent product backlogs</Description>
        <EntityCode>Bugs</EntityCode>
        <IsPublic>Y</IsPublic>
        <OwnerUserId>24661</OwnerUserId>
        <DeptId>8162</DeptId>
        <ParentName>Backlogs</ParentName>
        <IsActive>Y</IsActive>
        <IsVersion>N</IsVersion>
        <FullFolderName>Backlogs/Product Backlogs</FullFolderName>
        <OwnerUserName>Doe, John</OwnerUserName>
        <DateCreated>2014-07-17T06:33:08</DateCreated>
        <DateUpdated>2014-07-20T11:23:17</DateUpdated>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
      </Folders_LoadResult>
    </Folders_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 950 {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>
    <Folders_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <Folders_LoadResult>
        <FolderId>4</FolderId>
        <ProjId>11873</ProjId>
        <FolderName>Product Backlogs</FolderName>
        <Description>Recent product backlogs</Description>
        <EntityCode>Bugs</EntityCode>
        <IsPublic>Y</IsPublic>
        <OwnerUserId>24661</OwnerUserId>
        <DeptId>8162</DeptId>
        <ParentName>Backlogs</ParentName>
        <IsActive>Y</IsActive>
        <IsVersion>N</IsVersion>
        <FullFolderName>Backlogs/Product Backlogs</FullFolderName>
        <OwnerUserName>Doe, John</OwnerUserName>
        <DateCreated>2014-07-17T06:33:08</DateCreated>
        <DateUpdated>2014-07-20T11:23:17</DateUpdated>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
      </Folders_LoadResult>
    </Folders_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

Folders_Add
Folders_Delete
Folders_LoadByCriteria
Folders_Update
Folders Operations
SOAP API Reference

Highlight search results