Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



Jobs: list

Requires authorization

Lists all the Jobs in the specified project that were started by the user. Try it now .

Required ACLs: To call this method, you must have one of the following rights:

  • Be the job creator
  • Project OWNER

Request

HTTP request 

GET https://www.googleapis.com/bigquery/v2/projects/projectId/jobs

Parameters

Parameter name Value Description
Path parameters
projectId string Project ID of the jobs to list
Optional query parameters
allUsers boolean Whether to display jobs owned by all users in the project. Default false
maxResults unsigned integer Maximum number of results to return
pageToken string Page token, returned by a previous call, to request the next page of results
projection string Restrict information returned to a set of selected fields

Acceptable values are:
  • " full ": Includes all job data
  • " minimal ": Does not include the job configuration
stateFilter string Filter for job state

Acceptable values are:
  • " done ": Finished jobs
  • " pending ": Pending jobs
  • " running ": Running jobs

Authorization

This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).

Scope
https://www.googleapis.com/auth/bigquery
https://www.googleapis.com/auth/cloud-platform

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure: 

{
  "kind": "bigquery#jobList",
  "etag": etag,
  "nextPageToken": string,
  "jobs": [
    {
      "id": string,
      "kind": "bigquery#job",
      "jobReference": {
        "projectId": string,
        "jobId": string
      },
      "state": string,
      "errorResult": {
        "reason": string,
        "location": string,
        "debugInfo": string,
        "message": string
      },
      "statistics": {
        "creationTime": long,
        "startTime": long,
        "endTime": long,
        "totalBytesProcessed": long,
        "query": {
          "totalBytesProcessed": long,
          "cacheHit": boolean
        },
        "load": {
          "inputFiles": long,
          "inputFileBytes": long,
          "outputRows": long,
          "outputBytes": long
        }
      },
      "configuration": {
        "query": {
          "query": string,
          "destinationTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "createDisposition": string,
          "writeDisposition": string,
          "defaultDataset": {
            "datasetId": string,
            "projectId": string
          },
          "priority": string,
          "preserveNulls": boolean,
          "allowLargeResults": boolean,
          "useQueryCache": boolean,
          "flattenResults": boolean
        },
        "load": {
          "sourceUris": [
            string
          ],
          "schema": {
            "fields": [
              {
                "name": string,
                "type": string,
                "mode": string,
                "fields": [
                  (TableFieldSchema)
                ],
                "description": string
              }
            ]
          },
          "destinationTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "createDisposition": string,
          "writeDisposition": string,
          "fieldDelimiter": string,
          "skipLeadingRows": integer,
          "encoding": string,
          "quote": string,
          "maxBadRecords": integer,
          "schemaInlineFormat": string,
          "schemaInline": string,
          "allowQuotedNewlines": boolean,
          "sourceFormat": string,
          "allowJaggedRows": boolean,
          "ignoreUnknownValues": boolean
        },
        "link": {
          "sourceUri": [
            string
          ],
          "destinationTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "createDisposition": string,
          "writeDisposition": string
        },
        "copy": {
          "sourceTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "sourceTables": [
            {
              "projectId": string,
              "datasetId": string,
              "tableId": string
            }
          ],
          "destinationTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "createDisposition": string,
          "writeDisposition": string
        },
        "extract": {
          "sourceTable": {
            "projectId": string,
            "datasetId": string,
            "tableId": string
          },
          "destinationUri": string,
          "destinationUris": [
            string
          ],
          "printHeader": boolean,
          "fieldDelimiter": string,
          "destinationFormat": string,
          "compression": string
        },
        "dryRun": boolean
      },
      "status": {
        "state": string,
        "errorResult": {
          "reason": string,
          "location": string,
          "debugInfo": string,
          "message": string
        },
        "errors": [
          {
            "reason": string,
            "location": string,
            "debugInfo": string,
            "message": string
          }
        ]
      },
      "user_email": string
    }
  ],
  "totalItems": integer
}
Property name Value Description Notes
kind bigquery#jobList The resource type of the response.
etag etag A hash of this page of results.
nextPageToken string A token to request the next page of results.
jobs[] list List of jobs that were requested.
jobs[]. id string Unique opaque ID of the job.
jobs[]. jobReference nested object Job reference uniquely identifying the job.
jobs[].jobReference. projectId string [Required] Project ID being billed for the job.
jobs[].jobReference. jobId string [Required] ID of the job.
jobs[]. state string Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
jobs[]. errorResult nested object A result object that will be present only if the job has failed.
jobs[].errorResult. reason string A short error code that summarizes the error.
jobs[].errorResult. location string Specifies where the error occurred, if present.
jobs[].errorResult. message string A human-readable description of the error.
jobs[]. statistics nested object [Output-only] Information about the job, including starting time and ending time of the job.
jobs[].statistics. startTime long [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
jobs[].statistics. endTime long [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
jobs[].statistics. totalBytesProcessed long [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
jobs[]. configuration nested object [Full-projection-only] Specifies the job configuration.
jobs[].configuration. query nested object [Pick one] Configures a query job.
jobs[].configuration.query. query string [Required] BigQuery SQL query to execute.
jobs[].configuration.query. destinationTable nested object [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
jobs[].configuration.query.destinationTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.query.destinationTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.query.destinationTable. tableId string [Required] The table ID.
jobs[].configuration.query. createDisposition string [Optional] Specifies whether the job is allowed to create new tables.

The following values are supported:
  • CREATE_IF_NEEDED : If the table does not exist, BigQuery creates the table.
  • CREATE_NEVER : The table must already exist. If it does not, a 'notFound' error is returned in the job result.
The default value is CREATE_IF_NEEDED .

Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.query. writeDisposition string [Optional] Specifies the action that occurs if the destination table already exists.

The following values are supported:
  • WRITE_TRUNCATE : If the table already exists, BigQuery overwrites the table data.
  • WRITE_APPEND : If the table already exists, BigQuery appends the data to the table.
  • WRITE_EMPTY : If the table already exists and contains data, a 'duplicate' error is returned in the job result.
The default value is WRITE_EMPTY .

Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.query. defaultDataset nested object [Optional] Specifies the default dataset to use for unqualified table names in the query.
jobs[].configuration.query.defaultDataset. datasetId string [Required] A unique ID for this dataset, without the project name.
jobs[].configuration.query.defaultDataset. projectId string [Optional] The ID of the container project.
jobs[].configuration. load nested object [Pick one] Configures a load job.
jobs[].configuration.load. sourceUris[] list [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
jobs[].configuration.load. schema nested object [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
jobs[].configuration.load.schema. fields[] list Describes the fields in a table.
jobs[].configuration.load.schema.fields[]. name string [Required] The field name.
jobs[].configuration.load.schema.fields[]. type string [Required] The field data type. Possible values include STRING , INTEGER , FLOAT , BOOLEAN , TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
jobs[].configuration.load.schema.fields[]. mode string [Optional] The field mode. Possible values include NULLABLE , REQUIRED and REPEATED . The default value is NULLABLE .
jobs[].configuration.load.schema.fields[]. fields[] list [Optional] Describes the nested schema fields if the type property is set to RECORD.
jobs[].configuration.load. destinationTable nested object [Required] The destination table to load the data into.
jobs[].configuration.load.destinationTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.load.destinationTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.load.destinationTable. tableId string [Required] The table ID.
jobs[].configuration.load. createDisposition string [Optional] Specifies whether the job is allowed to create new tables.

The following values are supported:
  • CREATE_IF_NEEDED : If the table does not exist, BigQuery creates the table.
  • CREATE_NEVER : The table must already exist. If it does not, a 'notFound' error is returned in the job result.
The default value is CREATE_IF_NEEDED .

Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.load. writeDisposition string [Optional] Specifies the action that occurs if the destination table already exists.

The following values are supported:
  • WRITE_TRUNCATE : If the table already exists, BigQuery overwrites the table data.
  • WRITE_APPEND : If the table already exists, BigQuery appends the data to the table.
  • WRITE_EMPTY : If the table already exists and contains data, a 'duplicate' error is returned in the job result.
The default value is WRITE_EMPTY .

Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.load. fieldDelimiter string [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
jobs[].configuration.load. skipLeadingRows integer [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
jobs[].configuration.load. encoding string [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
jobs[].configuration.load. maxBadRecords integer [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
jobs[].configuration. copy nested object [Pick one] Copies a table.
jobs[].configuration.copy. sourceTable nested object [Pick one] Source table to copy.
jobs[].configuration.copy.sourceTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.copy.sourceTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.copy.sourceTable. tableId string [Required] The table ID.
jobs[].configuration.copy. destinationTable nested object [Required] The destination table
jobs[].configuration.copy.destinationTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.copy.destinationTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.copy.destinationTable. tableId string [Required] The table ID.
jobs[].configuration.copy. createDisposition string [Optional] Specifies whether the job is allowed to create new tables.

The following values are supported:
  • CREATE_IF_NEEDED : If the table does not exist, BigQuery creates the table.
  • CREATE_NEVER : The table must already exist. If it does not, a 'notFound' error is returned in the job result.
The default value is CREATE_IF_NEEDED .

Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.copy. writeDisposition string [Optional] Specifies the action that occurs if the destination table already exists.

The following values are supported:
  • WRITE_TRUNCATE : If the table already exists, BigQuery overwrites the table data.
  • WRITE_APPEND : If the table already exists, BigQuery appends the data to the table.
  • WRITE_EMPTY : If the table already exists and contains data, a 'duplicate' error is returned in the job result.
The default value is WRITE_EMPTY .

Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration. extract nested object [Pick one] Configures an extract job.
jobs[].configuration.extract. sourceTable nested object [Required] A reference to the table being exported.
jobs[].configuration.extract.sourceTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.extract.sourceTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.extract.sourceTable. tableId string [Required] The table ID.
jobs[].configuration.extract. destinationUri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
jobs[]. status nested object [Full-projection-only] Describes the state of the job.
jobs[].status. state string [Output-only] Running state of the job.
jobs[].status. errorResult nested object [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
jobs[].status.errorResult. reason string A short error code that summarizes the error.
jobs[].status.errorResult. location string Specifies where the error occurred, if present.
jobs[].status.errorResult. message string A human-readable description of the error.
jobs[].status. errors[] list [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
jobs[].status.errors[]. reason string A short error code that summarizes the error.
jobs[].status.errors[]. location string Specifies where the error occurred, if present.
jobs[].status.errors[]. message string A human-readable description of the error.
totalItems integer Total number of jobs in this collection.
jobs[]. kind string The resource type.
jobs[].errorResult. debugInfo string Debugging information. This property is internal to Google and should not be used.
jobs[].configuration.link. sourceUri[] list [Required] URI of source table to link.
jobs[].configuration.link. destinationTable nested object [Required] The destination table of the link job.
jobs[].configuration.link.destinationTable. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.link.destinationTable. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.link.destinationTable. tableId string [Required] The table ID.
jobs[].configuration.link. createDisposition string [Optional] Specifies whether the job is allowed to create new tables.

The following values are supported:
  • CREATE_IF_NEEDED : If the table does not exist, BigQuery creates the table.
  • CREATE_NEVER : The table must already exist. If it does not, a 'notFound' error is returned in the job result.
The default value is CREATE_IF_NEEDED .

Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.link. writeDisposition string [Optional] Specifies the action that occurs if the destination table already exists.

The following values are supported:
  • WRITE_TRUNCATE : If the table already exists, BigQuery overwrites the table data.
  • WRITE_APPEND : If the table already exists, BigQuery appends the data to the table.
  • WRITE_EMPTY : If the table already exists and contains data, a 'duplicate' error is returned in the job result.
The default value is WRITE_EMPTY .

Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.




jobs[].configuration.extract. printHeader boolean [Optional] Whether to print out a header row in the results. Default is true.
jobs[].configuration.extract. fieldDelimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','
jobs[].status.errorResult. debugInfo string Debugging information. This property is internal to Google and should not be used.
jobs[].status.errors[]. debugInfo string Debugging information. This property is internal to Google and should not be used.
jobs[].statistics. query nested object [Output-only] Statistics for a query job.
jobs[].statistics.query. totalBytesProcessed long [Output-only] Total bytes processed for this job.
jobs[].statistics. load nested object [Output-only] Statistics for a load job.
jobs[].statistics.load. inputFiles long [Output-only] Number of source files in a load job.
jobs[].statistics.load. inputFileBytes long [Output-only] Number of bytes of source data in a joad job.
jobs[].statistics.load. outputRows long [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
jobs[].statistics.load. outputBytes long [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
jobs[].configuration.query. priority string [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
jobs[].configuration.load. quote string [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
jobs[].configuration.load. schemaInlineFormat string [Deprecated] The format of the schemaInline property.
jobs[].configuration.load. schemaInline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
jobs[].configuration.load. allowQuotedNewlines boolean Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
jobs[].configuration.load. sourceFormat string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
jobs[].configuration.extract. destinationFormat string [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
jobs[].configuration.query. preserveNulls boolean [Deprecated] This property is deprecated.
jobs[].statistics.query. cacheHit boolean [Output-only] Whether the query result was fetched from the query cache.
jobs[].configuration.query. allowLargeResults boolean If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
jobs[].configuration.query. useQueryCache boolean [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
jobs[].configuration.load. allowJaggedRows boolean [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
jobs[].configuration. dryRun boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
jobs[].statistics. creationTime long [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
jobs[].configuration.load.schema.fields[]. description string [Optional] The field description.
jobs[]. user_email string [Full-projection-only] User who ran the job.
jobs[].configuration.load. ignoreUnknownValues boolean [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false which treats unknown values as errors. For CSV this ignores extra values at the end of a line. For JSON this ignores named values that do not match any column name.
jobs[].configuration.extract. destinationUris[] list [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
jobs[].configuration.query. flattenResults boolean [Experimental] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
jobs[].configuration.extract. compression string [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
jobs[].configuration.copy. sourceTables[] list [Pick one] Source tables to copy.
jobs[].configuration.copy.sourceTables[]. projectId string [Required] The ID of the project that contains the table.
jobs[].configuration.copy.sourceTables[]. datasetId string [Required] The ID of the dataset that contains the table.
jobs[].configuration.copy.sourceTables[]. tableId string [Required] The table ID.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.