Property description
The columns property defines visible columns in an API table.
Minimal JSON
{
"type": "",
"value": ""
}{
"type": "definedKey",
"value": "objectName"
}JSON 3
{
"type": "definedKey",
"value": "statusName"
}JSON 4
{
"type": "definedKey",
"value": "objectTypeName"
}JSON 5
{
"type": "definedKey",
"value": "applicationName"
}JSON 6
{
"type": "definedKey",
"value": "path"
}JSON 7
{
"type": "definedKey",
"value": "lastChange"
}Example taken from the core package.
Nested properties
| Property | Description | Vales | Mandatory |
|---|---|---|---|
type | Type of displayed attribute. | string* | Yes |
value | Value type. | string | Yes |
clearNewLine | Specifies whether values are separated into multiple lines (e.g., each label will have its own line). Available only for attributeTypeKey and externalKey type values. | boolean | No |
bulkEditable | Enables the selection multiple rows in a table and bulk editing values in the selected column (e.g., change all selected workflow statuses provided that the user has sufficient permissions). To use this property, make sure bulkEditable is true on the API table level as well. Not available for externalKey type value. | boolean | No |
filter | Static list of available filters for the column. Available for: Tables with extraRequestData (see api-table)., externalKey column type. | json | No |
isHTML | Determines whether value is shown with HTML tags. | boolean | No |
maxLength | Maximum number of characters that is shown in a field. | number | No |
minWidth | Minimum width of a column. When defined, value must be within the range of 100 to 500. | integer | No |
title | Translation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section. | string | No |
tooltipKey | Translation key of the tooltip that appears when hovering over the property. Define in translations to specify how the text is displayed in the UI. | string | No |
*Supported type values
| Type | Description |
|---|---|
attributeTypeKey | The column contains values of the specified attribute type. |
customActionButton | Adds a button that triggers a specific POST request (POST /action/{activityKey}). The request sends the row data in JSON, which the backend processes according to a specified activityKey. API response: The API returns a JSON object with the following fields: status: Indicates success or failure (e.g., “success”)., successText: A message key or translated text indicating the result., targetUrl: A URL for redirection (nullable). Handling the response If targetUrl is included, open it in a new tab., If the status is successful and no targetUrl is provided, refresh the table., If the status is not successful, reset the button to its original state and display an error message. Only the tooltipKey property can be configured for this type value. |
definedKey | Predefined attributes such as last object edit, object name etc. Column widths adjust dynamically to fit the content, with longer values displaying up to a defined maximum. Supported values are, e.g.: accessedTime: Timestamp when objects were last visited., applicationName: Names of the appliactions where the objects are., comment: Texts of the comments. Available only for the comments API Available only for the comments API (/api/mr-comment/customizable-overview-filter)., created: Timestamps when comments were created. Available only for the comments API (/api/mr-comment/customizable-overview-filter)., creatorName: Names of the object creators., isMentioned: Names of users who were mentioned in the comments. Available only for the comments API (/api/mr-comment/customizable-overview-filter)., lastChange: Timestamp when objects were last changed., numberOfFavourites: Number of users who favorited the objects., numberOfRelations: Number of relations the objects have., objectKarma: The total counts of likes and dislikes for the objects., objectName: Names of the objects., objectNameWithNumbering: Names of the objects including their number (position in the hierarchy)., objectPath: Object paths (breadcrumbs)., objectTypeName: Object types names., path: Object paths., spaceName: Names of the spaces where the objects are., statusName: Workflow statuses of the objects., updaterName: Names of the users who last updated the objects., userRelationTypeKey: Names of users who have the specified user relation type to the objects., viewsAllTime: Total number of visits to the objects. Each page load is counted as a visit., viewsIn1M: Total number of visits to the objects in the past one-month period. Each page load is counted as a visit. |
externalKey | The column contains values from an external data source that is defined when the API endpoint of the table is /api/sql-external/table. |
relationTypeKey | The column contains objects related via the specified relation type. |
userRelationTypeKey | The column contains users related to the object via the specified user relation type. |