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:
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 [email protected]: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"
}
The project’s unique identifier.
The folder’s unique identifier.
The code of the entity the folder belongs to.
The ID of the last user who updated the folder.
The ID of the user who owns the folder.
The date and time when the folder was created.
The date and time when the folder was last updated.
True if the folder is active and False if hidden.
True if the folder is public and False if private.
The name of the last user, who updated the folder, in the Lastname, Firstname format.
The name of the user, who created the folder, in the Lastname, Firstname format.
The ID of the folder in which the selected folder resides.
The parent folder’s name.
The folder’s name.
The full path to the folder.
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.