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	Modifier	Type	Inherited from	Defined in
authHeader?	readonly	string	GeneratedTestManagementClient.authHeader	core/src/api-client.ts:50
baseUrls	readonly	object	GeneratedTestManagementClient.baseUrls	core/src/api-client.ts:49
baseUrls.sdk	public	string	-	core/src/api-client.ts:49
baseUrls.sdkCloud	public	string	-	core/src/api-client.ts:49
fetchFn	readonly	(input, init?) => Promise<Response>	GeneratedTestManagementClient.fetchFn	core/src/api-client.ts:52
registry	readonly	CodecRegistry	GeneratedTestManagementClient.registry	core/src/api-client.ts:53
userAgent	readonly	string	GeneratedTestManagementClient.userAgent	core/src/api-client.ts:51

Methods

addTestCaseAttachment()

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

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

Add attachment to a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
body	{ file: Blob; } | { url: string; } & object & Record<string, unknown>
inline?	string
options?	ExecuteOptions

Returns

Promise<AddTestManagementTestCaseAttachmentResult>

Inherited from

GeneratedTestManagementClient.addTestCaseAttachment

---

addTestResultAttachment()

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

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

Add attachment to a test result

Parameters

Parameter	Type
projectId	string
testResultId	number
body	{ file: Blob; } | { url: string; } & object & Record<string, unknown>
options?	ExecuteOptions

Returns

Promise<AddTestManagementTestResultAttachmentResult>

Inherited from

GeneratedTestManagementClient.addTestResultAttachment

---

addTestRunResults()

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

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

Add test result(s) to a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
body	DeepCamelCase<{ configuration_id?: number; test_case_id: string; test_result: { comment?: string; custom_fields?: Record<string, never>; duration?: number; issue_tracker?: { host?: string; name?: string; }; issues?: string[]; status: string; }; } | { results: object[]; }>
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.addTestRunResults

---

archiveTestCase()

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

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

Archive a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
options?	ExecuteOptions

Returns

Promise<ArchiveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.archiveTestCase

---

assignTestRunTestCases()

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

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

Update assignees of test cases within a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
body	{ assignTo: object[]; }
body.assignTo	object[]
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.assignTestRunTestCases

---

bulkArchiveTestCases()

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

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

Bulk archive test cases

Parameters

Parameter	Type
projectId	string
body	{ ids: string[]; }
body.ids	string[]
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkArchiveTestCases

---

bulkDeleteTestCases()

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

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

Bulk delete test cases

Parameters

Parameter	Type
projectId	string
body	{ ids: string[]; }
body.ids	string[]
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkDeleteTestCases

---

bulkEditTestCases()

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

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

Bulk edit test cases

Parameters

Parameter	Type
projectId	string
body	{ ids: string[]; testCase: { automationStatus?: string; caseType?: string; customFields?: {[key: string]: never; }; owner?: string; preconditions?: string; priority?: string; status?: string; tags?: string[]; }; }
body.ids	string[]
body.testCase?	{ automationStatus?: string; caseType?: string; customFields?: {[key: string]: never; }; owner?: string; preconditions?: string; priority?: string; status?: string; tags?: string[]; }
body.testCase.automationStatus?	string
body.testCase.caseType?	string
body.testCase.customFields?	{[key: string]: never; }
body.testCase.owner?	string
body.testCase.preconditions?	string
body.testCase.priority?	string
body.testCase.status?	string
body.testCase.tags?	string[]
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkEditTestCases

---

bulkEditTestCasesWithOperations()

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

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

Bulk edit test cases with operations

Parameters

Parameter	Type
projectId	string
body	{ ids: string[]; testCase: {[key: string]: never; }; }
body.ids	string[]
body.testCase?	{[key: string]: never; }
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkEditTestCasesWithOperations

---

bulkUnarchiveTestCases()

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

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

Bulk unarchive test cases

Parameters

Parameter	Type
projectId	string
body	{ ids: string[]; }
body.ids	string[]
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.bulkUnarchiveTestCases

---

closeTestRun()

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

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

Close a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
options?	ExecuteOptions

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:1147

Add a custom configuration

Parameters

Parameter	Type
body	{ name: string; }
body.name	string
options?	ExecuteOptions

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:1198

Create a custom field

Parameters

Parameter	Type
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

Returns

Promise<CreateTestManagementCustomFieldResult>

Inherited from

GeneratedTestManagementClient.createCustomField

---

createFolder()

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

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

Create a folder

Parameters

Parameter	Type
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

Returns

Promise<CreateTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.createFolder

---

createProject()

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

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

Create a project

