SpiraTeam: REST Web Service (v4.0)

See all operations

POST: projects/{project_id}/test-cases/{test_case_id}/test-steps

Description

Adds a new test step to the specified test case

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/test-cases/{test_case_id}/test-steps

Request Parameters

Name Description
project_id The id of the current project
test_case_id The test case to add it to

Request Body

Property Description
TestStepId The id of the test step
TestCaseId The id of the test case the step belongs to
ExecutionStatusId The id of the execution status for the last time it was executed
Position The position of the step in the test case
Description The description of what the tester should do to execute this step
ExpectedResult The description of what the tester should see if the step succeeds
SampleData Any sample data that the tester should use during execution
LinkedTestCaseId If this step is really a linked test case, this is the id of the linked test case
LastUpdateDate The date the test step was last updated
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
ArtifactTypeId The type of artifact that we have (read-only)
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
TestStepId The id of the test step
TestCaseId The id of the test case the step belongs to
ExecutionStatusId The id of the execution status for the last time it was executed
Position The position of the step in the test case
Description The description of what the tester should do to execute this step
ExpectedResult The description of what the tester should see if the step succeeds
SampleData Any sample data that the tester should use during execution
LinkedTestCaseId If this step is really a linked test case, this is the id of the linked test case
LastUpdateDate The date the test step was last updated
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
ArtifactTypeId The type of artifact that we have (read-only)
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact