object	object	complete details of the query
summary	string	summary for an audience that helps understanding what it does
description	string	detailed description that helps understanding the results to expect
query	string	sql query statement
parameters	array[object]	list of dictionary objects referred in the query statement
name	string	name of the parameter
type	string	Valid BQ data type of the parameter Enum: `INT64`,`NUMERIC`,`FLOAT64`,`BOOL`,`STRING`,`BYTES`,`DATE`,`DATETIME`,`GEOGRAPHY`,`TIME`,`TIMESTAMP`

PUT /queries/{id}

Responses

200

Successfully updated the query in the registry

object object

404

Failed to update the query since it was not found in the registry

Response

De-activate a query in the registry

Auth

Required Scopes:delete:queries

Path Params

id string

DELETE /queries/{id}

Responses

200

Successfully de-activated the query in the registry

object object

404

Failed to de-activate the query since it was not found in the registry

Response

Get the paginated list of details of all the queries stored in the registry

Auth

Required Scopes:get:queries

Query String

page

integer

Default: 1

GET /queries

Responses

200

Successfully returned the paginated list of details of all the queries stored in the registry

object object

400

Failed to fetch the paginated list of details of all the queries stored in the registry

Response

Add a new query to the registry

Auth

Required Scopes:post:queries

Request Body

object	object	complete details of the query
summary	string	summary for an audience that helps understanding what it does
description	string	detailed description that helps understanding the results to expect
query	string	sql query statement
parameters	array[object]	list of dictionary objects referred in the query statement
name	string	name of the parameter
type	string	Valid BQ data type of the parameter Enum: `INT64`,`NUMERIC`,`FLOAT64`,`BOOL`,`STRING`,`BYTES`,`DATE`,`DATETIME`,`GEOGRAPHY`,`TIME`,`TIMESTAMP`

POST /queries

Responses

200

Successfully added query to the registry

object object

400

Failed to add query to the registry

Response

Run

POST

/run

Execute a query segment from the registry

Auth

Required Scopes:post:run

Query String

id	string
trace_id	string

Request Body

object	object
parameters	object	Parameter values referred in the query statement

POST /run

Responses

200

job id for the query execeution request is returned

object object

Response