qase-api-client

Qase TestOps API v1 Specification.

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.4.0 For more information, please visit https://qase.io

Requirements.

PHP 8.0+

Installation & Usage

Use this command to install the package:

$ composer require qase/qase-api-client

Getting Started

use GuzzleHttp\Client;
use Qase\APIClientV1\Api\RunsApi;
use Qase\APIClientV1\Configuration;
use Qase\APIClientV1\Model\RunCreate;

$config = Configuration::getDefaultConfiguration()
    ->setHost(getenv('QASE_API_BASE_URL'))
    ->setApiKey('Token', getenv('QASE_API_TOKEN'));

$runApi = new RunsApi($client, $config);

$run = $runApi->createRun(getenv('QASE_PROJECT_CODE'), new RunCreate([
    'title' => sprintf('PHPUnit [%F]', microtime(true)),
    'is_autotest' => true,
]));

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

Authentication schemes defined for the API:

TokenAuth

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

Author

[email protected]