columns (API table)

Property description

The columns property defines visible columns in an API table.

Minimal JSON

{
    "type": "",
    "value": ""
}

"columns": [
    {
        "type": "definedKey",
        "value": "objectName"
    },
    {
        "type": "definedKey",
        "value": "statusName"
    },
    {
        "type": "definedKey",
        "value": "objectTypeName"
    },
    {
        "type": "definedKey",
        "value": "applicationName"
    },
    {
        "type": "definedKey",
        "value": "path"
    },
    {
        "type": "definedKey",
        "value": "lastChange"
    }
]

Example taken from the core package.

Nested properties

Property	Description	Values	Mandatory
`type`	Type of displayed attribute.	string*	Yes
`value`	Value type.	string	Yes
`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
`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
`filter`	Conditions used to limit or refine data selection. For more information, see filter. 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 clickable button that triggers a POST request. For more information, see customActionButton configuration.
`customActionSelectBox`	Adds a dropdown selector backed by a codelist or manually defined values. For more information, see customActionSelectBox configuration.
`definedKey`	Predefined attributes such as object name, workflow status, or last edit timestamp. For more information, see supported `definedKey` values.
`externalKey`	The column contains values from an external data source defined when the API endpoint 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.

Supported `definedKey` values

Value	Description
`accessedTime`	Timestamp when objects were last visited.
`applicationName`	Names of the applications where the objects are.
`comment`	Text of the comment. Available only for the comments API (`/api/mr-comment/customizable-overview-filter`).
`created`	Timestamp when the comment was created. Available only for the comments API (`/api/mr-comment/customizable-overview-filter`).
`creatorName`	Names of the object creators.
`isMentioned`	Names of users mentioned in 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`	Total count of likes and dislikes for the objects.
`objectName`	Names of the objects.
`objectNameWithNumbering`	Names of the objects including their position number in the hierarchy.
`objectPath`	Object paths (breadcrumbs).
`objectTypeName`	Object type 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 with the specified user relation type to the objects.
`viewsAllTime`	Total visits to the objects. Each page load counts as one visit.
`viewsIn1M`	Total visits in the past one-month period. Each page load counts as one visit.

Property description

Minimal JSON

Nested properties

*Supported type values

Supported definedKey values

We use cookies

Supported `definedKey` values