Gets information about all query jobs in the org. The information includes Bulk API 2.0 query jobs and all Bulk API jobs. Job records are returned in an indeterminate order.
URI:
/services/data/vXX.X/jobs/query
1/services/data/vXX.X/jobs/query/
2 ?isPkChunkingEnabled=isPkChunkingEnabled
3 &jobType=jobType
4 &concurrencyMode=concurrencyMode
5 &queryLocator=queryLocatorAvailable since release:
This resource is available in API version 47.0 and later.
Formats: JSON
HTTP methods: GET
Authentication: Authorization: Bearer token
Request parameters:
| Parameter | Description | Required or Optional |
|---|---|---|
isPkChunkingEnabled | If set to true, the request only returns information about jobs where PK Chunking is enabled. This only applies to Bulk API (not Bulk API 2.0) jobs. For more information on PK Chunking, see Use PK Chunking to Extract Large Data Sets from Salesforce. | Optional |
jobType | Gets information only about jobs matching the specified job type. Possible values are:
| Optional |
concurrencyMode | For future use. Gets information only about jobs matching the specified concurrency mode. Possible values are serial and parallel. Currently only parallel mode is supported. | Optional |
queryLocator | Gets information about jobs starting with that locator value. Do not enter your own value here. Always use the value from the nextRecordsUrl from the previous set. See Example and Rules and Guidelines. | Optional |
Response Body
The response contains a completion flag, an array of records, and a locator value to be used to obtain more records. For example:
1{
2 "done" : false,
3 "records" : [
4 {
5 "id" : "750R0000000zhfdIAA",
6 "operation" : "query",
7 "object" : "Account",
8 "createdById" : "005R0000000GiwjIAC",
9 "createdDate" : "2018-12-07T19:58:09.000+0000",
10 "systemModstamp" : "2018-12-07T19:59:14.000+0000",
11 "state" : "JobComplete",
12 "concurrencyMode" : "Parallel",
13 "contentType" : "CSV",
14 "apiVersion" : 68.0,
15 "jobType" : "V2Query",
16 "lineEnding" : "LF",
17 "columnDelimiter" : "COMMA"
18 },
19 {
20 "id" : "750R0000000zhjzIAA",
21 "operation" : "query",
22 "object" : "Account",
23 "createdById" : "005R0000000GiwjIAC",
24 "createdDate" : "2018-12-07T20:52:28.000+0000",
25 "systemModstamp" : "2018-12-07T20:53:15.000+0000",
26 "state" : "JobComplete",
27 "concurrencyMode" : "Parallel",
28 "contentType" : "CSV",
29 "apiVersion" : 68.0,
30 "jobType" : "V2Query",
31 "lineEnding" : "LF",
32 "columnDelimiter" : "COMMA"
33 },
34 ...
35 ],
36 "nextRecordsUrl" : "/services/data/v68.0/jobs/ingest?queryLocator=01gR0000000opRTIAY-2000"
37}Response Parameters:
| Parameter | Description |
|---|---|
done
|
This is
true
if this is the last (or only) set of results. It is
false
if there are more records to fetch. See
Example
and
Rules and Guidelines
.
|
records
|
An array of record objects. |
nextRecordsUrl
|
The URI to get the next set of records (if there are any).
This method returns up to 1,000 result rows per request. If there are more than 1,000 records, use the
This parameter is
|
Record Objects
| Parameter | Description |
|---|---|
id | The unique ID for this job. |
operation | The type of query. Possible values are:
|
object | The object type being queried. |
createdById | The ID of the user who created the job. |
createdDate | The UTC date and time when the job was created. |
systemModstamp | The UTC date and time when the API last updated the job information. |
state | The current state of processing for the job. Possible values are:
|
concurrencyMode | Reserved for future use. How the request is processed. Currently only parallel mode is supported. (When other modes are added, the API chooses the mode automatically. The mode isn’t user configurable.) |
contentType | The format to be used for the results. Currently the only supported value is CSV (comma-separated variables). Defaults to CSV. The actual separator can be a character other than a comma. The columnDelimiter parameter specifies what character to use. |
apiVersion | The API version that the job was created in. |
lineEnding | The line ending used for CSV job data, marking the end of a data row. The default is LF. Possible values are:
|
columnDelimiter | The column delimiter used for CSV job data. The default value is COMMA. Possible values are:
|
This example shows how to use the nextRecordsUrl query parameter.
The first request doesn’t use nextRecordsUrl, because we don’t know what value to use yet.
1curl --request GET \
2--header "Authorization: Bearer TOKEN"
3https://INSTANCE.salesforce.com/services/data/vXX.X/jobs/queryThe response body is:
1{
2 "done": false,
3 "nextRecordsUrl": "/services/data/vXX.X/jobs/ingest?queryLocator=01gRM000000NS1vYAG-1000",
4 "records": [
5 {
6 ...
7 }
8 ]
9}Because there are more records than can be returned in a single response, the value of done in the response isn’t true. We use the value of nextRecordsUrl, /services/data/vXX.X/jobs/ingest?queryLocator=01gRM000000NS1vYAG-1000, as the URI to get the next set of records:
1curl --request GET \
2--header "Authorization: Bearer TOKEN"
3https://INSTANCE.salesforce.com/services/data/vXX.X/jobs/query?queryLocator=01gRM000000NS1vYAG-1000Repeat this process until done is true, indicating that there are no more results to fetch.
To use this URI, follow these rules and guidelines.
/services/data/vXX.X/jobs/query to get the first set of records.done set to false. Use the value of nextRecordsUrl to get the next set of records.done is true. That set is the last set of records.
j