Property description
The commentType property defines comment types available in the comment section of an object page.
Minimal JSON
{
"key": "",
"name": "",
"colorKey": ""
}{
"key": "feedback",
"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 comment type. | string | Yes |
name | Name of the comment type used as default EN translation. | string | Yes |
colorKey | Key of the color used to visually represent the asset. Use predefined colors from Settings > Configuration > Colors. For more information, see colors. | string | Yes |
description | Description of the property. | string | No |
isRemovable | Determines whether the comment type tag can be removed after creation. | boolean | No |
isVisible | Determines whether the comment type tag is visible. False value is usually used for the default comment type. | boolean | No |
state | Current status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment). | string | 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 |
workflowKey | Key of the workflow that allow the comment type. | string | |
workflowStateKeys | Array of keys of workflow states that allow the comment type. | string |