HomeGuidesRecipesAPI Reference
Alation Help Center

## Overview

In this guide, we will walk you through on how to update the descriptions on BI Folders. These steps will work for any BI object (Report, Data Source, BI Server, and etc.). Let's assume we want to update the description of a folder that's on our Tableau BI server. This guide will work for any BI source that's been cataloged by Alation.

### APIs being used

  • [BI Source (GBMv2) Overview](🔗)

  • [Custom Field](🔗)

  • [Custom Field Values Overview](🔗)

  • [APIAccessToken](🔗) <- This guide assumes you have a valid access token

### Permissions Needed

You will need a **Server Admin** role to do these steps. You can check the [APIs by Roles](🔗) for more details.

### Completed Code

Below is the completed python code for this guide.

Updating Custom Metadata/Descriptions for BI Objects
Open Recipe

## 1. Identify which object(s) we want to update

### Get BI Server ID

We can use [GET a list of BI Servers](🔗) to identify the BI Server ID that Alation uses. This can also be found in the URL.


### Get the BI Folders

We can use the [GET a list of folders from a specified BI Server](🔗) on this BI Server. Now a folder in Alation can represent projects in Tableau, Work Spaces in PowerBI, and etc. Browse your BI Server and Alation to get a feel for how it is organized in Alation.

## 2. Get the Custom Field IDs

We need to get the custom field ID for our "Description", singular name, custom field. The "Description" field is also a "Rich Text" type. If you wanted to update more custom fields on a BI source, then get those additional IDs here. [GET multiple Custom Fields](🔗)

In our URL parameters, we will specify the field type as "RICH_TEXT".

## 3. Update the description

Alright! We have all of the needed ids. Let's go to update the Description.

**NOTE:** When updating Rich Text Fields, make sure you review [HTML Sanitization](🔗) for which HTML values are allowed. iframes are always a good work around when needed ;)

### Before API Update

Here's our "Folder" right before the API call.


### Update Call

### After API Call

And now we can see the updated description!


And as always....

(Script tags will be stripped)