/vesa/displayport/products

POST /api/vesa/displayport/products

Price: 5 credits

Fetch one VESA DisplayPort certified product by its registry alias. Returns the certified model name, the manufacturer, the certification categories and product types the registry files it under, and the family model numbers or part numbers the certification also covers.

How to use it

Take the alias from a /vesa/displayport/products/search result rather than guessing it: it is the model name lowercased with separators replaced, and an unknown one answers 412. A few registry cards link through a draft-preview address and come back with `alias` null — pass their numeric `id` here instead, and the answer carries the alias the registry publishes. The certification covers more SKUs than the headline model — `aliases` lists them, and `alias_label` says whether the registry calls them family models (displays) or part numbers (cables). A monitor and a cable are filed under different `product_types`, which is the vocabulary the search endpoint's own filter takes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• alias string required — Product alias, the last segment of its displayport.org/products/... address. A full product URL is accepted and reduced to the alias, and the numeric registry `id` a search result carries is accepted in its place (examples: "27m4n5500xi", "https://www.displayport.org/products/wldp-10-001f/", "12618"; minLength: 1)

Response

• @type string (default: "VesaDisplayPortProduct")
• id string nullable
• alias string nullable
• url string nullable
• listing_name string nullable
• manufacturer string nullable
• manufacturer_alias string nullable
• model string nullable
• categories array (default: [])
• product_types array (default: [])
• product_type_label string nullable
• is_certified boolean nullable
• alias_label string nullable
• aliases array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No certified product carries that alias Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.