How to use Kanban API actions

Kanban API methods are used to make visual changes in Kanban layout, show messages and work with variables.

Show Message

This method will execute this action:

• Show a notification message over the current Kanban

This method will NOT:

• Affect any variables

• Affect any other Kanban elements

• Refresh the web page

This methods accepts the following parameters:

• Name = "type" Value = one of the following designs:

"error":

"warning":

"success":

"info":

This parameter is optional; if omit it, the message type will be "info" by default

• Name = "title" Value = any text (with merge fields or formulas, if needed), that will be used as message header This parameter is optional; if you omit it, system will just show a message without header

• Name = "body" Value = any text you want to show in the message body This parameter is required

• Name = "mode" Value = one of the following:

  • "pester" - the message will automatically disappear after some time (5 seconds by default); it has no "close" button, so user can't dismiss it before time set in Kanban configuration

  • "dismissible" - the same as "pester", but user can close the message manually earlier than show time will expire

  • "sticky" - the message will not disappear until user close it manually

This parameter is optional; if omit it, the mode will be "dismissible" by default

• Name = "duration" Value = time duration of message show (in seconds) This parameter is optional and used only for messages with "pester" and "dismissible" modes; if omit it, message will disappear in 5 seconds.

Refresh Kanbans

This method forces the specified Kanbans be refreshed.

This method will execute this action:

• Reload Kanban contents including all columns, cards, top menus and buttons

This method will NOT:

• Reset Kanban variables (and this allow user to re-initiate Kanban with other data)

• Refresh the web page where Kanban is inserted into

This method accepts the following parameters:

• Name = "kanbans" Value = Kanban IDs or names separated by comma or in JSON array format This parameter is optional - if do not set it, the method will refresh the current Kanban

Kanban ID of current kanban is available as {$KanBan.Id} merge field. IDs of other kanbans should be known - taken from URL or selected in Merge Field Picker.

Update Variables

This method will execute this action:

• Update Variables with specified names in all kanbans from the specified list (if some variable does not exist, it will be created)

This method will NOT:

• Affect any other Kanban elements

• Refresh the web page

This method accepts the following parameters:

• kanbans = list of Kanban IDs or names separated by comma or in JSON format ({"key":"value"}).

• variables = variables and their values in JSON format

If it is needed to calculate formulas at the time of the event, an Action/Action Group type of handler should be used instead and variables should be defined there.

Print Kanban

This method will execute this action:

• Print specified Kanban page

This method accepts the following parameters:

• kanbanId = ID of Kanban to print This parameter is optional

Navigate to Kanban

This method will execute this action:

• Open other specified Kanban page

This method accepts the following parameters:

• kanbanId = ID of Kanban to open

• variables = initial variables and their values in JSON format. This works in the same way as Input Variables on Composite Kanban
• filters = initial filters in JSON format

Show/Hide Kanban

These methods will execute this action:

• Show / hide the specified kanban in the current composite Kanban

These methods will NOT:

• Affect any variables

• Affect any other Kanban elements except recalculation of other kanban widths

• Refresh the web page

• Change layout state (hide or show)

These methods accept the following parameter:

• Name = "kanbans" Value = Kanban Junction IDs or API names separated by comma or in JSON array format This parameter is required

In the context of this action Kanban Junctions are the same as child kanbans.

Full Screen

This method forces the specified Kanban view be full screen.

This method will execute this action:

• Change standard view to full screen of specified Kanban

This method will NOT:

• Affect any variables

• Refresh the Kanban containing specified column

• Refresh the web page

This method accepts the following parameters:

• Name = "fullscreen" Value = "true" or "false" This parameter is required

Refresh Columns

This method forces the specified Kanban columns be refreshed.

This method will execute this action:

• Reload specified column(s) contents including all cards

This method will NOT:

• Affect any variables

• Refresh the Kanban containing specified column

• Refresh the web page

This method accepts the following parameters:

• Name = "columns" Value = Kanban columns IDs or names separated by comma or in JSON array format This parameter is required

Show / Hide Columns

These methods will execute this action:

