次の方法で共有

Test Plans - Create

  • リファレンス
Service:
Test
API Version:
5.0

テスト計画を作成します。

POST https://dev.azure.com/{organization}/{project}/_apis/test/plans?api-version=5.0

URI パラメーター

名前 / 必須 型 説明
organization
 path True

string

Azure DevOps 組織の名前です。
project
 path True

string

プロジェクト ID またはプロジェクト名
api-version
 query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '5.0' に設定する必要があります。

要求本文

名前 型 説明
area

ShallowReference

テスト計画が属するエリア パス。 これは、このテスト計画で動作するチームのエリア パスに設定する必要があります。
build

ShallowReference

このテスト 計画のテストによって品質がテストされるビルドのビルド ID。 自動テストの場合、このビルド ID は、自動テスト メソッドを含むテスト バイナリを検索するために使用されます。
buildDefinition

ShallowReference

このテスト 計画に関連付けられているビルドを生成するビルド定義。
configurationIds

integer[]

新しいテスト スイートとテスト ケースがテスト 計画に追加されたときに適用される構成の ID。
description

string

テスト計画の説明。
endDate

string

テスト計画の終了日。
iteration

string

テスト計画に割り当てられたイテレーション パス。 これは、この計画のテストが完了し、製品をリリースする準備ができているターゲットイテレーションがいつ完了するかを示します。
name

string

テスト 計画の名前。
owner

IdentityRef

テスト計画の所有者。
releaseEnvironmentDefinition

ReleaseEnvironmentDefinitionReference

ビルドをデプロイし、このテスト計画から自動テストを実行するために使用されるリリース環境。
startDate

string

テスト計画の開始日。
state

string

テスト計画の状態。
testOutcomeSettings

TestOutcomeSettings

テスト結果の設定

応答

名前 型 説明
200 OK

TestPlan

正常な操作

セキュリティ

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

名前 説明
vso.test_write テスト 計画、ケース、結果、その他のテスト管理関連の成果物を読み取り、作成、更新する機能を付与します。

例

Create a test plan in an area and iteration.
Create a test plan with a description.
Create a test plan with start date and end date.

Create a test plan in an area and iteration.

Sample Request

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "ANewPlan",
  "area": {
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1"
}

Sample Response

Status code:
200 
{
  "id": 16,
  "name": "ANewPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/16",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "411",
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "startDate": "2014-05-06T13:43:02.803578Z",
  "endDate": "2014-05-13T13:43:02.803578Z",
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1",
  "updatedDate": "2014-05-06T13:43:02.187Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_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://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "33",
    "name": "ANewPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/16/Suites/33"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=16"
}

Create a test plan with a description.

Sample Request

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "newCreatedPlan",
  "description": "This is a new test plan"
}

Sample Response

Status code:
200 
{
  "id": 15,
  "name": "newCreatedPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/15",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "343",
    "name": "Fabrikam-Fiber-TFVC"
  },
  "description": "This is a new test plan",
  "startDate": "2014-05-06T13:42:59.3008007Z",
  "endDate": "2014-05-13T13:42:59.3008007Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-05-06T13:42:58.71Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_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://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "32",
    "name": "newCreatedPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/15/Suites/32"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=15"
}

Create a test plan with start date and end date.

Sample Request

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "ANewPlan",
  "startDate": "2014-05-01",
  "endDate": "2014-05-10"
}

Sample Response

Status code:
200 
{
  "id": 17,
  "name": "ANewPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/17",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "343",
    "name": "Fabrikam-Fiber-TFVC"
  },
  "startDate": "2014-05-01T00:00:00Z",
  "endDate": "2014-05-10T00:00:00Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-05-06T13:43:04.743Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_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://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "34",
    "name": "ANewPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/17/Suites/34"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=17"
}

定義

名前 説明
IdentityRef
PlanUpdateModel

テスト 計画の作成と更新に使用されるモデル クラス。
ReferenceLinks

