Configuring Data Warehouse and Dashboards binding settings in Management API

Data Warehouse limitations

The Management API does not provide endpoints to enumerate the valid values for workspace_single_mapping and workspace_mapping_table. To obtain the IDs of valid workspaces and mapping tables, use the Adverity user interface.

Listing Data Warehouse bindings

To list the Data Warehouse bindings, follow these steps:

1. Create a GET request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you obtain the list of Data Warehouse bindings, including the current values of all configurable settings.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request GET 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}'

Retrieving a single Data Warehouse binding

To retrieve the settings of a specific Data Warehouse binding, follow these steps:

1. Create a GET request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you obtain the current settings for the specified binding.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request GET 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}'

Discovering available Data Warehouse settings

To see all configurable fields, their accepted values, and help text before creating or updating a binding, send an OPTIONS request.

To discover available settings, follow these steps:

1. Create an OPTIONS request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, the response contains the full schema for the binding endpoint, including all accepted fields, their types, choices, and which are required.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request OPTIONS 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}'

Creating a Data Warehouse binding

To create a new Data Warehouse binding, follow these steps:

1. Create a POST request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. In the HTTP request header, include the parameter Content-Type with value application/json.

4. In the HTTP request body, include the binding parameters. At minimum, include the datastream field. For the full list of available parameters, see Available Data Warehouse binding settings:

   {
       "datastream": "{{DATASTREAM_ID}}",
       "ingestion_mode": 1,
       "workspace_mapping_type": 1,
       "workspace_single_mapping": "{{WORKSPACE_ID}}",
       "datasource_label": "My Datasource"
   }
   

5. Send the request.

As a result, you created a new Data Warehouse binding. The response contains the created binding with all its settings and returns HTTP 201.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request POST 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{"datastream": "{{DATASTREAM_ID}}", "ingestion_mode": 1, "workspace_mapping_type": 1, "workspace_single_mapping": "{{WORKSPACE_ID}}", "datasource_label": "My Datasource"}'

Updating Data Warehouse binding settings

To update the settings of an existing Data Warehouse binding, follow these steps:

1. Create a PATCH request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. In the HTTP request header, include the parameter Content-Type with value application/json.

4. In the HTTP request body, include only the settings you want to update:

   {
       "datasource_label": "Updated Label",
       "overwrite_key_columns": true
   }
   

5. Send the request.

As a result, the binding is updated and the response reflects the new values.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request PATCH 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{"datasource_label": "Updated Label", "overwrite_key_columns": true}'

Deleting a Data Warehouse binding

To delete an existing Data Warehouse binding, follow these steps:

1. Create a DELETE request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you deleted the Data Warehouse binding and the destination is removed from the datastream. The response returns HTTP 204 with no body.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request DELETE 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}'

Available Data Warehouse binding settings

The settings are grouped into three categories: ingestion settings, Dashboards workspace selection, and other settings. To see the full set of accepted values for each field, send an OPTIONS request as described in Discovering available Data Warehouse settings.

Dashboards limitations

The Management API does not provide endpoints to enumerate the valid values for workspace_single_mapping and workspace_mapping_table. To obtain the IDs of valid workspaces and mapping tables, use the Adverity user interface.

Listing Dashboards bindings

To list the Dashboards bindings, follow these steps:

1. Create a GET request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you obtain the list of Dashboards bindings, including the current values of all configurable settings.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request GET 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}'

Retrieving a single Dashboards binding

To retrieve the settings of a specific Dashboards binding, follow these steps:

1. Create a GET request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you obtain the current settings for the specified binding.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request GET 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}'

Discovering available Dashboards settings

To see all configurable fields, their accepted values, and help text before creating or updating a binding, send an OPTIONS request.

To discover available settings, follow these steps:

1. Create an OPTIONS request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, the response contains the full schema for the binding endpoint, including all accepted fields, their types, choices, and which are required.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request OPTIONS 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}'

Creating a Dashboards binding

To create a new Dashboards binding, follow these steps:

1. Create a POST request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. In the HTTP request header, include the parameter Content-Type with value application/json.

4. In the HTTP request body, include the binding parameters. At minimum, include the datastream field. For the full list of available parameters, see Available Dashboards binding settings:

   {
       "datastream": "{{DATASTREAM_ID}}",
       "workspace_mapping_type": 1,
       "workspace_single_mapping": "{{WORKSPACE_ID}}",
       "datasource_label": "My Datasource"
   }
   

5. Send the request.

As a result, you created a new Dashboards binding. The response contains the created binding with all its settings and returns HTTP 201.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request POST 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{"datastream": "{{DATASTREAM_ID}}", "workspace_mapping_type": 1, "workspace_single_mapping": "{{WORKSPACE_ID}}", "datasource_label": "My Datasource"}'

Updating Dashboards binding settings

To update the settings of an existing Dashboards binding, follow these steps:

1. Create a PATCH request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. In the HTTP request header, include the parameter Content-Type with value application/json.

4. In the HTTP request body, include only the settings you want to update:

   {
       "datasource_label": "Updated Label",
       "overwrite_filename": true
   }
   

5. Send the request.

As a result, the binding is updated and the response reflects the new values.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request PATCH 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{"datasource_label": "Updated Label", "overwrite_filename": true}'

Deleting a Dashboards binding

To delete an existing Dashboards binding, follow these steps:

1. Create a DELETE request to the following endpoint:

   https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/
   

2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

3. Send the request.

As a result, you deleted the Dashboards binding and the destination is removed from the datastream. The response returns HTTP 204 with no body.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --location --request DELETE 'https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{BINDING_ID}}/' \
--header 'Authorization: Bearer {{KEY}}'

Available Dashboards binding settings

The settings are grouped into three categories: Dashboards workspace selection, overwrite settings, and other settings. To see the full set of accepted values for each field, send an OPTIONS request as described in Discovering available Dashboards settings.