Set sort order for suites
POST
/suites/setOrderSet sort order for suites
Example
Section titled “Example”Use resource IDs from your own project. Keep the API token in your server or CI environment.
import { createConfiguration, SuitesApi } from '@testcollab/sdk';
const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);const api = new SuitesApi(config);
const result = await api.setSuitesOrder({ "suitesOrderPayload": { "suite": { "dropPosition": 123, "draggedOnSuiteId": 123, "targetSuiteId": [] }, "project": 123 }});console.log(result);curl --request POST \ "https://api.testcollab.io/suites/setOrder?token=$TESTCOLLAB_TOKEN" \ --header 'Content-Type: application/json' \ --data '{ "Suite": { "dropToGap": true, "dropPosition": 123, "draggedOnSuiteId": 123, "targetSuiteId": [] }, "project": 123}'Request body
Section titled “Request body”| Field | Type | Required | Description |
|---|---|---|---|
Suite |
Suite Order Property | Yes | — |
Suite.dropToGap |
boolean | No | — |
Suite.dropPosition |
number | Yes | — |
Suite.draggedOnSuiteId |
number | Yes | — |
Suite.targetSuiteId |
Array of number | Yes | Array of test suite ids which are dragged |
project |
number | Yes | — |
Response
Section titled “Response”200 — Action status details
| Field | Type | Required | Description |
|---|---|---|---|
status |
boolean | Yes | — |
created_id |
number | Yes | — |
message |
string | No | — |
{ "status": true, "created_id": 123, "message": "example"}Errors
Section titled “Errors”| Status | Meaning |
|---|---|
403 |
Forbidden |