Request cleaning on a dataset

Request a cleaning job for the specified dataset.

POST /agents/{username}/{namespace}/{datasetName}/requestCleaning

Request cleaning on a dataset

cURL

curl --request POST \
  --url https://api.datalinks.com/api/v1/agents/{username}/{namespace}/{datasetName}/requestCleaning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompts": [
    "Remove extra spaces from firstName and lastName fields.",
    "Remove empty values from the age field."
  ],
  "outputNamespace": "all_about_movies",
  "outputDatasetName": "movies_cleaned"
}
'

422

{
  "error_code": "UNAUTHORIZED",
  "message": "Missing authentication token",
  "error_message": "",
  "sub_errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

bearerAuthopenId

Authorization · string · header · required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Path Parameters

namespace · string · required

Namespace for the dataset.

datasetName · string · required

Name of the dataset.

username · string · required

The username associated with the request.

Body

application/json

prompts · string[] · required

Prompts that describe each cleaning step in the intended order.

Required array length: 1 - 10 elements

Example:

[
  "Remove extra spaces from firstName and lastName fields.",
  "Remove empty values from the age field."
]

outputNamespace · string · required

Target namespace where the cleaned dataset will be created.

Example:

"all_about_movies"

outputDatasetName · string · required

Specifies the name of the cleaned dataset. The service creates this dataset when the cleaning job starts, and the name must be unused in the target namespace.

Example:

"movies_cleaned"

Response

201

Schedules a new cleaning task.