Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Entity APIs - Board

  • Article
  • 1 minutes to read
API Description
addTag Add tag to board
checkPermissions Check the permissions on the board for the specified user. The flowcode will throw an exception if an input permission is not allowed.
createBoard Create a board and set its activitystream
createBoardFromTemplate Create a board from template and set its activitystream
getBoardList load a board and data
getBoardsContainingCard Returns the boards the calling user can see that already hold a card matching the given type and key, or a given card id. Used to tell whether something has already been added to a board. An operation rather than a direct stored-query call so a client can ask for it over the JSON API, where data::queryExec is not available.
getBoardsList Returns the boards the calling user can see, as the getBoardsList stored query resolves them. An operation rather than a direct stored-query call so that a client can ask for the list over the JSON API: data::queryExec is not available there, and a stored query invoked through it is rejected on some platform builds and tolerated on others.
removeBoard Archive or permantely delete the board
requestAccess Request access to board
shareBoard Share the board with a user group or role
updateBoard Update the Board
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document