Documentation / test-management / TestManagementClient

Class: TestManagementClient

Defined in: test-management/src/index.ts:4

Extends

• GeneratedTestManagementClient

Constructors

Constructor

new TestManagementClient(options?): TestManagementClient

Defined in: test-management/src/index.ts:5

Parameters

Parameter	Type
options?	BrowserStackOptions

Returns

TestManagementClient

Overrides

GeneratedTestManagementClient.constructor

Properties

Property	Type	Description	Inherited from	Defined in
authHeader?	string	HTTP Basic Auth header derived from username and access key.	GeneratedTestManagementClient.authHeader	core/src/api-client.ts:55
baseUrls	object	Base URLs used for API requests.	GeneratedTestManagementClient.baseUrls	core/src/api-client.ts:53
baseUrls.sdk	string	-	-	core/src/api-client.ts:53
baseUrls.sdkCloud	string	-	-	core/src/api-client.ts:53
clientTimeout?	number	-	GeneratedTestManagementClient.clientTimeout	core/src/api-client.ts:66
fetchFn	(input, init?) => Promise<Response>	Fetch implementation used to make HTTP requests.	GeneratedTestManagementClient.fetchFn	core/src/api-client.ts:59
registry	CodecRegistry	Registry of request and response codecs.	GeneratedTestManagementClient.registry	core/src/api-client.ts:61
userAgent	string	User-Agent string sent with every request.	GeneratedTestManagementClient.userAgent	core/src/api-client.ts:57

Methods

addTestCaseAttachment()

addTestCaseAttachment(projectId, testCaseId, body, inline?, options?): Promise<AddTestManagementTestCaseAttachmentResult>

Defined in: openapi/generated/test-management.client.ts:839

Add attachment to a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
body	{ file: Blob; } | { url: string; } & object & Record<string, unknown>	-
inline?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<AddTestManagementTestCaseAttachmentResult>

Inherited from

GeneratedTestManagementClient.addTestCaseAttachment

---

addTestResultAttachment()

addTestResultAttachment(projectId, testResultId, body, options?): Promise<AddTestManagementTestResultAttachmentResult>

Defined in: openapi/generated/test-management.client.ts:1175

Add attachment to a test result

Parameters

Parameter	Type	Description
projectId	string	-
testResultId	number	-
body	{ file: Blob; } | { url: string; } & object & Record<string, unknown>	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<AddTestManagementTestResultAttachmentResult>

Inherited from

GeneratedTestManagementClient.addTestResultAttachment

---

addTestRunResults()

