StarterTemplate ASP.NET Host

<back to all web services

RequestFolderPostSearch

Folders Service

The following routes are available for this service:
POST/service/api/v2/projects/{ProjectId}/{EntityCode}/folders/searchReturns the list of folders in a projectThe authenticating user must have the Read privilege for the entity (Defects, Tests and so on) that are stored in folders. This method fully equivalent to GET method, but this one allows you to send large filter string.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains folders
EntityCodepathstringYesThe type of the items in the folders
OffsetqueryintNoThe number of folders to skip before counting the returned folders
LimitqueryintNoThe maximum number of folders to return

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"project_id":0,"entity_code":"String","offset":0,"limit":0,"filter":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"results":[{"id":0,"parent_id":0,"project_id":0,"entity_code":"String","folder_name":"String","is_active":false,"description":"String","is_public":false,"date_created":"0001-01-01T00:00:00.0000000","date_updated":"0001-01-01T00:00:00.0000000","update_user_id":0,"owner_user_id":0,"parent_name":"String","full_folder_name":"String","updated_user_name":"String","created_user_name":"String"}]}