API Body Documentation

Wednesday, July 20, 2016
Avatar

Is there any documentation for the expected values for various API body parameters?

Ex: For /projects/{project_id}/test-runs/record

What are the expected/possible values for ExecutionStatusId, TestRunFormatId, etc?

More generally, it'd be great if there was a way to determine the expected values/format for all of the REST body args. The sample values shown in the documentation don't always give a clear picture of how to determine that value. Perhaps a REST library?

2 Replies
Thursday, July 21, 2016
Avatar
re: dlakes_meg Wednesday, July 20, 2016
Hi DL

We include the sample values where possible in the comments of the different functions and the object property names.

Regards
Jim.
Wednesday, May 19, 2021
Avatar
re: dlakes_meg Wednesday, July 20, 2016

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.
Statistics
  • Started: Wednesday, July 20, 2016
  • Last Reply: Wednesday, May 19, 2021
  • Replies: 2
  • Views: 10650