Data dictionary API reference guide
The data dictionary API allows you to manage the data dictionary for your data sources.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
| Method | Path | Purpose |
|---|---|---|
POST /dictionary/{dataSourceId}
Create the dictionary for the specified data source.
| Attribute | Description | Required |
|---|---|---|
The following request creates a data dictionary (saved in example-payload.json) for the data source with ID 1.
Payload example
Other status codes returned include:
PUT /dictionary/{dataSourceId}
Update the dictionary for the specified data source.
The request below updates the data dictionary for the data source with the ID 1.
Payload example
Other status codes returned include
GET /dictionary/{dataSourceId}
Get the dictionary for the specified data source.
The request below gets the data dictionary for the data source with the ID 1.
GET /dictionary/columns
Search across all dictionary columns.
The following request searches for columns in all dictionaries that contain the text address in their name, with a limit of 10 results.
DELETE /dictionary/{dataSourceId}
Delete the data dictionary for the specified data source.
The request below deletes the data dictionary for the data source with ID 1.
This endpoint returns {} on success.
Other status codes returned include
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Status Code | Message |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Status Code | Message |
|---|---|
| Method | Path | Purpose |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Status Code | Message |
|---|---|
POST
/dictionary/{dataSourceId}
PUT
/dictionary/{dataSourceId}
dataSourceId
integer The ID of the data source that will contain the data dictionary.
Yes
body
array[object] Data dictionary metadata, including column names, data types, description and tags.
Yes
metadata
array[string] Metadata for each column in the dictionary.
Yes
metadata.name
string The name of the column.
Yes
metadata.dataType
string The type of data in the column.
Yes
metadata.remoteType
string The type of data in the remote column.
Yes
createdAt
timestamp When the object was created.
dataSource
integer The ID of the data source the dictionary is associated with.
id
integer The ID of the dictionary object.
metadata
array[string] Metadata for the individual fields in the dictionary, including name, dataType, and remoteType.
types
array[string] A list of all data types the dictionary contains, such as text, integer, json, or timestamp with time zone.
400
Bad request: (detailed reason).
401
A valid Authorization token must be provided.
403
User must have one of the following roles to delete dictionary: owner,expert.
404
Data source not found.
dataSourceId
integer The ID of the data source that will contain the data dictionary.
Yes
body
array[object] Data dictionary metadata, including column names, data types, description and tags.
Yes
metadata
array[string] Metadata for each column in the dictionary.
Yes
metadata.name
string The name of the column.
Yes
metadata.dataType
string The type of data in the column.
Yes
metadata.remoteType
string The type of data in the remote column.
Yes
createdAt
timestamp When the object was created.
dataSource
integer The ID of the data source the dictionary is associated with.
id
integer The ID of the dictionary object.
metadata
array[string] Metadata for the individual fields in the dictionary, including name, dataType, and remoteType.
types
array[string] A list of all data types the dictionary contains, such as text, integer, json, or timestamp with time zone.
400
Bad request: (detailed reason).
401
A valid Authorization token must be provided.
403
User must have one of the following roles to delete dictionary: owner,expert.
404
Data source not found.
GET
/dictionary/{dataSourceId}
GET
/dictionary/columns
dataSourceId
integer The ID of the data source that contains the data dictionary.
Yes
createdAt
timestamp When the object was created.
dataSource
integer The ID of the data source the dictionary is associated with.
id
integer The ID of the dictionary object.
metadata
array[string] Metadata for the individual fields in the dictionary, including name, dataType, and remoteType.
types
array[string] A list of all data types the dictionary contains, such as text, integer, json, or timestamp with time zone.
searchText
string A string used to filter returned columns. The query is executed with a wildcard prefix and suffix.
No
limit
integer The maximum number of search results that will be returned. Default is 10.
No
columnName
string The name of the column.
dataSourceId
integer The ID of the data source.
Yes
401
A valid Authorization token must be provided.
403
User must have one of the following roles to delete dictionary: owner,expert.
404
Data source not found.