• Show / hide the specified column in the current Kanban

These methods will NOT:

• Affect any variables

• Affect any other Kanban elements except recalculation of other columns widths

• Refresh the web page

• Change layout state (hide or show)

These methods accept the following parameters:

• Name = "columns" Value = Kanban columns IDs or names separated by comma or in JSON array format This parameter is required

Refresh Card

This method forces the currently selected card (in column) in the specified Kanban be refreshed.

This method will execute this action:

• Reload card contents

This method will NOT:

• Affect any variables

• Refresh any other Kanban elements

• Refresh the web page

This method accepts the following parameters:

• Name = "kanbans" Value = ID of Kanban where card should be refreshed in (useful for composite kanbans) This parameter is optional - if do not set it, the method will refresh the card in the current Kanban

• Name = "columns" Value = ID of Columns where card should be refreshed in This parameter is optional - if do not set it, the method will refresh the card in all columns

• Name = "recordId" Value = record ID to specify which card should be refreshed in This parameter is optional

Refresh Card Layout

This method forces the currently selected card layout (in sidebar or popup) in the specified Kanban be refreshed.

This method will execute this action:

• Reload card layout contents including all tabs and buttons

This method will NOT:

• Affect any variables

• Refresh any other Kanban elements

• Refresh the web page

• Change layout state (hide or show)

This method accepts the following parameters:

• Name = "kanbanId" Value = ID of Kanban where card layout should be refreshed in (useful for composite kanbans) This parameter is optional - if do not set it, the method will refresh the card layout in the current Kanban

Show Card Layout

This method will execute this action:

• Show the specified record card layout (in the sidebar or popup) in the current Kanban

This method will NOT:

• Affect any variables

• Affect any other Kanban elements

• Refresh the web page

Theis method accepts the following parameters:

• Name = "recordId" Value = ID of the record which is represented in the specified column by some card This parameter is required

• Name = "columnId" Value = ID of the column which selected record card is shown in This parameter is required

What this can be useful for? Different columns in the Kanban can show cards for the same record (e.g., when one record matches conditions of more than one columns). And cards with different layouts and components can be configured for the same object. Thus, same record can be represented with different layouts depending on column its card is shown in. In this case system should know which layout should be shown - and it is possible only if provide not only Record ID but Column ID too.

Hide Card Layout

This method will execute this action:

• Hide the shown card layout (sidebar or popup) from the current Kanban

This method will NOT:

• Affect any variables

• Affect any other Kanban elements

• Refresh the web page

This method accepts the following parameters:

• Name = "kanbanId" Value = ID of the Kanban where card layout should be hidden from This parameter is optional; if omit it, a card layout will be hidden from the current Kanban

Refresh cell

This method forces the specified cell(s) be refreshed in the specified column(s) and card(s) of Kanban.

This method will execute this action:

• Reload specified cell(s) contents

This method will NOT:

• Affect any variables

• Refresh the Kanban or column

• Refresh the web page

This method accepts the following parameters:

• Name = "Cell Id" Value = cell ID This parameter is required
• Name = "Column Id" Value = column ID where card cell(s), column cell(s), should be refreshed in This parameter is optional

• Name = "Record Id" Value = record ID to specify which card cell(s) should be refreshed in This parameter is optional

Update cell

This method forces the specified cell(s) be updated in the specified column(s) and card(s) of Kanban.

This method will execute this action:

• Update specified cell(s) contents

This method will NOT:

• Affect any variables

• Affect any other Kanban elements

• Refresh the web page

This method accepts the following parameters:

• Name = "Cell Id" Value = cell ID This parameter is required
• Name = "Column Id" Value = column ID where card cell(s), column cell(s), should be updated in This parameter is optional

• Name = "Record Id" Value = record ID to specify which card cell(s) should be updated in This parameter is optional

• Name = "Value" Value = the cell(s) value that should be updated This parameter is required

• Name = "Title" Value = the cell(s) title that should be updated This parameter is optional

• Name = "Styles" Value = the cell(s) styles in CSS format that should be updated This parameter is optional