StarterTemplate ASP.NET Host

<back to all web services

RequestFolderAll

Folders service

The following routes are available for this service:
GET/service/api/v2/projects/{ProjectId}/{EntityCode}/foldersReturns the list of folders of the specified itemThe authenticating user must have the Read privilege for the entity (Defects, Tests and so on) that is stored in the folder.
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of folders to skip before counting the returned folders
LimitqueryintNoThe maximum number of folders to return
ProjectIdpathintYesThe ID of the project that contains folders
EntityCodepathstringYesThe type of items in the folders
FilterquerystringNoThe filter expression to apply to the list of folders

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestFolderAll HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestFolderAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Folders">
  <EntityCode>String</EntityCode>
  <Filter>String</Filter>
  <Limit>0</Limit>
  <Offset>0</Offset>
  <ProjectId>0</ProjectId>
</RequestFolderAll>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseFoldersCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Folders">
  <Metadata i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common" />
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Folders" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseFolderSingle>
      <d2p1:CreatedUserName>String</d2p1:CreatedUserName>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EntityCode>String</d2p1:EntityCode>
      <d2p1:FolderName>String</d2p1:FolderName>
      <d2p1:FullFolderName>String</d2p1:FullFolderName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsPublic>false</d2p1:IsPublic>
      <d2p1:OwnerUserId>0</d2p1:OwnerUserId>
      <d2p1:ParentId>0</d2p1:ParentId>
      <d2p1:ParentName>String</d2p1:ParentName>
      <d2p1:ProjectId>0</d2p1:ProjectId>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UpdatedUserName>String</d2p1:UpdatedUserName>
    </d2p1:ResponseFolderSingle>
  </Results>
</ResponseFoldersCollection>