Appearance
Get rule list
About 323 wordsAbout 1 min
apiData Security
2025-03-13
MethodPOST
Request URL
/plugin/datafor-modeler/api/auth/row/query
Authorization
Use of this API requires authentication. For details about the authentication method, see
Authorization.
Content Typeapplication/json
Preconditions
- The current user’s type cannot be
SYS_Reader
. - The current user must have administrative privileges for the connection.
Request Schema
Name | Location | Type | Required | Description |
---|---|---|---|---|
body | body | object | Yes | Request payload |
├── id | body | string | No | Rule ID (leave empty to fetch all) |
├── dbconn | body | string | No | Database connection name |
├── enable | body | string | No | Filter by enable status |
├── editable | body | string | No | Editable status |
├── withGranted | body | boolean | No | Whether to include granted user/role list |
├── withConfig | body | boolean | No | Whether to include config list |
Request Example
{
"id": "3a95ade7937743d6a04d27db8d4c69a3",
"dbconn": "Demo",
"schema": "public",
"tbname": "time_dim",
"enable": "1",
"withGranted": true,
"type": "1"
}
Response Examples
{
"code": "200",
"data": [
{
"grantedList": [
{
"name": "admin",
"type": "0"
},
{
"name": "Administrator",
"type": "1"
}
],
"dbconn": "Demo",
"update_time": "2025-02-26 17:29:35.872",
"add_by": "admin",
"enable": "1",
"editable": "1",
"id": "8699a11df24c49ddab9451e249ff2c97",
"update_by": "admin",
"add_time": "2025-02-26 17:29:35.872",
"desc": "test"
}
],
"success": true
}
HTTP Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | none | Inline |
Response Data Schema (HTTP 200)
Name | Type | Required | Description |
---|---|---|---|
code | string | No | Response status code |
data | array | Yes | List of rule objects |
├── grantedList | array | No | List of granted users/roles |
│ ├── name | string | Yes | User or role name |
│ ├── type | string | Yes | 0 for user, 1 for role |
├── dbconn | string | No | Database connection name |
├── update_time | string | No | Last update timestamp |
├── add_by | string | No | Rule creator |
├── enable | string | No | Enable status (1 for enabled) |
├── editable | string | No | Editable status (1 for editable) |
├── id | string | No | Rule ID |
├── update_by | string | No | Last updated by |
├── add_time | string | No | Creation timestamp |
├── desc | string | No | Rule description |
success | boolean | Yes | Request success status |
msg | string | No | Response message |