CentraSite Documentation : Working with REST-based APIs : About CentraSite RESTful API Model : REST Parameters : Parameter Types : Path Parameters
Path Parameters
Path parameters are defined as part of the resource URI. For example, the URI can include phones/item, where /item is a path parameter that identifies the item in the collection of resource /phones. Because path parameters are part of the URI, they are essential in identifying the request.
Now, consider the above online Phone Store API example. A customer may wish to fetch details about a phone {phone-id} whose product code is "412456". The URI for this resource could look like this:
/phones/412456
Important:  
As a best practice, we recommend that you adopt the following conventions when specifying a path parameter in the resource URI:
*Append a path parameter variable within curly {} brackets.
*Specify a path parameter variable such that it exactly matches the path parameter defined at the Resource level.
Copyright © 2005-2015 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback