You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/publish-apis/create-api-service.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,14 @@ Currently, it supports Doris, MongoDB, MySQL, Oracle, PostgreSQL, SQL Server, an
22
22
***Owner Application**: Select the business application this API belongs to. This helps categorize your APIs clearly. See [Application Management](manage-app.md) for more details.
23
23
***Connection Type**, **Connection Name**, **Object Name**: Choose the data source and object (e.g. a view like `orders-wide-view`) that the API will query.
24
24
-**Interface Type**: TapData provides two modes for querying data via APIs:
25
-
-**Default Query**: Includes three default input parameters—`page`, `limit`, and `filter`. This lets clients control pagination and filtering dynamically during runtime. If no filter is passed, the API returns the full dataset (default: 20 records per page). Suitable for general-purpose data access.
26
-
-**Custom Query**: Gives you more control over the API behavior. You can define fixed filter and sort conditions, specify output fields, and add custom input parameters (e.g., `region`, `startDate`, `userLevel`). Unlike the Default mode, `filter` is not included by default—but you can manually add it to support dynamic filtering if needed. Ideal for delivering domain-specific or constrained endpoints.
27
-
28
-
-**API Path Settings**: Your API’s path is structured as `/api/{version}/{prefix}/{base_path}`.
29
-
-`version` and `prefix` are optional for versioning or business labeling (e.g. `/api/v1/orders/summary`)
30
-
-`base_path` is required and uniquely identifies the endpoint (auto-generated if left blank)
25
+
-**Default Query**: A general-purpose mode with built-in pagination and filtering, suitable for client-driven access.
26
+
-**Custom Query**: A structured mode that enables domain-specific APIs with full control over query logic, sorting, and inputs.
27
+
-**API Path Settings**: Your API path follows the format `/api/{version}/{prefix}/{base_path}`.
28
+
-`version` and `prefix` are optional and can be used for versioning or business labeling (e.g., `/api/v1/orders/summary`).
29
+
-`base_path` is required and uniquely identifies the endpoint. It is auto-generated if left blank.
31
30
-**Input Parameters**: Define the parameters clients can pass when calling this API.
32
-
* If you choose **Default Query**, the system provides three built-in parameters—`page`, `limit`, and `filter`. This allows the client to dynamically control pagination and filtering at runtime. Custom parameters are not allowed in this mode.
33
-
* In contrast, **Custom Query** lets you design more structured APIs. You can define your own input parameters (e.g. `region`, `startDate`, `userLevel`) and bind them to filter or sort conditions in the UI. The filtering logic is handled entirely on the serverside, and no `filter`object is exposed to the client. This gives you full control over how the data is queried and returned. For supported types and configuration rules, see [API Query Parameters](api-query-params.md).
31
+
- For **Default Query**, the platform automatically includes three built-in parameters: `page`, `limit`, and `filter`. This allows dynamic pagination and filtering by the client; custom parameters are **not** supported.
32
+
- For **Custom Query**, you can define your own parameters (such as `region`, `startDate`, or `userLevel`), and map them to specific filter or sort conditions in the UI. In this mode, all filtering is managed server-side; the `filter`parameter is not included unless you explicitly add it. For supported types and configuration rules, see [API Query Parameters](api-query-params.md).
34
33
-**Output Results**: By default, all fields from the selected object are returned. You can manually adjust the list to return only selected fields.
Copy file name to clipboardExpand all lines: docs/publish-apis/manage-api-versions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ If your original API endpoint is `/e_commerce_orders`, by assigning version `v1`
23
23
24
24
:::tip
25
25
26
-
You can create versioned APIs by dragging a target table from the [ADM Layer](../operational-data-hub/adm-layer/integrate-apis.md) into the API builder, or by opening the Data Service section and clicking [Create API](create-api-service.md). From there, you’ll define the endpoint path and assign a version to it.
26
+
You can create versioned APIs by [dragging a target table](../operational-data-hub/adm-layer/integrate-apis.md) from the FDM or MDM Layer into the API builder, or by opening the Data Service section and clicking [Create API](create-api-service.md). From there, you’ll define the endpoint path and assign a version to it.
Copy file name to clipboardExpand all lines: docs/system-admin/manage-role.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,12 @@
1
1
# Manage Roles
2
2
3
-
A role is a collection of one or more permissions. You can grant multiple operation permissions to a role, and then grant the role to a [user](manage-user.md), who will inherit all the permissions within that role. Based on this design, you can pre-create roles based on business needs and then directly assign roles to users when creating them, without the need to configure permissions for each user, thereby simplifying operational management and enhancing security.
3
+
A role is a collection of one or more permissions. It controls access to features and data across the TapData platform.
4
+
Roles can be assigned to both:
5
+
6
+
-**[Users](manage-user.md)**, to control what operations they can perform in the TapData UI.
7
+
-**[Clients](../publish-apis/create-api-client.md)**, to control which APIs they are authorized to access under API Services.
8
+
9
+
By pre-defining roles for typical use cases, you can quickly assign them to users or clients without configuring individual permissions each time—streamlining management and enhancing security.
0 commit comments