Update an existing testcase

Updates an existing test case for a library component item. All fields are optional for partial updates. Editor content (description, steps, expectedResult) accepts HTML or Markdown input and returns HTML output. Only library component test cases can be updated.

PATCH/administration/project-components/item-details/{itemId}/testcases/{testCaseId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

itemIdstringrequired

Component item UUID. Items are the building blocks within components (Epics, Work Packages, Todo Lists, Test Suites).

testCaseIdstringrequired

Test case UUID

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Request body

requiredapplication/json

descriptionstring

Test case description in HTML or Markdown format

expectedResultstring

Expected result in HTML or Markdown format

stepsstring

Test steps in HTML or Markdown format

titlestring

Test case title

Responses

200

descriptionstringrequired

Test case description in HTML format

expectedResultstringrequired

Expected result in HTML format

idstringrequired

Test case ID

sortnumberrequired

Sort order

stepsstringrequired

Test steps in HTML format

testCommentstring | null

Test comment in HTML format (optional)

testStatusstring | null

Test status (optional)

Allowed:PassedPassedWithReservationsFailed

testedAtstring | null

Date when tested (optional)

testedBystring | null

User ID who tested (optional)

titlestringrequired

Test case title

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

itemIdpath*Component item UUID. Items are the building blocks within components (Epics, Work Packages, Todo Lists, Test Suites).testCaseIdpath*Test case UUIDfieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Bodyapplication/json

descriptionstringTest case description in HTML or Markdown formatexpectedResultstringExpected result in HTML or Markdown formatstepsstringTest steps in HTML or Markdown formattitlestringTest case title

Request

curl -X PATCH "https://leadtime.app/api/public/administration/project-components/item-details/3047983b-d798-4aff-8dd4-628cf1900703/testcases/550e8400-e29b-41d4-a716-446655440010" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "<p>Verify that users can log in with valid credentials.</p>",
  "expectedResult": "<p>User is successfully logged in and redirected to dashboard.</p>",
  "steps": "<ol><li>Navigate to login page</li><li>Enter credentials</li><li>Click login button</li></ol>",
  "title": "Test login with valid credentials"
}'

const response = await fetch("https://leadtime.app/api/public/administration/project-components/item-details/3047983b-d798-4aff-8dd4-628cf1900703/testcases/550e8400-e29b-41d4-a716-446655440010", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"<p>Verify that users can log in with valid credentials.</p>\",\n  \"expectedResult\": \"<p>User is successfully logged in and redirected to dashboard.</p>\",\n  \"steps\": \"<ol><li>Navigate to login page</li><li>Enter credentials</li><li>Click login button</li></ol>\",\n  \"title\": \"Test login with valid credentials\"\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/administration/project-components/item-details/3047983b-d798-4aff-8dd4-628cf1900703/testcases/550e8400-e29b-41d4-a716-446655440010",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"<p>Verify that users can log in with valid credentials.</p>\",\n  \"expectedResult\": \"<p>User is successfully logged in and redirected to dashboard.</p>\",\n  \"steps\": \"<ol><li>Navigate to login page</li><li>Enter credentials</li><li>Click login button</li></ol>\",\n  \"title\": \"Test login with valid credentials\"\n}",
)

Response

{
  "description": "<p>Verify that users can log in with valid credentials.</p>",
  "expectedResult": "<p>User is successfully logged in and redirected to dashboard.</p>",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "sort": 1,
  "steps": "<ol><li>Navigate to login page</li><li>Enter credentials</li><li>Click login button</li></ol>",
  "testComment": "<p>Test passed successfully.</p>",
  "testStatus": "Passed",
  "testedAt": "2024-01-01T00:00:00.000Z",
  "testedBy": "550e8400-e29b-41d4-a716-446655440020",
  "title": "Test login with valid credentials"
}