GET/projects/{ProjectId}/configurations/{Id}

Applies to QAComplete 12.93 SaaS, last modified on November 01, 2021

Gets information on a configuration from QAComplete.

Use the operation to get information on a configuration specified by its ID.

To get information on all the configurations registered in a QAComplete project, use the …/configurations (GET) operation.

Authentication

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

Security Rights

The authenticating user must belong to a security group that has the Read privilege for Test Library.

Request Format

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

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

ProjectId  :  integer, required

The ID of the project, to which the configuration belongs.

Id  :  integer, required

The ID of the configuration you want to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v2/projects/11873/configurations/1 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/configurations/1

Response Format

On success, the operation responds with HTTP status code 200 and returns a JSON object with the configuration information.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 466


{
        "id": 1,
        "folder_id": 0,
        "title": "Sample Configuration",
        "is_active": false,
        "create_user_id": 123456,
        "update_user_id": 123456,
        "date_created": "2016-08-31T09:13:59.9600000",
        "date_updated": "2016-08-31T09:13:59.9600000",
        "owner_user_id": 123456,
        "owner_name": "Smith, John ",
        "nbr_files_not_secured": 0,
        "user_name": "Smith, John ",
        "nbr_files": 0,
        "nbr_notes": 0,
        "original_id": 0,
        "import_id": 0,
        "project_id": 11873,
        "is_c_b_t": false,
        "custom_fields": [],
        "permissions": {
            "acl": 7
       }

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 configuration with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Configurations Resources

Highlight search results