See all operations
PUT: projects/{project_id}/test-cases
Description
Updates a test case in the system together with its test steps (if populated)
Does not currently update test step custom properties
How to Execute
To access this REST web service, you need to use the following URL:
https://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/test-cases
Request Parameters
Name
|
Description
|
project_id
|
The id of the current project
|
Request Body
Property
|
Description
|
TestCaseId
|
The id of the test case
|
IndentLevel
|
The indentation level of the artifact
The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)
|
ExecutionStatusId
|
The execution status id of the test case
|
AuthorId
|
The id of the user that wrote the test case
The authenticated user is used if no value is provided
|
OwnerId
|
The id of the user that the test case is assigned-to
|
TestCasePriorityId
|
The id of the priority of the test case
|
AutomationEngineId
|
The id of the automation engine the associated test script uses (null if manual only)
|
AutomationAttachmentId
|
The id of the attachment that is being used to store the test script (file or url)
Null if manual only
|
Name
|
The name of the test case
|
Description
|
The description of the test case
|
CreationDate
|
The date the test case was created
|
LastUpdateDate
|
The date the test case was last updated
|
ExecutionDate
|
The date the test case was last executed
|
EstimatedDuration
|
The estimated time to execute the test case
|
Folder
|
Whether this is actually a test case folder or not
|
Active
|
Whether this test case is marked as active or not
|
AuthorName
|
The display name of the user that wrote the test case
|
OwnerName
|
The display name of the user that the test case is assigned-to
|
ProjectName
|
The display name of the project that the test case belongs to
|
TestCasePriorityName
|
The display name of the priority of the test case
|
TestSteps
|
The list of test steps that comprise the test case
|
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
|
<RemoteTestCase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<ProjectId i:nil="true" />
<Active>false</Active>
<AuthorId i:nil="true" />
<AuthorName i:nil="true" />
<AutomationAttachmentId i:nil="true" />
<AutomationEngineId i:nil="true" />
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<EstimatedDuration i:nil="true" />
<ExecutionDate i:nil="true" />
<ExecutionStatusId i:nil="true" />
<Folder>false</Folder>
<IndentLevel i:nil="true" />
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<OwnerId i:nil="true" />
<OwnerName i:nil="true" />
<ProjectName i:nil="true" />
<TestCaseId i:nil="true" />
<TestCasePriorityId i:nil="true" />
<TestCasePriorityName i:nil="true" />
<TestSteps i:nil="true" />
</RemoteTestCase>
{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"ProjectId":null,
"Active":false,
"AuthorId":null,
"AuthorName":null,
"AutomationAttachmentId":null,
"AutomationEngineId":null,
"CreationDate":"\/Date(-62135578800000-0500)\/",
"Description":null,
"EstimatedDuration":null,
"ExecutionDate":null,
"ExecutionStatusId":null,
"Folder":false,
"IndentLevel":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"Name":null,
"OwnerId":null,
"OwnerName":null,
"ProjectName":null,
"TestCaseId":null,
"TestCasePriorityId":null,
"TestCasePriorityName":null,
"TestSteps":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.