All Products
Search
Document Center

DataWorks:Generate API

Last Updated:Dec 05, 2024

DataService Studio allows you to create an API by using the codeless UI or code editor. In the codeless UI, you can configure an API in a visualized manner without the need of being able to code. In the code editor, you can write SQL statements for an API. The code editor allows you to use features such as table join queries, complex queries, and aggregate functions. This topic describes the features supported by APIs created by using the codeless UI or code editor.

The following table shows the differences in supported features of an API created by using the codeless UI and an API created by using the code editor.

Category

Feature

Codeless UI

Code editor

Query object

Query a single table in a single data source.

Supported

Supported

Query joined tables in a single data source.

Not supported

Supported

Query condition

Query an exact number.

Supported

Supported

Query a range of numbers.

Supported

Supported

Query a string in exact match mode.

Supported

Supported

Query strings in fuzzy match mode.

Supported

Supported

Query result

Return field values without changes.

Supported

Supported

Return a mathematical calculation of field values.

Not supported

Supported

Return an aggregate calculation of field values.

Not supported

Supported

Return results on multiple pages.

Supported

Supported

Query logic

Advanced SQL statements that support MyBatis tags are used to write the query logic.

Not supported

Supported