Ana içeriğe geç
Versiyon: Next

Projects

RabbitQA has two unrelated resources called "project", owned by different services and reached through different prefixes. Choose the one that matches the module you are working with.

ResourcePrefixUsed by
Test management project/tmt/company/api/v1/projectsTestPilot, CaseWriter, Accessibility and the shared test repository
Automation project/autorunner/api/v1/projectsAutoRunner (the UI calls these Sources)

Both are scoped by X-Workspace-Id.

not

The organization-level container is the workspace, not the project. See Workspaces.

Test management projects​

Base path: https://api.rabbitqa.com/tmt/company/api/v1/projects

curl https://api.rabbitqa.com/tmt/company/api/v1/projects \
-H "Authorization: Bearer $TOKEN" \
-H "X-Workspace-Id: 91"
MethodPathPurpose
GET/projectsList projects
POST/projectsCreate a project
POST/projects/copyCopy an existing project
GET/projects/{projectId}Retrieve one
PUT/projects/{projectId}Update
DELETE/projects/{projectId}Delete
GET/projects/{projectId}/statusProject status summary

Contents of a project​

MethodPathPurpose
GET/projects/{projectId}/testCasesTest cases in the project
POST/projects/{projectId}/testCasesAdd test cases
DELETE/projects/{projectId}/testCasesRemove test cases
GET/projects/{projectId}/testSetsTest sets in the project
POST/projects/{projectId}/testSetsAdd test sets
DELETE/projects/{projectId}/testSetsRemove test sets
POST/projects/{projectId}/testTreesBuild the test tree
POST/projects/{projectId}/testResultsResults for the project
POST/projects/{projectId}/testResults/detailedResults with step detail
GET/projects/{projectId}/testCases/{testCaseId}/testResultLatest result for one case

Scheduled project operations live under /tmt/company/api/v1/projects/schedules.

AutoRunner automation projects​

Base path: https://api.rabbitqa.com/autorunner/api/v1/projects

These represent a source-controlled automation codebase. In the AutoRunner interface they appear as Sources.

MethodPathPurpose
GET/projectsList automation projects
GET/projects/summarySummary rows for listing screens
GET/projects/health-summaryHealth indicators per project
GET/projects/workspace-sourcesSources available in the workspace
GET/projects/{id}Retrieve one
GET/projects/{id}/contextResolved project context
POST/projectsCreate
PUT/projects/{id}Update
PATCH/projects/{id}/scmChange the source-control binding
PATCH/projects/{id}/nameRename
PATCH/projects/{id}/branchChange the tracked branch
DELETE/projects/{id}Delete
GET/projects/typesSupported project types
POST/projects/detect-frameworkDetect the test framework in a repository

Related endpoints on the same base path cover project settings, members, templates and Postman collections.

See also​

  • Test Cases — the case resource shared by TestPilot and CaseWriter
  • Test Runs — executing and reporting on tests