---
title: "API Changes"
canonical: "https://docs.vaultspeed.com/space/VPD/3364192361/API%20Changes"
format: markdown
---
# Release 5.3

> Macro (toc)

> ℹ️ Note: Request and Response structure is expressed in Schema representation. For actual JSON examples please refer to [user-facing API documentation](https://app.vaultspeed.com/vaultspeed-api) (toggle between *Example* and *Schema*).
> ℹ️ 
> ℹ️ Schema does not have commas (`,`) between objects (denoted by `{` and `}`) when compared to actual Example (JSON). Also in Schema `[number]` means “an array of numeric type values”, that is an Example may be `[2]` or `[1, 2, 3]`. An example of `[string]` would be `["string 1", "string 2", "string 3"]`, etc.

## Breaking Changes

### Multi-path Relationship in Bridges

For the Bridge editor to support adding the same Hub multiple times (with another alias), enabling relationships to the same object, the following API endpoints are modified:

#### Modified endpoint: Create New Bridge

| **Type** | POST |
| --- | --- |
| **Endpoint URL** | `/business-vault/bridge` |
| **Authorization** | Bearer Token |
| **Modification summary** | Request body attribute changes. |
| **Request Body** | Changes from:<br>```scheme
{
  bv_vs_id*: number
  bridge_tab_name*: string
  tab_dv_vs_ids*: [ number ]
  tab_dv_vs_id_bks: [ number ]
  create_bridge_hash_key: boolean
  vss_code_generation: boolean
}
```<br>Changes to:<br>```scheme
{
  bv_vs_id*: number
  bridge_tab_name*: string
  data_vault_objects*: [{
    tab_dv_vs_id: number
    include_bks: boolean
    alias: string
    linked_to_aliases: [ string ]
  }]
  create_bridge_hash_key: boolean
  vss_code_generation: boolean
}
``` |
| **Response** | No changes |

#### Modified endpoint: Update Existing Bridge

| **Type** | PATCH |
| --- | --- |
| **Endpoint URL** | `/business-vault/{bv_vs_id}/bridge/{bridge_tab_id}` |
| **Authorization** | Bearer Token |
| **Modification summary** | Request body changes. |
| **Request Body** | Changes from:<br>```scheme
{
  bridge_tab_name*: string
  tab_dv_vs_ids*: [ number ]
  tab_dv_vs_id_bks: [ number ]
  create_bridge_hash_key: boolean
  vss_code_generation: boolean
} 
```<br>Changes to:<br>```scheme
{
  bridge_tab_name*: string
  data_vault_objects*: [{
  tab_dv_vs_id: number
  include_bks: boolean
  alias: string
  linked_to_aliases: [ string ]
  create_bridge_hash_key: boolean
  vss_code_generation: boolean
} 
``` |
| **Response** | No changes |

### Description for Database Type (1)

#### Removed endpoint: Get Database Links Custom

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/db-links/custom` |
| **Authorization** | Bearer Token |
| **Modification summary** | Endpoint is removed from API. |
| **Request Body** | No changes |
| **Response** | No changes |

## Non-breaking Changes

### DB-link management

#### Modified endpoint: Delete a DB-Link

| **Type** | DELETE |
| --- | --- |
| **Endpoint URL** | `/db-link/{database_link_id}` |
| **Authorization** | Bearer Token |
| **Modification summary** | Attempting to delete a DB-Link that still has sources associated to it will not perform deletion but will return `error` object with details and HTTP status code `500 Internal Server Error`. |
| **Request Body** | No changes |
| **Response** | No changes |

Not modified, provided for reference: Error object structure is the following:

```scheme
error {
  statusCode: number
  name: string
  message: string
}
```

### Signature Objects

New endpoints introduced - no effect on existing API usage.

### Description for Database Type (2)

#### Modified endpoint: Get Database Links

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/db-links` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional properties in response: `database_type` and `database_type_description`;<br>For request these two new properties are available in Query-string Parameter `filter` object. |
| **Request** | Properties `database_type` and `database_type_description` added to Query-string Parameter: `filter` object.<br>After modification Query-string Parameter `filter` object is following (JSON example, see lines 16-17):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "database_link_id": true,
    "database_link_name": true,
    "link_url": true,
    "link_type": true,
    "database_type_id": true,
    "link_url_object": true,
    "database_type": true,
    "database_type_description": true
  }
}
``` |
| **Response** | Response Body schema after (see lines 8-9):<br>```scheme
[{
  database_link_id: number
  database_link_name: string
  link_url: string
  link_type: string
  database_type_id: number
  link_url_object: string
  database_type: string
  database_type_description: string
}] 
``` |

#### Modified endpoint: Get Data Vault Data Type Mappings

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/data-vault/{dv_vs_id}/data-type-mappings` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in response;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Query-string Parameter `filter` object.<br>After modification (JSON example, see line 13):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "data_type_mapping_id": true,
    "dv_id": true,
    "database_type": true,
    "database_type_description": true,
    "data_type_src": true,
    "sql_data_type": true,
    "data_length_src": true,
    "data_precision_src": true,
    "data_scale_src": true,
    "data_type_target": true,
    "data_length_target": true,
    "data_precision_target": true,
    "data_scale_target": true,
    "dv_vs_id": true
  }
}
``` |
| **Response** | Response body schema after (see line 5):<br>```scheme
[ {
  data_type_mapping_id: number
  dv_id: number
  database_type: string
  database_type_description: string
  data_type_src: string
  sql_data_type: string
  data_length_src: string
  data_precision_src: string
  data_scale_src: string
  data_type_target: string
  data_length_target: string
  data_precision_target: string
  data_scale_target: string
  dv_vs_id: number
} ]
``` |

#### Modified endpoint: Get DDL-ETL parameters

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/ddl-etl/parameters/{database_type_id}` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Query-string Parameter `filter` object.<br>After modification (JSON example, see line 17):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "param_id": true,
    "param_name": true,
    "param_loc": true,
    "param_text": true,
    "param_type": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "param_required": true,
    "etl_generation_language_id": true,
    "etl_generation_language": true,
    "param_order": true
  }
}
``` |
| **Response** | Response body schema after modification (see line 9):<br>```scheme
[{
  param_id*: number
  param_name: string
  param_loc: string
  param_text: string
  param_type: string
  database_type_id: number
  database_type: string
  database_type_description: string
  param_required: boolean
  etl_generation_language_id: number
  etl_generation_language: string
  param_order: number
}] 
``` |

#### Modified endpoint: Get DDL Applied Parameter Settings

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/ddl-etl/ddl-parameters/applied-settings` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Parameter `filter` object.<br>After modification (JSON example, see line 20):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "ddl_etl_object_parameters_id": true,
    "ddl_etl_saved_parameters_id": true,
    "dv_id": true,
    "dv_name": true,
    "src_id": true,
    "src_name": true,
    "project_id": true,
    "project_name": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "save_time": true,
    "settings_name": true,
    "tab_type_id": true,
    "tab_type": true,
    "layer_type_id": true,
    "layer": true,
    "etl_generation_language_id": true,
    "etl_generation_language": true,
    "build_flag": true
  }
}
``` |
| **Response** | Response body schema after modification (see line 12):<br>```scheme
[{
  ddl_etl_object_parameters_id: number
  ddl_etl_saved_parameters_id: number
  dv_id: number
  dv_name: string
  src_id: number
  src_name: string
  project_id: number
  project_name: string
  database_type_id: number
  database_type: string
  database_type_description: string
  save_time: date-time
  settings_name: string
  tab_type_id: number
  tab_type: string
  layer_type_id: number
  layer: string
  etl_generation_language_id: number
  etl_generation_language: string
  build_flag: boolean
}]
``` |

#### Modified endpoint: Get ETL Applied Parameter Settings

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/ddl-etl/etl-parameters/applied-settings` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Parameter `filter` object.<br>After modification (JSON example, see line 20):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "ddl_etl_object_parameters_id": true,
    "ddl_etl_saved_parameters_id": true,
    "dv_id": true,
    "dv_name": true,
    "src_id": true,
    "src_name": true,
    "project_id": true,
    "project_name": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "save_time": true,
    "settings_name": true,
    "tab_type_id": true,
    "tab_type": true,
    "layer_type_id": true,
    "layer": true,
    "etl_generation_language_id": true,
    "etl_generation_language": true,
    "build_flag": true
  }
}
``` |
| **Response** | Response body schema after modification (see line 12):<br>```scheme
[{
  ddl_etl_object_parameters_id: number
  ddl_etl_saved_parameters_id: number
  dv_id: number
  dv_name: string
  src_id: number
  src_name: string
  project_id: number
  project_name: string
  database_type_id: number
  database_type: string
  database_type_description: string
  save_time: date-time
  settings_name: string
  tab_type_id: number
  tab_type: string
  layer_type_id: number
  layer: string
  etl_generation_language_id: number
  etl_generation_language: string
  build_flag: boolean
}] 
``` |

#### Modified endpoint: Get Data Vaults

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/data-vaults` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Parameter `filter` object.<br>After modification (JSON example, see line 18):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "project_id": true,
    "project_name": true,
    "dv_id": true,
    "dv_name": true,
    "dv_code": true,
    "hide_dv": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "has_locked_release": true
  }
}
``` |
| **Response** | Response body schema after modification (see line 10):<br>```scheme
[{
  project_id: number
  project_name: string
  dv_id: number
  dv_name: string
  dv_code: string
  hide_dv: boolean
  database_type_id: number
  database_type: string
  database_type_description: string
  has_locked_release: boolean
}] 
``` |

#### Modified endpoint: Get Data Vault

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/data-vault/{dv_id}` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body. |
| **Request** | No changes |
| **Response** | Response body scheme after modification (see line 10):<br>```scheme
{
  project_id: number
  project_name: string
  dv_id: number
  dv_name: string
  dv_code: string
  hide_dv: boolean
  database_type_id: number
  database_type: string
  database_type_description: string
  has_locked_release: boolean
} 
``` |

