Skip to main content

Managing Data APIs

Talend Cloud Data Inventory allows you to easily generate an API based on your dataset so the data it contains can be consumed by applications or business partners. It also improves the Talend Trust Score™ of your dataset.

You can for example consume a dataset containing customer data, directly in a platform such as Salesforce, after a quick configuration in the Talend Cloud Data Inventory interface.

Enabling an API for a dataset comes with the following specifications and limitations:

  • You can only enable an API for datasets created from a JDBC connection, see the list of Compatible data sources to enable an API.
  • The resulting API is OData v4 compliant, and can therefore be called by applications supporting this standard, such as:
  • The generated API gives read-only access to the data.
  • The engine used to host the API endpoint is the same as the one hosting the connection to your dataset. If you are using a Cloud Engine for Design, the API will have performance and scaling limitations. A Cloud Engine for Design is best suited for designing and testing the API. Consider installing a Remote Engine Gen2 for production use. For more advanced configuration when using a Remote Engine Gen2, see Customizing Data APIs usage.
  • The API generated has limited OData v4 expressivity, see Calling the API for examples of supported expressivity.
  • When retrieving records containing fields of type blob that are larger than 10 MB, the value will not be returned and will be replaced by an empty value.
Information noteNote: Once your API is enabled, you can still edit the configuration. After any edit the API will be disabled and re-enabled with the updated configuration.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!