BasicAI CE Open & Plugin API
  1. Dataset
BasicAI CE Open & Plugin API
  • Open API
    • Dataset
      • Create Dataset
        POST
      • Edit Dataset
        POST
      • Delete Dataset
        POST
      • Query a single dataset
        GET
      • Query the list of datasets
        GET
      • Upload the dataset compressed package
        POST
      • Query the processing progress of the compressed dataset
        GET
      • Query the data under the dataset
        GET
      • Delete multiple data
        POST
      • Query a single data
        GET
      • Query multiple data
        GET
      • Generate presigned file upload url
        GET
      • Upload file through presigned url
        PUT
    • Annotation
      • Get data and result information
      • Download dataset annotation results
    • Model
      • Image object detection
      • Point cloud object detection
  • Plugin API
    • Model
      • Point cloud object detection
      • Image object detection
  1. Dataset

Query the list of datasets

Docker Compose
http://localhost:8190/api
Docker Compose
http://localhost:8190/api
GET
http://localhost:8190/api
/dataset/findByPage

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
pageNo
integer 
required
Current page number
Example:
1
pageSize
string 
required
Number of items displayed per page
Example:
10
name
string 
optional
Name
Example:
Name
createStartTime
string 
optional
Start time (Date type)
Example:
2022-12-01T00:00:00
createEndTime
string 
optional
End time (Date type)
Example:
2022-12-22T00:00:00
sortFiled
string 
optional
Sort field (NAME, CREATED_AT, UPDATED_AT)
Example:
NAME
ascOrDesc
string 
optional
Ascending or descending (ASC,DESC)
Example:
ASC
type
string 
optional
Data type: LIDAR_FUSION, LIDAR_BASIC, IMAGE
Example:
LIDAR_FUSION

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8190/api/dataset/findByPage?pageNo=1&pageSize=10'

Responses

🟢200Successful
application/json
Body
code
string 
required
message
string 
required
data
object 
required
pageSize
integer 
Item per page
required
pageNo
integer 
Current page number
required
total
integer 
Total
required
list
array [object {9}] 
required
Example
{
    "code": "string",
    "message": "string",
    "data": {
        "pageSize": 0,
        "pageNo": 0,
        "total": 0,
        "list": [
            {
                "id": 0,
                "name": "string",
                "type": "string",
                "description": null,
                "annotatedCount": 0,
                "notAnnotatedCount": 0,
                "invalidCount": 0,
                "itemCount": 0,
                "datas": [
                    {
                        "id": 0,
                        "datasetId": 0,
                        "name": "string",
                        "content": [
                            {
                                "name": "string",
                                "fileId": 0,
                                "type": "string",
                                "file": {
                                    "@type": "string",
                                    "id": 0,
                                    "name": "string",
                                    "originalName": "string",
                                    "path": "string",
                                    "zipPath": null,
                                    "type": "string",
                                    "size": 0,
                                    "bucketName": "string",
                                    "url": "string",
                                    "pathHash": 0,
                                    "extraInfo": null,
                                    "largeThumbnail": {
                                        "@type": "string",
                                        "id": 0,
                                        "name": "string",
                                        "originalName": "string",
                                        "path": "string",
                                        "zipPath": null,
                                        "type": "string",
                                        "size": null,
                                        "bucketName": "string",
                                        "url": "string",
                                        "pathHash": 0,
                                        "extraInfo": null
                                    },
                                    "mediumThumbnail": {
                                        "@type": "string",
                                        "id": 0,
                                        "name": "string",
                                        "originalName": "string",
                                        "path": "string",
                                        "zipPath": null,
                                        "type": "string",
                                        "size": null,
                                        "bucketName": "string",
                                        "url": "string",
                                        "pathHash": 0,
                                        "extraInfo": null
                                    },
                                    "smallThumbnail": {
                                        "@type": "string",
                                        "id": 0,
                                        "name": "string",
                                        "originalName": "string",
                                        "path": "string",
                                        "zipPath": null,
                                        "type": "string",
                                        "size": null,
                                        "bucketName": "string",
                                        "url": "string",
                                        "pathHash": 0,
                                        "extraInfo": null
                                    }
                                },
                                "files": [
                                    {
                                        "name": "string",
                                        "fileId": 0,
                                        "type": "string",
                                        "file": {
                                            "@type": "string",
                                            "id": 0,
                                            "name": "string",
                                            "originalName": "string",
                                            "path": "string",
                                            "zipPath": null,
                                            "type": "string",
                                            "size": 0,
                                            "bucketName": "string",
                                            "url": "string",
                                            "pathHash": 0,
                                            "extraInfo": null,
                                            "largeThumbnail": {
                                                "@type": "string",
                                                "id": 0,
                                                "name": "string",
                                                "originalName": "string",
                                                "path": "string",
                                                "zipPath": null,
                                                "type": "string",
                                                "size": null,
                                                "bucketName": "string",
                                                "url": "string",
                                                "pathHash": 0,
                                                "extraInfo": null
                                            },
                                            "mediumThumbnail": {
                                                "@type": "string",
                                                "id": 0,
                                                "name": "string",
                                                "originalName": "string",
                                                "path": "string",
                                                "zipPath": null,
                                                "type": "string",
                                                "size": null,
                                                "bucketName": "string",
                                                "url": "string",
                                                "pathHash": 0,
                                                "extraInfo": null
                                            },
                                            "smallThumbnail": {
                                                "@type": "string",
                                                "id": 0,
                                                "name": "string",
                                                "originalName": "string",
                                                "path": "string",
                                                "zipPath": null,
                                                "type": "string",
                                                "size": null,
                                                "bucketName": "string",
                                                "url": "string",
                                                "pathHash": 0,
                                                "extraInfo": null
                                            },
                                            "binary": null,
                                            "binaryCompressed": null,
                                            "renderImage": null
                                        }
                                    }
                                ],
                                "directoryType": "string"
                            }
                        ],
                        "status": "string",
                        "annotationStatus": "string",
                        "lockedBy": null
                    }
                ]
            }
        ]
    }
}
Modified at 2023-01-04 10:36:52
Previous
Query a single dataset
Next
Upload the dataset compressed package
Built with