Status & Error Codes¶
This page documents the status codes and error messages that may be returned by the Dataset Profiler API.
HTTP Status Codes¶
The Dataset Profiler API uses standard HTTP status codes to indicate the success or failure of requests:
| Status Code | Description |
|---|---|
| 200 | OK - The request was successful |
| 400 | Bad Request - The request was invalid or cannot be served |
| 404 | Not Found - The requested resource does not exist |
| 500 | Internal Server Error - An error occurred on the server |
Job Status Codes¶
The following status codes are returned by the /profiler/job_status/{profile_job_id} endpoint:
| Status | Description |
|---|---|
| SUBMITTING | The job is being submitted to the processing queue |
| STARTING | The job has been accepted and is starting |
| LIGHT_PROFILE_READY | The light profile (basic metadata and distributions) is ready |
| HEAVY_PROFILES_READY | The heavy profile (including record sets) is ready |
| FAILED | The job has failed |
Runner Status Codes¶
The following status codes are returned by the /profiler/runner_status/{profile_job_id} endpoint:
| Status | Description |
|---|---|
| pending | The job is waiting to be processed |
| in_progress | The job is currently being processed |
| completed | The job has completed successfully |
| failed | The job has failed |
| unknown | The job ID is not recognized |
Common Error Messages¶
400 Bad Request¶
{
"detail": "Invalid profile specification format"
}
This error occurs when the profile specification in the request body is not properly formatted or is missing required fields.
404 Not Found¶
{
"detail": "No profile found for the given job ID. Profiling might still be in progress."
}
This error occurs when trying to retrieve a profile that doesn't exist or isn't ready yet.
500 Internal Server Error¶
{
"detail": "An error occurred while processing the dataset"
}
This error indicates a server-side issue that prevented the profiling job from completing successfully.
Troubleshooting¶
"No profile found" Error¶
If you receive a "No profile found" error when trying to retrieve a profile:
- Check the job status using the
/profiler/job_status/{profile_job_id}endpoint - If the status is not "LIGHT_PROFILE_READY" or "HEAVY_PROFILES_READY", wait for the job to complete
- If the job status is "FAILED", check the logs for more information
Invalid Profile Specification¶
If you receive an "Invalid profile specification format" error:
- Ensure all required fields are present in the profile specification
- Check that field values are of the correct type
- Verify that the dataset_file_path points to a valid location
Logging¶
For more detailed error information, check the service logs. The logging level can be configured in the service configuration file.
Support¶
If you encounter persistent issues that cannot be resolved using this documentation, please contact the DataGEMS support team or open an issue on the GitHub repository.