Parameters

Parameter	Type
body	{ project?: { description?: string; name: string; }; }
body.project?	{ description?: string; name: string; }
body.project.description?	string
body.project.name?	string
options?	ExecuteOptions

Returns

Promise<CreateTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.createProject

---

createTestCase()

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

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

Create a test case

Parameters

Parameter	Type
projectId	string
folderId	number
body	{ testCase?: { background?: string; caseType?: string; customFields?: {[key: string]: never; }; 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]: never; }; 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]: never; }
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

Returns

Promise<CreateTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.createTestCase

---

createTestPlan()

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

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

Create a test plan

Parameters

Parameter	Type
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

Returns

Promise<CreateTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.createTestPlan

---

createTestRun()

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

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

Create a test run

Parameters

Parameter	Type
projectId	string
body	{ testRun?: { assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: never; }; 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]: never; }; 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]: never; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }
body.testRun.filterTestCases.caseType?	string[]
body.testRun.filterTestCases.customFields?	{[key: string]: never; }
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

Returns

Promise<CreateTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.createTestRun

---

deleteCustomField()

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

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

Delete a custom field

Parameters

Parameter	Type
customFieldId	string
options?	ExecuteOptions

Returns

Promise<{ success?: boolean; }>

Inherited from

GeneratedTestManagementClient.deleteCustomField

---

deleteFolder()

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

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

Delete a folder

Parameters

Parameter	Type
projectId	string
folderId	number
options?	ExecuteOptions

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:399

Delete a project

Parameters

Parameter	Type
projectId	string
options?	ExecuteOptions

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:654

Delete a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
options?	ExecuteOptions

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:756

Delete attachment from a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
attachmentId	number
options?	ExecuteOptions

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:1028

Delete attachment from a test result

Parameters

Parameter	Type
projectId	string
testResultId	number
attachmentId	number
options?	ExecuteOptions

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:926

Delete a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedTestManagementClient.deleteTestRun

---

execute()

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

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

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:1164

Get configuration by ID

Parameters

Parameter	Type
configurationId	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementConfigurationResult>

Inherited from

GeneratedTestManagementClient.getConfiguration

---

getConfigurations()

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

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

Get all configurations

Parameters

Parameter	Type
p?	number
pageSize?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementConfigurationsResult>

Inherited from

GeneratedTestManagementClient.getConfigurations

---

getCustomFields()

getCustomFields(options?): Promise<GetTestManagementCustomFieldsResult>

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

Get all custom fields

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

Promise<GetTestManagementCustomFieldsResult>

Inherited from

GeneratedTestManagementClient.getCustomFields

---

getFolder()

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

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

Get folder details

Parameters

Parameter	Type
projectId	string
folderId	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.getFolder

---

getFolders()

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

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

Get list of folders in a project

Parameters

Parameter	Type
projectId	string
p?	number
pageSize?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementFoldersResult>

Inherited from

GeneratedTestManagementClient.getFolders

---

getProject()

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

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

Get project details

Parameters

Parameter	Type
projectId	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.getProject

---

getProjects()

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

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

Get list of projects

Parameters

Parameter	Type
p?	number
pageSize?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementProjectsResult>

Inherited from

GeneratedTestManagementClient.getProjects

---

getTestCaseAttachments()

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

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

Get attachments for a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
p?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestCaseAttachmentsResult>

Inherited from

GeneratedTestManagementClient.getTestCaseAttachments

---

getTestCaseResults()

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

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

Get test results for a test case across all test runs

Parameters

Parameter	Type
projectId	string
testCaseId	string
p?	number
options?	ExecuteOptions

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:518

Get list of test cases

Parameters

Parameter	Type
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

Returns

Promise<GetTestManagementTestCasesResult>

Inherited from

GeneratedTestManagementClient.getTestCases

---

getTestPlan()

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

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

Get test plan details

Parameters

Parameter	Type
projectId	string
testPlanId	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.getTestPlan

---

getTestPlans()

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

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

Get list of test plans

Parameters

Parameter	Type
projectId	string
p?	number
pageSize?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestPlansResult>

Inherited from

GeneratedTestManagementClient.getTestPlans

---

getTestPlanTestRuns()

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

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

Get test runs linked to a test plan

Parameters

Parameter	Type
projectId	string
testPlanId	string
p?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestPlanTestRunsResult>

Inherited from

GeneratedTestManagementClient.getTestPlanTestRuns

---

getTestResultAttachments()

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

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

Get attachments for a test result

Parameters

Parameter	Type
projectId	string
testResultId	number
p?	number
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestResultAttachmentsResult>

