Test Plans - Update

参考

服务:: Test Plan

API 版本:: 7.1

更新测试计划。

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/plans/{planId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
planId	path	True	integer (int32)	要更新的测试计划的 ID。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
areaPath	string	测试计划的区域。
buildDefinition	BuildDefinitionReference	生成与此测试计划关联的生成定义的生成。
buildId	integer (int32)	要测试的生成。
description	string	测试计划的说明。
endDate	string (date-time)	测试计划的结束日期。
iteration	string	测试计划的迭代路径。
name	string	测试计划的名称。
owner	IdentityRef	测试计划的所有者。
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	要用于部署生成并从此测试计划运行自动测试的发布环境。
revision	integer (int32)	测试计划的修订。
startDate	string (date-time)	测试计划的开始日期。
state	string	测试计划的状态。
testOutcomeSettings	TestOutcomeSettings	在测试计划下配置跨测试套件的相同测试需要的行为的值

响应

名称	类型	说明
200 OK	TestPlan	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.test_write	授予读取、创建和更新测试计划、事例、结果和其他测试管理相关项目的能力。

示例

Update test plan details.

Update test plan name, area and iteration.

Update test plan details.

示例请求

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans/{planId}?api-version=7.1

{
  "revision": 7,
  "name": "updatedPlan-2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:50:04.7235162+05:30",
  "endDate": "2018-08-26T20:50:04.7235162+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null,
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

示例响应

状态代码:: 200

{
  "id": 9,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:20:05.303Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 10,
    "name": "updatedPlan-2",
    "plan": {
      "id": 9,
      "name": "updatedPlan-2"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=9"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9/Suites/10"
    },
    "build": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Builds/3"
    },
    "buildDefinition": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Definitions/2"
    }
  },
  "revision": 8,
  "name": "updatedPlan-2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:50:04.7235162+05:30",
  "endDate": "2018-08-26T20:50:04.7235162+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

Update test plan name, area and iteration.

示例请求

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans/{planId}?api-version=7.1

{
  "revision": 0,
  "name": "updatedPlan-1",
  "areaPath": "sampleProject\\Team1",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null
}

示例响应

状态代码:: 200

{
  "id": 9,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:20:04.06Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 10,
    "name": "updatedPlan-1",
    "plan": {
      "id": 9,
      "name": "updatedPlan-1"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=9"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9/Suites/10"
    }
  },
  "revision": 7,
  "name": "updatedPlan-1",
  "areaPath": "sampleProject\\Team1",
  "description": "description new<br>",
  "startDate": "2018-08-17T14:33:32.613Z",
  "endDate": "2018-08-24T14:33:32.613Z",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Active",
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

定义

名称	说明
BuildDefinitionReference	生成定义参考资源
IdentityRef
ProjectState	项目状态。
ProjectVisibility	项目可见性。
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseEnvironmentDefinitionReference	对发布环境资源的引用。
TeamProjectReference	表示对 TeamProject 的浅表引用。
TestOutcomeSettings	测试结果设置
TestPlan	测试计划资源。
TestPlanUpdateParams	测试计划更新参数。
TestSuiteReference	测试套件参考资源。

BuildDefinitionReference

Object

生成定义参考资源

名称	类型	说明
id	integer (int32)	生成定义的 ID
name	string	生成定义的名称

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

ProjectState

枚举

项目状态。

值	说明
all	所有项目，无论状态如何，都已删除。
createPending	项目已排队创建，但该过程尚未启动。
deleted	项目已被删除。
deleting	项目正在删除。
new	正在创建项目。
unchanged	项目尚未更改。
wellFormed	项目已完全创建并可供使用。

ProjectVisibility

枚举

项目可见性。

值	说明
private	只有具有显式访问权限的用户才能看到该项目。
public	项目对所有人可见。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

ReleaseEnvironmentDefinitionReference

Object

对发布环境资源的引用。

名称	类型	说明
definitionId	integer (int32)	包含发布环境定义的发布定义的 ID。
environmentDefinitionId	integer (int32)	发布环境定义的 ID。

TeamProjectReference

Object

表示对 TeamProject 的浅表引用。

名称	类型	说明
abbreviation	string	项目缩写。
defaultTeamImageUrl	string	指向默认团队标识映像的 URL。
description	string	项目的说明（如果有）。
id	string (uuid)	项目标识符。
lastUpdateTime	string (date-time)	上次更新时间的项目。
name	string	项目名称。
revision	integer (int64)	项目修订。
state	ProjectState	项目状态。
url	string	指向对象完整版本的 URL。
visibility	ProjectVisibility	项目可见性。

TestOutcomeSettings

Object

测试结果设置

名称	类型	说明
syncOutcomeAcrossSuites	boolean	用于配置跨套件的相同测试的测试结果如何显示的值

TestPlan

Object

测试计划资源。

名称	类型	说明
_links	ReferenceLinks	相关链接
areaPath	string	测试计划的区域。
buildDefinition	BuildDefinitionReference	生成与此测试计划关联的生成定义的生成。
buildId	integer (int32)	要测试的生成。
description	string	测试计划的说明。
endDate	string (date-time)	测试计划的结束日期。
id	integer (int32)	测试计划的 ID。
iteration	string	测试计划的迭代路径。
name	string	测试计划的名称。
owner	IdentityRef	测试计划的所有者。
previousBuildId	integer (int32)	与测试计划关联的上一个生成 ID
project	TeamProjectReference	包含测试计划的项目。
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	要用于部署生成并从此测试计划运行自动测试的发布环境。
revision	integer (int32)	测试计划的修订。
rootSuite	TestSuiteReference	测试计划的根测试套件。
startDate	string (date-time)	测试计划的开始日期。
state	string	测试计划的状态。
testOutcomeSettings	TestOutcomeSettings	在测试计划下配置跨测试套件的相同测试需要的行为的值
updatedBy	IdentityRef	测试计划的上次更新的标识参考
updatedDate	string (date-time)	测试计划的更新日期

TestPlanUpdateParams

Object

测试计划更新参数。

名称	类型	说明
areaPath	string	测试计划的区域。
buildDefinition	BuildDefinitionReference	生成与此测试计划关联的生成定义的生成。
buildId	integer (int32)	要测试的生成。
description	string	测试计划的说明。
endDate	string (date-time)	测试计划的结束日期。
iteration	string	测试计划的迭代路径。
name	string	测试计划的名称。
owner	IdentityRef	测试计划的所有者。
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	要用于部署生成并从此测试计划运行自动测试的发布环境。
revision	integer (int32)	测试计划的修订。
startDate	string (date-time)	测试计划的开始日期。
state	string	测试计划的状态。
testOutcomeSettings	TestOutcomeSettings	在测试计划下配置跨测试套件的相同测试需要的行为的值

TestSuiteReference

Object

测试套件参考资源。

名称	类型	说明
id	integer (int32)	测试套件的 ID。
name	string	测试套件的名称。

通过

Test Plans - Update

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

Update test plan details.

示例请求

示例响应

Update test plan name, area and iteration.

示例请求

示例响应

定义

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanUpdateParams

TestSuiteReference

其他资源