Set sort order for test cases

POST/testcases/setSortOrder

Set sort order for test cases

Example

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

TypeScript SDK

example.ts

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

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

const result = await api.setTestCasesSortOrder({
  "testCasesSortOrderPayload": {
    "testCase": {
      "id": [],
      "oldPosition": 123,
      "newPosition": 123
    },
    "project": 123
  }
});
console.log(result);

HTTP

curl --request POST \
  "https://api.testcollab.io/testcases/setSortOrder?token=$TESTCOLLAB_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "TestCase": {
    "id": [],
    "suite_id": 123,
    "oldPosition": 123,
    "newPosition": 123,
    "limit": 123
  },
  "project": 123
}'

Request body

Field	Type	Required	Description
TestCase	Test Case Sort Property	Yes	—
TestCase.id	Array of number	Yes	Array of test case IDs
TestCase.suite_id	number	No	—
TestCase.oldPosition	number	Yes	—
TestCase.newPosition	number	Yes	—
TestCase.limit	number	No	—
project	number	Yes	—

Response

200 — Action status details

Field	Type	Required	Description
status	boolean	Yes	—
created_id	number	Yes	—
message	string	No	—

Illustrative response

{
  "status": true,
  "created_id": 123,
  "message": "example"
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse cases and suites
• Authentication
• Handle errors