qase-api-client

Qase API v1 Client

Qase TestOps API v1 Specification.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.4.0
• Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen

For more information, please visit https://qase.io

Requirements

• Node.js >= 14.0.0
• npm >= 6.0.0

Installation & Usage

npm install

npm install qase-api-client

yarn install

yarn add qase-api-client

Then import the package:

import { ResultApi } from 'qase-api-client';

Getting Started

Please follow the installation procedure and then run the following:

import { RunsApi, Configuration } from 'qase-api-client';

// Defining the host is optional and defaults to https://api.qase.io/v2
// See configuration.ts for a list of all supported configuration parameters.
const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});

// The client must configure the authentication and authorization parameters
// in accordance with the API server security policy.
// Examples for each auth method are provided below, use the example that
// satisfies your auth use case.

// Configure API key authorization: TokenAuth
configuration.apiKey = process.env.API_KEY;

// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// configuration.apiKeyPrefix = 'Bearer';

// Create an instance of the API class
const qaseApi = new RunsApi(configuration);

// Create test run
try {
    const run = {
        title: 'Regression Test Run',
        description: 'Full regression testing before release',
        cases: [1, 2, 3, 4, 5],
        environment_id: 1,
        milestone_id: 1,
        tags: ['regression', 'release']
    };

    const response = await api.createRun('PROJECT_CODE', run);
    console.log(`Created test run with ID: ${response.result.id}`);
} catch (error) {
    console.error('Error creating run:', error);
}

Documentation for API Endpoints

All URIs are relative to https://api.qase.io/v1

