Sign in
TestCaseManagement

List the test cases of one Zephyr project behind an integration

Changed on

One page of the project's case keys and names, for a picker that filters them locally. The project must be one of the integration's project_keys. With key, resolves that one case instead and returns it, or nothing when Zephyr does not know it; the key's project must equal project_key. Pages are read live from Zephyr; nothing is cached.

get/tcm/external/zephyr/integrations/{workspace_integration_id}/cases

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/tcm/external/zephyr/integrations/{workspace_integration_id}/cases
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_integration_idstring required

Query parameters

project_keystring required

A project key from the integration's project_keys.

keystring

An exact case key, e.g. PROJ-T12. When present, cursor is ignored.

cursorstring

The next_cursor of the previous page. Omitted reads the first page.

Response

One page of cases

project_keystring required
workspace_integration_idstring required
next_cursorstring

Pass as cursor to read the next page. Absent on the last page and for a key lookup.

Example response

{
  "cases": [
    {
      "key": "PROJ-T12"
    }
  ]
}

Changes