Test Step

Get test steps

GET /teststep

Description

Returns the test steps of given test case.

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	testCaseIssueId	Issue id of test case.	true	integer (int64)
QueryParameter	maxResults	Maximum number of test steps to return in each call. Max value is 50. By default max value will be returned.	false	integer (int32)	50
QueryParameter	offset	Index of the first test step to return. Default is 0.	false	integer (int32)	0

Responses

HTTP Code	Description	Schema
200	Successful operation	No Content
400	Returned if the given test case is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given test case’s test steps.	No Content
404	Returned if the test case is not found.	No Content
500	Returned if exception occured during retrieval of test steps.	No Content

Consumes

application/json

Produces

application/json

Tags

test step

Create a test step

POST /teststep

Description

Create a new test step in given test case.

Parameters

Type	Name	Description	Required	Schema	Default
BodyParameter	body	test step object that needs to create.	true	Test Step#CreateTestStepRequest

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test case is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to create new test step.	No Content
404	Returned if the given test case does not exist.	No Content
500	Returned if there is problem in creating a test step.	No Content

Consumes

application/json

Produces

application/json

Tags

test step

Edit a test step

PUT /teststep/{id}

Description

Edit step details, test data or expected result of test step. Either one of three value is required.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	id	Id of test step to edit.	true	integer (int32)
BodyParameter	body	test step object that needs to edit.	true	Test Step#TestStepRequest

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test step id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to edit given test step.	No Content
404	Returned if the given test step or linked test case does not exist.	No Content
500	Returned if there is problem in editing test step.	No Content

Consumes

application/json

Produces

application/json

Tags

test step

Delete a test step

DELETE /teststep/{id}

Description

Delete given test step.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	id	Id of test step to delete.	true	integer (int32)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test step id is invalid.	No Content
403	Returned if the currently athenticated user does not have permission to delete given test step.	No Content
404	Returned if the given test step or linked test case does not exist.	No Content
500	Returned if there is problem in deleting test step.	No Content

Consumes

application/json

Produces

application/json

Tags

test step

Get a test step

GET /teststep/{id}

Description

Returns a test step by given id.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	id	Id of test step to get.	true	integer (int32)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test step id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given test step.	No Content
404	Returned if the given test step or linked test case does not exist.	No Content
500	Returned if there is problem in getting a test step.	No Content

Consumes

application/json

Produces

application/json

Tags

test step

Clone a test step

POST /teststep/{id}/clone

Description

Clone all the details of given test step in new one.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	id	Id of test step to clone.	true	integer (int32)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test step id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to clone given test step.	No Content
404	Returned if the given test step or linked test case does not exist.	No Content
500	Returned if there is problem in cloning a test step.	No Content

Produces

application/json

Tags

test step

Move a test step to new position

PUT /teststep/{id}/move

Description

Move given test step to new position.

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	newPos	New position of test step.	true	integer (int32)
PathParameter	id	Id of test step to move.	true	integer (int32)

Responses

HTTP Code	Description	Schema
200	Successful operation	No Content
400	Returned if the given test step id or new position is invalid	No Content
403	Returned if the currently athenticated user does not have permission to edit given test step	No Content
404	Returned if the given test step or linked test case does not exist	No Content
500	Returned if there is problem in editing test step	No Content

Produces

application/json

Tags

test step

CreateTestStepRequest

Name	Description	Required	Schema
testData	Test Data for test step. You can provide wiki markup text here.	false	string
stepDetails	Summary of test step. You can provide wiki markup text here.	true	string
expectedResult	Expected result of test step	false	string
testCaseIssueId	Issue id of test case	true	integer (int64)

TestStepRequest

Name	Description	Required	Schema
testData	Test Data for test step. Here you can provide wiki markup text.	false	string
stepDetails	Summary of test step. Here you can provide wiki markup text.	false	string
expectedResult	Expected result of test step. Here you can provide wiki markup text.	false	string