Get matching test plans' id(s)

POST/testplans/fetchIds

Get id(s) of test plan(s) that match the filter criteria

Example

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

TypeScript SDK

example.ts

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

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

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

HTTP

curl --request POST \
  "https://api.testcollab.io/testplans/fetchIds?token=$TESTCOLLAB_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "filterModel": "example",
  "project": 123
}'

Request body

Field	Type	Required	Description
filterModel	string	No	JSON Stringified
project	number	Yes	—

Response

200 — Action result

Field	Type	Required	Description
result	Array of number	Yes	ids list

Illustrative response

{
  "result": []
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse plans and runs
• Authentication
• Handle errors