{"metadata": [ {"name":"notificationType","dataType":"text","remoteType":"text" }, {"name":"actionBy","dataType":"text","remoteType":"integer" }, {"name":"targetUser","dataType":"integer","remoteType":"integer" }, {"name":"metadata","dataType":"json","remoteType":"json" }, {"name":"id","dataType":"integer","remoteType":"integer" }, {"name":"notifyInitiator","dataType":"text","remoteType":"boolean" }, {"name":"eventTime","dataType":"timestamp with time zone","remoteType":"timestamp with time zone" } ]}
Response example
{"createdAt":"2018-03-21T10:52:30.535Z","dataSource":1,"id":1,"metadata": [ {"name":"notificationType","dataType":"text","remoteType":"text" }, {"name":"actionBy","dataType":"text","remoteType":"integer" }, {"name":"targetUser","dataType":"integer","remoteType":"integer" }, {"name":"metadata","dataType":"json","remoteType":"json" }, {"name":"id","dataType":"integer","remoteType":"integer" }, {"name":"notifyInitiator","dataType":"text","remoteType":"boolean" }, {"name":"eventTime","dataType":"timestamp with time zone","remoteType":"timestamp with time zone" } ],"types": ["text","integer","json","timestamp with time zone" ],"updatedAt":"2018-03-21T12:18:25.531Z"}
Other status codes returned include:
Update a data dictionary
PUT/dictionary/{dataSourceId}
Update the dictionary for the specified data source.
Query parameters
Payload parameters
Response parameters
Request example
The request below updates the data dictionary for the data source with the ID 1.
{"metadata": [ {"name":"notificationType","dataType":"text","remoteType":"text" }, {"name":"actionBy","dataType":"text","remoteType":"integer" }, {"name":"targetUser","dataType":"integer","remoteType":"integer" }, {"name":"metadata","dataType":"json","remoteType":"json" }, {"name":"id","dataType":"integer","remoteType":"integer" }, {"name":"notifyInitiator","dataType":"text","remoteType":"boolean" }, {"name":"eventTime","dataType":"timestamp with time zone","remoteType":"timestamp with time zone" } ]}
Response example
{"createdAt":"2018-03-21T10:52:30.535Z","dataSource":1,"id":1,"metadata": [ {"name":"notificationType","dataType":"text","remoteType":"text" }, {"name":"actionBy","dataType":"text","remoteType":"integer" }, {"name":"targetUser","dataType":"integer","remoteType":"integer" }, {"name":"metadata","dataType":"json","remoteType":"json" }, {"name":"id","dataType":"integer","remoteType":"integer" }, {"name":"notifyInitiator","dataType":"text","remoteType":"boolean" }, {"name":"eventTime","dataType":"timestamp with time zone","remoteType":"timestamp with time zone" } ],"types": ["text","integer","json","timestamp with time zone" ],"updatedAt":"2018-03-21T12:18:25.531Z"}
Other status codes returned include
Search data dictionaries
Get the dictionary for a specified data source
GET/dictionary/{dataSourceId}
Get the dictionary for the specified data source.
Query parameters
Response parameters
Request example
The request below gets the data dictionary for the data source with the ID 1.
{"createdAt":"2018-03-21T10:52:30.535Z","dataSource":1,"id":1,"metadata": [ {"name":"notificationType","dataType":"text","remoteType":"text" }, {"name":"actionBy","dataType":"text","remoteType":"integer" }, {"name":"targetUser","dataType":"integer","remoteType":"integer" }, {"name":"metadata","dataType":"json","remoteType":"json" }, {"name":"id","dataType":"integer","remoteType":"integer" }, {"name":"notifyInitiator","dataType":"text","remoteType":"boolean" }, {"name":"eventTime","dataType":"timestamp with time zone","remoteType":"timestamp with time zone" } ],"types": ["text","integer","json","timestamp with time zone" ],"updatedAt":"2018-03-21T12:18:25.531Z"}
Search across all dictionary columns
GET/dictionary/columns
Search across all dictionary columns.
Query parameters
Response parameters
Request example
The following request searches for columns in all dictionaries that contain the text address in their name, with a limit of 10 results.