Asset Tools

Asset tools manage the OpenBI asset records within a session — creating, listing, updating, and importing assets.

create_asset

Creates a new empty OpenBI asset record in the session (AssetInfo). Call create_session first. Use load_openbi_asset instead when importing an existing asset JSON.

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`
`id_site`	`string`	✅	Site id from `list_sites`
`asset_type_id`	`string`	✅	Platform asset type id from `list_bi_platform_asset_types` (e.g. `"Report"`)
`name`	`string`	✅	Asset display name
`description`	`string`	—	Optional description

Response

{
  "status": "Success",
  "sessionId": "3fa85f64-...",
  "assetId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "idSite": "my-bi-site",
  "name": "Sales Dashboard",
  "externalType": "Report"
}

list_assets

Lists all OpenBI assets stored in the session.

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`

Response

{
  "assets": [
    {
      "id": "xxxxxxxx-...",
      "idSite": "my-bi-site",
      "name": "Sales Dashboard",
      "type": "Report",
      "externalType": "Report",
      "description": "",
      "latestUpdate": "2024-01-15T10:30:00Z",
      "latestUpdater": null
    }
  ]
}

update_asset

Updates the name and/or description of an asset in the session. Null fields leave the current value unchanged.

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`
`asset_id`	`string`	✅	Asset id from `list_assets`
`name`	`string`	—	New display name
`description`	`string`	—	New description

Response

{ "status": "Success" }

list_asset_dependencies

Lists direct asset-to-asset dependencies in the session. Each row means the dependent asset requires the referenced asset (X needs Y).

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`

Response

{
  "dependencies": [
    {
      "dependentAssetId": "report-guid",
      "dependsOnAssetId": "data-model-guid",
      "dependentName": "Sales Dashboard",
      "dependsOnName": "Sales Data Model"
    }
  ]
}

load_openbi_asset

Loads an OpenBI asset from a JSON file on disk into the session. The file must be a valid serialized Asset JSON.

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`
`file_path`	`string`	✅	Absolute path to the OpenBI asset JSON file

Response

{
  "status": "Success",
  "assets": 1,
  "assetDependencies": 0,
  "tables": 12,
  "columns": 87,
  "pages": 5,
  "visuals": 34,
  "relationships": 8,
  "filters": 3,
  "refreshTasks": 1,
  "dataSourceConnections": 2
}

add_metadata

Adds or updates a key/value entry in AssetInfo.AdditionalMetadata for a given asset.

Parameters

Name	Type	Required	Description
`session_id`	`string`	✅	Session id from `create_session`
`asset_id`	`string`	✅	Asset id from `list_assets`
`metadata_name`	`string`	✅	Metadata key to add or update
`metadata_value`	`string`	✅	Metadata value to set

Response

{
  "status": "Success",
  "assetId": "xxxxxxxx-...",
  "metadataName": "myKey"
}