Inflectra Customer Forums: API Body Documentation (Thread) 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, itd 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 dont always give a clear picture of how to determine that value. Perhaps a REST library? en-US(C) Copyright 2006-2026 Inflectra Corporation.support@inflectra.com/Computers/Software/Project_Management//Computers/Software/Quality_Assurance/KronoDesksupport@inflectra.comhttp://www.inflectra.com/kronodesk/forums/threads120/Support/Forum/spirateam/issues-questions/1507.aspxthreadId=1507D L (dlakes@misoenergy.org)spira api restAPI Body Documentation 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, itd 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 dont always give a clear picture of how to determine that value. Perhaps a REST library? Wed, 20 Jul 2016 20:50:13 -04002021-05-19T07:20:23-04:00/Support/Forum/spirateam/issues-questions/1507.aspxmessageId=2706Jim R (donotreply5@kronodesk.net) Hi DL We include the sample values where possible in the comments of the different function Hi DL We include the sample values where possible in the comments of the different functions and the object property names. Regards Jim. Thu, 21 Jul 2016 15:28:39 -04002016-07-21T15:28:39-04:00/Support/Forum/spirateam/issues-questions/1507.aspx#reply2706messageId=3963Steve Skok (steveskok3@gmail.com) There are four different parts of parameters which are often documented in separate groups on the s 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. Wed, 19 May 2021 07:20:23 -04002021-05-19T07:20:23-04:00/Support/Forum/spirateam/issues-questions/1507.aspx#reply3963