addTestRunResults(projectId, testRunId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1112

Add test result(s) to a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
body	DeepCamelCase<{ configuration_id?: number; test_case_id: string; test_result: { comment?: string; custom_fields?: {[key: string]: unknown; }; duration?: number; issue_tracker?: { host?: string; name?: string; }; issues?: string[]; status: string; }; } | { results: object[]; }>	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.addTestRunResults

---

archiveTestCase()

archiveTestCase(projectId, testCaseId, options?): Promise<ArchiveTestManagementTestCaseResult>

Defined in: openapi/generated/test-management.client.ts:755

Archive a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<ArchiveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.archiveTestCase

---

assignTestRunTestCases()

assignTestRunTestCases(projectId, testRunId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1028

Update assignees of test cases within a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
body	{ assignTo: object[]; }	-
body.assignTo	object[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.assignTestRunTestCases

---

bulkArchiveTestCases()

bulkArchiveTestCases(projectId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:629

Bulk archive test cases

Parameters

Parameter	Type	Description
projectId	string	-
body	{ ids: string[]; }	-
body.ids	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkArchiveTestCases

---

bulkDeleteTestCases()

bulkDeleteTestCases(projectId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:608

Bulk delete test cases

Parameters

Parameter	Type	Description
projectId	string	-
body	{ ids: string[]; }	-
body.ids	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkDeleteTestCases

---

bulkEditTestCases()

bulkEditTestCases(projectId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:587

Bulk edit test cases

Parameters

Parameter	Type	Description
projectId	string	-
body	{ ids: string[]; testCase: { automationStatus?: string; caseType?: string; customFields?: {[key: string]: unknown; }; owner?: string; preconditions?: string; priority?: string; status?: string; tags?: string[]; }; }	-
body.ids	string[]	-
body.testCase?	{ automationStatus?: string; caseType?: string; customFields?: {[key: string]: unknown; }; owner?: string; preconditions?: string; priority?: string; status?: string; tags?: string[]; }	-
body.testCase.automationStatus?	string	-
body.testCase.caseType?	string	-
body.testCase.customFields?	{[key: string]: unknown; }	-
body.testCase.owner?	string	-
body.testCase.preconditions?	string	-
body.testCase.priority?	string	-
body.testCase.status?	string	-
body.testCase.tags?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkEditTestCases

---

bulkEditTestCasesWithOperations()

bulkEditTestCasesWithOperations(projectId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:671

Bulk edit test cases with operations

Parameters

Parameter	Type	Description
projectId	string	-
body	{ ids: string[]; testCase: {[key: string]: never; }; }	-
body.ids	string[]	-
body.testCase?	{[key: string]: never; }	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkEditTestCasesWithOperations

---

bulkUnarchiveTestCases()

bulkUnarchiveTestCases(projectId, body, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:650

Bulk unarchive test cases

Parameters

Parameter	Type	Description
projectId	string	-
body	{ ids: string[]; }	-
body.ids	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkUnarchiveTestCases

---

closeTestRun()

closeTestRun(projectId, testRunId, options?): Promise<CloseTestManagementTestRunResult>

Defined in: openapi/generated/test-management.client.ts:1049

Close a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CloseTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.closeTestRun

---

createConfiguration()

createConfiguration(body, options?): Promise<{ id?: number; name?: string; success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1343

Add a custom configuration

Parameters

Parameter	Type	Description
body	{ name: string; }	-
body.name	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ id?: number; name?: string; success?: boolean; }>

Inherited from

GeneratedTestManagementClient.createConfiguration

---

createCustomField()

createCustomField(body, options?): Promise<CreateTestManagementCustomFieldResult>

Defined in: openapi/generated/test-management.client.ts:1406

Create a custom field

Parameters

Parameter	Type	Description
body	{ appliesToAllProjects?: boolean; assignedProjects?: string[]; fieldEntityType: "test_case" | "test_result"; fieldName: string; fieldType: "string" | "boolean" | "text" | "url" | "dropdown" | "user" | "date" | "int"; isRequired?: boolean; linkToFutureProjects?: boolean; options?: object[]; placeHolderText?: string; }	-
body.appliesToAllProjects?	boolean	-
body.assignedProjects?	string[]	-
body.fieldEntityType?	"test_case" | "test_result"	-
body.fieldName?	string	-
body.fieldType?	"string" | "boolean" | "text" | "url" | "dropdown" | "user" | "date" | "int"	-
body.isRequired?	boolean	-
body.linkToFutureProjects?	boolean	-
body.options?	object[]	-
body.placeHolderText?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementCustomFieldResult>

Inherited from

GeneratedTestManagementClient.createCustomField

---

createFolder()

createFolder(projectId, body, options?): Promise<CreateTestManagementFolderResult>

Defined in: openapi/generated/test-management.client.ts:461

Create a folder

Parameters

Parameter	Type	Description
projectId	string	-
body	{ folder?: { description: string; name: string; parentId?: number | null; }; }	-
body.folder?	{ description: string; name: string; parentId?: number | null; }	-
body.folder.description?	string	-
body.folder.name?	string	-
body.folder.parentId?	number | null	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.createFolder

---

createProject()

createProject(body, options?): Promise<CreateTestManagementProjectResult>

Defined in: openapi/generated/test-management.client.ts:356

Create a project

Parameters

Parameter	Type	Description
body	{ project?: { description?: string; name: string; }; }	-
body.project?	{ description?: string; name: string; }	-
body.project.description?	string	-
body.project.name?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.createProject

---

createTestCase()

createTestCase(projectId, folderId, body, options?): Promise<CreateTestManagementTestCaseResult>

Defined in: openapi/generated/test-management.client.ts:692

Create a test case

Parameters

Parameter	Type	Description
projectId	string	-
folderId	number	-
body	{ testCase?: { background?: string; caseType?: string; customFields?: {[key: string]: unknown; }; description?: string; feature?: string; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; owner?: string; preconditions?: string; priority?: string; scenario?: string; tags?: string[]; template?: string; testCaseSteps?: object[]; }; }	-
body.testCase?	{ background?: string; caseType?: string; customFields?: {[key: string]: unknown; }; description?: string; feature?: string; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; owner?: string; preconditions?: string; priority?: string; scenario?: string; tags?: string[]; template?: string; testCaseSteps?: object[]; }	-
body.testCase.background?	string	-
body.testCase.caseType?	string	-
body.testCase.customFields?	{[key: string]: unknown; }	-
body.testCase.description?	string	-
body.testCase.feature?	string	-
body.testCase.issues?	string[]	-
body.testCase.issueTracker?	{ host?: string; name?: string; }	-
body.testCase.issueTracker.host?	string	-
body.testCase.issueTracker.name?	string	-
body.testCase.name?	string	-
body.testCase.owner?	string	-
body.testCase.preconditions?	string	-
body.testCase.priority?	string	-
body.testCase.scenario?	string	-
body.testCase.tags?	string[]	-
body.testCase.template?	string	-
body.testCase.testCaseSteps?	object[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.createTestCase

---

createTestPlan()

createTestPlan(projectId, body, options?): Promise<CreateTestManagementTestPlanResult>

Defined in: openapi/generated/test-management.client.ts:1238

Create a test plan

Parameters

Parameter	Type	Description
projectId	string	-
body	{ testPlan?: { description?: string; endDate?: string | null; name: string; planStatus?: string; startDate?: string; }; }	-
body.testPlan?	{ description?: string; endDate?: string | null; name: string; planStatus?: string; startDate?: string; }	-
body.testPlan.description?	string	-
body.testPlan.endDate?	string | null	-
body.testPlan.name?	string	-
body.testPlan.planStatus?	string	-
body.testPlan.startDate?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.createTestPlan

---

createTestRun()

createTestRun(projectId, body, options?): Promise<CreateTestManagementTestRunResult>

Defined in: openapi/generated/test-management.client.ts:923

Create a test run

Parameters

Parameter	Type	Description
projectId	string	-
body	{ testRun?: { assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; folderIds?: number[]; includeAll?: boolean; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; runState?: string; tags?: string[]; testCaseAssignee?: string; testCases?: string[]; testPlanId?: string; }; }	-
body.testRun?	{ assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; folderIds?: number[]; includeAll?: boolean; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; runState?: string; tags?: string[]; testCaseAssignee?: string; testCases?: string[]; testPlanId?: string; }	-
body.testRun.assignee?	string	-
body.testRun.configurationMap?	object[]	-
body.testRun.configurations?	number[]	-
body.testRun.description?	string	-
body.testRun.filterTestCases?	{ caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }	-
body.testRun.filterTestCases.caseType?	string[]	-
body.testRun.filterTestCases.customFields?	{[key: string]: unknown; }	-
body.testRun.filterTestCases.owner?	string[]	-
body.testRun.filterTestCases.priority?	string[]	-
body.testRun.filterTestCases.status?	string[]	-
body.testRun.filterTestCases.tags?	string[]	-
body.testRun.folderIds?	number[]	-
body.testRun.includeAll?	boolean	-
body.testRun.issues?	string[]	-
body.testRun.issueTracker?	{ host?: string; name?: string; }	-
body.testRun.issueTracker.host?	string	-
body.testRun.issueTracker.name?	string	-
body.testRun.name?	string	-
body.testRun.runState?	string	-
body.testRun.tags?	string[]	-
body.testRun.testCaseAssignee?	string	-
body.testRun.testCases?	string[]	-
body.testRun.testPlanId?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<CreateTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.createTestRun

---

deleteCustomField()

deleteCustomField(customFieldId, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1448

Delete a custom field

Parameters

Parameter	Type	Description
customFieldId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteCustomField

---

deleteFolder()

deleteFolder(projectId, folderId, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:524

Delete a folder

Parameters

Parameter	Type	Description
projectId	string	-
folderId	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteFolder

---

deleteProject()

deleteProject(projectId, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:419

Delete a project

Parameters

Parameter	Type	Description
projectId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ message?: string; success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteProject

---

deleteTestCase()

deleteTestCase(projectId, testCaseId, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:734

Delete a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteTestCase

---

deleteTestCaseAttachment()

deleteTestCaseAttachment(projectId, testCaseId, attachmentId, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:860

Delete attachment from a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
attachmentId	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteTestCaseAttachment

---

deleteTestResultAttachment()

deleteTestResultAttachment(projectId, testResultId, attachmentId, options?): Promise<{ success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1196

Delete attachment from a test result

Parameters

Parameter	Type	Description
projectId	string	-
testResultId	number	-
attachmentId	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteTestResultAttachment

---

deleteTestRun()

deleteTestRun(projectId, testRunId, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-management.client.ts:1070

Delete a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ message?: string; success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteTestRun

---

execute()

protected execute<T>(spec): Promise<T>

Defined in: core/src/api-client.ts:126

Internal

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
spec	{[key: string]: unknown; baseUrl?: "sdk" | "sdkCloud"; method: HttpMethod; operationId: string; params?: { path?: Record<string, unknown>; query?: Record<string, unknown>; }; path: string; requestCodec?: string; requestCodecConfig?: unknown; requestInput?: unknown; responseCodec: string; responseCodecConfig: unknown; signal?: AbortSignal; }
spec.baseUrl?	"sdk" | "sdkCloud"
spec.method	HttpMethod
spec.operationId	string
spec.params?	{ path?: Record<string, unknown>; query?: Record<string, unknown>; }
spec.params.path?	Record<string, unknown>
spec.params.query?	Record<string, unknown>
spec.path	string
spec.requestCodec?	string
spec.requestCodecConfig?	unknown
spec.requestInput?	unknown
spec.responseCodec	string
spec.responseCodecConfig	unknown
spec.signal?	AbortSignal

Returns

Promise<T>

Inherited from

GeneratedTestManagementClient.execute

---

getConfiguration()

getConfiguration(configurationId, options?): Promise<GetTestManagementConfigurationResult>

Defined in: openapi/generated/test-management.client.ts:1364

Get configuration by ID

Parameters

Parameter	Type	Description
configurationId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementConfigurationResult>

Inherited from

GeneratedTestManagementClient.getConfiguration

---

getConfigurations()

getConfigurations(p?, pageSize?, options?): Promise<GetTestManagementConfigurationsResult>

Defined in: openapi/generated/test-management.client.ts:1322

Get all configurations

Parameters

Parameter	Type	Description
p?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementConfigurationsResult>

Inherited from

GeneratedTestManagementClient.getConfigurations

---

getCustomFields()

getCustomFields(options?): Promise<GetTestManagementCustomFieldsResult>

Defined in: openapi/generated/test-management.client.ts:1385

Get all custom fields

Parameters

Parameter	Type	Description
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementCustomFieldsResult>

Inherited from

GeneratedTestManagementClient.getCustomFields

---

getFolder()

getFolder(projectId, folderId, options?): Promise<GetTestManagementFolderResult>

Defined in: openapi/generated/test-management.client.ts:482

Get folder details

Parameters

Parameter	Type	Description
projectId	string	-
folderId	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.getFolder

---

getFolders()

getFolders(projectId, p?, pageSize?, options?): Promise<GetTestManagementFoldersResult>

Defined in: openapi/generated/test-management.client.ts:440

Get list of folders in a project

Parameters

Parameter	Type	Description
projectId	string	-
p?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementFoldersResult>

Inherited from

GeneratedTestManagementClient.getFolders

---

getProject()

getProject(projectId, options?): Promise<GetTestManagementProjectResult>

Defined in: openapi/generated/test-management.client.ts:377

Get project details

Parameters

Parameter	Type	Description
projectId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.getProject

---

getProjects()

getProjects(p?, pageSize?, options?): Promise<GetTestManagementProjectsResult>

Defined in: openapi/generated/test-management.client.ts:335

Get list of projects

Parameters

Parameter	Type	Description
p?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementProjectsResult>

Inherited from

GeneratedTestManagementClient.getProjects

---

getTestCaseAttachments()

getTestCaseAttachments(projectId, testCaseId, p?, options?): Promise<GetTestManagementTestCaseAttachmentsResult>

Defined in: openapi/generated/test-management.client.ts:818

Get attachments for a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
p?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestCaseAttachmentsResult>

Inherited from

GeneratedTestManagementClient.getTestCaseAttachments

---

getTestCaseResults()

getTestCaseResults(projectId, testCaseId, p?, options?): Promise<GetTestManagementTestCaseResultsResult>

Defined in: openapi/generated/test-management.client.ts:881

Get test results for a test case across all test runs

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
p?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestCaseResultsResult>

Inherited from

GeneratedTestManagementClient.getTestCaseResults

---

getTestCases()

getTestCases(projectId, p?, pageSize?, updatedAfter?, updatedBefore?, archived?, minify?, id?, status?, priority?, owner?, caseType?, folderId?, tags?, issueIds?, issueType?, options?): Promise<GetTestManagementTestCasesResult>

Defined in: openapi/generated/test-management.client.ts:566

Get list of test cases

Parameters

Parameter	Type	Description
projectId	string	-
p?	number	-
pageSize?	number	-
updatedAfter?	string	-
updatedBefore?	string	-
archived?	string	-
minify?	string	-
id?	string	-
status?	string	-
priority?	string	-
owner?	string	-
caseType?	string	-
folderId?	number	-
tags?	string	-
issueIds?	string	-
issueType?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestCasesResult>

Inherited from

GeneratedTestManagementClient.getTestCases

---

getTestPlan()

getTestPlan(projectId, testPlanId, options?): Promise<GetTestManagementTestPlanResult>

Defined in: openapi/generated/test-management.client.ts:1259

Get test plan details

Parameters

Parameter	Type	Description
projectId	string	-
testPlanId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.getTestPlan

---

getTestPlans()

getTestPlans(projectId, p?, pageSize?, options?): Promise<GetTestManagementTestPlansResult>

Defined in: openapi/generated/test-management.client.ts:1217

Get list of test plans

Parameters

Parameter	Type	Description
projectId	string	-
p?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestPlansResult>

Inherited from

GeneratedTestManagementClient.getTestPlans

---

getTestPlanTestRuns()

getTestPlanTestRuns(projectId, testPlanId, p?, options?): Promise<GetTestManagementTestPlanTestRunsResult>

Defined in: openapi/generated/test-management.client.ts:1301

Get test runs linked to a test plan

Parameters

Parameter	Type	Description
projectId	string	-
testPlanId	string	-
p?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestPlanTestRunsResult>

Inherited from

GeneratedTestManagementClient.getTestPlanTestRuns

---

getTestResultAttachments()

getTestResultAttachments(projectId, testResultId, p?, options?): Promise<GetTestManagementTestResultAttachmentsResult>

Defined in: openapi/generated/test-management.client.ts:1154

Get attachments for a test result

Parameters

Parameter	Type	Description
projectId	string	-
testResultId	number	-
p?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestResultAttachmentsResult>

Inherited from

GeneratedTestManagementClient.getTestResultAttachments

---

getTestRun()

getTestRun(projectId, testRunId, minify?, options?): Promise<GetTestManagementTestRunResult>

Defined in: openapi/generated/test-management.client.ts:944

Get test run details

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
minify?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.getTestRun

---

getTestRunResults()

getTestRunResults(projectId, testRunId, p?, validateTc?, options?): Promise<GetTestManagementTestRunResultsResult>

Defined in: openapi/generated/test-management.client.ts:1091

Get all test results for a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
p?	number	-
validateTc?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestRunResultsResult>

Inherited from

GeneratedTestManagementClient.getTestRunResults

---

getTestRuns()

getTestRuns(projectId, closedBefore?, closedAfter?, createdBefore?, createdAfter?, testPlanId?, assignee?, includeClosed?, runState?, options?): Promise<GetTestManagementTestRunsResult>

Defined in: openapi/generated/test-management.client.ts:902

Get list of test runs

Parameters

Parameter	Type	Description
projectId	string	-
closedBefore?	string	-
closedAfter?	string	-
createdBefore?	string	-
createdAfter?	string	-
testPlanId?	string	-
assignee?	string	-
includeClosed?	string	-
runState?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestRunsResult>

Inherited from

GeneratedTestManagementClient.getTestRuns

---

getTestRunTestCaseResults()

getTestRunTestCaseResults(projectId, testRunId, testCaseId, p?, options?): Promise<GetTestManagementTestRunTestCaseResultsResult>

Defined in: openapi/generated/test-management.client.ts:1133

Get test results for a specific test case in a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
testCaseId	string	-
p?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestRunTestCaseResultsResult>

Inherited from

GeneratedTestManagementClient.getTestRunTestCaseResults

---

getTestRunTestCases()

getTestRunTestCases(projectId, testRunId, p?, fetchSteps?, minify?, options?): Promise<GetTestManagementTestRunTestCasesResult>

Defined in: openapi/generated/test-management.client.ts:965

Get test cases of a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
p?	number	-
fetchSteps?	string	-
minify?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<GetTestManagementTestRunTestCasesResult>

Inherited from

GeneratedTestManagementClient.getTestRunTestCases

---

moveFolder()

moveFolder(projectId, folderId, body, options?): Promise<MoveTestManagementFolderResult>

Defined in: openapi/generated/test-management.client.ts:545

Move a folder

Parameters

Parameter	Type	Description
projectId	string	-
folderId	number	-
body	{ parentId?: number | null; }	-
body.parentId?	number | null	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<MoveTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.moveFolder

---

moveTestCase()

moveTestCase(projectId, testCaseId, body, options?): Promise<MoveTestManagementTestCaseResult>

Defined in: openapi/generated/test-management.client.ts:797

Move a test case to a different folder

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
body	{ destinationFolderId: number; }	-
body.destinationFolderId	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<MoveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.moveTestCase

---

patchTestRun()

patchTestRun(projectId, testRunId, body, options?): Promise<PatchTestManagementTestRunResult>

Defined in: openapi/generated/test-management.client.ts:1007

Partially update a test run

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
body	{ testRun?: { configurationMap?: object[]; configurations?: number[]; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; name?: string; runState?: string; tags?: string[]; }; }	-
body.testRun?	{ configurationMap?: object[]; configurations?: number[]; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; name?: string; runState?: string; tags?: string[]; }	-
body.testRun.configurationMap?	object[]	-
body.testRun.configurations?	number[]	-
body.testRun.filterTestCases?	{ caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }	-
body.testRun.filterTestCases.caseType?	string[]	-
body.testRun.filterTestCases.customFields?	{[key: string]: unknown; }	-
body.testRun.filterTestCases.owner?	string[]	-
body.testRun.filterTestCases.priority?	string[]	-
body.testRun.filterTestCases.status?	string[]	-
body.testRun.filterTestCases.tags?	string[]	-
body.testRun.name?	string	-
body.testRun.runState?	string	-
body.testRun.tags?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<PatchTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.patchTestRun

---

unarchiveTestCase()

unarchiveTestCase(projectId, testCaseId, options?): Promise<UnarchiveTestManagementTestCaseResult>

Defined in: openapi/generated/test-management.client.ts:776

Unarchive a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UnarchiveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.unarchiveTestCase

---

updateCustomField()

updateCustomField(customFieldId, body, options?): Promise<UpdateTestManagementCustomFieldResult>

Defined in: openapi/generated/test-management.client.ts:1427

Update a custom field

Parameters

Parameter	Type	Description
customFieldId	string	-
body	{ appliesToAllProjects?: boolean; assignedProjects?: string[]; fieldEntityType?: string; fieldName?: string; fieldType?: string; isRequired?: boolean; linkToFutureProjects?: boolean; options?: object[]; placeHolderText?: string; }	-
body.appliesToAllProjects?	boolean	-
body.assignedProjects?	string[]	-
body.fieldEntityType?	string	-
body.fieldName?	string	-
body.fieldType?	string	-
body.isRequired?	boolean	-
body.linkToFutureProjects?	boolean	-
body.options?	object[]	-
body.placeHolderText?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementCustomFieldResult>

Inherited from

GeneratedTestManagementClient.updateCustomField

---

updateFolder()

updateFolder(projectId, folderId, body, options?): Promise<UpdateTestManagementFolderResult>

Defined in: openapi/generated/test-management.client.ts:503

Update a folder

Parameters

Parameter	Type	Description
projectId	string	-
folderId	number	-
body	{ folder?: { description?: string; name?: string; }; }	-
body.folder?	{ description?: string; name?: string; }	-
body.folder.description?	string	-
body.folder.name?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.updateFolder

---

updateProject()

updateProject(projectId, body, options?): Promise<UpdateTestManagementProjectResult>

Defined in: openapi/generated/test-management.client.ts:398

Update a project

Parameters

Parameter	Type	Description
projectId	string	-
body	{ project?: { description?: string; name?: string; }; }	-
body.project?	{ description?: string; name?: string; }	-
body.project.description?	string	-
body.project.name?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.updateProject

---

updateTestCase()

updateTestCase(projectId, testCaseId, body, options?): Promise<UpdateTestManagementTestCaseResult>

Defined in: openapi/generated/test-management.client.ts:713

Update a test case

Parameters

Parameter	Type	Description
projectId	string	-
testCaseId	string	-
body	{ testCase?: { automationStatus?: string; background?: string; caseType?: string; customFields?: {[key: string]: unknown; }; description?: string; feature?: string; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; owner?: string; preconditions?: string; priority?: string; scenario?: string; status?: string; tags?: string[]; testCaseSteps?: object[]; }; }	-
body.testCase?	{ automationStatus?: string; background?: string; caseType?: string; customFields?: {[key: string]: unknown; }; description?: string; feature?: string; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; owner?: string; preconditions?: string; priority?: string; scenario?: string; status?: string; tags?: string[]; testCaseSteps?: object[]; }	-
body.testCase.automationStatus?	string	-
body.testCase.background?	string	-
body.testCase.caseType?	string	-
body.testCase.customFields?	{[key: string]: unknown; }	-
body.testCase.description?	string	-
body.testCase.feature?	string	-
body.testCase.issues?	string[]	-
body.testCase.issueTracker?	{ host?: string; name?: string; }	-
body.testCase.issueTracker.host?	string	-
body.testCase.issueTracker.name?	string	-
body.testCase.name?	string	-
body.testCase.owner?	string	-
body.testCase.preconditions?	string	-
body.testCase.priority?	string	-
body.testCase.scenario?	string	-
body.testCase.status?	string	-
body.testCase.tags?	string[]	-
body.testCase.testCaseSteps?	object[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.updateTestCase

---

updateTestPlan()

updateTestPlan(projectId, testPlanId, body, options?): Promise<UpdateTestManagementTestPlanResult>

Defined in: openapi/generated/test-management.client.ts:1280

Update a test plan

Parameters

Parameter	Type	Description
projectId	string	-
testPlanId	string	-
body	{ testPlan?: { description?: string; endDate?: string | null; name?: string; planStatus?: string; startDate?: string; }; }	-
body.testPlan?	{ description?: string; endDate?: string | null; name?: string; planStatus?: string; startDate?: string; }	-
body.testPlan.description?	string	-
body.testPlan.endDate?	string | null	-
body.testPlan.name?	string	-
body.testPlan.planStatus?	string	-
body.testPlan.startDate?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.updateTestPlan

---

updateTestRun()

updateTestRun(projectId, testRunId, body, options?): Promise<UpdateTestManagementTestRunResult>

Defined in: openapi/generated/test-management.client.ts:986

Fully update a test run (replaces test cases)

Parameters

Parameter	Type	Description
projectId	string	-
testRunId	string	-
body	{ testRun?: { assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; folderIds?: number[]; includeAll?: boolean; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; runState?: string; tags?: string[]; testCaseAssignee?: string; testCases?: string[]; testPlanId?: string; }; }	-
body.testRun?	{ assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; folderIds?: number[]; includeAll?: boolean; issues?: string[]; issueTracker?: { host?: string; name?: string; }; name?: string; runState?: string; tags?: string[]; testCaseAssignee?: string; testCases?: string[]; testPlanId?: string; }	-
body.testRun.assignee?	string	-
body.testRun.configurationMap?	object[]	-
body.testRun.configurations?	number[]	-
body.testRun.description?	string	-
body.testRun.filterTestCases?	{ caseType?: string[]; customFields?: {[key: string]: unknown; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }	-
body.testRun.filterTestCases.caseType?	string[]	-
body.testRun.filterTestCases.customFields?	{[key: string]: unknown; }	-
body.testRun.filterTestCases.owner?	string[]	-
body.testRun.filterTestCases.priority?	string[]	-
body.testRun.filterTestCases.status?	string[]	-
body.testRun.filterTestCases.tags?	string[]	-
body.testRun.folderIds?	number[]	-
body.testRun.includeAll?	boolean	-
body.testRun.issues?	string[]	-
body.testRun.issueTracker?	{ host?: string; name?: string; }	-
body.testRun.issueTracker.host?	string	-
body.testRun.issueTracker.name?	string	-
body.testRun.name?	string	-
body.testRun.runState?	string	-
body.testRun.tags?	string[]	-
body.testRun.testCaseAssignee?	string	-
body.testRun.testCases?	string[]	-
body.testRun.testPlanId?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<UpdateTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.updateTestRun