Create Test Plan
9 min
creates a new test plan for a project, with specified configurations such as environment, test run type, and scenarios endpoint information url https //testinium io/testinium restapi/api/projects/{projectid}/plans method post authentication required ( bearer token ) request { "group plan" false, "environment resolutions" \[ { "editable" true, "environment" { "id" 1188 }, "resolutionvalue" "1920x1080", "resolution" { "resolution name" "fhd", "resolution width" 1920, "resolution height" 1080 } } ], "project id" 1424, "test run type" "cross", "test dispatch method type" "all in one", "plan name" "deneme123", "company id" 5267, "scenarios" \[23057] } request parameters parameter type description group plan boolean whether the test plan is a group plan or not environment resolutions array a list of environment resolutions associated with the test plan project id integer id of the project the test plan belongs to test run type string type of test run (e g , cross ) test dispatch method type string test dispatch method type (e g , all in one ) plan name string the name of the test plan company id integer the id of the company creating the test plan scenarios array list of scenario ids associated with the test plan response { "id" 3362, "type" "selenium", "project id" 1424, "project name" "selinkaratedene", "company id" 5267, "plan name" "deneme123", "scenarios" \[23057], "period" { "period type" "manual", "days of week" "", "scheduled days of week" \[], "repeat period" 60 }, "alerts" \[], "enabled" true, "group plan" false, "plan parallel test limit" 24, "failed test retry count" 0, "alerts enabled result" false, "project enabled" true, "test run type" "cross", "created at" "2025 01 23t04 26 40z", "updated at" "2025 01 23t04 26 40z", "created by" "mehmetaksahin", "updated by" "mehmetaksahin", "xray enabled" false, "test rail enabled" false, "test rail any mismatch" false, "is parent" false, "childs" \[], "screen shot type" "yes", "video enabled" true, "environment resolutions" \[ { "environment" { "id" 1188, "name" "firefox", "operating system" "win10", "browser type" "firefox", "environment type" "firefox", "environment version" "134", "enabled" true, "operating system clean name" "windows 10", "mobile" false }, "resolution" { "resolution name" "fhd", "resolution width" 1920, "resolution height" 1080 } } ], "test plan java parameters" \[], "performance data enabled" false, "file download path" "" } response fields field type description id integer unique id of the test plan type string the type of the test plan (e g , selenium ) project id integer the id of the project associated with the test plan company id integer the id of the company that created the test plan plan name string the name of the test plan scenarios array list of scenario ids associated with the test plan period object information about the test plan's execution period enabled boolean whether the test plan is enabled alerts array list of alerts configured for the test plan (currently empty) test run type string the type of test run (e g , cross ) created at string the creation timestamp of the test plan updated at string the last update timestamp of the test plan screen shot type string the screenshot type for the test plan (e g , yes ) video enabled boolean whether video recording is enabled for the test plan environment resolutions array list of environment resolutions associated with the test plan test plan java parameters array java parameters associated with the test plan (currently empty) performance data enabled boolean whether performance data collection is enabled for the test plan file download path string the file download path associated with the test plan example request curl location request post "https //testinium io/testinium restapi/api/projects/{projectid}/plans" \\ \ header 'authorization bearer \<your access token>' \\ \ header 'content type application/json' \\ \ data raw '{ "group plan" false, "environment resolutions" \[ { "editable" true, "environment" { "id" 1188 }, "resolutionvalue" "1920x1080", "resolution" { "resolution name" "fhd", "resolution width" 1920, "resolution height" 1080 } } ], "project id" 1424, "test run type" "cross", "test dispatch method type" "all in one", "plan name" "deneme123", "company id" 5267, "scenarios" \[23057] }'