Class	Method	HTTP request	Description
AttachmentsApi	deleteattachment	DELETE /attachment/{hash}	Remove attachment by Hash
AttachmentsApi	getattachment	GET /attachment/{hash}	Get attachment by Hash
AttachmentsApi	getattachments	GET /attachment	Get all attachments
AttachmentsApi	uploadattachment	POST /attachment/{code}	Upload attachment
AuthorsApi	getauthor	GET /author/{id}	Get a specific author
AuthorsApi	getauthors	GET /author	Get all authors
CasesApi	bulk	POST /case/{code}/bulk	Create test cases in bulk
CasesApi	caseattachexternalissue	POST /case/{code}/external-issue/attach	Attach the external issues to the test cases
CasesApi	casedetachexternalissue	POST /case/{code}/external-issue/detach	Detach the external issues from the test cases
CasesApi	createcase	POST /case/{code}	Create a new test case
CasesApi	deletecase	DELETE /case/{code}/{id}	Delete test case
CasesApi	getcase	GET /case/{code}/{id}	Get a specific test case
CasesApi	getcases	GET /case/{code}	Get all test cases
CasesApi	updatecase	PATCH /case/{code}/{id}	Update test case
ConfigurationsApi	createconfiguration	POST /configuration/{code}	Create a new configuration in a particular group.
ConfigurationsApi	createconfigurationgroup	POST /configuration/{code}/group	Create a new configuration group.
ConfigurationsApi	getconfigurations	GET /configuration/{code}	Get all configuration groups with configurations.
CustomFieldsApi	createcustomfield	POST /customfield	Create new Custom Field
CustomFieldsApi	deletecustomfield	DELETE /customfield/{id}	Delete Custom Field by id
CustomFieldsApi	getcustomfield	GET /customfield/{id}	Get Custom Field by id
CustomFieldsApi	getcustomfields	GET /customfield	Get all Custom Fields
CustomFieldsApi	updatecustomfield	PATCH /customfield/{id}	Update Custom Field by id
DefectsApi	createdefect	POST /defect/{code}	Create a new defect
DefectsApi	deletedefect	DELETE /defect/{code}/{id}	Delete defect
DefectsApi	getdefect	GET /defect/{code}/{id}	Get a specific defect
DefectsApi	getdefects	GET /defect/{code}	Get all defects
DefectsApi	resolvedefect	PATCH /defect/{code}/resolve/{id}	Resolve a specific defect
DefectsApi	updatedefect	PATCH /defect/{code}/{id}	Update defect
DefectsApi	updatedefectstatus	PATCH /defect/{code}/status/{id}	Update a specific defect status
EnvironmentsApi	createenvironment	POST /environment/{code}	Create a new environment
EnvironmentsApi	deleteenvironment	DELETE /environment/{code}/{id}	Delete environment
EnvironmentsApi	getenvironment	GET /environment/{code}/{id}	Get a specific environment
EnvironmentsApi	getenvironments	GET /environment/{code}	Get all environments
EnvironmentsApi	updateenvironment	PATCH /environment/{code}/{id}	Update environment
MilestonesApi	createmilestone	POST /milestone/{code}	Create a new milestone
MilestonesApi	deletemilestone	DELETE /milestone/{code}/{id}	Delete milestone
MilestonesApi	getmilestone	GET /milestone/{code}/{id}	Get a specific milestone
MilestonesApi	getmilestones	GET /milestone/{code}	Get all milestones
MilestonesApi	updatemilestone	PATCH /milestone/{code}/{id}	Update milestone
PlansApi	createplan	POST /plan/{code}	Create a new plan
PlansApi	deleteplan	DELETE /plan/{code}/{id}	Delete plan
PlansApi	getplan	GET /plan/{code}/{id}	Get a specific plan
PlansApi	getplans	GET /plan/{code}	Get all plans
PlansApi	updateplan	PATCH /plan/{code}/{id}	Update plan
ProjectsApi	createproject	POST /project	Create new project
ProjectsApi	deleteproject	DELETE /project/{code}	Delete Project by code
ProjectsApi	getproject	GET /project/{code}	Get Project by code
ProjectsApi	getprojects	GET /project	Get All Projects
ProjectsApi	grantaccesstoproject	POST /project/{code}/access	Grant access to project by code
ProjectsApi	revokeaccesstoproject	DELETE /project/{code}/access	Revoke access to project by code
ResultsApi	createresult	POST /result/{code}/{id}	Create test run result
ResultsApi	createresultbulk	POST /result/{code}/{id}/bulk	Bulk create test run result
ResultsApi	deleteresult	DELETE /result/{code}/{id}/{hash}	Delete test run result
ResultsApi	getresult	GET /result/{code}/{hash}	Get test run result by code
ResultsApi	getresults	GET /result/{code}	Get all test run results
ResultsApi	updateresult	PATCH /result/{code}/{id}/{hash}	Update test run result
RunsApi	completerun	POST /run/{code}/{id}/complete	Complete a specific run
RunsApi	createrun	POST /run/{code}	Create a new run
RunsApi	deleterun	DELETE /run/{code}/{id}	Delete run
RunsApi	getrun	GET /run/{code}/{id}	Get a specific run
RunsApi	getruns	GET /run/{code}	Get all runs
RunsApi	updaterunpublicity	PATCH /run/{code}/{id}/public	Update publicity of a specific run
SearchApi	search	GET /search	Search entities by Qase Query Language (QQL)
SharedStepsApi	createsharedstep	POST /sharedstep/{code}	Create a new shared step
SharedStepsApi	deletesharedstep	DELETE /sharedstep/{code}/{hash}	Delete shared step
SharedStepsApi	getsharedstep	GET /sharedstep/{code}/{hash}	Get a specific shared step
SharedStepsApi	getsharedsteps	GET /sharedstep/{code}	Get all shared steps
SharedStepsApi	updatesharedstep	PATCH /sharedstep/{code}/{hash}	Update shared step
SuitesApi	createsuite	POST /suite/{code}	Create a new test suite
SuitesApi	deletesuite	DELETE /suite/{code}/{id}	Delete test suite
SuitesApi	getsuite	GET /suite/{code}/{id}	Get a specific test suite
SuitesApi	getsuites	GET /suite/{code}	Get all test suites
SuitesApi	updatesuite	PATCH /suite/{code}/{id}	Update test suite
SystemFieldsApi	getsystemfields	GET /systemfield	Get all System Fields

