Get component library item details
Returns full details of a component library item including all test cases, todos, questions, conditions, and nested children.
What are Component Items? Items are the building blocks within components. Each item can be:
- Epic: Major section or phase (e.g., “Technical Implementation”, “Design & Development”)
- Work Package: Specific task with deliverables (e.g., “Set up hosting”, “Design homepage”)
- Todo List: Checklist of actionable items (e.g., “Kickoff Checklist”, “Quality Control”)
- Test Suite: Acceptance tests for formal approval (e.g., “Contact Form Tests”, “SEO Review”)
Attached Resources:
- Questions: Capture customer requirements (defined but not answered in library)
- Todos: Checklist items within a Work Package or Todo List
- Test Cases: Individual test steps within a Test Suite
All ProseMirror editor content is converted to HTML format. Only library component items (component.projectId is null) are accessible through this endpoint.
/administration/project-components/item-details/{id}AuthorizationOAuth2 access token · headerrequiredapi:readAuthorizationBearer token (JWT) · headerrequiredidstringrequiredComponent item UUID
childrenComponentChildrenShortItemDto[]requiredNested children items
Show propertiesHide properties
ComponentChildrenShortItemDtochildrenComponentChildrenShortItemDto[]requiredNested children items
Show propertiesHide properties
ComponentChildrenShortItemDtoComponentChildrenShortItemDto.conditionsValidbooleanrequiredWhether all conditions are valid
entityUniqueIdstringrequiredEntity unique ID
iconstring | nullrequiredIcon identifier in the format :icon_name: (e.g., :rocket:, :check:, :star:). Can be null if no icon is set.
idstringrequiredUnique identifier
namestringrequiredName of the item
questionsCountnumberrequiredCount of questions
taskIdstring | nullrequiredTask ID if linked to a task
taskShortNumbernumber | nullrequiredTask short number if linked to a task
testCasesCountnumberrequiredCount of test cases
todosCountnumberrequiredCount of todo items
typestringrequiredType of the component item. Items are the building blocks within components:
- Epic: Groups related work packages around a common theme
- WorkPackage: Self-contained task that delivers a tangible result
- TodoList: Checklist of sub-steps or checkpoints
- TestSuite: Formal acceptance tests with test cases
EpicWorkPackageTodoListTestSuitecomponentIdstringrequiredParent component ID
conditionsComponentItemConditionDto[]requiredConditions for this item
Show propertiesHide properties
ComponentItemConditionDtocontainsTypestringrequiredContains type
SomeAllidstring | nullCondition ID (optional)
targetQuestionIdstring | nullTarget question ID (optional)
targetTestCaseIdstring | nullTarget test case ID (optional)
targetTodoIdstring | nullTarget todo ID (optional)
targetValuestring | nullTarget value (optional)
typestringrequiredCondition type
QuestionAnsweredQuestionNotAnsweredQuestionAnswerContainsQuestionAnswerDoesNotContainQuestionAnswerEqualQuestionAnswerDoesNotEqualTodoIsDoneTodoIsNotDoneTestCasePassedTestCaseFailedconditionsValidbooleanrequiredWhether all conditions are valid
descriptionstringrequiredItem description in HTML format
entityUniqueIdstringrequiredEntity unique ID
failedConditionsIdsstring[]requiredArray of failed condition IDs
iconstring | nullrequiredIcon identifier in the format :icon_name: (e.g., :rocket:, :check:, :star:). Can be null if no icon is set.
idstringrequiredItem ID
includeInSpecificationbooleanrequiredWhether to include in specification
internalNotestringrequiredInternal note in HTML format
namestringrequiredItem name
parentIdstring | nullrequiredParent item ID (nullable for top-level items)
questionsComponentQuestionDto[]requiredQuestions associated with this item. Questions capture customer requirements and can affect effort calculation. In library components, questions are defined but not answered.
Show propertiesHide properties
ComponentQuestionDtoansweredAtstring | nullDate when answered (optional)
answeredBystring | nullUser ID who answered (optional)
descriptionstringrequiredQuestion description in HTML format
editorAnswerstring | nullEditor answer in HTML format (optional)
idstringrequiredQuestion ID
isAnsweredbooleanrequiredWhether the question has been answered
optionsComponentQuestionOptionDto[]requiredAvailable options
Show propertiesHide properties
ComponentQuestionOptionDtoextraHoursnumber | nullExtra hours for this option (optional)
idstringrequiredOption ID
isSelectedboolean | nullWhether this option is selected (optional)
titlestringrequiredOption title
questionstringrequiredQuestion text
titlestringrequiredQuestion title
typestringrequiredQuestion type
ShortTextEditorCheckboxRadioFilesDatepickerMultiplierPersontagsstring[]requiredArray of tags
taskIdobject | nullrequiredTask ID if linked to a task
taskShortNumberobject | nullrequiredTask short number if linked to a task
testCasesComponentTestCaseDto[]requiredTest cases associated with this item. Test cases are individual test steps within a Test Suite that document formal review and approval criteria.
Show propertiesHide properties
ComponentTestCaseDtodescriptionstringrequiredTest case description in HTML format
expectedResultstringrequiredExpected result in HTML format
idstringrequiredTest case ID
stepsstringrequiredTest steps in HTML format
testCommentstring | nullTest comment in HTML format (optional)
testStatusstring | nullTest status (optional)
PassedPassedWithReservationsFailedtestedAtstring | nullDate when tested (optional)
testedBystring | nullUser ID who tested (optional)
titlestringrequiredTest case title
timeFramenumberrequiredTime frame in hours
todoItemsComponentTodoItemDto[]requiredTodo items associated with this item. Todos are checklist items that can be checked off individually and support comments.
Show propertiesHide properties
ComponentTodoItemDtodescriptionstringrequiredTodo item description in HTML format
doneByobject | nullrequiredUser ID who marked as done (nullable)
doneUpdatedAtobject | nullrequiredDate when marked as done (nullable)
idstringrequiredTodo item ID
isDonebooleanrequiredWhether the todo is marked as done
titlestringrequiredTodo item title. Todos are checklist items used to track actionable tasks within component items. They are perfect for recurring processes, quality control checkpoints, and project preparation steps.
todoCommentobject | nullrequiredTodo comment in HTML format (nullable)
typestringrequiredItem type
EpicWorkPackageTodoListTestSuiteUnauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions