v1

latestSwagger 2.02026-07-147311.0 KB
products

Returns products along with their associated files by short names.

Use this GET to search for bulk data products by their short names and description. Note that "From" and "To" dates can be inputted separately as year/month/day values or as a single date string in format "YYYY-MM-DD". If all values are entered, single date strings have a higher priority For the list of default values rules, see GET /products/byname/{productName} above

get/products/{shortName}

Path parameters

shortNamestring required

Short name of the product, for example, "PTGRSP"

Query parameters

fromYearinteger

Year from when the product files are needed, for example, 1999.

toYearinteger

Year until when the product files are needed, for example, 2000.

fromMonthinteger

Month from when the product files are needed, for example, 01.

toMonthinteger

Month until when the product files are needed, for example, 12.

fromDayinteger

Day from when the product files are needed, for example, 01.

toDayinteger

Day until when the product files are needed, for example, 31.

fromDatestring

Year from when the product files are needed, for example, 1999-01-01.

toDatestring

Year until when the product files are needed, for example, 2001-12-31.

hierarchystring

Boolean flag (possible values: true and false) to indicate if product hierarchy needs to be return in the response. By default it doesn't return the hierarchy in the response.

Response

Successful operation.