#### Modified endpoint: Get Sources

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/sources` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Parameter `filter` object.<br>After modification (JSON example, see line 26):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "project_id": true,
    "project_name": true,
    "record_src_name": true,
    "src_id": true,
    "src_name": true,
    "src_short_name": true,
    "src_name_in_bk": true,
    "src_physical_schema": true,
    "src_type_id": true,
    "src_type": true,
    "mtd_source": true,
    "cdc_id": true,
    "cdc_type": true,
    "build_flag": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "database_link_id": true,
    "database_link_name": true,
    "link_type": true,
    "link_url": true,
    "has_locked_release": true,
    "latest_locked_vs_grp_src_id": true
  }
}
``` |
| **Response** | Response body schema after modification (see line 18):<br>```scheme
[{
  project_id: number
  project_name: string
  record_src_name: string
  src_id: number
  src_name: string
  src_short_name: string
  src_name_in_bk: string
  src_physical_schema: string
  src_type_id: number
  src_type: string
  mtd_source: string
  cdc_id: number
  cdc_type: string
  build_flag: boolean
  database_type_id: number
  database_type: string
  database_type_description: string
  database_link_id: number
  database_link_name: string
  link_type: string
  link_url: string
  has_locked_release: boolean
  latest_locked_vs_grp_src_id: number
}] 
``` |

