Test Plans - Create

참조

Service:: Test

API Version:: 5.0

테스트 계획을 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '5.0'으로 설정해야 합니다.

요청 본문

Name	형식	Description
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	테스트 결과 설정

응답

Name	형식	Description
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

Name	Description
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

HTTP

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

HTTP

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

HTTP

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"
}

정의

Name	Description
IdentityRef
PlanUpdateModel	테스트 계획을 만들고 업데이트하는 데 사용되는 모델 클래스입니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
ReleaseEnvironmentDefinitionReference	릴리스 환경 리소스에 대한 참조입니다.
ShallowReference	다른 리소스에 대한 추상화된 참조입니다. 이 클래스는 링크를 통해 쉽게 트래버스할 수 있는 방식으로 다른 리소스를 참조하는 균일한 방법으로 빌드 데이터 계약을 제공하는 데 사용됩니다.
TestOutcomeSettings	테스트 결과 설정
TestPlan	테스트 계획 리소스입니다.

IdentityRef

Name	형식	Description
_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

테스트 계획을 만들고 업데이트하는 데 사용되는 모델 클래스입니다.

Name	형식	Description
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	테스트 결과 설정

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

ReleaseEnvironmentDefinitionReference

릴리스 환경 리소스에 대한 참조입니다.

Name	형식	Description
definitionId	integer	릴리스 환경 정의를 포함하는 릴리스 정의의 ID입니다.
environmentDefinitionId	integer	릴리스 환경 정의의 ID입니다.

ShallowReference

다른 리소스에 대한 추상화된 참조입니다. 이 클래스는 링크를 통해 쉽게 트래버스할 수 있는 방식으로 다른 리소스를 참조하는 균일한 방법으로 빌드 데이터 계약을 제공하는 데 사용됩니다.

Name	형식	Description
id	string	리소스의 ID
name	string	연결된 리소스의 이름(정의 이름, 컨트롤러 이름 등)
url	string	리소스에 대한 전체 http 링크

TestOutcomeSettings

테스트 결과 설정

Name	형식	Description
syncOutcomeAcrossSuites	boolean	도구 모음에서 동일한 테스트에 대한 테스트 결과가 표시되는 방식을 구성하는 값

TestPlan

테스트 계획 리소스입니다.

Name	형식	Description
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입니다.

다음을 통해 공유

Test Plans - Create

URI 매개 변수

요청 본문

응답

보안

oauth2

Scopes

예제

Create a test plan in an area and iteration.

Sample Request

Sample Response

Create a test plan with a description.

Sample Request

Sample Response

Create a test plan with start date and end date.

Sample Request

Sample Response

정의

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

추가 리소스