GET/projects/{ProjectId}/{EntityCode}/folders/{Id}

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Gets information on the specified entity’s folder by its ID.

Use the operation to return information about a specific folder from the specified project entity (for example, Bugs or FunctionalSpecs).

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must have the Read privilege for the needed entity.

Request Format

To get information on folders, send a GET request to the following URL:

http://{server}/rest-api/service/api/v2/projects/{ProjectId}/{EntityCode}/folders/{Id}

ProjectId  :  integer, required

The ID of the needed project.

EntityCode  :  string, required

The entity, which folder you need to get. Possible values:

  • Releases
  • Bugs (defects)
  • FunctionalSpecs (requirements)
  • Tests
  • TestSets
  • TestSteps

Id  :  integer

The needed folder’s ID.

A sample request:

GET http://yourserver.com/rest-api/service/api/v2/projects/11873/FunctionalSpecs/folders/733 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11873/Bugs/folders/733

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about the requested folder.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 536



   {
  "id": 254,
  "parent_id": 22,
  "project_id": 11873,
  "entity_code": "Requirements",
  "folder_name": "Sample Folder",
  "is_active": true,
  "is_public": true,
  "date_created": "2013-09-14T13:53:53.4230000",
  "date_updated": "2013-09-14T13:53:53.4230000",
  "update_user_id": 24663,
  "owner_user_id": 24663,
  "parent_name": "Parent Folder",
  "full_folder_name": "Parent Folder/Sample Folder",
  "updated_user_name": "Smith, John",
  "created_user_name": "Smith, John"
   }

Error responses

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

If the project with the specified ProjectId does not exist or the authenticating user does not have rights to access the project, the operation returns the Access is denied error.

If the specified entity does not exist, the operation returns the Invalid entity code error.

See Also

Folders REST API Reference

Highlight search results