Query the data under the dataset - BasicAI CE Open & Plugin API

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

Dataset 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-20T00:00:00

sortFiled

string

optional

Sort field (NAME, CREATED_AT, UPDATED_AT)

Example:

NAME

ascOrDesc

string

optional

Ascending or descending (ASC,DESC)

Example:

ASC

annotationStatus

string

optional

Annotation status (ANNOTATED,NOT_ANNOTATED,INVALID)

Example:

ANNOTATED

datasetId

integer

required

Dataset ID

Example:

750009

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Successful

application/json

Body

code

string

required

message

string

required

data

object

required

pageSize

integer

Item per page

required

pageNo

integer

Page number

required

total

integer

Total

required

list

array [object {7}]

required

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "pageSize": 0,
    "pageNo": 0,
    "total": 0,
    "list": [
      {
        "id": "string",
        "datasetId": "string",
        "name": "string",
        "content": [
          {
            "name": "string",
            "type": "string",
            "files": [
              {
                "name": "string",
                "fileId": "string",
                "type": "string",
                "file": {
                  "id": "string",
                  "name": "string",
                  "originalName": "string",
                  "path": "string",
                  "type": "string",
                  "size": "string",
                  "bucketName": "string",
                  "url": "string",
                  "pathHash": "string",
                  "extraInfo": "string"
                }
              }
            ],
            "directoryType": "string"
          }
        ],
        "status": "string",
        "annotationStatus": "string",
        "lockedBy": "string"
      }
    ]
  }
}