Defect


Create defect

POST /defect

Description

Create defect issue.


Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Defect object which needs to create.

true

JiraCreateIssueDetails



Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given defect is invalid.

No Content

403

Returned if user does not have permission to create defect.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in creating defect.

No Content


Consumes

  • application/json

Produces

  • application/json

Tags

  • Defect


Link defect with test run,test scenario or test case

PUT /defect/{defectIssueId}/link

Description

Link given defect with test run,test scenario, test step or test case. You can either provide test result id directly or issue ids of test case, test scenario, test step and story (if applicable).


Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

defectIssueId

Issue id of defect.

true

integer (int64)


BodyParameter

body

Other required parameters

true

DefectRequest



Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given defect is invalid.

No Content

403

Returned if user does not have permission to link defect.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in linking defect.

No Content


Consumes

  • application/json


Produces

  • application/json


Tags

  • Defect


Get defect traceability

GET /defect/{defectIssueId}/traceability


Description

Get list of stories, test runs, test scenarios, test cases or test steps in which given defect is produced.


Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

defectIssueId

Issue id of defect

true

integer (int64)


QueryParameter

maxResults

Maximum number of records to return in each call. Maximum possible value is 200. By default the value mentioned in the Default column will be returned. 

false

integer (int32)

50

QueryParameter

offset

Index of the first record to return.Default is 0.

false

integer (int32)

0


Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given defect is invalid.

No Content

403

Returned if user does not have permission to access defect.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem during retrieval of defect.

No Content


Consumes

  • application/json


Produces

  • application/json


Tags

  • Defect


Un-link defect

DELETE /defect/{defectIssueId}/unlink


Description

Un-link defect from given test run,test scenario or test case.You can either provide defect id directly or combination of multiple issue ids are required.


Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

defectIssueId

Issue id of defect.

true

integer (int64)


QueryParameter

defectId

Map id of defect.

false

integer (int32)


QueryParameter

testRunIssueId

Issue id of test run.

false

integer (int64)


QueryParameter

testScenarioIssueId

Issue id of test scenario.

false

integer (int64)


QueryParameter

testCaseIssueId

Issue id of test case.

false

integer (int64)


QueryParameter

testStepId

Issue id of test step.

false

integer (int64)


QueryParameter

storyIssueId

Issue id of story.

false

integer (int64)



Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given defect is invalid.

No Content

403

Returned if user does not have permission to unlink defect.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in unlinking defect.

No Content

Consumes

  • application/json

Produces

  • application/json


Tags

  • Defect

Get defect

GET /defect/{testRunIssueId}/getDefect

Description

Get defect details. You can either provide test result id directly or issue ids of test case, test scenario, test step and story (if applicable).

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)


QueryParameter

testResultId

Id of test result

true

integer (int64)


QueryParameter

testScenarioIssueId

Issue id of test scenario.

false

integer (int64)


QueryParameter

testCaseIssueId

Issue id of test case.

false

integer (int64)


QueryParameter

testStepId

Id of test step.

false

integer (int64)


QueryParameter

storyIssueId

Issue id of story.

false

integer (int64)



Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given defect is invalid.

No Content

403

Returned if user does not have permission to access defect.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem during retrieval of defect.

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Defect

JiraCreateIssueDetails

Name

Description

Required

Schema

Default

summary

Issue summary

true

string


projectId

Project Id

true

string


reporter

Reporter of issue

false

string


duedate

Due Date associated to issue

false

string


description

Issue description

false

string


assignee

Assignee of Issue

false

string


priority

Issue priority

false

string


versions

An array of version ids.

false

string array


labels

An array of labels associated to issue

false

string array


components

An array of component ids.

false

string array


DefectRequest

Name

Description

Required

Schema

Default

testResultId

Test result id

true

integer (int64)


testRunIssueId

Issue id of test run

false

integer (int64)


storyIssueId

Issue id of story

false

integer (int64)


testScenarioIssueId

Issue id of test scenario

false

integer (int64)


testCaseIssueId

Issue id of test case

false

integer (int64)


testStepId

Issue id of test step

false

integer (int64)


sequenceNumber

test case sequence number

false

integer (int64)


defectId

Defect Id

false

integer (int32)