Board Public APIs

• Applies to: All Board Cloud subscriptions

This section gives an overview of Board's Public APIs. To find out more about Board's APIs, read the Client API section, and about the Board SCIM API.

Unless otherwise indicated below, query parameters are case sensitive. OAuth 2.0 Authorization Code with PKCE flow specifications are also supported for the authentication in API requests.

• ApiQuery: returns the result of the specified query. It is possible to add querystring parameters for the select.

  • Submission method: GET

  • /public/{dbName}/query/{queryName}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string
  queryName	Required	API query name	path	string
  json	Accepted Value: full (Optional)	Set the parameter to full to repeat keys for each returned record	query	string

  The queryName parameter value must match an existing API query name in the specified database.

  • Examples:

    • Base

      ?{entity_name}={member_code}

      ?year=2012

      
      Result: returns all values from 2012

    • Multiple

      ?{entity_name}={member_code}&{entity_name}={member_code}

      ?year=2012&city=IT01 

      Result: returns all values from 2012 and city with code IT01

    • List

      ?{entity_name}={member_code},{member_code},{member_code}

      ?year=2012,2017,2019

      
      Result: returns all values from years 2012, 2017 and 2019

    • Range

      ?{entity_name}={member_code}..{member_code}

      ?year=2015..2019 

      Result: returns all values from years 2015 to 2019

    • Escape

      ?{entity_name}="{member_code}"

      ?city="IT01"

      Result: returns all values from city code IT01

    • json parameter

      ?json=full 

      Result: repeats all keys for each returned record, instead of listing all keys once at the beginning of the returned dataset

• Schema: returns a list of entities, of entity members or cubes for a specified database.

  • Submission method: GET

  • /public/{dbName}/schema/Entities

  • Parameter

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string
  format	Optional	The format of the response: tree or flat	query	string

  • /public/{dbName}/schema/Entities/{name}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string
  name	Required	Entity name	path	string
  skip	Optional	Bypass a specified number of search results then return the remaining results	query	integer
  take	Optional	Specify the number of search results to return	query	integer
  searchString	Optional	Text query. Case insensitive	query	string

  • /public/{dbName}/schema/Cubes

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string

• Procedure: starts the execution of a specified Procedure and returns the Procedure status after its execution.

  Execution is only applicable for Data model Procedures and will not work on Capsule Procedures.

  • Submission method: POST

  • • /public/{dbName}/procedure/Execute/{procedureName}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string
  procedureName	Required	Procedure name	path	string

  It is possible to trigger the execution of a Procedure with a selection added through query string parameters: the selection will define the scope of the Procedure, just as it happens when the Procedure is triggered from a Capsule Screen which has an active Selection applied.

  • Examples:

    • Base

      ?{entity_name}={member_code}

      ?year=2012

      Result: the Procedure is executed considering the year 2012

    • Multiple
      

      ?{entity_name}={member_code}&{entity_name}={member_code}

      ?year=2012&city=IT01 

      Result: the Procedure is executed considering the year 2012 and the city code IT01

    • List
      

      ?{entity_name}={member_code},{member_code},{member_code}

      ?year=2012,2017,2019

      Result: the Procedure is executed considering the years 2012, 2017 and 2019

    • Range
      

      ?{entity_name}={member_code}..{member_code}

      ?year=2015..2019 

      Result: the Procedure is executed considering the years 2015 to 2019

    • Escape
      

      ?{entity_name}="{member_code}"

      ?city="IT01"

      Result: the Procedure is executed considering the city with code IT01

  • Submission method: GET

  • /public/{dbName}/procedure/Status/{sessionId}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  dbName	Required	Database name	path	string
  sessionId	Required	The Session id value included in the response of the execute procedure query	path	string

  • Response types
    

    • Procedure status: running.
      

      {
       "status": 1,
       "message": "Running"
      }

    • Procedure status: stopped.
      

      {
       "status": 0,
       "message": "Stopped"
      }

• Capsule: returns the Capsule tree (with folders, if present) o a specific Capsule by name. By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

  • Submission method: GET

  • /public/capsules/{capsuleName}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  capsuleName	Required	Capsule name	path	string
  username	Optional	Username	query	string

• FullTextSearch: returns the results of a Full Text Search in the entire Platform (the search is executed in Capsules and Presentations, but it will return also Data models, procedures and anything that matches or contains the search query).
  By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

  • Submission method: GET

  • /public/search/{textToSearch}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  textToSearch	Required	Text search query	path	string
  username	Optional	Username	query	string

• Presentations: returns a list of available Presentations, metadata about a specific Presentation, the list of Slides from a specific Presentation, metadata about a specific Slide, a list of Screen Objects/Layout titles from a specific Slide, values from a single Layout. By passing a username as a query parameter, the endpoint will return results based on that user's specific authorizations.

  • Submission method: GET

  • /public/presentations/{name}

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  name	Optional	The Presentation name	path	string
  username	Optional	The owner of the Presentation	query	string

  • /public/presentations/{name}/slides/{slideName}

  • Submission method: GET

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  name	Required	The Presentation name	path	string
  slideName	Optional	The Slide name	path	string
  username	Optional	The owner of the Presentation	query	string

  • /public/presentations/{name}/slides/{slideName}/toolboxes

  • Submission method: GET

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  name	Required	The Presentation name	path	string
  slideName	Required	The Slide name	path	string
  username	Optional	The owner of the Presentation	query	string

  • /public/presentations/{name}/slides/{slideName}/toolbox/{toolboxName}

  • Submission method: GET

  • Parameters

  Parameter	Value	Description	Parameter Type	Data Type
  name	Required	The Presentation name	path	string
  slideName	Required	The Slide name	path	string
  toolboxName	Required	The Toolbox name	path	string
  username	Optional	The owner of the Presentation	query	string

The most up-to-date technical documentation is available right in each active Board platform. To access it, head to the desired platform, click on "Data model" from the main menu, select any data model you have in place, and click on "API queries". Once there, click on "GO TO DOCUMENTATION".

By default, the following quotas apply to all Public API calls:

• 500 requests per day (this limit can be increased with an additional license. If you need an increase to your quota, please contact your Board Customer Success Manager or Key Account Manager)

• 10 requests per second

• Board has a default timeout of 100 seconds. If the remote API server does not return a response within 100 seconds, Board closes the connection.