StarterTemplate ASP.NET Host

<back to all web services

RequestFolderById

Folders service

The following routes are available for this service:
GET/service/api/v2/projects/{ProjectId}/{EntityCode}/folders/{Id}Returns information about folder by IdThe authenticating user must have the Read privilege for the entity (Defects, Tests and so on) that is stored in the folder.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the folder
EntityCodepathstringYesThe type of the items in the folder
IdpathstringYesThe ID of the folder you need to get

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/RequestFolderById HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

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

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

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