Batch Jobs

The batch jobs system allows you to execute a large number of API calls at once. This is especially helpful if your application retrieves data for many locations once a day, or when you need lots of data for some form of analysis. It's much faster and more efficient than making many individual calls, because it eliminates the overhead of HTTP transactions for each request.

When creating a batch job, you'll send a single API request that defines all the API calls you would like to make. The Jobs queue will then make process each request in the batch internally as if you were calling each one yourself. When complete, the results of each call are packaged into a single payload and you can retrieve them with another API request.

Note: At this the batch jobs system only supports GET requests.

Important: For the Fields and Weather API, there is a limit of 10,000 requests per batch job. Due to its complex processes the Agronomics endpoint is limited 1,500 requests per batch job.

Create a Batch Job

Use this API to define the batch of requests you want the aWhere Platform to process for you. | View Documentation

POST /v2/jobs

Get Job Status or Results

To check the status of a batch job, you'll need to occasionally use this API, which will report the status of the job and when it's complete, include the results. | View Documentation

GET /v2/jobs/{jobId}

Cancel a Batch Job

Once you define a batch job it can't be changed, but you can cancel it to create a new one. If you no longer need the results of a completed job, this API also purges the results sooner than it would automatically. | View Documentation

DELETE /v2/jobs/{jobId}