Bulk Jobs
Use jobs for bulk operations on domains.
Jobs run bulk operations on domains asynchronously. For the upload file format, see Bulk jobs CSV format.
How to use Jobs Endpoints
Create a Placeholder Job
- Use Create job (
POST /v3/aftermarket/customers/{customerId}/jobs) to create a placeholder job. - Specify the type of job (e.g.,
BULK_JOBorRECONCILE_JOB) in the query parameter.
Upload Data to the Job
- Use Upload data to job (
POST /v3/aftermarket/customers/{customerId}/jobs/{jobId}/upload) to upload a CSV file or data for processing. - Ensure the file is in the correct format and does not exceed the size limit (100MB).
Check Job Status
- Use Get job (
GET /v3/aftermarket/customers/{customerId}/jobs/{jobId}) to check the status of the job. - The job will transition through states like
CREATED,RUNNING, andCOMPLETED.
Retrieve Job Results
- Once the job is completed, use Get job results (
GET /v3/aftermarket/customers/{customerId}/jobs/{jobId}/results) to download the results. - The results will be streamed back as a CSV file.
Update or Cancel a Job (Optional)
- Use Update job (
PATCH /v3/aftermarket/customers/{customerId}/jobs/{jobId}) to update the job details or cancel it if needed.
You can have a maximum of 3 jobs in the CREATED state at a time. Exceeding this limit will result in a
400 Bad Request error.