Documentation For Models

• Attachment
• AttachmentGet
• AttachmentHash
• AttachmentListResponse
• AttachmentListResponseAllOfResult
• AttachmentResponse
• AttachmentUploadsResponse
• Attachmentupload
• Author
• AuthorListResponse
• AuthorListResponseAllOfResult
• AuthorResponse
• BaseResponse
• Bulk200Response
• Bulk200ResponseAllOfResult
• Configuration
• ConfigurationCreate
• ConfigurationGroup
• ConfigurationGroupCreate
• ConfigurationListResponse
• ConfigurationListResponseAllOfResult
• CustomField
• CustomFieldCreate
• CustomFieldCreateValueInner
• CustomFieldListResponse
• CustomFieldResponse
• CustomFieldUpdate
• CustomFieldValue
• CustomFieldsResponse
• CustomFieldsResponseAllOfResult
• Defect
• DefectCreate
• DefectListResponse
• DefectListResponseAllOfResult
• DefectQuery
• DefectResponse
• DefectStatus
• DefectUpdate
• Environment
• EnvironmentCreate
• EnvironmentListResponse
• EnvironmentListResponseAllOfResult
• EnvironmentResponse
• EnvironmentUpdate
• ExternalIssue
• ExternalIssueIssuesInner
• HashResponse
• HashResponseAllOfResult
• IdResponse
• IdResponseAllOfResult
• Milestone
• MilestoneCreate
• MilestoneListResponse
• MilestoneListResponseAllOfResult
• MilestoneResponse
• MilestoneUpdate
• Plan
• PlanCreate
• PlanDetailed
• PlanDetailedAllOfCases
• PlanListResponse
• PlanListResponseAllOfResult
• PlanQuery
• PlanResponse
• PlanUpdate
• Project
• ProjectAccess
• ProjectCodeResponse
• ProjectCodeResponseAllOfResult
• ProjectCounts
• ProjectCountsDefects
• ProjectCountsRuns
• ProjectCreate
• ProjectListResponse
• ProjectListResponseAllOfResult
• ProjectResponse
• QqlDefect
• QqlPlan
• QqlTestCase
• Requirement
• Response
• Result
• ResultCreate
• ResultCreateBulk
• ResultCreateCase
• ResultCreateResponse
• ResultCreateResponseAllOfResult
• ResultListResponse
• ResultListResponseAllOfResult
• ResultResponse
• ResultUpdate
• ResultcreateBulk
• Run
• RunCreate
• RunEnvironment
• RunListResponse
• RunListResponseAllOfResult
• RunMilestone
• RunPublic
• RunPublicResponse
• RunPublicResponseAllOfResult
• RunResponse
• RunStats
• SearchResponse
• SearchResponseAllOfResult
• SearchResponseAllOfResultEntities
• SharedStep
• SharedStepContent
• SharedStepContentCreate
• SharedStepCreate
• SharedStepListResponse
• SharedStepListResponseAllOfResult
• SharedStepResponse
• SharedStepUpdate
• Suite
• SuiteCreate
• SuiteDelete
• SuiteListResponse
• SuiteListResponseAllOfResult
• SuiteResponse
• SuiteUpdate
• SystemField
• SystemFieldListResponse
• SystemFieldOption
• TagValue
• TestCase
• TestCaseCreate
• TestCaseExternalIssues
• TestCaseExternalIssuesLinksInner
• TestCaseListResponse
• TestCaseListResponseAllOfResult
• TestCaseParams
• TestCaseQuery
• TestCaseResponse
• TestCaseUpdate
• TestCasebulk
• TestCasebulkCasesInner
• TestCaseexternalIssues
• TestStep
• TestStepCreate
• TestStepResult
• TestStepResultCreate

Documentation For Authorization

TokenAuth

• Type: API key
• API key parameter name: Token
• Location: HTTP header

Author

[e-mail]