Get Plan By ID (Appium2)

endpoint information url \<your gateway url>/plan/ method get authentication required ( bearer token ) path variables parameter type required description planid long yes the id of the test plan response body { "data" { "id" 316, "planname" "demo", "groupplan" false, "description" "", "enabled" true, "deleted" false, "planparalleltestlimit" 50, "periodid" 318, "projectid" 913, "projectname" "demo", "projecttestframework" "appium2", "userid" 13, "companyid" 2, "failedtestretrycount" 0, "testruntype" "cross", "screenshottype" "yes", "videoenabled" true, "uninstallapp" false, "clearappdata" false, "selectediosmobileapp" { "id" 84, "mobileappname" "demo ipa", "mobileapphash" "demo", "mobileappmetadata" "{\\"demo"}", "operatingsystem" "ios", "createdat" "2025 03 04t13 00 02 784+00 00", "apkmetadata" { "packagename" null, "activityname" null, "label" null, "icon" null, "versionname" null, "versioncode" null, "installlocation" null, "minsdkandroidversion" null, "minsdkversion" null, "targetsdkversion" null, "maxsdkversion" null, "glesversion" null }, "iosmetadata" { "bundlename" "demo", "bundledisplayname" "demo", "bundleversion" "3 2 15", "bundleminosversion" "12 0", "bundledevelopmentregion" "tr", "bundleexecutable" "demo", "bundleiconfiles" "", "bundleinfodictversion" "6 0", "bundlepackagetype" "appl", "bundlemainstoryboardfile" "main", "bundleidentifier" "demo", "teamname" null } }, "testfiletype" "appium gauge", "testrunnertool" "maven", "gridtype" "testinium enterprise" }, "result" { "code" 0, "message" "success" } } field type description id long unique identifier of the test plan plan name string the display name of the test plan groupplan boolean indicates whether the plan is a grouped plan description string a detailed explanation or note describing the plan enabled boolean specifies whether the plan is active and can be executed deleted boolean marks the plan as deleted without permanently removing it planparalleltestlimit integer maximum number of tests allowed to run in parallel for this plan periodid integer identifier of the associated period configuration for scheduled execution project id integer id of the project to which this plan belongs projectname string name of the associated project projecttestframework string the test framework used by the project userid integer id of the user who created or updated the plan company id integer id of the company owning this plan failedtestretrycount integer number of times failed tests will be retried automatically testruntype string defines how tests are executed screenshottype string determines screenshot capturing behavior during test execution videoenabled boolean indicates whether video recording is enabled for test runs uninstallapp boolean whether the mobile application should be uninstalled before execution clearappdata boolean whether app data should be cleared before test execution selectediosmobileapp object the selected ios application associated with the plan selectedandroidmobileapp object the selected android application associated with the plan testfiletype string type of test files used in this plan testrunnertool string the automation tool used to run tests gridtype string execution type within the grid environment parameter type description data object the payload of the response in this case null since no extra data is returned result object contains details about the outcome of the operation result code integer the result code (e g , 0 indicates success) result message string a message describing the outcome (e g , "success" ) error codes http code error message description 400 invalid request the request was malformed or contained errors 500 internal server error an unexpected error occurred on the server side example request curl location '\<your gateway url>/plan/{planid}' \\ \ header 'accept application/json, text/plain, / ' \\ \ header 'authorization bearer \<your access token>' \\ \ header 'content type application/json'