5 Query the list of Workspace
Description: Get user's all workspace list information.
5.1. Interface URL
Post http://${server-host}:${server-port}/api/v1/listWorkspaces
5.2. Request Parameters
Field | Type | Required | Description |
---|---|---|---|
userKey | String | Y | Activation code |
pageNumber | int | N | Page number (default 1) |
pageSize | int | N | Page size (default 10) |
Request Example
{
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"pageNumber": 1,
"pageSize": 10
}
5.3. Response
Field | Type | Description |
---|---|---|
code | int | Status code |
message | String | Description |
data | Object | Data |
Data structure of data
Field | Type | Description |
---|---|---|
records | array | Workspace list information |
workspaceId | String | Workspace ID |
workspaceName | String | Workspace name |
dbType | String | Database type |
createTime | String | Creation time |
numberOfAnalysis | int | Number of workspace analyses |
latestAnalysisTime | String | Latest analysis time |
status | String | Workspace creation status |
total | String | Total |
size | String | Page size |
current | String | Page number |
pages | String | Total pages |
Response Example
{
"code": 200,
"message": "Success",
"data": {
"records": [
{
"workspaceId": "1730411624641736706",
...
},
{
"workspaceId": "1730187810133712898",
...
}
],
...
}
}