Get test datasets

GET/testdatasets

Get test datasets specific to a project

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK
HTTP

import { createConfiguration, TestDatasetsApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestDatasetsApi(config);

const result = await api.getTestDatasets({
  "project": 123
});
console.log(result);

curl --request GET \
  "https://api.testcollab.io/testdatasets?token=$TESTCOLLAB_TOKEN&project=123"

Parameters

Name	Location	Type	Required	Description
`project`	query	number	Yes	Project ID
`_limit`	query	integer	No	Limit the size of the returned results
`_start`	query	integer	No	Skip a specific number of entries (for pagination)
`_sort`	query	string	No	Sort according to a specific field.
`_filter`	query	string	No	Stringified filter object

Response

200 — List of test datasets

Field	Type	Required	Description
`[].id`	number	Yes	—
`[].name`	string	Yes	—
`[].description`	string	No	—
`[].parameters`	Array of Test Dataset Parameter	Yes	—
`[].datarows`	string	Yes	JSON stringified
`[].created_at`	string	No	—
`[].updated_at`	string	No	—
`[].created_by`	User Minified	No	—
`[].created_by.id`	number	Yes	—
`[].created_by.username`	string	No	—
`[].created_by.name`	string	Yes	—
`[].created_by.avatar`	Upload	No	—
`[].created_by.avatar.id`	number	Yes	—
`[].created_by.avatar.name`	string	Yes	—
`[].created_by.avatar.hash`	string	Yes	—
`[].created_by.avatar.ext`	string	Yes	—
`[].created_by.avatar.mime`	string	Yes	—
`[].created_by.avatar.size`	string	Yes	—
`[].created_by.avatar.url`	string	Yes	—
`[].created_by.avatar.created_by`	number	No	—
`[].created_by.avatar.created_at`	string	Yes	—
`[].created_by.avatar.updated_at`	string	Yes	—
`[].created_by.is_guest`	number	No	—
`[].archived`	number	No	—
`[].is_bdd_managed`	boolean	No	True when a BDD sync (`tc sync`) made the dataset from the `Examples:` tables of a Scenario Outline in a `.feature` file in Git. The repository owns it, so it cannot be changed or deleted by hand (`PUT` and `DELETE` answer 422); only `tc sync` changes it. Each of its data rows also holds `bdd_example_index`, the Examples row as Cucumber numbers it in a report (`.`, for example “2.1”), and `bdd_example_name`, the name of its Examples table. They are not parameters.

[]

Errors

Status	Meaning
`401`	Unauthorized
`403`	Forbidden
`404`	Not found
`500`	Internal server error

Get test datasets

Example

Parameters

Response

Errors

Next steps