A model class used for creating and updating test plans.

interface PlanUpdateModel {
    area?: ShallowReference;
    automatedTestEnvironment?: TestEnvironment;
    automatedTestSettings?: TestSettings;
    build?: ShallowReference;
    buildDefinition?: ShallowReference;
    configurationIds?: number[];
    description?: string;
    endDate?: string;
    iteration?: string;
    manualTestEnvironment?: TestEnvironment;
    manualTestSettings?: TestSettings;
    name?: string;
    owner?: IdentityRef;
    releaseEnvironmentDefinition?: ReleaseEnvironmentDefinitionReference;
    startDate?: string;
    state?: string;
    status?: string;
    testOutcomeSettings?: TestOutcomeSettings;
}

Properties

Area path to which the test plan belongs. This should be set to area path of the team that works on this test plan.

automatedTestEnvironment?: TestEnvironment
automatedTestSettings?: TestSettings

Build ID of the build whose quality is tested by the tests in this test plan. For automated testing, this build ID is used to find the test binaries that contain automated test methods.

buildDefinition?: ShallowReference

The Build Definition that generates a build associated with this test plan.

configurationIds?: number[]

IDs of configurations to be applied when new test suites and test cases are added to the test plan.

description?: string

Description of the test plan.

endDate?: string

End date for the test plan.

iteration?: string

Iteration path assigned to the test plan. This indicates when the target iteration by which the testing in this plan is supposed to be complete and the product is ready to be released.

manualTestEnvironment?: TestEnvironment
manualTestSettings?: TestSettings
name?: string

Name of the test plan.

owner?: IdentityRef

Owner of the test plan.

releaseEnvironmentDefinition?: ReleaseEnvironmentDefinitionReference

Release Environment to be used to deploy the build and run automated tests from this test plan.

startDate?: string

Start date for the test plan.

state?: string

State of the test plan.

status?: string
testOutcomeSettings?: TestOutcomeSettings

Test Outcome settings