Inherited from

GeneratedTestManagementClient.getTestResultAttachments

---

getTestRun()

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

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

Get test run details

Parameters

Parameter	Type
projectId	string
testRunId	string
minify?	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.getTestRun

---

getTestRunResults()

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

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

Get all test results for a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
p?	number
validateTc?	string
options?	ExecuteOptions

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:790

Get list of test runs

Parameters

Parameter	Type
projectId	string
closedBefore?	string
closedAfter?	string
createdBefore?	string
createdAfter?	string
testPlanId?	string
assignee?	string
includeClosed?	string
runState?	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestRunsResult>

Inherited from

GeneratedTestManagementClient.getTestRuns

---

getTestRunTestCaseResults()

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

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

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

Parameters

Parameter	Type
projectId	string
testRunId	string
testCaseId	string
p?	number
options?	ExecuteOptions

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:841

Get test cases of a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
p?	number
fetchSteps?	string
minify?	string
options?	ExecuteOptions

Returns

Promise<GetTestManagementTestRunTestCasesResult>

Inherited from

GeneratedTestManagementClient.getTestRunTestCases

---

moveFolder()

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

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

Move a folder

Parameters

Parameter	Type
projectId	string
folderId	number
body	{ parentId?: number | null; }
body.parentId?	number | null
options?	ExecuteOptions

Returns

Promise<MoveTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.moveFolder

---

moveTestCase()

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

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

Move a test case to a different folder

Parameters

Parameter	Type
projectId	string
testCaseId	string
body	{ destinationFolderId: number; }
body.destinationFolderId	number
options?	ExecuteOptions

Returns

Promise<MoveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.moveTestCase

---

patchTestRun()

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

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

Partially update a test run

Parameters

Parameter	Type
projectId	string
testRunId	string
body	{ testRun?: { configurationMap?: object[]; configurations?: number[]; filterTestCases?: { caseType?: string[]; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }; name?: string; runState?: string; tags?: string[]; }; }
body.testRun?	{ configurationMap?: object[]; configurations?: number[]; filterTestCases?: { caseType?: string[]; 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[]; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }
body.testRun.filterTestCases.caseType?	string[]
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

Returns

Promise<PatchTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.patchTestRun

---

unarchiveTestCase()

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

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

Unarchive a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
options?	ExecuteOptions

Returns

Promise<UnarchiveTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.unarchiveTestCase

---

updateCustomField()

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

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

Update a custom field

Parameters

Parameter	Type
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

Returns

Promise<UpdateTestManagementCustomFieldResult>

Inherited from

GeneratedTestManagementClient.updateCustomField

---

updateFolder()

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

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

Update a folder

Parameters

Parameter	Type
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

Returns

Promise<UpdateTestManagementFolderResult>

Inherited from

GeneratedTestManagementClient.updateFolder

---

updateProject()

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

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

Update a project

Parameters

Parameter	Type
projectId	string
body	{ project?: { description?: string; name?: string; }; }
body.project?	{ description?: string; name?: string; }
body.project.description?	string
body.project.name?	string
options?	ExecuteOptions

Returns

Promise<UpdateTestManagementProjectResult>

Inherited from

GeneratedTestManagementClient.updateProject

---

updateTestCase()

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

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

Update a test case

Parameters

Parameter	Type
projectId	string
testCaseId	string
body	{ testCase?: { automationStatus?: string; background?: string; caseType?: string; customFields?: {[key: string]: never; }; 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]: never; }; 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]: never; }
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

Returns

Promise<UpdateTestManagementTestCaseResult>

Inherited from

GeneratedTestManagementClient.updateTestCase

---

updateTestPlan()

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

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

Update a test plan

Parameters

Parameter	Type
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

Returns

Promise<UpdateTestManagementTestPlanResult>

Inherited from

GeneratedTestManagementClient.updateTestPlan

---

updateTestRun()

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

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

Fully update a test run (replaces test cases)

Parameters

Parameter	Type
projectId	string
testRunId	string
body	{ testRun?: { assignee?: string; configurationMap?: object[]; configurations?: number[]; description?: string; filterTestCases?: { caseType?: string[]; customFields?: {[key: string]: never; }; 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]: never; }; 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]: never; }; owner?: string[]; priority?: string[]; status?: string[]; tags?: string[]; }
body.testRun.filterTestCases.caseType?	string[]
body.testRun.filterTestCases.customFields?	{[key: string]: never; }
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

Returns

Promise<UpdateTestManagementTestRunResult>

Inherited from

GeneratedTestManagementClient.updateTestRun