Tests

Retrieving tests

Retrieving tests list

get

Returns many tests.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

folderstring · uuidOptional

folderIdstring · uuidOptional

latestRunbooleanOptional

Include the latest run summary for each test.

noFolderbooleanOptional

orderingstring · enumOptionalPossible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

querystringOptional

Search in names with the following query

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

401

Authentication credentials were missing or invalid.

get/api/v2/tests/

GET /api/v2/tests/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "folderId": null
    }
  ]
}

Create a new test

post

Create test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

namestring · max: 255 · nullableOptional

screenSizeTypestring · enumOptional

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

notesstring · nullableOptional

folderIdstring · nullableOptional

Responses

201Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 255Optional

folderIdstring · nullableOptional

groupsstringRead-onlyRequired

notesstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

webappUrlstringRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/tests/

POST /api/v2/tests/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 69

"name=null&screenSizeType='desktop'&notes=null&folderId=null"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "folderId": null,
  "groups": "text",
  "notes": null,
  "screenSizeType": "desktop",
  "webappUrl": "text"
}

Retrieving test by ID

get

Returns a single test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 255Optional

folderIdstring · nullableOptional

groupsstringRead-onlyRequired

notesstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

webappUrlstringRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/tests/{id}/

GET /api/v2/tests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "folderId": null,
  "groups": "text",
  "notes": null,
  "screenSizeType": "desktop",
  "webappUrl": "text"
}

Retrieve a test by its ID and remove it

delete

Remove a test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Responses

204

No response body

No content

401

Authentication credentials were missing or invalid.

404

Resource not found.

delete/api/v2/tests/{id}/

DELETE /api/v2/tests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Retrieve a test by its ID and update details

patch

Updates test details.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Body

namestring · max: 255 · nullableOptional

screenSizeTypestring · enumOptional

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

notesstring · nullableOptional

folderIdstring · nullableOptional

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 255Optional

folderIdstring · nullableOptional

groupsstringRead-onlyRequired

notesstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

webappUrlstringRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

patch/api/v2/tests/{id}/

PATCH /api/v2/tests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 69

"name=null&screenSizeType='desktop'&notes=null&folderId=null"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "folderId": null,
  "groups": "text",
  "notes": null,
  "screenSizeType": "desktop",
  "webappUrl": "text"
}

Insert a component into a test by test ID

post

Insert a component into a test. Prefer componentId. The legacy groupId field is still accepted and must contain the component relation ID returned by the components endpoint.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Body

groupIdstring · uuidOptional

componentIdstring · uuidWrite-onlyOptional

atIndexinteger · nullableOptional

Responses

201Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 255Optional

folderIdstring · nullableOptional

groupsstringRead-onlyRequired

notesstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

webappUrlstringRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

post/api/v2/tests/{id}/insert-component/

POST /api/v2/tests/{id}/insert-component/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118

"groupId='123e4567-e89b-12d3-a456-426614174000'&componentId='123e4567-e89b-12d3-a456-426614174000'&atIndex=null"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "folderId": null,
  "groups": "text",
  "notes": null,
  "screenSizeType": "desktop",
  "webappUrl": "text"
}

Unlink a component from a test by test ID

post

Unlink a component from a test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Body

groupIdstring · uuidRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 255Optional

folderIdstring · nullableOptional

groupsstringRead-onlyRequired

notesstring · nullableRead-onlyRequired

screenSizeTypestring · enumRead-onlyRequired

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

webappUrlstringRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

post/api/v2/tests/{id}/unlink-component/

POST /api/v2/tests/{id}/unlink-component/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 50

"groupId='123e4567-e89b-12d3-a456-426614174000'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "folderId": null,
  "groups": "text",
  "notes": null,
  "screenSizeType": "desktop",
  "webappUrl": "text"
}

Move a step to a different position or group

post

Update the position of a step within a test.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this test.

Body

stepIdstring · uuidRequired

groupIdstring · uuidOptional

atIndexintegerOptional

blockIdstring · nullableOptional

Responses

200

No response body

No content

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

post/api/v2/tests/{id}/update-step-position/

POST /api/v2/tests/{id}/update-step-position/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 125

"stepId='123e4567-e89b-12d3-a456-426614174000'&groupId='123e4567-e89b-12d3-a456-426614174000'&atIndex=1&blockId=null"

No content

PreviousProjects

NextSuites

Last updated 2 days ago

Was this helpful?