Skip to main content

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

FieldTypeRequiredDescription
userKeyStringYActivation code
pageNumberintNPage number (default 1)
pageSizeintNPage size (default 10)

Request Example

{  
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"pageNumber": 1,
"pageSize": 10
}

5.3. Response

FieldTypeDescription
codeintStatus code
messageStringDescription
dataObjectData

Data structure of data

FieldTypeDescription
recordsarrayWorkspace list information
workspaceIdStringWorkspace ID
workspaceNameStringWorkspace name
dbTypeStringDatabase type
createTimeStringCreation time
numberOfAnalysisintNumber of workspace analyses
latestAnalysisTimeStringLatest analysis time
statusStringWorkspace creation status
totalStringTotal
sizeStringPage size
currentStringPage number
pagesStringTotal pages

Response Example

{  
"code": 200,
"message": "Success",
"data": {
"records": [
{
"workspaceId": "1730411624641736706",
...
},
{
"workspaceId": "1730187810133712898",
...
}
],
...
}
}