Method: gaugeModels.batchGet

  • This endpoint retrieves metadata for multiple hydrological gauge models.

  • The HTTP request uses a GET method to the URL https://floodforecasting.googleapis.com/v1/gaugeModels:batchGet.

  • The required query parameter names[] specifies the gauge model names to retrieve, in the format: gaugeModels/{gaugeId}.

  • The request body for this endpoint must be empty.

  • The response body returns an array of gauge models in the JSON format.

Get the current hydrological model metadata for multiple gauges.

HTTP request

GET https://floodforecasting.googleapis.com/v1/gaugeModels:batchGet

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
names[]

string

Required. The gauge model names to retrieve. Name format: gaugeModels/{gaugeId}. The supported list size is limited to 20,000. If a list larger than 20,000 is provided it fails with an INVALID_REQUEST error.

Request body

The request body must be empty.

Response body

The response of gaugeModels.batchGet.

If successful, the response body contains data with the following structure:

JSON representation
{
  "gaugeModels": [
    {
      object (GaugeModel)
    }
  ]
}
Fields
gaugeModels[]

object (GaugeModel)

The requested gauge models.