​x
29
        break
 
1
# if you get an error, on the command line type pip install requests
2
import requests
3
​
4
# setting the base_url so that all we need to do is swap API endpoints
5
base_url = "CHANGEME"
6
# api access key
7
api_key = "CHANGEME"
8
# setting up this access key to be in the headers
9
headers = {"token": api_key}
10
# api for bi server endpoint
11
bi_server_api = "/integration/v2/bi/server/"
12
bi_server_uri = "https://tableau2020."
13
​
14
# make the API call
15
res = requests.get(base_url + bi_server_api, headers=headers)
16
# convert the response to a python dict.
17
bi_servers = res.json()
18
​
19
# iterate through our servers to find the one we need
20
bi_server_id = 0
21
​
22
# would recommend creating a function for this action
23
# vs what we're doing in this guide
24
for serv in bi_servers:
25
  # matching on URI to find the one that starts with what we need

xxxxxxxxxx
1
14
 
1
# this code is a continuation of the above code.
2
​
3
bi_folder_name = "Ticket Sales"
4
bi_folder_api = "/integration/v2/bi/server/{}/folder/".format(bi_server_id)
5
res = requests.get(base_url + bi_folder_api, headers=headers)
6
bi_folders = res.json()
7
​
8
bi_folder_id = 0
9
for folder in bi_folders:
10
  # matching on folder name to find the one that starts with what we need
11
    if folder["name"].startswith(bi_folder_name):
12
        bi_folder_id = folder["id"] # in this example, our bi folder ID = 744
13
        print("The BI folder id for \"{}\" is {}". format(bi_folder_name, bi_folder_id))
14
        break

xxxxxxxxxx
1
14
 
1
needed_cf_type = "RICH_TEXT"
2
singular_field_name = "Description" # the custom field name we're looking for
3
custom_field_api = "/integration/v2/custom_field/?field_type={}&limit=100&skip=0".format(needed_cf_type)
4
​
5
res = requests.get(base_url + custom_field_api, headers=headers)
6
custom_fields = res.json()
7
​
8
custom_field_id = 0
9
for cf in custom_fields:
10
  # matching on folder name to find the one that starts with what we need
11
    if cf["name_singular"] == (singular_field_name):
12
        custom_field_id = folder["id"] # in this example, our bi folder ID = 4
13
        print("The custom field \"{}\" the ID is {}". format(singular_field_name, custom_field_id))
14
        break

xxxxxxxxxx
1
16
 
1
custom_field_value_api = "/integration/v2/custom_field_value/"
2
data = [
3
    {
4
        "field_id": custom_field_id,
5
        "otype": "bi_folder",
6
        "oid": bi_folder_id,
7
        "value": "<ul><li>Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</li><li>Aliquam tincidunt mauris eu risus.</li><li>Vestibulum auctor dapibus neque.</li></ul>"
8
    }
9
]
10
​
11
# Requests library makes it easy for us to convert a payload to json.
12
res = requests.put(base_url + custom_field_value_api, headers=headers, json=data)
13
print(res.json())
14
​
15
# if all went according to plan then, you should see a response that looks like
16
# {'updated_field_values': 1, 'new_field_values': 0, 'field_values_received': 1}