REST 参照リンクのコレクションを表す クラス。
ReleaseEnvironmentDefinitionReference

リリース環境リソースへの参照。
ShallowReference

他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。
TestOutcomeSettings

テスト結果の設定
TestPlan

テスト計画リソース。

IdentityRef

名前 型 説明
_links

ReferenceLinks

このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor

string

記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias

string

displayName

string

これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。
id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

この URL は、このグラフの件名のソース リソースへの完全なルートです。

PlanUpdateModel

テスト 計画の作成と更新に使用されるモデル クラス。

名前 型 説明
area

ShallowReference

テスト計画が属するエリア パス。 これは、このテスト計画で動作するチームのエリア パスに設定する必要があります。
build

ShallowReference

このテスト 計画のテストによって品質がテストされるビルドのビルド ID。 自動テストの場合、このビルド ID は、自動テスト メソッドを含むテスト バイナリを検索するために使用されます。
buildDefinition

ShallowReference

このテスト 計画に関連付けられているビルドを生成するビルド定義。
configurationIds

integer[]

新しいテスト スイートとテスト ケースがテスト 計画に追加されたときに適用される構成の ID。
description

string

テスト計画の説明。
endDate

string

テスト計画の終了日。
iteration

string

テスト計画に割り当てられたイテレーション パス。 これは、この計画のテストが完了し、製品をリリースする準備ができているターゲットイテレーションがいつ完了するかを示します。
name

string

テスト 計画の名前。
owner

IdentityRef

テスト計画の所有者。
releaseEnvironmentDefinition

ReleaseEnvironmentDefinitionReference

ビルドをデプロイし、このテスト計画から自動テストを実行するために使用されるリリース環境。
startDate

string

テスト計画の開始日。
state

string

テスト計画の状態。
testOutcomeSettings

TestOutcomeSettings

テスト結果の設定

REST 参照リンクのコレクションを表す クラス。

名前 型 説明
links

object

リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

ReleaseEnvironmentDefinitionReference

リリース環境リソースへの参照。

名前 型 説明
definitionId

integer

リリース環境定義を含むリリース定義の ID。
environmentDefinitionId

integer

リリース環境定義の ID。

ShallowReference

他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。

名前 型 説明
id

string

リソースの ID
name

string

リンクされたリソースの名前 (定義名、コントローラー名など)
url

string

リソースへの完全な http リンク

TestOutcomeSettings

テスト結果の設定

名前 型 説明
syncOutcomeAcrossSuites

boolean

スイート間で同じテストのテスト結果を表示する方法を構成する値

TestPlan

テスト計画リソース。

名前 型 説明
area

ShallowReference

テスト計画の領域。
build

ShallowReference

テスト対象のビルド。
buildDefinition

ShallowReference

このテスト 計画に関連付けられているビルドを生成するビルド定義。
description

string

テスト計画の説明。
endDate

string

テスト計画の終了日。
id

integer

テスト 計画の ID。
iteration

string

テスト計画のイテレーション パス。
name

string

テスト 計画の名前。
owner

IdentityRef

テスト計画の所有者。
previousBuild

ShallowReference

他のリソースへの抽象化された参照。 このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルド データ コントラクトを提供するために使用されます。
project

ShallowReference

テスト計画を含むプロジェクト。
releaseEnvironmentDefinition

ReleaseEnvironmentDefinitionReference

ビルドをデプロイし、このテスト計画から自動テストを実行するために使用されるリリース環境。
revision

integer

テスト計画の改訂。
rootSuite

ShallowReference

テスト計画のルート テスト スイート。
startDate

string

テスト計画の開始日。
state

string

テスト計画の状態。
testOutcomeSettings

TestOutcomeSettings

テスト計画の下でテスト スイート間で同じテストを実行する必要がある方法を構成するための値
updatedBy

IdentityRef

updatedDate

string

url

string

テスト 計画リソースの URL。