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 (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/spira/services/v5_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
ConcurrencyDate	The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties	The list of associated custom properties/fields for this artifact

<RemoteTestStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <ProjectId i:nil="true" />
  <Description i:nil="true" />
  <ExecutionStatusId i:nil="true" />
  <ExpectedResult i:nil="true" />
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <LinkedTestCaseId i:nil="true" />
  <Position>0</Position>
  <SampleData i:nil="true" />
  <TestCaseId>0</TestCaseId>
  <TestStepId i:nil="true" />
</RemoteTestStep>

{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"IsAttachments":false,
"ProjectId":null,
"Description":null,
"ExecutionStatusId":null,
"ExpectedResult":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"LinkedTestCaseId":null,
"Position":0,
"SampleData":null,
"TestCaseId":0,
"TestStepId":null}

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
ConcurrencyDate	The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties	The list of associated custom properties/fields for this artifact
IsAttachments	Does this artifact have any attachments?

<RemoteTestStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <ProjectId i:nil="true" />
  <Description i:nil="true" />
  <ExecutionStatusId i:nil="true" />
  <ExpectedResult i:nil="true" />
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <LinkedTestCaseId i:nil="true" />
  <Position>0</Position>
  <SampleData i:nil="true" />
  <TestCaseId>0</TestCaseId>
  <TestStepId i:nil="true" />
</RemoteTestStep>

{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"IsAttachments":false,
"ProjectId":null,
"Description":null,
"ExecutionStatusId":null,
"ExpectedResult":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"LinkedTestCaseId":null,
"Position":0,
"SampleData":null,
"TestCaseId":0,
"TestStepId":null}