Test Plans - List

Get a list of test plans.

GET https://{instance}/{collection}/{project}/_apis/test/plans?api-version=5.0
GET https://{instance}/{collection}/{project}/_apis/test/plans?owner={owner}&$skip={$skip}&$top={$top}&includePlanDetails={includePlanDetails}&filterActivePlans={filterActivePlans}&api-version=5.0

URI Parameters

Name In Required Type Description
collection
path True
  • string

The name of the Azure DevOps collection.

instance
path True
  • string

Azure DevOps server name ({server:port})

project
path True
  • string

Project ID or project name

api-version
query True
  • string

Version of the API to use. This should be set to '5.0' to use this version of the api.

$skip
query
  • integer
int32

Number of test plans to skip.

$top
query
  • integer
int32

Number of test plans to return.

filterActivePlans
query
  • boolean

Get just the active plans.

includePlanDetails
query
  • boolean

Get all properties of the test plan.

owner
query
  • string

Filter for test plan by owner ID or name.

Responses

Name Type Description
200 OK

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.test Grants the ability to read test plans, cases, results and other test management related artifacts.

Examples

Get a list of active test plans.
Get list of test plans with their details.
Get top 3 plans.

Get a list of active test plans.

Sample Request

GET https://{instance}/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?filterActivePlans=true&api-version=5.0

Sample Response

