Sign in

v1

latestSwagger 2.02026-07-147311.0 KB
products

Returns files associated with products (of level PRODUCT) based on their full or partial names.

Use this GET to search for bulk data services by product name or description. An error message will be returned if the product cannot be found by name. Note that product name is not case sensitive. You can enter full or partial name of an existing product to receive bulk data services. Default values for field names are as follows

  • if both years are not defined, toYear will be set equal to current year, fromYear will be set equal to previous year
  • if fromYear is defined, toYear will be set equal to fromYear+1
  • if fromMonth not defined, current month will be used
  • if toMonth not defined, it will be set equal to fromMonth
  • if fromDay is not defined, it will be set equal to current day (today)
  • if toDay is not defined, it will be set to the last day of toMonth/toYear
get/products/byname/{productName}

Path parameters

productNamestring required

Name of the product, for example, "Trademark"

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.

hierarchystring

Boolean flag to indicate if product hierarchy needs to be return in the response. By default it doesn't return the hierarchy in the response.

maxFilesinteger

Max. number of files to retrieve, per product. Set value to -1 to get all files

Response

Successful operation.