API Body Documentation

There are four different parts of parameters which are often documented in separate groups on the same page. They include:

• Header parameters – These parameters are featured in the request header and are usually related to authorization.
• Query parameters – These are separated from the hierarchy parameters by a question mark
• Request body parameters – they are included in the request body and are used to send and receive data via the REST API.
• Template/Path parameters – Set off within curly braces, path parameters are placed within the path of an endpoint just before the query string, and they provide developers with an effective way to parameterize resources.
• Matrix parameters – They come in between the resource path and Query parameters and are separated from the hierarchy parameters by a semicolon.
• Plain Parameters – These are parameters that are defined in a request and are easily accessible in ReadyAPI but are omitted when the request is submitted.