#### Modified endpoint: Add a New Source

| **Type** | POST |
| --- | --- |
| **Endpoint URL** | `/source` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body |
| **Request** | No changes |
| **Response** | Response body schema after modification (see line 18):<br>```scheme
{
  project_id: number
  project_name: string
  record_src_name: string
  src_id: number
  src_name: string
  src_short_name: string
  src_name_in_bk: string
  src_physical_schema: string
  src_type_id: number
  src_type: string
  mtd_source: string
  cdc_id: number
  cdc_type: string
  build_flag: boolean
  database_type_id: number
  database_type: string
  database_type_description: string
  database_link_id: number
  database_link_name: string
  link_type: string
  link_url: string
  has_locked_release: boolean
  latest_locked_vs_grp_src_id: number
} 
``` |

#### Modified endpoint: Get VaultSpeed Studio Templates

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/business-vault/{bv_vs_id}/vss/templates` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional property (`database_type_description`) in Response body;<br>For request this new property is available in Query-string Parameter `filter` object. |
| **Request** | Property `database_type_description` added to Parameter `filter` object.<br>After modification (JSON example, see line 34):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "vss_template_id": true,
    "vss_template_name": true,
    "vss_template_description": true,
    "vss_template_etl": true,
    "vss_template_ddl": true,
    "base_tab_type_id": true,
    "base_tab_type": true,
    "object_type_id": true,
    "object_type": true,
    "tab_type_prefix": true,
    "tab_type_suffix": true,
    "test_status_etl": true,
    "test_status_ddl": true,
    "test_error_msg_etl": true,
    "test_error_msg_ddl": true,
    "generated_code_etl": true,
    "generated_code_ddl": true,
    "bv_vs_id": true,
    "load_type_id": true,
    "load_type": true,
    "has_attributes": true,
    "has_dependencies": true,
    "database_type_id": true,
    "database_type": true,
    "database_type_description": true,
    "user_layer_type_id": true,
    "layer_type_name": true,
    "folder": true,
    "user_tab_type_id": true,
    "tab_type": true
  }
}
``` |
| **Response** | Response body scheme after modification (see line 26):<br>```scheme
[{
  vss_template_id: number
  vss_template_name: string
  vss_template_description: string
  vss_template_etl: string
  vss_template_ddl: string
  base_tab_type_id: number
  base_tab_type: string
  object_type_id: number
  object_type: string
  tab_type_prefix: string
  tab_type_suffix: string
  test_status_etl: boolean
  test_status_ddl: boolean
  test_error_msg_etl: string
  test_error_msg_ddl: string
  generated_code_etl: string
  generated_code_ddl: string
  bv_vs_id: number
  load_type_id: number
  load_type: string
  has_attributes: boolean
  has_dependencies: boolean
  database_type_id: number
  database_type: string
  database_type_description: string
  user_layer_type_id: number
  layer_type_name: string
  folder: string
  user_tab_type_id: number
  tab_type: string
}] 
``` |

### Select Object Screen Update

#### Modified endpoint: Get Source Objects

| **Type** | GET |
| --- | --- |
| **Endpoint URL** | `/source/{src_id}/objects` |
| **Authorization** | Bearer Token |
| **Modification summary** | Returns additional properties: `map_table_id`, `map_table_name` and `error_msg` in Response body;<br>For request these new properties are available in Query-string Parameter `filter` object. |
| **Request** | Properties `map_table_id`, `map_table_name`, `error_msg` added to Parameter `filter` object.<br>After modification (JSON example, see lines 16-18):<br>```json
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {
    "additionalProp1": {}
  },
  "fields": {
    "all_src_tables_id": true,
    "schema_table_name": true,
    "schema_name": true,
    "src_id": true,
    "selected_flag": true,
    "exists_in_source_flag": true,
    "map_table_id": true,
    "map_table_name": true,
    "error_msg": true
  }
}
``` |
| **Response** | Response body scheme after modification (see lines 8-10):<br>```scheme
[{
  all_src_tables_id*: number
  schema_table_name: string
  schema_name: string
  src_id: number
  selected_flag: boolean
  exists_in_source_flag: boolean
  map_table_id: number
  map_table_name: string
  error_msg: string
}] 
``` |

#### New endpoint: Update Object for The Source Model

| **Type** | POST |
| --- | --- |
| **Endpoint URL** | `/source/{src_id}/object/{all_src_tables_id}/update` |
| **Authorization** | Bearer Token |
| **Modification summary** | New endpoint |
| **Request** | Request body schema:<br>```scheme
{
  map_table_id: number┃null
  selected_flag: boolean
}
```<br>Note: `map_table_id` is nullable. |
| **Response** | Response body schema:<br>```scheme
[{
  all_src_tables_id*: number
  schema_table_name: string
  schema_name: string
  src_id: number
  selected_flag: boolean
  exists_in_source_flag: boolean
}] 
```<br>Note: property `all_src_tables_id` is required. |