Property description
The commentTypeCategories asset configures the comment section and its comment types. Comment categories are assigned to specific applications using the comment type category applications asset.
Minimal JSON
{
"key": "",
"name": "",
"defaultCommentTypeKey": ""
}{
"key": "feedback",
"name": "Feedback",
"defaultCommentTypeKey": "comment",
"isVisible": true,
"commentTypes": [
{
"key": "suggestion",
"name": "Suggestion",
"colorKey": "core_status_approved",
"workflowKey": "feedback_workflow",
"isVisible": true,
"isRemovable": true
}
]
}Example taken from Custom Comments and Comment Workflows.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey. | string | Yes |
name | Name of the asset, used as the default EN translation. | string | Yes |
defaultCommentType | Key of the default comment type. | string | Yes |
commentTypes | Array of comment types. | array | No |
description | Description of the asset. | string | No |
isReadOnly | Determines whether the comment type category is set to read-only. | boolean | No |
isVisible | Determines whether the comment type category (in other words, the whole comment section) is visible. | boolean | No |
sortOrder | The comment category’s position relative to the other comment type categories (sections). If not specified, it will be added to the end. | integer | No |
translations | Array of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations. | array | No |