{
  "value": [
    {
      "id": 1,
      "name": "sprint1",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/1",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "1"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=1"
    },
    {
      "id": 2,
      "name": "sprint2",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/2",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "2"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=2"
    },
    {
      "id": 4,
      "name": "spritn3",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/4",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "21"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=4"
    },
    {
      "id": 5,
      "name": "sprint4",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/5",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "22"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=5"
    },
    {
      "id": 6,
      "name": "sprint5",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/6",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "23"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=6"
    },
    {
      "id": 7,
      "name": "newCreatedPlan2",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/7",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC",
      "state": "Active",
      "rootSuite": {
        "id": "24"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=7"
    },
    {
      "id": 8,
      "name": "newCreatedPlan",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/8",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC",
      "state": "Active",
      "rootSuite": {
        "id": "25"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=8"
    },
    {
      "id": 10,
      "name": "newCreatedPlan",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/10",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC",
      "state": "Active",
      "rootSuite": {
        "id": "27"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=10"
    },
    {
      "id": 11,
      "name": "ANewPlan",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/11",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "411",
        "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1",
      "state": "Active",
      "rootSuite": {
        "id": "28"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=11"
    },
    {
      "id": 13,
      "name": "newCreatedPlan",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/13",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC",
      "state": "Active",
      "rootSuite": {
        "id": "30"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=13"
    }
  ],
  "count": 10
}

Get list of test plans with their details.

Sample Request

GET https://{instance}/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?includePlanDetails=true&api-version=5.0

Sample Response

{
  "value": [
    {
      "id": 60,
      "name": "sprint1",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/60",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "description": "",
      "startDate": "2014-05-04T16:21:36.253Z",
      "endDate": "2014-05-11T16:21:36.253Z",
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "updatedDate": "2014-05-04T10:51:37.127Z",
      "updatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "owner": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "revision": 5,
      "state": "Active",
      "rootSuite": {
        "id": "61",
        "name": "sprint1",
        "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/60/Suites/61"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=60"
    },
    {
      "id": 68,
      "name": "sprint2",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/68",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "description": "",
      "startDate": "2014-05-04T16:21:47.337Z",
      "endDate": "2014-05-11T16:21:47.337Z",
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "updatedDate": "2014-05-04T10:51:47.887Z",
      "updatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "owner": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "revision": 6,
      "state": "Active",
      "rootSuite": {
        "id": "69",
        "name": "sprint2",
        "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/68/Suites/69"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=68"
    },
    {
      "id": 72,
      "name": "spritn3",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/72",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "description": "",
      "startDate": "2014-05-06T18:41:46.133Z",
      "endDate": "2014-05-13T18:41:46.133Z",
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "updatedDate": "2014-05-06T13:11:46.723Z",
      "updatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "owner": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "revision": 8,
      "state": "Active",
      "rootSuite": {
        "id": "73",
        "name": "spritn3",
        "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/72/Suites/73"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=72"
    },
    {
      "id": 74,
      "name": "sprint4",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/74",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "description": "",
      "startDate": "2014-05-06T18:41:55.927Z",
      "endDate": "2014-05-13T18:41:55.927Z",
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "updatedDate": "2014-05-06T13:11:56.327Z",
      "updatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "owner": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "revision": 9,
      "state": "Active",
      "rootSuite": {
        "id": "75",
        "name": "sprint4",
        "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/74/Suites/75"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=74"
    },
    {
      "id": 76,
      "name": "sprint5",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/76",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "description": "",
      "startDate": "2014-05-06T18:42:04.77Z",
      "endDate": "2014-05-13T18:42:04.77Z",
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "updatedDate": "2014-05-06T13:12:05.027Z",
      "updatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "owner": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://fabrikam:8080/tfs/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://fabrikam:8080/tfs/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "revision": 10,
      "state": "Active",
      "rootSuite": {
        "id": "77",
        "name": "sprint5",
        "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/76/Suites/77"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=76"
    }
  ],
  "count": 5
}

Get top 3 plans.

Sample Request

GET https://{instance}/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?$top=3&api-version=5.0

Sample Response

{
  "value": [
    {
      "id": 1,
      "name": "sprint1",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/1",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "1"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=1"
    },
    {
      "id": 2,
      "name": "sprint2",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/2",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
      "state": "Active",
      "rootSuite": {
        "id": "2"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=2"
    },
    {
      "id": 3,
      "name": "newCreatedPlan2",
      "url": "https://fabrikam:8080/tfs/fabrikam-fiber-tfvc/_apis/test/Plans/3",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://fabrikam:8080/tfs/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "area": {
        "id": "343",
        "name": "Fabrikam-Fiber-TFVC"
      },
      "iteration": "Fabrikam-Fiber-TFVC",
      "state": "Inactive",
      "rootSuite": {
        "id": "3"
      },
      "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=3"
    }
  ],
  "count": 3
}

Definitions

IdentityRef
ReferenceLinks

The class to represent a collection of REST reference links.

ReleaseEnvironmentDefinitionReference

Reference to release environment resource.

ShallowReference

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

TestOutcomeSettings

Test outcome settings

TestPlan

The test plan resource.

IdentityRef

Name Type Description
_links

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor
  • string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and collections.

directoryAlias
  • string
displayName
  • string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id
  • string
imageUrl
  • string
inactive
  • boolean
isAadIdentity
  • boolean
isContainer
  • boolean
isDeletedInOrigin
  • boolean
profileUrl
  • string
uniqueName
  • string
url
  • string

This url is the full route to the source resource of this graph subject.

The class to represent a collection of REST reference links.

Name Type Description
links
  • object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ReleaseEnvironmentDefinitionReference

Reference to release environment resource.

Name Type Description
definitionId
  • integer

ID of the release definition that contains the release environment definition.

environmentDefinitionId
  • integer

ID of the release environment definition.

ShallowReference

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

Name Type Description
id
  • string

ID of the resource

name
  • string

Name of the linked resource (definition name, controller name, etc.)

url
  • string

Full http link to the resource

TestOutcomeSettings

Test outcome settings

Name Type Description
syncOutcomeAcrossSuites
  • boolean

Value to configure how test outcomes for the same tests across suites are shown

TestPlan

The test plan resource.

Name Type Description
area

Area of the test plan.

build

Build to be tested.

buildDefinition

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

description
  • string

Description of the test plan.

endDate
  • string

End date for the test plan.

id
  • integer

ID of the test plan.

iteration
  • string

Iteration path of the test plan.

name
  • string

Name of the test plan.

owner

Owner of the test plan.

previousBuild

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

project

Project which contains the test plan.

releaseEnvironmentDefinition

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

revision
  • integer

Revision of the test plan.

rootSuite

Root test suite of the test plan.

startDate
  • string

Start date for the test plan.

state
  • string

State of the test plan.

testOutcomeSettings

Value to configure how same tests across test suites under a test plan need to behave

updatedBy
updatedDate
  • string
url
  • string

URL of the test plan resource.