Returns a filtered list of configurations declared in the specified QAComplete project.
Use the operation to get a list of all the configurations registered in a QAComplete project. This operation is equivalent to the /project/{ProjectId}/configurations (GET) operation, but this one allows you to send a large filter string.
To get parameters of an individual configuration by its ID, use the …/configurations/{Id} (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 a filtered list of configurations, send a POST request to the following URL:
URL parameters
ProjectId : integer, required
The ID of the project.
offset : integer, default: 0
The number of configurations to skip before counting the returned configurations. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.
limit : integer, default: 25
The maximum number of configurations to return in the response.
Body parameters
In the request body, pass the RequestTestConfigurationsAllPostV2 object that describes the configurations to search for.
"Filter": "string"
}
Some string property values (for example, OperatingSystem) are based on the choice lists defined in your QAComplete project. To view these values, go to the Test Library > Configurations > Tools > Manage Choice Lists screen in QAComplete.
Filter : string
The filter expression to apply to the returned list. See Search Filters.
A sample request:
POST http://yourserver.com/rest-api/service/api/v2/projects/11873/configurations/search HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 74
{
"Filter": "(title is not empty) OR (OperatingSystem != 'Windows 10')"
}
A sample request made by using cURL:
curl -u [email protected]:p@ssword -d @configurations.txt -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/rest-api/service/api/v1/projects/11873/configurations/search
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about the configurations.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 575
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"limit": 25,
"total": 1
},
"permissions": {
"acl": 7
}
},
"results": [
{
"id": 1,
"folder_id": 0,
"title": "IE9",
"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
}
}
]
}
Metadata about the configuration list.
Pagination information about the configuration list. (See Paging Through Results Using Offset and Limit).
The number of returned configurations.
The offset of the first configuration requested.
The maximum number of configurations requested.
The total number of configurations.
The authenticating user’s rights to access the Test Library.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of configurations.
Unique identifier of the configuration.
The ID of the folder containing the configuration, or 0 if the configuration is not in any folder.
The user-friendly name (title) of the configuration.
True if the configuration is active and False if the configuration is hidden.
The ID of the user who created the configuration.
The ID of the user who updated the configuration last time.
The date and time when the configuration was created.
The date and time when the configuration was last updated.
The ID of the user who owns the configuration.
The name of the user who owns the configuration, in the Lastname, Firstname format.
Reserved.
The name of the last user who updated the configuration, in the LastName, FirstName format.
The number of files attached to the configuration.
The number of notes attached to the configuration.
For importing: the original key that was imported.
The ID of the import session, in which the configuration was imported. If the configuration was created in QAComplete, the ImportId property is equal to 0.
The ID of the QAComplete project that contains the configuration.
Shows whether the configuration was created using the CrossBrowserTesting capabilities.
An array of objects that describe custom fields and their values.
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.