POST
/
api
/
v2
/
datasource
/
getDatasourceProgress
Get AWSS3 sync Progress status
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress \
  --header 'Content-Type: application/json' \
  --data '{
  "input.datasourceId": "<string>"
}'
{
  "status": {
    "progress": "16/16",
    "error": ""
  }
}

​
Endpoint:

POST /datasource/getDatasourceProgress

​
Request Body

​
input.datasourceId
string
required

​
Response Body

{
  "status": {
    "progress": "16/16",
    "error": ""
  }
}

​
Response Body:

Below is a response when no sync is completed for AWSS3: 
{
  "status": {
    "progress": "0/...",
    "error": ""
  }
}

​
Response Error:

Below is a response error when while syncing AWSS3 throws an error: 
{
  "status": {
    "progress": "0/...",
    "error": "Error: Bind error data type"
  }
}

​
Error Codes

  • INVALID_REQUEST_BODY: The request body is invalid.
  • WORKSPACE_ID_ERROR: The workspace name provided does not exist.

​
Validation Schema

The request body must conform to the following schema:
  • workspaceName (required): Name of the workspace.
  • isPagination (optional): Boolean flag to enable pagination.
  • pageNumber (optional): Page number when pagination is enabled.