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/v7_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
|
|
TestCaseGuid
|
The guid 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
|
|
Precondition
|
Precondition field (used for BDD tests)
|
|
ProjectId
|
The id of the project that the artifact belongs to
|
|
ProjectGuid
|
The guid of the project that the artifact belongs to
|
|
ConcurrencyDate
|
The datetime used to track optimistic concurrency to prevent edit conflicts
|
|
CustomProperties
|
The list of associated custom properties/fields for this artifact
|
|
Tags
|
The list of meta-tags that should be associated with the artifact
|
|
Guid
|
The unique identifier for the artifact
|
<RemoteTestStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<Guid i:nil="true" />
<IsAttachments>false</IsAttachments>
<ProjectGuid i:nil="true" />
<ProjectId>0</ProjectId>
<Tags 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>
<Precondition i:nil="true" />
<SampleData i:nil="true" />
<TestCaseGuid i:nil="true" />
<TestCaseId>0</TestCaseId>
<TestStepId i:nil="true" />
</RemoteTestStep>
{"TestStepId":null,
"TestCaseId":0,
"TestCaseGuid":null,
"ExecutionStatusId":null,
"Position":0,
"Description":null,
"ExpectedResult":null,
"SampleData":null,
"LinkedTestCaseId":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"Precondition":null,
"ProjectId":0,
"ProjectGuid":null,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null,
"Guid":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
|
|
TestCaseGuid
|
The guid 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
|
|
Precondition
|
Precondition field (used for BDD tests)
|
|
ProjectId
|
The id of the project that the artifact belongs to
|
|
ProjectGuid
|
The guid of the project that the artifact belongs to
|
|
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?
|
|
Tags
|
The list of meta-tags that should be associated with the artifact
|
|
Guid
|
The unique identifier for the artifact
|
<RemoteTestStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<Guid i:nil="true" />
<IsAttachments>false</IsAttachments>
<ProjectGuid i:nil="true" />
<ProjectId>0</ProjectId>
<Tags 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>
<Precondition i:nil="true" />
<SampleData i:nil="true" />
<TestCaseGuid i:nil="true" />
<TestCaseId>0</TestCaseId>
<TestStepId i:nil="true" />
</RemoteTestStep>
{"TestStepId":null,
"TestCaseId":0,
"TestCaseGuid":null,
"ExecutionStatusId":null,
"Position":0,
"Description":null,
"ExpectedResult":null,
"SampleData":null,
"LinkedTestCaseId":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"Precondition":null,
"ProjectId":0,
"ProjectGuid":null,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null,
"Guid":null}