Business analysis glossary
Path Parameter
What it is
A path parameter is a variable part of an API URL that identifies a specific resource, such as the order id in the path orders slash 1005. It is part of the path itself rather than added after a question mark, and it is usually required.
Why it matters
Path parameters decide which record an API call acts on, so getting them wrong returns the wrong data or a not found error. Analysts specify the identifier used in each path, its format and the response when the record does not exist or belongs to someone else.
Example
In the API contract, getting a shipment uses the shipment id in the path. The analyst adds two rules: an unknown id returns 404, and a valid id belonging to another customer also returns 404 rather than 403, so that the API does not reveal that the shipment exists.