Skip to content
Leadtime
English
EnglishDeutschNot translated
Esc
↑↓navigate↵open⌘Jpreview

Partially update a component library item

Updates only the provided fields of an existing component library item (epic, work package, todo list, test suite). The description and internalNote fields accept HTML or Markdown and will be converted to the internal format. When the conditions array is provided, it completely replaces existing conditions. Conditions with id are updated, conditions without id are created, and conditions not in the array are deleted. Only library component items (component.projectId is null) can be updated through this endpoint.

PATCH/administration/project-components/items/{id}
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstringrequired
Component item 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
componentIdstring
ID of the component this item belongs to
conditionsSaveComponentItemConditionDto[]
Array of conditions (full array replaces existing conditions)
Show properties
Array of SaveComponentItemConditionDto
containsTypestringrequired
Contains type
Allowed:SomeAll
idstring | null
Condition ID (optional, for updates)
targetQuestionIdstring | null
Target question ID (optional)
targetTestCaseIdstring | null
Target test case ID (optional)
targetTodoIdstring | null
Target todo ID (optional)
targetValuestring | null
Target value (optional)
typestringrequired
Condition type
Allowed:QuestionAnsweredQuestionNotAnsweredQuestionAnswerContainsQuestionAnswerDoesNotContainQuestionAnswerEqualQuestionAnswerDoesNotEqualTodoIsDoneTodoIsNotDoneTestCasePassedTestCaseFailed
descriptionstring
Description in HTML or Markdown format (will be converted to IDoc if provided)
iconobject | null
Icon identifier (can be set to null). Format: :icon_name: (e.g., :rocket:, :check:, :star:)
includeInSpecificationboolean
Whether to include in specification
internalNotestring
Internal note in HTML or Markdown format (will be converted to IDoc if provided)
namestring
Name of the item
parentIdstring
ID of parent item for nested items
tagsstring[]
Array of tag UUIDs
timeFramenumber
Time frame in hours. Required for all types except Epic (when type is provided)
typestring
Type of item (Epic, WorkPackage, TodoList, TestSuite)
Allowed:EpicWorkPackageTodoListTestSuite
Responses
200Item updated successfully
idstring<uuid>
400Invalid request: invalid UUID format for item ID, component ID, tag IDs, or invalid type/timeFrame combination
401Unauthorized - Invalid or missing authentication token
403Insufficient permissions to edit component library
404Item not found, item does not belong to library component, or component not found
422Editor content conversion errors
Request
curl -X PATCH "https://leadtime.app/api/public/administration/project-components/items/3047983b-d798-4aff-8dd4-628cf1900703" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "componentId": "550e8400-e29b-41d4-a716-446655440000",
  "conditions": [
    {
      "containsType": "Some",
      "id": "550e8400-e29b-41d4-a716-446655440013",
      "targetQuestionId": "550e8400-e29b-41d4-a716-446655440014",
      "targetTestCaseId": "550e8400-e29b-41d4-a716-446655440016",
      "targetTodoId": "550e8400-e29b-41d4-a716-446655440015",
      "targetValue": "option-value",
      "type": "QuestionAnswered"
    }
  ],
  "description": "<p>Implement user authentication and authorization</p>",
  "icon": ":check:",
  "includeInSpecification": true,
  "internalNote": "<p>Implementation notes for the development team</p>",
  "name": "User Authentication Feature",
  "parentId": "550e8400-e29b-41d4-a716-446655440000",
  "tags": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "timeFrame": 40,
  "type": "WorkPackage"
}'
Response
{
  "id": "3047983b-d798-4aff-8dd4-628cf1900703"
}