This document introduces the "Open API for dataset operations." You will learn how users can update, move, and delete datasets, as well as check and move datasets to the recycle bin through the API, and other operations.
Caution: Before using the APIs described in this document, you must complete the prerequisites of integrating JWT-Token and applying for a Token. Please familiarize yourself with the invocation method. For details, see Invocation Method.

2.1 Check whether a dataset can be moved to the recycle bin #

• Permission requirements

  Resource	Permission
  Dataset	admin

• Interface description: Checks whether the current dataset has lineage associations or other issues. If there are no issues, an empty list is returned, indicating that the dataset can be deleted directly. Otherwise, the user must manually remove lineage associations as indicated by the interface response before moving the dataset to the recycle bin.

Note: This should be used in conjunction with the Move dataset to recycle bin API.

Request description

Endpoint: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/recyclable

Request example

curl --location --request GET '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/recyclable' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}'

Request parameters

Response example

• Response description: If the response is normal, the dataset can be deleted directly.

  {
      "code": "aeolus/ok",
      "data": [],
      "msg": "成功"
  }
  

2.2 Move dataset to recycle bin #

• Permission requirements

  Resource	Permission
  Dataset	admin

• Interface description: Moves the dataset to the recycle bin without permanently deleting it

Note: This should be used in conjunction with the Check whether a dataset can be moved to the recycle bin API

Request description

Endpoint: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/recycle

Request example

curl --location --request DELETE '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/recycle' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}'

Request parameters

Response example

{
    "code": "aeolus/ok",
    "data": [],
    "msg": "成功"
}

2.3 Restore dataset from recycle bin #

• Permission requirements

  Resource	Permission
  Dataset	admin

• Interface description: Moves the dataset out of the recycle bin.
  

Request description

Endpoint: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/restore

Request example

curl --location --request PUT '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/restore' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}'

Request parameters

Response example

If fails is an empty list, the dataset has been restored successfully

{
    "code": "aeolus/ok",
    "data": {
        "fails": []
    },
    "msg": "成功"
}

2.4 Permanently delete dataset #

• Permission requirements

  Resource	Permission
  Dataset	admin

• Interface description: Permanently deletes the dataset, clears the dataset's data and underlying tables, stops synchronization tasks, and so on; only the dataset's metadata is retained.

Request description

Endpoint: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}

Request example

curl --location --request DELETE '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}'

Request parameters

Response example

If deletion is successful, the dataset ID is returned

{
    "code": "aeolus/ok",
    "data": [
        "180664"
    ],
    "msg": "成功"
}

2.5 Move dataset location (update folder path) #

• Permission requirements

  Resource	Permission
  Dataset	write
  Destination folder	write

• Interface description and explanation: Move the specified dataset to a designated folder. This can be used together with the "Dataset Folder - Get dataset folder information under a project" API.
  

Request description

API path: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/folder/move

Request example

curl --location --request PUT '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/folder' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}' \
--data-raw '{
    "folderId": 2706
}'

Request parameters

Response example

{
    "code": "aeolus/ok",
    "data": "ok",
    "msg": "成功"
}